#1: create sample cmake project

.azure/pipelines/build-and-test.yml

@@ -0,0 +1,167 @@
+name: PR tests
+
+trigger:
+  branches:
+    include:
+      - master
+
+pr:
+  drafts: false
+  autoCancel: true
+  branches:
+    include:
+      - '*'
+variables:
+  WF_REPO: DARMA-tasking/workflows
+  WF_BRANCH: 2-implement-common-docker-containers # master
+
+jobs:
+- job: getMatrix
+  pool:
+    vmImage: 'ubuntu-latest'
+  displayName: 'Get matrix'
+  steps:
+    # Note: Filtering the test environments
+    # A jq query can be used to filter the matrix of test environments
+    # - All (default):           `matrix=$(cat azure.json | jq '.matrix')`
+    # - CLang only:              `matrix=$(cat azure.json | jq '.matrix | map(select(.label | contains("clang")))')`
+    # - gcc>=11:                 `matrix=$(cat azure.json | jq '.matrix | map(select(.name | test("gcc-[1-9][1-9]+")))')`
+    # - gcc>=11|clang>=14        `matrix=$(cat azure.json | jq '.matrix | map(select(.name | test("gcc-[1-9][1-9]+-|clang-[1-9][2-9]+")))')`
+    - bash: |
+        wget https://raw.githubusercontent.com/${{ variables.WF_REPO }}/refs/heads/${{ variables.WF_BRANCH }}/ci/shared/matrix/azure.json
+        matrix=$(cat azure.json | jq -c '.matrix')
+        echo "##vso[task.setvariable variable=matrix;isOutput=true]$matrix"
+      displayName: 'Get matrix'
+      name: getMatrixStep
+
+- job: run
+  displayName: 'Run'
+  dependsOn: getMatrix
+  strategy:
+    matrix: $[ dependencies.getMatrix.outputs['getMatrixStep.matrix'] ]
+  pool:
+    vmImage: $(vmImage)
+  timeoutInMinutes: 180
+  variables:
+    TS_YEAR: ~
+    TS_MONTH: ~
+    TS_DAY: ~
+    TS: ~
+    BUILD_DIR: /opt/foo/build
+    OUTPUT_DIR: /opt/foo/output
+    CCACHE_DIR: /opt/foo/build/ccache
+    COVERAGE_ENABLED: 0
+    JUNIT_REPORT_PATH: /opt/foo/output/junit.xml
+    cache_name: $(name)
+  steps:
+    - checkout: self
+      fetchDepth: 0
+    - bash: |
+        echo "Environment=$(label)"
+        echo "Runner=$(vmImage)"
+        if [ "$(image)" != "" ]
+        then
+          echo "> With Docker Image=$(image)"
+        else
+          echo "> With Runner Setup=$(setup)"
+        fi
+      displayName: Display configuration
+
+    - bash: |
+        if [ "$(name)" == "wf-amd64-ubuntu-22.04-gcc-12-cpp" ]
+        then
+          echo "##vso[task.setvariable variable=COVERAGE_ENABLED]1"
+        fi
+        if [[ "$(image)" == "" ]]; then
+          echo "::group::Setup in runner"
+          echo "Set setup permissions..."
+          sudo mkdir -p /opt
+          sudo chown $(whoami) /opt
+          wget -O setup.sh https://raw.githubusercontent.com/${{ variables.CI_REPO }}/refs/heads/${{ variables.CI_BRANCH }}/ci/shared/scripts/setup-$(setup).sh
+          chmod +x setup.sh
+          export WF_SETUP_ID=$(setup)
+          ./setup.sh
+          echo "::endgroup::"
+        elif [[ "$(image)" != "" ]]; then
+          echo "::group::Pull Docker image"
+          docker image pull $(image)
+          echo "::endgroup::"
+        fi
+      displayName: Set up dependencies
+
+    - bash: |
+        echo "##vso[task.setvariable variable=TS_YEAR]$(date -u +%Y)"
+        echo "##vso[task.setvariable variable=TS_MONTH]$(date -u +%m)"
+        echo "##vso[task.setvariable variable=TS_DAY]$(date -u +%d)"
+        echo "##vso[task.setvariable variable=TS]$(date -u +%H%M%S)"
+      displayName: Build timestamp for caching
+
+    - task: Cache@2
+      displayName: Update cache
+      continueOnError: true
+      inputs:
+        securityNamespace: cache
+        key: $(Agent.OS) | "$(cache_name)" | $(TS_YEAR) | $(TS_MONTH) | $(TS_DAY) | $(TS)
+        path: $(CCACHE_DIR)
+        restoreKeys: |
+          $(Agent.OS) | "$(cache_name)" | $(TS_YEAR) | $(TS_MONTH) | $(TS_DAY)
+          $(Agent.OS) | "$(cache_name)" | $(TS_YEAR) | $(TS_MONTH)
+          $(Agent.OS) | "$(cache_name)" | $(TS_YEAR)
+          $(Agent.OS) | "$(cache_name)"
+
+    - bash: |
+        mkdir -p $(CCACHE_DIR)
+        WORKSPACE=$(Pipeline.Workspace)/s
+        if [[ "$(image)" != "" ]]; then
+          WORKSPACE=/workspace
+        fi
+        CMD='
+          cd '${WORKSPACE}'; \
+          ls -l; \
+          chmod +x ./build.sh; \
+          \
+          FOO_COVERAGE_ENABLED="$(COVERAGE_ENABLED)" \
+          FOO_TEST_REPORT="$(JUNIT_REPORT_PATH)" \
+          ./build.sh'
+
+        echo "Running ${CMD}"
+
+        if [[ "$(image)" == "" ]]; then
+          bash -c "export $(cat .env | sed '/^[[:blank:]]*#/d;s/#.*//' | xargs) && $CMD";
+        else
+          docker run \
+            --name test-container \
+            --env-file .env \
+            -w $WORKSPACE \
+            -v $(Pipeline.Workspace)/s:/workspace \
+            -v $(BUILD_DIR):/opt/foo/build \
+            -v $(OUTPUT_DIR):/opt/foo/output \
+            -e CI="1" \
+            -e https_proxy="" \
+            -e http_proxy="" \
+            $(image) \
+            bash -c "$CMD"
+          exit $(docker container inspect --format '{{.State.ExitCode}}' test-container)
+        fi
+
+        if [ -f "$FOO_TEST_REPORT" ]; then
+          echo "##vso[task.setvariable variable=JUNIT_REPORT_PATH]${FOO_TEST_REPORT}"
+        fi
+      displayName: PR tests
+
+    - task: PublishTestResults@2
+      displayName: Tests ($(name))
+      inputs:
+        testResultsFormat: 'JUnit'
+        testResultsFiles: $(JUNIT_REPORT_PATH)
+
+    - task: PublishPipelineArtifact@1
+      displayName: Upload artifacts
+      continueOnError: true
+      inputs:
+        targetPath: $(OUTPUT_DIR)
+        artifact: foo-output-$(name)
+        publishLocation: 'pipeline'
+
+    # FEAT: include also coverage reporting for Azure (require cobertura or JaCoCo format)
+    # task: PublishCodeCoverageResults@1

