merge: #10045

10045: Extract reusable action for test artifact upload r=menski a=menski ## Description Create composite github action to bundle test artifact upload steps. At the moment the steps are: - clean system-out from test XML output - upload test artifact for later use ## Related issues  closes #9135 Co-authored-by: Sebastian Menski <sebastian.menski@camunda.com>
camunda · Aug 15, 2022 · 661e6bb · 661e6bb
2 parents cdc96b0 + c4995c0
commit 661e6bb
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 64 deletions.
diff --git a/.github/actions/collect-test-artifacts/action.yml b/.github/actions/collect-test-artifacts/action.yml
@@ -0,0 +1,41 @@
+---
+name: Collect test artifacts
+
+description: Collects test outputs and uploads them as artifact
+
+inputs:
+  name:
+    description: 'Name of the test artifact.'
+    required: true
+
+runs:
+  using: composite
+  steps:
+
+    # MacOS sed is not compatible with the remove script, we need gnu sed instead
+  - name: Install GNU sed
+    if: runner.os == 'macOS'
+    shell: bash
+    run: |
+      brew install gnu-sed
+      echo "SED_BIN=gsed" >> $GITHUB_ENV
+
+    # Mitigate to large test output files by deleting the system-out element using sed
+    # Note: we cannot use XML tools like xmlstarlet as they all suffer the same libxml2 limitation
+    # Related to https://github.com/camunda/zeebe/issues/9959
+  - name: Remove system-out from test xml files
+    shell: bash
+    run: |
+      find . -iname TEST-*.xml -print0 | xargs -0 -r ${SED_BIN:-sed} '/<system-out>/,/<\/system-out>/d' -i
+
+  - name: Archive Test Results
+    uses: actions/upload-artifact@v3
+    if: always()
+    with:
+      name: Test results for ${{ inputs.name  }}
+      path: |
+        **/target/failsafe-reports/
+        **/target/surefire-reports/
+        **/hs_err_*.log
+      retention-days: 7
+      if-no-files-found: ignore
diff --git a/.github/workflows/publish-test-results.yml b/.github/workflows/publish-test-results.yml
@@ -28,13 +28,6 @@ jobs:
             unzip -d "$name" "$name.zip"
           done
 
-        # Mitigate to large test output files by deleting the system-out element using sed
-        # Note: we cannot use XML tools like xmlstarlet as they all suffer the same libxml2 limitation
-        # Related to https://github.com/camunda/zeebe/issues/9959
-      - name: Remove system-out from test xml files
-        run: |
-          find . -iname TEST-*.xml -print0 | xargs -0 sed '/<system-out>/,/<\/system-out>/d' -i
-
       - name: Publish Test Results
         uses: EnricoMi/publish-unit-test-result-action@v2
         with:

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -56,15 +56,10 @@ jobs:
           -P parallel-tests,extract-flaky-tests
           -pl !:zeebe-elasticsearch-exporter
           verify
-      - name: Archive Test Results
-        uses: actions/upload-artifact@v3
-        if: always()
+      - name: Upload test artifacts
+        uses: ./.github/actions/collect-test-artifacts
         with:
-          name: Integration test results
-          path: |
-            **/target/failsafe-reports/
-            **/hs_err_*.log
-          retention-days: 7
+          name: Integration Tests
   exporter-tests:
     name: Exporter tests
     runs-on: "n1-standard-8-netssd-preempt"
@@ -85,15 +80,10 @@ jobs:
           -D skipUTs -D skipChecks -D failsafe.rerunFailingTestsCount=3
           -pl :zeebe-elasticsearch-exporter
           verify
-      - name: Archive Test Results
-        uses: actions/upload-artifact@v3
-        if: always()
+      - name: Upload test artifacts
+        uses: ./.github/actions/collect-test-artifacts
         with:
-          name: Exporter test results
-          path: |
-            **/target/failsafe-reports/
-            **/hs_err_*.log
-          retention-days: 7
+          name: Exporter Tests
   project-list:
     # Builds a list of projects where unit tests can be run on hosted runners
     name: List projects
@@ -135,16 +125,10 @@ jobs:
           verify
       - name: Normalize artifact name
         run: echo "ARTIFACT_NAME=$(echo ${{ matrix.project }} | sed 's/\//-/g')" >> $GITHUB_ENV
-      - name: Archive Test Results
-        uses: actions/upload-artifact@v3
-        if: always()
+      - name: Upload test artifacts
+        uses: ./.github/actions/collect-test-artifacts
         with:
-          name: Unit test results for ${{ env.ARTIFACT_NAME }}
-          path: |
-            **/target/surefire-reports/
-            **/hs_err_*.log
-          retention-days: 7
-          if-no-files-found: ignore
+          name: ${{ env.ARTIFACT_NAME }}
   slow-unit-tests:
     name: Slow unit tests
     runs-on: "n1-standard-8-netssd-preempt"
@@ -169,15 +153,10 @@ jobs:
           -D skipITs -D skipChecks
           -pl :zeebe-workflow-engine
           verify
-      - name: Archive Test Results
-        uses: actions/upload-artifact@v3
-        if: always()
+      - name: Upload test artifacts
+        uses: ./.github/actions/collect-test-artifacts
         with:
-          name: Slow unit test results
-          path: |
-            **/target/surefire-reports/
-            **/hs_err_*.log
-          retention-days: 7
+          name: Slow Unit Tests
   smoke-tests:
     # This name is hard-referenced from bors.toml
     # Remember to update that if this name, or the matrix.os changes
@@ -210,15 +189,10 @@ jobs:
           -pl qa/integration-tests
           -P smoke-test
           verify
-      - name: Archive Test Results
-        uses: actions/upload-artifact@v3
-        if: always()
+      - name: Upload test artifacts
+        uses: ./.github/actions/collect-test-artifacts
         with:
-          name: Smoke test results for ${{ matrix.os }}
-          path: |
-            **/target/failsafe-reports/
-            **/hs_err_*.log
-          retention-days: 7
+          name: Smoke Tests ${{ matrix.os }}
   java-randomized-tests:
     name: Java randomized tests
     runs-on: ubuntu-latest
@@ -231,15 +205,10 @@ jobs:
           java-version: '17'
       - run: mvn -B -D skipChecks -D skipTests install
       - run: mvn -T1C -B -D skipChecks -P parallel-tests,include-random-tests test
-      - name: Archive Test Results
-        uses: actions/upload-artifact@v3
-        if: always()
+      - name: Upload test artifacts
+        uses: ./.github/actions/collect-test-artifacts
         with:
-          name: Java randomized test results
-          path: |
-            **/target/surefire-reports/
-            **/hs_err_*.log
-          retention-days: 7
+          name: Java Randomized Tests
   go-client:
     name: Go client tests
     runs-on: ubuntu-latest
@@ -296,15 +265,10 @@ jobs:
           -D surefire.rerunFailingTestsCount=3
           -pl clients/java
           verify
-      - name: Archive Test Results
-        uses: actions/upload-artifact@v3
-        if: always()
+      - name: Upload test artifacts
+        uses: ./.github/actions/collect-test-artifacts
         with:
-          name: Java 8 client test results
-          path: |
-            **/target/surefire-reports/
-            **/hs_err_*.log
-          retention-days: 7
+          name: Java 8 Client
 
   # Used by bors to check all tests, including the unit test matrix.
   # New test jobs must be added to the `needs` lists!