chore: CI test artifact handling improvement (#1497)

* trying to reduce gh action times as it is taking way too long

* fix e2e name, was treating as two inputs

* we don't want node_modules in the artifacts

* download path not required since tar has dir within

* remove node_modules from artifact upload of cypress test suite

* don't need the download paths now

Author: bmartel

.github/actions/download-artifact/action.yml

@@ -0,0 +1,33 @@
+# source https://github.com/actions/upload-artifact/issues/199#issuecomment-1516555821
+name: Download artifact
+description: Wrapper around GitHub's official action, with additional extraction before download
+
+# https://github.com/actions/download-artifact/blob/main/action.yml
+inputs:
+  name:
+    description: Artifact name
+    required: true
+  path:
+    description: Destination path
+    required: false
+    default: .
+
+runs:
+  using: composite
+  steps:
+    - name: Download artifacts
+      uses: actions/download-artifact@v3
+      with:
+        name: ${{ inputs.name }}
+        path: ${{ inputs.path }}
+
+    - name: Extract artifacts
+      run: tar -xvf ${{ inputs.name }}.tar
+      shell: bash
+      working-directory: ${{ inputs.path }}
+
+    - name: Remove archive
+      run: rm -f ${{ inputs.name }}.tar
+      shell: bash
+      working-directory: ${{ inputs.path }}
+

.github/actions/upload-artifact/action.yml

@@ -0,0 +1,47 @@
+# source https://github.com/actions/upload-artifact/issues/199#issuecomment-1516555821
+name: Upload artifact
+description: Wrapper around GitHub's official action, with additional archiving before upload
+
+# https://github.com/actions/upload-artifact/blob/main/action.yml
+inputs:
+  name:
+    description: Artifact name
+    required: true
+  path:
+    description: A file, directory or wildcard pattern that describes what to upload
+    required: true
+  if-no-files-found:
+    description: >
+      The desired behavior if no files are found using the provided path.
+      Available Options:
+        warn: Output a warning but do not fail the action
+        error: Fail the action with an error message
+        ignore: Do not output any warnings or errors, the action does not fail
+    required: false
+    default: warn
+  retention-days:
+    description: >
+      Duration after which artifact will expire in days. 0 means using default retention.
+      Minimum 1 day.
+      Maximum 90 days unless changed from the repository settings page.
+    required: false
+    default: '0'
+
+runs:
+  using: composite
+  steps:
+    - name: Archive artifacts
+      run: tar -cvf ${{ inputs.name }}.tar ${{ inputs.path }}
+      shell: bash
+
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v3
+      with:
+        if-no-files-found: ${{ inputs.if-no-files-found }}
+        name: ${{ inputs.name }}
+        path: ${{ inputs.name }}.tar
+        retention-days: ${{ inputs.retention-days }}
+
+    - name: Remove archive
+      run: rm -f ${{ inputs.name }}.tar
+      shell: bash

.github/workflows/build_bundle.yml

@@ -69,7 +69,7 @@ jobs:
 
       # upload this build as artifact to current Action
       - name: Upload bundle
-        uses: actions/upload-artifact@v3
+        uses: ./.github/actions/upload-artifact
         with:
           name: LSF-${{ inputs.build_for_coverage && 'coverage-' || '' }}${{ inputs.sha }}
           path: build/

.github/workflows/e2e_tests.yml

@@ -54,12 +54,10 @@ jobs:
         run: du -d 0 -h ${{ steps.yarn-cache-dir-path.outputs.dir }}
 
       - name: "Download bundle"
-        uses: actions/download-artifact@v3
+        uses: ./.github/actions/download-artifact
         with:
           name: LSF-coverage-${{ inputs.sha }}
 
-          path: build/
-
       # run http-server with build in background (will be killed after job ends)
       # do this only for master branch (so only for push event)
       # because pr can contain unfinished job
@@ -95,10 +93,10 @@ jobs:
           yarn run test:ci ${{ steps.cpu-info.outputs.cores-count }}
 
       - name: "Upload e2e output" 
-        uses: actions/upload-artifact@v3
+        uses: ./.github/actions/upload-artifact
         if: ${{ failure() }}
         with:
-          name: e2e output
+          name: e2e-output
           path: e2e/output/
 
       - name: Merge coverage reports
@@ -108,7 +106,7 @@ jobs:
           yarn coverage:merge 
 
       - name: Upload coverage to Artifact
-        uses: actions/upload-artifact@v3
+        uses: ./.github/actions/upload-artifact
         if: ${{ success() }}
         with:
           name: e2e-tests-coverage

.github/workflows/fun_tests.yml

@@ -67,10 +67,9 @@ jobs:
         run: du -d 0 -h ${{ steps.yarn-cache-dir-path.outputs.dir }}
 
       - name: "Download bundle"
-        uses: actions/download-artifact@v3
+        uses: ./.github/actions/download-artifact
         with:
           name: LSF-coverage-${{ inputs.sha }}
-          path: build/
 
       # run http-server with build in background (will be killed after job ends)
       # do this only for master branch (so only for push event)
@@ -110,8 +109,14 @@ jobs:
           cd ./tests/functional
           yarn run test:parallel
 
+      - name: Prepare suite output
+        if: ${{ failure() }}
+        run: |
+          cd ./tests/functional
+          rm -rf node_modules
+
       - name: "Upload suite output" 
-        uses: actions/upload-artifact@v3
+        uses: ./.github/actions/upload-artifact
         if: ${{ failure() }}
         with:
           name: failure-result
@@ -125,7 +130,7 @@ jobs:
           yarn cvg:report
 
       - name: Upload coverage to Artifact
-        uses: actions/upload-artifact@v3
+        uses: ./.github/actions/upload-artifact
         if: ${{ success() }}
         with:
           name: cypress-tests-coverage

.github/workflows/tests_coverage.yml

@@ -20,10 +20,9 @@ jobs:
         uses: actions/checkout@v3
 
       - name: "Download Unit coverage from Artifact"
-        uses: actions/download-artifact@v3
+        uses: ./.github/actions/download-artifact
         with:
           name: unit-tests-coverage
-          path: coverage/
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3.1.4
@@ -43,10 +42,9 @@ jobs:
         uses: actions/checkout@v3
 
       - name: "Download E2E coverage from Artifact"
-        uses: actions/download-artifact@v3
+        uses: ./.github/actions/download-artifact
         with:
           name: e2e-tests-coverage
-          path: coverage/
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3.1.4
@@ -66,10 +64,9 @@ jobs:
         uses: actions/checkout@v3
 
       - name: "Download Cypress coverage from Artifact"
-        uses: actions/download-artifact@v3
+        uses: ./.github/actions/download-artifact
         with:
           name: cypress-tests-coverage
-          path: coverage/
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3.1.4

.github/workflows/unit_tests.yml

@@ -58,7 +58,7 @@ jobs:
       #     token: ${{ secrets.CODECOV_TOKEN }}
       - name: Upload coverage to Artifacts
         if: ${{ !github.event.pull_request.head.repo.fork }}
-        uses: actions/upload-artifact@v3
+        uses: ./.github/actions/upload-artifact
         with:
           name: unit-tests-coverage
           path: coverage/