refactor(sync): replace legacy examples with structured sync scenario… #5
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Sync Strict CI | |
| on: | |
| push: | |
| branches: [main, master, dev] | |
| paths: | |
| - ".github/workflows/sync-strict-ci.yml" | |
| - "CMakeLists.txt" | |
| - "include/**" | |
| - "src/**" | |
| - "tests/**" | |
| - "examples/**" | |
| - "docs/**" | |
| - "README.md" | |
| - "CHANGELOG.md" | |
| - "vix.json" | |
| pull_request: | |
| branches: [main, master, dev] | |
| paths: | |
| - ".github/workflows/sync-strict-ci.yml" | |
| - "CMakeLists.txt" | |
| - "include/**" | |
| - "src/**" | |
| - "tests/**" | |
| - "examples/**" | |
| - "docs/**" | |
| - "README.md" | |
| - "CHANGELOG.md" | |
| - "vix.json" | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| env: | |
| DEPS: > | |
| build-essential | |
| cmake | |
| ninja-build | |
| clang | |
| llvm | |
| lld | |
| g++ | |
| cppcheck | |
| clang-tidy | |
| valgrind | |
| pkg-config | |
| git | |
| libasio-dev | |
| nlohmann-json3-dev | |
| BUILD_JOBS: 2 | |
| VIX_GIT_BRANCH: dev | |
| jobs: | |
| build-test-sanitized: | |
| name: Sanitized Build and Tests (${{ matrix.compiler }}, utils=${{ matrix.fetch_utils }}, net=${{ matrix.fetch_net }}, json=${{ matrix.fetch_json }}) | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| compiler: [clang, gcc] | |
| fetch_utils: [OFF] | |
| fetch_net: [OFF] | |
| fetch_json: [OFF] | |
| steps: | |
| - name: Checkout sync repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update -y | |
| sudo apt-get install -y $DEPS | |
| test -f /usr/include/asio.hpp || (echo "::error::System Asio header not found after install"; exit 1) | |
| - name: Fetch sibling dependencies | |
| run: | | |
| rm -rf ../utils ../net ../json | |
| git clone --depth 1 --branch "${VIX_GIT_BRANCH}" https://github.com/vixcpp/utils.git ../utils | |
| git clone --depth 1 --branch "${VIX_GIT_BRANCH}" https://github.com/vixcpp/net.git ../net | |
| git clone --depth 1 --branch "${VIX_GIT_BRANCH}" https://github.com/vixcpp/json.git ../json | |
| echo "---- sibling dependencies ----" | |
| ls -la ../utils || true | |
| ls -la ../net || true | |
| ls -la ../json || true | |
| - name: Verify required sibling dependencies | |
| run: | | |
| test -f ../utils/CMakeLists.txt || (echo "::error::../utils/CMakeLists.txt is missing"; exit 1) | |
| test -f ../net/CMakeLists.txt || (echo "::error::../net/CMakeLists.txt is missing"; exit 1) | |
| test -f ../json/CMakeLists.txt || (echo "::error::../json/CMakeLists.txt is missing"; exit 1) | |
| test -f ../json/include/vix/json/Simple.hpp || (echo "::error::../json/include/vix/json/Simple.hpp is missing"; exit 1) | |
| - name: Export dependency include paths | |
| run: | | |
| echo "CPATH=$GITHUB_WORKSPACE/../json/include:$GITHUB_WORKSPACE/../utils/include:$GITHUB_WORKSPACE/../net/include${CPATH:+:$CPATH}" >> "$GITHUB_ENV" | |
| echo "CPLUS_INCLUDE_PATH=$GITHUB_WORKSPACE/../json/include:$GITHUB_WORKSPACE/../utils/include:$GITHUB_WORKSPACE/../net/include${CPLUS_INCLUDE_PATH:+:$CPLUS_INCLUDE_PATH}" >> "$GITHUB_ENV" | |
| - name: Select compiler | |
| run: | | |
| if [ "${{ matrix.compiler }}" = "clang" ]; then | |
| echo "CC=clang" >> "$GITHUB_ENV" | |
| echo "CXX=clang++" >> "$GITHUB_ENV" | |
| else | |
| echo "CC=gcc" >> "$GITHUB_ENV" | |
| echo "CXX=g++" >> "$GITHUB_ENV" | |
| fi | |
| - name: Configure | |
| run: | | |
| cmake -G Ninja -S . -B build-sanitize \ | |
| -DCMAKE_BUILD_TYPE=Debug \ | |
| -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \ | |
| -DVIX_ENABLE_SANITIZERS=ON \ | |
| -DVIX_SYNC_BUILD_TESTS=ON \ | |
| -DVIX_SYNC_FETCH_UTILS=${{ matrix.fetch_utils }} \ | |
| -DVIX_SYNC_FETCH_NET=${{ matrix.fetch_net }} \ | |
| -DVIX_SYNC_FETCH_JSON=${{ matrix.fetch_json }} | |
| - name: Build | |
| run: | | |
| cmake --build build-sanitize -j"${BUILD_JOBS}" | |
| - name: Print executables | |
| run: | | |
| echo "---- executables ----" | |
| find build-sanitize -type f -executable | sort || true | |
| - name: Run ctest | |
| run: | | |
| set -e | |
| cd build-sanitize | |
| if ctest --output-on-failure --timeout 90; then | |
| echo "All discovered tests passed." | |
| else | |
| echo "::warning::Some tests failed or no tests were discovered." | |
| test -f Testing/Temporary/LastTest.log && cat Testing/Temporary/LastTest.log || true | |
| exit 0 | |
| fi | |
| runtime-smoke: | |
| name: Runtime Smoke Checks | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout sync repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update -y | |
| sudo apt-get install -y $DEPS | |
| test -f /usr/include/asio.hpp || (echo "::error::System Asio header not found after install"; exit 1) | |
| - name: Fetch sibling dependencies | |
| run: | | |
| rm -rf ../utils ../net ../json | |
| git clone --depth 1 --branch "${VIX_GIT_BRANCH}" https://github.com/vixcpp/utils.git ../utils | |
| git clone --depth 1 --branch "${VIX_GIT_BRANCH}" https://github.com/vixcpp/net.git ../net | |
| git clone --depth 1 --branch "${VIX_GIT_BRANCH}" https://github.com/vixcpp/json.git ../json | |
| - name: Verify required sibling dependencies | |
| run: | | |
| test -f ../utils/CMakeLists.txt || (echo "::error::../utils/CMakeLists.txt is missing"; exit 1) | |
| test -f ../net/CMakeLists.txt || (echo "::error::../net/CMakeLists.txt is missing"; exit 1) | |
| test -f ../json/include/vix/json/Simple.hpp || (echo "::error::JSON headers are missing"; exit 1) | |
| - name: Export dependency include paths | |
| run: | | |
| echo "CPATH=$GITHUB_WORKSPACE/../json/include:$GITHUB_WORKSPACE/../utils/include:$GITHUB_WORKSPACE/../net/include${CPATH:+:$CPATH}" >> "$GITHUB_ENV" | |
| echo "CPLUS_INCLUDE_PATH=$GITHUB_WORKSPACE/../json/include:$GITHUB_WORKSPACE/../utils/include:$GITHUB_WORKSPACE/../net/include${CPLUS_INCLUDE_PATH:+:$CPLUS_INCLUDE_PATH}" >> "$GITHUB_ENV" | |
| - name: Configure runtime build | |
| run: | | |
| cmake -G Ninja -S . -B build-runtime \ | |
| -DCMAKE_BUILD_TYPE=Debug \ | |
| -DVIX_ENABLE_SANITIZERS=OFF \ | |
| -DVIX_SYNC_BUILD_TESTS=ON \ | |
| -DVIX_SYNC_FETCH_UTILS=OFF \ | |
| -DVIX_SYNC_FETCH_NET=OFF \ | |
| -DVIX_SYNC_FETCH_JSON=OFF | |
| - name: Build runtime artifacts | |
| run: | | |
| cmake --build build-runtime -j"${BUILD_JOBS}" | |
| - name: List candidate executables | |
| run: | | |
| echo "---- runtime candidates ----" | |
| find build-runtime -type f -executable | sort || true | |
| - name: Run short smoke tests on executables | |
| shell: bash | |
| run: | | |
| set +e | |
| FAIL=0 | |
| mapfile -t CANDIDATES < <( | |
| find build-runtime -type f -executable | while read -r exe; do | |
| base="$(basename "$exe")" | |
| if [[ ! "$exe" =~ /CMakeFiles/ ]] && [[ ! "$base" =~ (cmake|ctest) ]]; then | |
| echo "$exe" | |
| fi | |
| done | sort -u | |
| ) | |
| if [ ${#CANDIDATES[@]} -eq 0 ]; then | |
| echo "No executable candidates found." | |
| exit 0 | |
| fi | |
| for exe in "${CANDIDATES[@]}"; do | |
| echo "==> Smoke run: $exe" | |
| timeout 5s "$exe" >/tmp/sync_smoke.log 2>&1 | |
| STATUS=$? | |
| cat /tmp/sync_smoke.log || true | |
| if [ $STATUS -ne 0 ] && [ $STATUS -ne 124 ]; then | |
| echo "::warning::Non-zero exit status from $exe (status=$STATUS)" | |
| FAIL=1 | |
| fi | |
| done | |
| if [ $FAIL -ne 0 ]; then | |
| echo "::warning::Some smoke runs reported issues." | |
| else | |
| echo "Smoke runs completed." | |
| fi | |
| exit 0 | |
| static-analysis: | |
| name: Static Analysis | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout sync repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update -y | |
| sudo apt-get install -y $DEPS | |
| test -f /usr/include/asio.hpp || (echo "::error::System Asio header not found after install"; exit 1) | |
| - name: Fetch sibling dependencies | |
| run: | | |
| rm -rf ../utils ../net ../json | |
| git clone --depth 1 --branch "${VIX_GIT_BRANCH}" https://github.com/vixcpp/utils.git ../utils | |
| git clone --depth 1 --branch "${VIX_GIT_BRANCH}" https://github.com/vixcpp/net.git ../net | |
| git clone --depth 1 --branch "${VIX_GIT_BRANCH}" https://github.com/vixcpp/json.git ../json | |
| - name: Verify required sibling dependencies | |
| run: | | |
| test -f ../utils/CMakeLists.txt || (echo "::error::../utils/CMakeLists.txt is missing"; exit 1) | |
| test -f ../net/CMakeLists.txt || (echo "::error::../net/CMakeLists.txt is missing"; exit 1) | |
| test -f ../json/include/vix/json/Simple.hpp || (echo "::error::JSON headers are missing"; exit 1) | |
| - name: Export dependency include paths | |
| run: | | |
| echo "CPATH=$GITHUB_WORKSPACE/../json/include:$GITHUB_WORKSPACE/../utils/include:$GITHUB_WORKSPACE/../net/include${CPATH:+:$CPATH}" >> "$GITHUB_ENV" | |
| echo "CPLUS_INCLUDE_PATH=$GITHUB_WORKSPACE/../json/include:$GITHUB_WORKSPACE/../utils/include:$GITHUB_WORKSPACE/../net/include${CPLUS_INCLUDE_PATH:+:$CPLUS_INCLUDE_PATH}" >> "$GITHUB_ENV" | |
| - name: Configure for analysis | |
| run: | | |
| cmake -G Ninja -S . -B build-analyze \ | |
| -DCMAKE_BUILD_TYPE=Debug \ | |
| -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \ | |
| -DVIX_ENABLE_SANITIZERS=OFF \ | |
| -DVIX_SYNC_BUILD_TESTS=ON \ | |
| -DVIX_SYNC_FETCH_UTILS=OFF \ | |
| -DVIX_SYNC_FETCH_NET=OFF \ | |
| -DVIX_SYNC_FETCH_JSON=OFF | |
| - name: Run clang-tidy on source files | |
| run: | | |
| set +e | |
| find src tests examples -name '*.cpp' -print0 | xargs -0 -n1 -P2 clang-tidy -p build-analyze | |
| STATUS=$? | |
| if [ $STATUS -ne 0 ]; then | |
| echo "::warning::clang-tidy reported issues." | |
| else | |
| echo "clang-tidy completed successfully." | |
| fi | |
| exit 0 | |
| - name: Run cppcheck on headers and sources | |
| run: | | |
| set +e | |
| cppcheck \ | |
| --enable=all \ | |
| --std=c++20 \ | |
| --inconclusive \ | |
| --quiet \ | |
| --suppress=missingIncludeSystem \ | |
| include/ src/ tests/ examples/ | |
| STATUS=$? | |
| if [ $STATUS -ne 0 ]; then | |
| echo "::warning::cppcheck reported issues." | |
| else | |
| echo "cppcheck completed successfully." | |
| fi | |
| exit 0 | |
| valgrind: | |
| name: Valgrind Checks | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 30 | |
| steps: | |
| - name: Checkout sync repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update -y | |
| sudo apt-get install -y $DEPS | |
| test -f /usr/include/asio.hpp || (echo "::error::System Asio header not found after install"; exit 1) | |
| - name: Fetch sibling dependencies | |
| run: | | |
| rm -rf ../utils ../net ../json | |
| git clone --depth 1 --branch "${VIX_GIT_BRANCH}" https://github.com/vixcpp/utils.git ../utils | |
| git clone --depth 1 --branch "${VIX_GIT_BRANCH}" https://github.com/vixcpp/net.git ../net | |
| git clone --depth 1 --branch "${VIX_GIT_BRANCH}" https://github.com/vixcpp/json.git ../json | |
| - name: Verify required sibling dependencies | |
| run: | | |
| test -f ../utils/CMakeLists.txt || (echo "::error::../utils/CMakeLists.txt is missing"; exit 1) | |
| test -f ../net/CMakeLists.txt || (echo "::error::../net/CMakeLists.txt is missing"; exit 1) | |
| test -f ../json/include/vix/json/Simple.hpp || (echo "::error::JSON headers are missing"; exit 1) | |
| - name: Export dependency include paths | |
| run: | | |
| echo "CPATH=$GITHUB_WORKSPACE/../json/include:$GITHUB_WORKSPACE/../utils/include:$GITHUB_WORKSPACE/../net/include${CPATH:+:$CPATH}" >> "$GITHUB_ENV" | |
| echo "CPLUS_INCLUDE_PATH=$GITHUB_WORKSPACE/../json/include:$GITHUB_WORKSPACE/../utils/include:$GITHUB_WORKSPACE/../net/include${CPLUS_INCLUDE_PATH:+:$CPLUS_INCLUDE_PATH}" >> "$GITHUB_ENV" | |
| - name: Configure valgrind build | |
| run: | | |
| cmake -G Ninja -S . -B build-valgrind \ | |
| -DCMAKE_BUILD_TYPE=Debug \ | |
| -DVIX_ENABLE_SANITIZERS=OFF \ | |
| -DVIX_SYNC_BUILD_TESTS=ON \ | |
| -DVIX_SYNC_FETCH_UTILS=OFF \ | |
| -DVIX_SYNC_FETCH_NET=OFF \ | |
| -DVIX_SYNC_FETCH_JSON=OFF | |
| - name: Build | |
| run: | | |
| cmake --build build-valgrind -j"${BUILD_JOBS}" | |
| - name: Run valgrind on executables | |
| shell: bash | |
| run: | | |
| set +e | |
| FAIL=0 | |
| mapfile -t BINS < <( | |
| find build-valgrind -type f -executable | while read -r exe; do | |
| base="$(basename "$exe")" | |
| if [[ ! "$exe" =~ /CMakeFiles/ ]] && [[ ! "$base" =~ (cmake|ctest) ]]; then | |
| echo "$exe" | |
| fi | |
| done | sort -u | |
| ) | |
| if [ ${#BINS[@]} -eq 0 ]; then | |
| echo "No candidate executables found for valgrind." | |
| exit 0 | |
| fi | |
| for exe in "${BINS[@]}"; do | |
| echo "==> Valgrind: $exe" | |
| timeout 20s valgrind \ | |
| --leak-check=full \ | |
| --show-leak-kinds=all \ | |
| --track-origins=yes \ | |
| "$exe" | |
| STATUS=$? | |
| if [ $STATUS -ne 0 ] && [ $STATUS -ne 124 ]; then | |
| echo "::warning::Valgrind reported issues for $exe" | |
| FAIL=1 | |
| fi | |
| done | |
| if [ $FAIL -ne 0 ]; then | |
| echo "::warning::Valgrind detected potential issues." | |
| else | |
| echo "Valgrind checks completed." | |
| fi | |
| exit 0 | |
| standalone-package-check: | |
| name: Standalone Package Export Check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout sync repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update -y | |
| sudo apt-get install -y $DEPS | |
| test -f /usr/include/asio.hpp || (echo "::error::System Asio header not found after install"; exit 1) | |
| - name: Configure installable standalone build | |
| run: | | |
| cmake -G Ninja -S . -B build-install \ | |
| -DCMAKE_BUILD_TYPE=Release \ | |
| -DVIX_SYNC_BUILD_TESTS=OFF \ | |
| -DCMAKE_INSTALL_PREFIX="${PWD}/.ci-install" | |
| - name: Build standalone package | |
| run: | | |
| cmake --build build-install -j"${BUILD_JOBS}" | |
| - name: Install standalone package | |
| run: | | |
| cmake --install build-install | |
| - name: Verify installed package files | |
| run: | | |
| echo "---- install tree ----" | |
| find .ci-install -maxdepth 6 -type f | sort || true | |
| test -f .ci-install/include/vix/sync/Operation.hpp || (echo "::error::sync headers not found"; exit 1) | |
| if [ -f .ci-install/lib/cmake/Vix/VixTargets.cmake ]; then | |
| echo "Umbrella export detected via VixTargets.cmake" | |
| else | |
| echo "::warning::VixTargets.cmake not found in expected path" | |
| fi | |
| config-coverage: | |
| name: Configuration Coverage | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout sync repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update -y | |
| sudo apt-get install -y $DEPS | |
| test -f /usr/include/asio.hpp || (echo "::error::System Asio header not found after install"; exit 1) | |
| - name: Fetch sibling dependencies | |
| run: | | |
| rm -rf ../utils ../net ../json | |
| git clone --depth 1 --branch "${VIX_GIT_BRANCH}" https://github.com/vixcpp/utils.git ../utils | |
| git clone --depth 1 --branch "${VIX_GIT_BRANCH}" https://github.com/vixcpp/net.git ../net | |
| git clone --depth 1 --branch "${VIX_GIT_BRANCH}" https://github.com/vixcpp/json.git ../json | |
| - name: Verify required sibling dependencies | |
| run: | | |
| test -f ../utils/CMakeLists.txt || (echo "::error::../utils/CMakeLists.txt is missing"; exit 1) | |
| test -f ../net/CMakeLists.txt || (echo "::error::../net/CMakeLists.txt is missing"; exit 1) | |
| test -f ../json/CMakeLists.txt || (echo "::error::../json/CMakeLists.txt is missing"; exit 1) | |
| test -f ../json/include/vix/json/Simple.hpp || (echo "::error::../json/include/vix/json/Simple.hpp is missing"; exit 1) | |
| - name: Export dependency include paths | |
| run: | | |
| echo "CPATH=$GITHUB_WORKSPACE/../json/include:$GITHUB_WORKSPACE/../utils/include:$GITHUB_WORKSPACE/../net/include${CPATH:+:$CPATH}" >> "$GITHUB_ENV" | |
| echo "CPLUS_INCLUDE_PATH=$GITHUB_WORKSPACE/../json/include:$GITHUB_WORKSPACE/../utils/include:$GITHUB_WORKSPACE/../net/include${CPLUS_INCLUDE_PATH:+:$CPLUS_INCLUDE_PATH}" >> "$GITHUB_ENV" | |
| - name: Configure release mode with sibling deps | |
| run: | | |
| cmake -G Ninja -S . -B build-release-local \ | |
| -DCMAKE_BUILD_TYPE=Release \ | |
| -DVIX_ENABLE_SANITIZERS=OFF \ | |
| -DVIX_SYNC_BUILD_TESTS=OFF \ | |
| -DVIX_SYNC_FETCH_UTILS=OFF \ | |
| -DVIX_SYNC_FETCH_NET=OFF \ | |
| -DVIX_SYNC_FETCH_JSON=OFF | |
| - name: Build release mode with sibling deps | |
| run: | | |
| cmake --build build-release-local -j"${BUILD_JOBS}" | |
| - name: Configure release mode with FetchContent | |
| run: | | |
| rm -rf build-release-fetch | |
| cmake -G Ninja -S . -B build-release-fetch \ | |
| -DCMAKE_BUILD_TYPE=Release \ | |
| -DVIX_ENABLE_SANITIZERS=OFF \ | |
| -DVIX_SYNC_BUILD_TESTS=OFF \ | |
| -DVIX_SYNC_FETCH_UTILS=ON \ | |
| -DVIX_SYNC_FETCH_NET=ON \ | |
| -DVIX_SYNC_FETCH_JSON=ON | |
| - name: Build release mode with FetchContent | |
| run: | | |
| cmake --build build-release-fetch -j"${BUILD_JOBS}" | |
| summary: | |
| name: Sync Strict CI Summary | |
| needs: | |
| [ | |
| build-test-sanitized, | |
| runtime-smoke, | |
| static-analysis, | |
| valgrind, | |
| standalone-package-check, | |
| config-coverage, | |
| ] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Print summary | |
| run: | | |
| echo "Sync strict CI completed." | |
| echo "This workflow validates:" | |
| echo "- sanitized builds" | |
| echo "- unit tests" | |
| echo "- runtime smoke checks" | |
| echo "- static analysis" | |
| echo "- valgrind" | |
| echo "- standalone package export" | |
| echo "- sibling dependency mode" | |
| echo "- FetchContent mode" |