.github/workflows/ci-pr-validation.yaml - pulsar-client-cpp - Git at Google

 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
 # regarding copyright ownership.  The ASF licenses this file
 # to you under the Apache License, Version 2.0 (the
 # "License"); you may not use this file except in compliance
 # with the License.  You may obtain a copy of the License at
 #
 #   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
 #

 name: PR validation
 on:
   pull_request:
     branches:
       - main

 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true

 jobs:

   wireshark-dissector-build:
     name: Build the Wireshark dissector
     runs-on: ${{ matrix.os }}
     timeout-minutes: 60
     strategy:
       matrix:
         os: [ubuntu-20.04, macos-12]

     steps:
       - name: checkout
         uses: actions/checkout@v3

       - name: Install deps (Ubuntu)
         if: ${{ startsWith(matrix.os, 'ubuntu') }}
         run: |
           sudo apt-get update -y
           sudo apt-get install -y protobuf-compiler libprotobuf-dev wireshark-dev

       - name: Install deps (macOS)
         if: ${{ startsWith(matrix.os, 'macos') }}
         run: |
           # See https://github.com/Homebrew/homebrew-core/issues/157142
           export HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK=1
           brew update
           brew install pkg-config wireshark protobuf
       - name: Build wireshark plugin
         run: |
           cmake -S wireshark -B build-wireshark
           cmake --build build-wireshark

   unit-tests:
     name: Run unit tests
     runs-on: ubuntu-22.04
     timeout-minutes: 120

     steps:
       - name: checkout
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
           submodules: recursive

       - name: Build core libraries
         run: |
           cmake . -DINTEGRATE_VCPKG=ON -DBUILD_TESTS=OFF
           cmake --build . -j8

       - name: Check formatting
         run: |
           ./vcpkg/vcpkg format-manifest vcpkg.json
           if [[ $(git diff | wc -l) -gt 0 ]]; then
               echo "Please run `./vcpkg/vcpkg format-manifest vcpkg.json` to reformat vcpkg.json"
           fi
           make check-format

       - name: Build tests
         run: |
           cmake . -DINTEGRATE_VCPKG=ON -DBUILD_TESTS=ON
           cmake --build . -j8

       - name: Install gtest-parallel
         run: |
           sudo curl -o /gtest-parallel https://raw.githubusercontent.com/google/gtest-parallel/master/gtest_parallel.py

       - name: Run unit tests
         run: RETRY_FAILED=3 ./run-unit-tests.sh

       - name: Build perf tools
         run: |
           cmake . -DINTEGRATE_VCPKG=ON -DBUILD_TESTS=ON -DBUILD_PERF_TOOLS=ON
           cmake --build . -j8

   cpp20-build:
     name: Build with the C++20 standard
     runs-on: ubuntu-22.04
     timeout-minutes: 60

     steps:
       - name: checkout
         uses: actions/checkout@v3
       - name: Install deps
         run: |
           sudo apt-get update -y
           sudo apt-get install -y libcurl4-openssl-dev libssl-dev \
             protobuf-compiler libprotobuf-dev libboost-dev \
             libboost-dev libboost-program-options-dev \
             libzstd-dev libsnappy-dev libgmock-dev libgtest-dev
       - name: CMake
         run: cmake -B build -DBUILD_PERF_TOOLS=ON -DCMAKE_CXX_STANDARD=20
       - name: Build
         run: |
           cmake --build build -j8 --target pulsarShared pulsarStatic
           cmake --build build -j8

   cpp-build-windows:
     timeout-minutes: 120
     name: Build CPP Client on ${{ matrix.name }}
     needs: unit-tests
     runs-on: ${{ matrix.os }}
     env:
       VCPKG_ROOT: '${{ github.workspace }}/vcpkg'
       INSTALL_DIR: 'C:\\pulsar-cpp'
     strategy:
       fail-fast: false
       matrix:
         include:
           - name: 'Windows x64'
             os: windows-2019
             triplet: x64-windows-static
             suffix: 'windows-win64'
             generator: 'Visual Studio 16 2019'
             arch: '-A x64'
           - name: 'Windows x86'
             os: windows-2019
             triplet: x86-windows-static
             suffix: 'windows-win32'
             generator: 'Visual Studio 16 2019'
             arch: '-A Win32'

     steps:
       - name: checkout
         uses: actions/checkout@v3

       - name: Restore vcpkg and its artifacts.
         uses: actions/cache@v3
         id: vcpkg-cache
         with:
           path: |
             ${{ env.VCPKG_ROOT }}
             vcpkg_installed
             !${{ env.VCPKG_ROOT }}/.git
             !${{ env.VCPKG_ROOT }}/buildtrees
             !${{ env.VCPKG_ROOT }}/packages
             !${{ env.VCPKG_ROOT }}/downloads
           key: |
             ${{ runner.os }}-${{ matrix.triplet}}-${{ hashFiles( 'vcpkg.json' ) }}

       - name: Get vcpkg(windows)
         if: ${{ runner.os == 'Windows' && steps.vcpkg-cache.outputs.cache-hit != 'true' }}
         run: |
           cd ${{ github.workspace }}
           mkdir build -force
           git clone https://github.com/Microsoft/vcpkg.git
           cd vcpkg
           .\bootstrap-vcpkg.bat

       - name: remove system vcpkg(windows)
         if: runner.os == 'Windows'
         run: rm -rf "$VCPKG_INSTALLATION_ROOT"
         shell: bash

       - name: Install vcpkg packages
         run: |
           ${{ env.VCPKG_ROOT }}\vcpkg.exe install --triplet ${{ matrix.triplet }}

       - name: Configure
         shell: bash
         run: |
           if [ "$RUNNER_OS" == "Windows" ]; then
             cmake \
               -B ./build-1 \
               -G "${{ matrix.generator }}" ${{ matrix.arch }} \
               -DUSE_ASIO=ON \
               -DBUILD_TESTS=OFF \
               -DVCPKG_TRIPLET="${{ matrix.triplet }}" \
               -DCMAKE_INSTALL_PREFIX="${{ env.INSTALL_DIR }}" \
               -S .
           fi

       - name: Install
         shell: bash
         run: |
           if [ "$RUNNER_OS" == "Windows" ]; then
             cmake --build ./build-1 --parallel --config Release
             cmake --install ./build-1
           fi

       - name: Test examples
         shell: bash
         run: |
           if [ "$RUNNER_OS" == "Windows" ]; then
             cd win-examples
             cmake \
               -G "${{ matrix.generator }}" ${{ matrix.arch }} \
               -DLINK_STATIC=OFF \
               -DCMAKE_PREFIX_PATH=${{ env.INSTALL_DIR }} \
               -B build-dynamic
             cmake --build build-dynamic --config Release
             cmake \
               -G "${{ matrix.generator }}" ${{ matrix.arch }} \
               -DLINK_STATIC=ON \
               -DCMAKE_PREFIX_PATH=${{ env.INSTALL_DIR }} \
               -B build-static
             cmake --build build-static --config Release
             ./build-static/Release/win-example.exe
           fi

       - name: Build (Debug)
         shell: bash
         run: |
           if [ "$RUNNER_OS" == "Windows" ]; then
             cmake \
               -B ./build-2 \
               -G "${{ matrix.generator }}" ${{ matrix.arch }} \
               -DUSE_ASIO=ON \
               -DBUILD_TESTS=OFF \
               -DVCPKG_TRIPLET="${{ matrix.triplet }}" \
               -DCMAKE_INSTALL_PREFIX="${{ env.INSTALL_DIR }}" \
               -DCMAKE_BUILD_TYPE=Debug \
               -S .
             cmake --build ./build-2 --parallel --config Debug
           fi

   package:
     name: Build ${{matrix.pkg.name}} ${{matrix.cpu.platform}}
     runs-on: ubuntu-22.04
     needs: unit-tests
     timeout-minutes: 500

     strategy:
       fail-fast: true
       matrix:
         pkg:
           - { name: 'RPM', type: 'rpm', path: 'pkg/rpm/RPMS' }
           - { name: 'Deb', type: 'deb', path: 'pkg/deb/BUILD/DEB' }
           - { name: 'Alpine', type: 'apk', path: 'pkg/apk/build' }
         cpu:
           - { arch: 'x86_64', platform: 'x86_64' }

     steps:
       - name: checkout
         uses: actions/checkout@v3

       - name: Set up QEMU
         uses: docker/setup-qemu-action@v2

       - name: Package Pulsar source
         run: build-support/generate-source-archive.sh

       - uses: docker/setup-buildx-action@v2
       - run: build-support/copy-deps-versionfile.sh

       - name: Build dependencies Docker image
         uses: docker/build-push-action@v3
         with:
           context: ./pkg/${{matrix.pkg.type}}
           load: true
           tags: build:latest
           platforms: linux/${{matrix.cpu.platform}}
           build-args: PLATFORM=${{matrix.cpu.arch}}
           cache-from: type=gha
           cache-to: type=gha,mode=max

       - name: Build packages
         run: pkg/${{matrix.pkg.type}}/docker-build-${{matrix.pkg.type}}-${{matrix.cpu.platform}}.sh build:latest

   cpp-build-macos:
     timeout-minutes: 120
     name: Build CPP Client on macOS
     runs-on: macos-12
     needs: unit-tests
     steps:
       - name: checkout
         uses: actions/checkout@v3

       - name: Install dependencies
         run: brew install openssl protobuf boost zstd snappy googletest

       - name: Configure (default)
         shell: bash
         run: cmake -B ./build-macos -S .

       - name: Compile
         shell: bash
         run: |
           cmake --build ./build-macos --parallel --config Release

   cpp-build-macos-static:
     timeout-minutes: 120
     name: Build CPP Client on macOS with static dependencies
     runs-on: macos-12
     needs: unit-tests
     steps:
       - name: checkout
         uses: actions/checkout@v3

       - name: Build libraries
         run: ./pkg/mac/build-static-library.sh

       - name: Test static libraries
         run: |
           export PULSAR_DIR=$PWD/pkg/mac/.install
           echo "Build with static library"
           clang++ win-examples/example.cc -o static.out -std=c++11 -I $PULSAR_DIR/include $PULSAR_DIR/lib/libpulsarwithdeps.a
           ./static.out
           echo "Build with dynamic library"
           clang++ win-examples/example.cc -o dynamic.out -std=c++11 -I $PULSAR_DIR/include -L $PULSAR_DIR/lib -Wl,-rpath $PULSAR_DIR/lib -lpulsar
           ./dynamic.out

   # Job that will be required to complete and depends on all the other jobs
   check-completion:
     name: Check Completion
     runs-on: ubuntu-latest
     needs: [wireshark-dissector-build, unit-tests, cpp20-build, cpp-build-windows, package, cpp-build-macos]

     steps:
       - run: true
	#
	# Licensed to the Apache Software Foundation (ASF) under one
	# or more contributor license agreements. See the NOTICE file
	# distributed with this work for additional information
	# regarding copyright ownership. The ASF licenses this file
	# to you under the Apache License, Version 2.0 (the
	# "License"); you may not use this file except in compliance
	# with the License. You may obtain a copy of the License at
	#
	# http://www.apache.org/licenses/LICENSE-2.0
	#
	# Unless required by applicable law or agreed to in writing,
	# software distributed under the License is distributed on an
	# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	# KIND, either express or implied. See the License for the
	# specific language governing permissions and limitations
	# under the License.
	#

	name: PR validation
	on:
	pull_request:
	branches:
	- main

	concurrency:
	group: ${{ github.workflow }}-${{ github.ref }}
	cancel-in-progress: true

	jobs:

	wireshark-dissector-build:
	name: Build the Wireshark dissector
	runs-on: ${{ matrix.os }}
	timeout-minutes: 60
	strategy:
	matrix:
	os: [ubuntu-20.04, macos-12]

	steps:
	- name: checkout
	uses: actions/checkout@v3

	- name: Install deps (Ubuntu)
	if: ${{ startsWith(matrix.os, 'ubuntu') }}
	run: \|
	sudo apt-get update -y
	sudo apt-get install -y protobuf-compiler libprotobuf-dev wireshark-dev

	- name: Install deps (macOS)
	if: ${{ startsWith(matrix.os, 'macos') }}
	run: \|
	# See https://github.com/Homebrew/homebrew-core/issues/157142
	export HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK=1
	brew update
	brew install pkg-config wireshark protobuf
	- name: Build wireshark plugin
	run: \|
	cmake -S wireshark -B build-wireshark
	cmake --build build-wireshark

	unit-tests:
	name: Run unit tests
	runs-on: ubuntu-22.04
	timeout-minutes: 120

	steps:
	- name: checkout
	uses: actions/checkout@v3
	with:
	fetch-depth: 0
	submodules: recursive

	- name: Build core libraries
	run: \|
	cmake . -DINTEGRATE_VCPKG=ON -DBUILD_TESTS=OFF
	cmake --build . -j8

	- name: Check formatting
	run: \|
	./vcpkg/vcpkg format-manifest vcpkg.json
	if [[ $(git diff \| wc -l) -gt 0 ]]; then
	echo "Please run `./vcpkg/vcpkg format-manifest vcpkg.json` to reformat vcpkg.json"
	fi
	make check-format

	- name: Build tests
	run: \|
	cmake . -DINTEGRATE_VCPKG=ON -DBUILD_TESTS=ON
	cmake --build . -j8

	- name: Install gtest-parallel
	run: \|
	sudo curl -o /gtest-parallel https://raw.githubusercontent.com/google/gtest-parallel/master/gtest_parallel.py

	- name: Run unit tests
	run: RETRY_FAILED=3 ./run-unit-tests.sh

	- name: Build perf tools
	run: \|
	cmake . -DINTEGRATE_VCPKG=ON -DBUILD_TESTS=ON -DBUILD_PERF_TOOLS=ON
	cmake --build . -j8

	cpp20-build:
	name: Build with the C++20 standard
	runs-on: ubuntu-22.04
	timeout-minutes: 60

	steps:
	- name: checkout
	uses: actions/checkout@v3
	- name: Install deps
	run: \|
	sudo apt-get update -y
	sudo apt-get install -y libcurl4-openssl-dev libssl-dev \
	protobuf-compiler libprotobuf-dev libboost-dev \
	libboost-dev libboost-program-options-dev \
	libzstd-dev libsnappy-dev libgmock-dev libgtest-dev
	- name: CMake
	run: cmake -B build -DBUILD_PERF_TOOLS=ON -DCMAKE_CXX_STANDARD=20
	- name: Build
	run: \|
	cmake --build build -j8 --target pulsarShared pulsarStatic
	cmake --build build -j8

	cpp-build-windows:
	timeout-minutes: 120
	name: Build CPP Client on ${{ matrix.name }}
	needs: unit-tests
	runs-on: ${{ matrix.os }}
	env:
	VCPKG_ROOT: '${{ github.workspace }}/vcpkg'
	INSTALL_DIR: 'C:\\pulsar-cpp'
	strategy:
	fail-fast: false
	matrix:
	include:
	- name: 'Windows x64'
	os: windows-2019
	triplet: x64-windows-static
	suffix: 'windows-win64'
	generator: 'Visual Studio 16 2019'
	arch: '-A x64'
	- name: 'Windows x86'
	os: windows-2019
	triplet: x86-windows-static
	suffix: 'windows-win32'
	generator: 'Visual Studio 16 2019'
	arch: '-A Win32'

	steps:
	- name: checkout
	uses: actions/checkout@v3

	- name: Restore vcpkg and its artifacts.
	uses: actions/cache@v3
	id: vcpkg-cache
	with:
	path: \|
	${{ env.VCPKG_ROOT }}
	vcpkg_installed
	!${{ env.VCPKG_ROOT }}/.git
	!${{ env.VCPKG_ROOT }}/buildtrees
	!${{ env.VCPKG_ROOT }}/packages
	!${{ env.VCPKG_ROOT }}/downloads
	key: \|
	${{ runner.os }}-${{ matrix.triplet}}-${{ hashFiles( 'vcpkg.json' ) }}

	- name: Get vcpkg(windows)
	if: ${{ runner.os == 'Windows' && steps.vcpkg-cache.outputs.cache-hit != 'true' }}
	run: \|
	cd ${{ github.workspace }}
	mkdir build -force
	git clone https://github.com/Microsoft/vcpkg.git
	cd vcpkg
	.\bootstrap-vcpkg.bat

	- name: remove system vcpkg(windows)
	if: runner.os == 'Windows'
	run: rm -rf "$VCPKG_INSTALLATION_ROOT"
	shell: bash

	- name: Install vcpkg packages
	run: \|
	${{ env.VCPKG_ROOT }}\vcpkg.exe install --triplet ${{ matrix.triplet }}

	- name: Configure
	shell: bash
	run: \|
	if [ "$RUNNER_OS" == "Windows" ]; then
	cmake \
	-B ./build-1 \
	-G "${{ matrix.generator }}" ${{ matrix.arch }} \
	-DUSE_ASIO=ON \
	-DBUILD_TESTS=OFF \
	-DVCPKG_TRIPLET="${{ matrix.triplet }}" \
	-DCMAKE_INSTALL_PREFIX="${{ env.INSTALL_DIR }}" \
	-S .
	fi

	- name: Install
	shell: bash
	run: \|
	if [ "$RUNNER_OS" == "Windows" ]; then
	cmake --build ./build-1 --parallel --config Release
	cmake --install ./build-1
	fi

	- name: Test examples
	shell: bash
	run: \|
	if [ "$RUNNER_OS" == "Windows" ]; then
	cd win-examples
	cmake \
	-G "${{ matrix.generator }}" ${{ matrix.arch }} \
	-DLINK_STATIC=OFF \
	-DCMAKE_PREFIX_PATH=${{ env.INSTALL_DIR }} \
	-B build-dynamic
	cmake --build build-dynamic --config Release
	cmake \
	-G "${{ matrix.generator }}" ${{ matrix.arch }} \
	-DLINK_STATIC=ON \
	-DCMAKE_PREFIX_PATH=${{ env.INSTALL_DIR }} \
	-B build-static
	cmake --build build-static --config Release
	./build-static/Release/win-example.exe
	fi

	- name: Build (Debug)
	shell: bash
	run: \|
	if [ "$RUNNER_OS" == "Windows" ]; then
	cmake \
	-B ./build-2 \
	-G "${{ matrix.generator }}" ${{ matrix.arch }} \
	-DUSE_ASIO=ON \
	-DBUILD_TESTS=OFF \
	-DVCPKG_TRIPLET="${{ matrix.triplet }}" \
	-DCMAKE_INSTALL_PREFIX="${{ env.INSTALL_DIR }}" \
	-DCMAKE_BUILD_TYPE=Debug \
	-S .
	cmake --build ./build-2 --parallel --config Debug
	fi

	package:
	name: Build ${{matrix.pkg.name}} ${{matrix.cpu.platform}}
	runs-on: ubuntu-22.04
	needs: unit-tests
	timeout-minutes: 500

	strategy:
	fail-fast: true
	matrix:
	pkg:
	- { name: 'RPM', type: 'rpm', path: 'pkg/rpm/RPMS' }
	- { name: 'Deb', type: 'deb', path: 'pkg/deb/BUILD/DEB' }
	- { name: 'Alpine', type: 'apk', path: 'pkg/apk/build' }
	cpu:
	- { arch: 'x86_64', platform: 'x86_64' }

	steps:
	- name: checkout
	uses: actions/checkout@v3

	- name: Set up QEMU
	uses: docker/setup-qemu-action@v2

	- name: Package Pulsar source
	run: build-support/generate-source-archive.sh

	- uses: docker/setup-buildx-action@v2
	- run: build-support/copy-deps-versionfile.sh

	- name: Build dependencies Docker image
	uses: docker/build-push-action@v3
	with:
	context: ./pkg/${{matrix.pkg.type}}
	load: true
	tags: build:latest
	platforms: linux/${{matrix.cpu.platform}}
	build-args: PLATFORM=${{matrix.cpu.arch}}
	cache-from: type=gha
	cache-to: type=gha,mode=max

	- name: Build packages
	run: pkg/${{matrix.pkg.type}}/docker-build-${{matrix.pkg.type}}-${{matrix.cpu.platform}}.sh build:latest

	cpp-build-macos:
	timeout-minutes: 120
	name: Build CPP Client on macOS
	runs-on: macos-12
	needs: unit-tests
	steps:
	- name: checkout
	uses: actions/checkout@v3

	- name: Install dependencies
	run: brew install openssl protobuf boost zstd snappy googletest

	- name: Configure (default)
	shell: bash
	run: cmake -B ./build-macos -S .

	- name: Compile
	shell: bash
	run: \|
	cmake --build ./build-macos --parallel --config Release

	cpp-build-macos-static:
	timeout-minutes: 120
	name: Build CPP Client on macOS with static dependencies
	runs-on: macos-12
	needs: unit-tests
	steps:
	- name: checkout
	uses: actions/checkout@v3

	- name: Build libraries
	run: ./pkg/mac/build-static-library.sh

	- name: Test static libraries
	run: \|
	export PULSAR_DIR=$PWD/pkg/mac/.install
	echo "Build with static library"
	clang++ win-examples/example.cc -o static.out -std=c++11 -I $PULSAR_DIR/include $PULSAR_DIR/lib/libpulsarwithdeps.a
	./static.out
	echo "Build with dynamic library"
	clang++ win-examples/example.cc -o dynamic.out -std=c++11 -I $PULSAR_DIR/include -L $PULSAR_DIR/lib -Wl,-rpath $PULSAR_DIR/lib -lpulsar
	./dynamic.out

	# Job that will be required to complete and depends on all the other jobs
	check-completion:
	name: Check Completion
	runs-on: ubuntu-latest
	needs: [wireshark-dissector-build, unit-tests, cpp20-build, cpp-build-windows, package, cpp-build-macos]

	steps:
	- run: true