feat: initial snapshot testing

Author: MacMur85

.github/workflows/cicd-1-pull-request.yaml

@@ -128,6 +128,7 @@ jobs:
     if: needs.metadata.outputs.does_pull_request_exist == 'true' || github.ref == 'refs/heads/main' || (github.event_name == 'pull_request' && (github.event.action == 'opened' || github.event.action == 'reopened'))
     with:
       docker_compose_file: application/CohortManager/compose.yaml
+      snapshot_test_dir: tests/snapshot-tests
       excluded_containers_csv_list: azurite,azurite-setup,sql-server
       environment_tag: ${{ needs.metadata.outputs.environment_tag }}
       function_app_source_code_path: application/CohortManager/src

.github/workflows/stage-2-test.yaml

@@ -218,24 +218,24 @@ jobs:
         with:
           submodules: true
 
-      - name: Run dependencies
-        working-directory: ${{ env.APP_DIR }}
-        run: |
-          docker compose -f compose.deps.yaml up -d
-          sleep 20
+      # - name: Run dependencies
+      #   working-directory: ${{ env.APP_DIR }}
+      #   run: |
+      #     docker compose -f compose.deps.yaml up -d
+      #     sleep 20
 
-      - name: Run application
-        working-directory: ${{ env.APP_DIR }}
-        run: |
-          docker compose up -d
-          sleep 20
+      # - name: Run application
+      #   working-directory: ${{ env.APP_DIR }}
+      #   run: |
+      #     docker compose up -d
+      #     sleep 20
 
-      - name: Run snapshot tests
-        run: ./tests/snapshot-tests/run-snapshot-tests.sh
+      # - name: Run snapshot tests
+      #   run: ./tests/snapshot-tests/run-snapshot-tests.sh
 
-      - name: teardown application
-        working-directory: ${{ env.APP_DIR }}
-        run: docker compose down && docker compose -f compose.deps.yaml down
+      # - name: teardown application
+      #   working-directory: ${{ env.APP_DIR }}
+      #   run: docker compose down && docker compose -f compose.deps.yaml down
 
   aggregate-test-results:
     name: Aggregate results and report

.github/workflows/stage-3-build-images.yaml

@@ -29,6 +29,10 @@ on:
         required: false
         type: boolean
         default: false
+      snapshot_test_dir:
+        description: Directory containing the snapshot tests
+        required: true
+        type: string
 
 jobs:
   get-functions:
@@ -236,12 +240,21 @@ jobs:
             } | tee -a "$VULNERABILITIES_SUMMARY_LOGFILE"
           done
 
+          docker save "${repo_name}:${COMMIT_HASH_TAG}" -o "${repo_name}:${COMMIT_HASH_TAG}".tar
+
           # Remove the image
           docker rmi "${repo_name}:${COMMIT_HASH_TAG}"
           docker rmi "${repo_name}:${PR_NUM_TAG}"
           docker rmi "${repo_name}:${ENVIRONMENT_TAG}"
           docker rmi ${PROJECT_NAME}-${function}:latest
 
+      - name: Upload docker image as an artifact
+        working-directory: ${{ steps.get-function-names.outputs.DOCKER_COMPOSE_DIR }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: docker-images
+          path: "*.tar"
+
       - name: Compress SBOM report
         shell: bash
         run: |
@@ -275,6 +288,51 @@ jobs:
           path: ./${{ env.VULNERABILITIES_SUMMARY_LOGFILE }}
           retention-days: 21
 
+  snapshot-tests:
+    name: Snapshot tests
+    runs-on: ubuntu-latest
+    env:
+      SNAPSHOT_TEST_DIR: ${{ inputs.snapshot_test_dir }}
+      APP_DIR: ${{ steps.get-function-names.outputs.DOCKER_COMPOSE_DIR }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Download Docker images artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: docker-images
+          path: ${{ env.APP_DIR }}
+
+      - name: Load Docker images
+        working-directory: ${{ env.APP_DIR }}
+        run: |
+          for tar in ${{ env.APP_DIR }}/*.tar; do
+            docker load -i $tar
+          done
+
+      - name: Run dependencies
+        working-directory: ${{ env.APP_DIR }}
+        run: |
+          docker compose -f compose.deps.yaml up -d
+          sleep 20
+
+      - name: Run application
+        working-directory: ${{ env.APP_DIR }}
+        run: |
+          docker compose up -d
+          sleep 20
+
+      - name: Run snapshot tests
+        run: ./tests/snapshot-tests/run-snapshot-tests.sh
+
+      - name: teardown application
+        working-directory: ${{ env.APP_DIR }}
+        run: docker compose down && docker compose -f compose.deps.yaml down
+
+
   aggregate-json:
     runs-on: ubuntu-latest
     needs: build-and-push