.env

@@ -0,0 +1,26 @@
+# Common environment variables to build and run the foo library
+
+# Usage: `source .env && build.sh`
+
+# CCache
+CCACHE_COMPILERCHECK=content
+CCACHE_COMPRESS=1
+CCACHE_COMPRESSLEVEL=5
+CCACHE_MAXSIZE=700M
+# Note: If building with a docker image you should use a specific cache directory
+# CCACHE_DIR=/opt/foo/build/ccache-{image_tag}
+CCACHE_DIR=/opt/foo/build/ccache
+
+# Compile
+CMAKE_CXX_STANDARD=17
+CMAKE_BUILD_TYPE=Release
+
+# Project
+FOO_BUILD_DIR=/opt/foo/build
+FOO_OUTPUT_DIR=/opt/foo/output
+FOO_TESTS_ENABLED=ON
+FOO_RUN_TESTS=ON
+FOO_CLEAN=OFF
+FOO_WERROR_ENABLED=ON
+FOO_COVERAGE_ENABLED=OFF
+FOO_COVERAGE_REPORT=/opt/foo/output/cov

.github/workflows/build-and-test.yml

@@ -0,0 +1,175 @@
+name: PR tests
+
+on:
+  push:
+    branches:
+      - '*' # master
+  pull_request:
+    branches:
+      - '*'
+
+env:
+  GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  WF_REPO: DARMA-tasking/workflows
+  WF_BRANCH: master
+
+jobs:
+  get-matrix:
+    name: Get matrix
+    runs-on: ubuntu-latest
+    steps:
+      # Note: Filtering the test environments
+      # A jq query can be used to filter the matrix of test environments
+      # - All (default):           `matrix=$(cat github.json | jq '.matrix')`
+      # - CLang only:              `matrix=$(cat github.json | jq '.matrix | map(select(.label | contains("clang")))')`
+      # - gcc>=11:                 `matrix=$(cat github.json | jq '.matrix | map(select(.name | test("gcc-[1-9][1-9]+")))')`
+      # - gcc>=11|clang>=14        `matrix=$(cat github.json | jq '.matrix | map(select(.name | test("gcc-[1-9][1-9]+-|clang-[1-9][2-9]+")))')`
+      - name: Get matrix
+        id: get-matrix
+        run: |
+          wget https://raw.githubusercontent.com/${{ env.WF_REPO }}/refs/heads/${{ env.WF_BRANCH }}/ci/shared/matrix/github.json
+          matrix=$(cat github.json | jq '.matrix')
+          echo "runner=$(echo $matrix)" >> $GITHUB_OUTPUT
+
+    outputs:
+      matrix: ${{ steps.get-matrix.outputs.runner }}
+
+  run:
+    name: Run ${{ matrix.runner.name }}
+    runs-on: ${{ matrix.runner.runs-on }}
+    needs: get-matrix
+    env:
+      TS_YEAR: ~
+      TS_MONTH: ~
+      TS_DAY: ~
+      TS: ~
+      BUILD_DIR: /opt/foo/build
+      OUTPUT_DIR: /opt/foo/output
+      CCACHE_DIR: /opt/foo/build/ccache
+      COVERAGE_ENABLED: ${{  matrix.runner.name == 'wf-amd64-ubuntu-22.04-gcc-12-cpp' && 1 || 0 }}
+      JUNIT_REPORT_PATH: /opt/foo/output/junit.xml
+    strategy:
+      fail-fast: false
+      matrix:
+        runner: ${{ fromJson(needs.get-matrix.outputs.matrix ) }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Display configuration
+        run: |
+          echo "Environment=${{ matrix.runner.name }}"
+          echo "Runner=${{ matrix.runner.runs-on }}"
+          if [ "${{ matrix.runner.image }}" != "" ]
+          then
+            echo "> With Docker Image=${{ matrix.runner.image }}"
+          else
+            echo "> With Runner Setup=${{ matrix.runner.setup }}"
+          fi
+
+      - name: Set up dependencies
+        run: |
+          if [[ "${{ matrix.runner.image }}" == "" ]]; then
+            echo "::group::Setup in runner"
+            echo "Set setup permissions..."
+            sudo mkdir -p /opt
+            sudo chown $(whoami) /opt
+            wget -O setup.sh https://raw.githubusercontent.com/${{ env.WF_REPO }}/refs/heads/${{ env.WF_BRANCH }}/ci/shared/scripts/setup-${{ matrix.runner.setup }}.sh
+            chmod +x setup.sh
+            export WF_SETUP_ID=${{ matrix.runner.setup }}
+            ./setup.sh
+            echo "::endgroup::"
+          elif [ "${{ matrix.runner.image }}" != "" ]; then
+            echo "::group::Pull Docker image"
+            docker image pull ${{ matrix.runner.image }}
+            echo "::endgroup::"
+          fi
+
+      - name: Display System Information
+        run: |
+          CMD="uname -a"
+          if [[ "${{ matrix.runner.image }}" == "" ]]
+          then
+            echo "Runner System Information:"
+            $CMD
+          else
+            echo "Docker System Information:"
+            docker run ${{ matrix.runner.image }} $CMD
+          fi
+
+      - name: Build timestamp for caching
+        continue-on-error: true
+        run: |
+          echo "TS_YEAR=$(date -u +%Y)" >> $GITHUB_ENV
+          echo "TS_MONTH=$(date -u +%m)" >> $GITHUB_ENV
+          echo "TS_DAY=$(date -u +%d)" >> $GITHUB_ENV
+          echo "TS=$(date -u +%H%M%S)" >> $GITHUB_ENV
+
+      - name: Update cache
+        continue-on-error: true
+        uses: actions/cache@v3
+        env:
+          cache_name: ${{ matrix.runner.name }}
+        with:
+          path: ${{ env.CCACHE_DIR }}
+          key: ${{ runner.os }}-${{ env.cache_name }}-${{ env.TS_YEAR }}-${{ env.TS_MONTH }}-${{ env.TS_DAY }}-${{ env.TS }}
+          restore-keys: |
+            ${{ runner.os }}-${{ env.cache_name }}-${{ env.TS_YEAR }}-${{ env.TS_MONTH }}-${{ env.TS_DAY }}-
+            ${{ runner.os }}-${{ env.cache_name }}-${{ env.TS_YEAR }}-${{ env.TS_MONTH }}-
+            ${{ runner.os }}-${{ env.cache_name }}-${{ env.TS_YEAR }}-
+            ${{ runner.os }}-${{ env.cache_name }}-
+
+      - name: PR tests
+        run: |
+          WORKSPACE=${{ github.workspace }}
+          if [[ "${{ matrix.runner.image }}" != "" ]]; then
+            WORKSPACE=/workspace
+          fi
+          CMD='
+            cd '${WORKSPACE}'; \
+            ls -l; \
+            chmod +x ./build.sh; \
+            \
+            FOO_COVERAGE_ENABLED="${{ env.COVERAGE_ENABLED }}" \
+            FOO_TEST_REPORT="${{ env.JUNIT_REPORT_PATH }}" \
+            ./build.sh'
+
+          echo "Running ${CMD}"
+
+          if [[ "${{ matrix.runner.image }}" == "" ]]; then
+            bash -c "export $(cat .env | sed '/^[[:blank:]]*#/d;s/#.*//' | xargs) && $CMD";
+          else
+            docker run \
+              --name test-container \
+              --env-file .env \
+              -w $WORKSPACE \
+              -v ${{ github.workspace }}:/workspace \
+              -v ${{ env.BUILD_DIR }}:/opt/foo/build \
+              -v ${{ env.OUTPUT_DIR }}:/opt/foo/output \
+              -e CI="1" \
+              -e https_proxy="" \
+              -e http_proxy="" \
+              ${{ matrix.runner.image }} \
+              bash -c "$CMD"
+            exit $(docker container inspect --format '{{.State.ExitCode}}' test-container)
+          fi
+
+          if [ -f "$FOO_TEST_REPORT" ]; then
+            echo "JUNIT_REPORT_PATH=${FOO_TEST_REPORT}" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Unit tests
+        if: (success() || failure()) && ${{ env.JUNIT_REPORT_PATH != '' }}
+        uses: phoenix-actions/test-reporting@v15
+        with:
+          name: Tests report
+          path: ${{ env.JUNIT_REPORT_PATH }}
+          reporter: java-junit
+          output-to: step-summary
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: foo-output-${{ matrix.runner.name }}
+          path: ${{ env.OUTPUT_DIR }}

.gitignore

@@ -0,0 +1,2 @@
+build/
+output/