test-suite

Author: BJSS-russell-pollock

.github/actions/run-test-suite/action.yaml

@@ -0,0 +1,58 @@
+name: "Run test suite"
+description: |
+  Composite action that runs a single test type (unit/contract/schema/integration/acceptance),
+  uploads the test artefacts, and publishes a JUnit summary to the GitHub Actions job.
+  Delegates to `make test-<type>` which invokes scripts/tests/run-test.sh.
+  For remote tests, pass apigee-access-token to authenticate with the APIM proxy.
+
+inputs:
+  test-type:
+    description: "Test type: unit, contract, schema, integration, acceptance"
+    required: true
+  apigee-access-token:
+    description: "Apigee access token (if needed)"
+    required: false
+    default: ""
+  env:
+    description: "Environment: local or remote"
+    required: false
+    default: "remote"
+
+runs:
+  using: composite
+  steps:
+    - name: "Run ${{ inputs.test-type }} tests"
+      shell: bash
+      env:
+        APIGEE_ACCESS_TOKEN: ${{ inputs.apigee-access-token }}
+        ENV: ${{ inputs.env }}
+      run: |
+        if [[ -n "${APIGEE_ACCESS_TOKEN}" ]]; then
+          echo "::add-mask::${APIGEE_ACCESS_TOKEN}"
+        fi
+        make test-${{ inputs.test-type }}
+
+    - name: "Upload ${{ inputs.test-type }} test results"
+      if: always()
+      uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
+      with:
+        name: ${{ inputs.test-type }}-test-results
+        path: pathology-api/test-artefacts/
+        retention-days: 30
+
+    - name: "Check ${{ inputs.test-type }}-tests.xml exists"
+      id: check
+      if: always()
+      shell: bash
+      run: |
+        if [[ -f "pathology-api/test-artefacts/${{ inputs.test-type }}-tests.xml" ]]; then
+          echo "exists=true" >> "$GITHUB_OUTPUT"
+        else
+          echo "exists=false" >> "$GITHUB_OUTPUT"
+        fi
+
+    - name: "Publish ${{ inputs.test-type }} test results to summary"
+      if: ${{ always() && steps.check.outputs.exists == 'true' }}
+      uses: test-summary/action@31493c76ec9e7aa675f1585d3ed6f1da69269a86
+      with:
+        paths: pathology-api/test-artefacts/${{ inputs.test-type }}-tests.xml

.github/actions/setup-python-project/action.yaml

@@ -7,6 +7,11 @@ inputs:
 runs:
   using: "composite"
   steps:
+    - name: "Install system dependencies"
+      shell: bash
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libxml2-dev libxslt-dev
     - name: "Set up Python"
       uses: actions/setup-python@v5
       with:

.github/workflows/preview-env.yml

@@ -293,151 +293,62 @@ jobs:
 
       # ---------- QUALITY CHECKS (Test Suites) ----------
 
-      # UNIT TESTS
-      - name: Run unit tests
-        if: github.event.action != 'closed'
-        run: make test-unit
-
-      - name: Upload unit test results
-        if: always()
-        uses: actions/upload-artifact@v7
-        with:
-          name: unit-test-results
-          path: gateway-api/test-artefacts/unit-tests*
-          retention-days: 30
-
-      - name: Check unit-tests.xml exists
-        id: check-unit
-        if: always()
+      - name: Retrieve Apigee Token
+        id: apigee-token
+        shell: bash
         run: |
-          [ -f "gateway-api/test-artefacts/unit-tests.xml" ] && echo "exists=true" >> "$GITHUB_OUTPUT" || echo "exists=false" >> "$GITHUB_OUTPUT"
+          set -euo pipefail
 
-      - name: Publish unit test results to summary
-        if: ${{ always() && steps.check-unit.outputs.exists == 'true' }}
-        uses: test-summary/action@31493c76ec9e7aa675f1585d3ed6f1da69269a86
-        with:
-          paths: gateway-api/test-artefacts/unit-tests.xml
-
-      # CONTRACT TESTS
-      - name: Run contract tests against preview
-        if: github.event.action != 'closed'
-        env:
-          BASE_URL: ${{ steps.tf-output.outputs.preview_url }}
-          MTLS_CERT: /tmp/client1-cert.pem
-          MTLS_KEY: /tmp/client1-key.pem
-        run: make test-contract
-
-      - name: Upload contract test results
-        if: always()
-        uses: actions/upload-artifact@v7
-        with:
-          name: contract-test-results
-          path: gateway-api/test-artefacts/contract-tests*
-          retention-days: 30
+          APIGEE_TOKEN="$(proxygen pytest-nhsd-apim get-token | jq -r '.pytest_nhsd_apim_token' 2>/dev/null)"
+          if [ -z "$APIGEE_TOKEN" ] || [ "$APIGEE_TOKEN" = "null" ]; then
+            echo "::error::Failed to retrieve Apigee token"
+            exit 1
+          fi
 
-      - name: Check contract-tests.xml exists
-        id: check-contract
-        if: always()
-        run: |
-          [ -f "gateway-api/test-artefacts/contract-tests.xml" ] && echo "exists=true" >> "$GITHUB_OUTPUT" || echo "exists=false" >> "$GITHUB_OUTPUT"
+          echo "::add-mask::$APIGEE_TOKEN"
+          printf 'apigee-access-token=%s\n' "$APIGEE_TOKEN" >> "$GITHUB_OUTPUT"
+          echo "Token retrieved successfully (length: ${#APIGEE_TOKEN})"
 
-      - name: Publish contract test results to summary
-        if: ${{ always() && steps.check-contract.outputs.exists == 'true' }}
-        uses: test-summary/action@31493c76ec9e7aa675f1585d3ed6f1da69269a86
+      - name: "Create coverage artefact name"
+        id: create-name
+        uses: ./.github/actions/create-artefact-name
         with:
-          paths: gateway-api/test-artefacts/contract-tests.xml
+          prefix: coverage
 
-      # SCHEMA TESTS
-      - name: Run schema validation against preview
+      - name: "Run unit tests"
         if: github.event.action != 'closed'
-        env:
-          BASE_URL: ${{ steps.tf-output.outputs.preview_url }}
-          MTLS_CERT: /tmp/client1-cert.pem
-          MTLS_KEY: /tmp/client1-key.pem
-        run: make test-schema
-
-      - name: Upload schema test results
-        if: always()
-        uses: actions/upload-artifact@v7
-        with:
-          name: schema-test-results
-          path: gateway-api/test-artefacts/schema-tests*
-          retention-days: 30
-
-      - name: Check schema-tests.xml exists
-        id: check-schema
-        if: always()
-        run: |
-          [ -f "gateway-api/test-artefacts/schema-tests.xml" ] && echo "exists=true" >> "$GITHUB_OUTPUT" || echo "exists=false" >> "$GITHUB_OUTPUT"
-
-      - name: Publish schema test results to summary
-        if: ${{ always() && steps.check-schema.outputs.exists == 'true' }}
-        uses: test-summary/action@31493c76ec9e7aa675f1585d3ed6f1da69269a86
+        uses: ./.github/actions/run-test-suite
         with:
-          paths: gateway-api/test-artefacts/schema-tests.xml
+          test-type: unit
+          env: local
 
-      # INTEGRATION TESTS
-      - name: Run integration tests against preview using remote APIM proxy
+      - name: "Run contract tests"
         if: github.event.action != 'closed'
-        env:
-          BASE_URL: "https://internal-dev.api.service.nhs.uk/clinical-data-gateway-api-poc"
-          PR_NUMBER: ${{ github.event.pull_request.number }}
-          PROXYGEN_KEY_ID: ${{ vars.PREVIEW_ENV_PROXYGEN_KEY_ID }}
-          PROXYGEN_CLIENT_ID: ${{ vars.PREVIEW_ENV_PROXYGEN_CLIENT_ID }}
-          PROXYGEN_KEY_SECRET: ${{ env._cds_gateway_dev_proxygen_proxygen_key_secret }}
-          MTLS_CERT: /tmp/client1-cert.pem
-          MTLS_KEY: /tmp/client1-key.pem
-        run: |
-          make test-integration
-
-      - name: Upload integration test results
-        if: always()
-        uses: actions/upload-artifact@v7
+        uses: ./.github/actions/run-test-suite
         with:
-          name: integration-test-results
-          path: gateway-api/test-artefacts/integration-tests*
-          retention-days: 30
+          test-type: contract
+          apigee-access-token: ${{ steps.apigee-token.outputs.apigee-access-token }}
 
-      - name: Check integration-tests.xml exists
-        id: check-integration
-        if: always()
-        run: |
-          [ -f "gateway-api/test-artefacts/integration-tests.xml" ] && echo "exists=true" >> "$GITHUB_OUTPUT" || echo "exists=false" >> "$GITHUB_OUTPUT"
-
-      - name: Publish integration test results to summary
-        if: ${{ always() && steps.check-integration.outputs.exists == 'true' }}
-        uses: test-summary/action@31493c76ec9e7aa675f1585d3ed6f1da69269a86
+      - name: "Run schema validation tests"
+        if: github.event.action != 'closed'
+        uses: ./.github/actions/run-test-suite
         with:
-          paths: gateway-api/test-artefacts/integration-tests.xml
+          test-type: schema
+          apigee-access-token: ${{ steps.apigee-token.outputs.apigee-access-token }}
 
-      # ACCEPTANCE TESTS
-      - name: Run acceptance tests against preview
+      - name: "Run integration tests"
         if: github.event.action != 'closed'
-        env:
-          BASE_URL: ${{ steps.tf-output.outputs.preview_url }}
-          MTLS_CERT: /tmp/client1-cert.pem
-          MTLS_KEY: /tmp/client1-key.pem
-        run: make test-acceptance
-
-      - name: Upload acceptance test results
-        if: always()
-        uses: actions/upload-artifact@v7
+        uses: ./.github/actions/run-test-suite
         with:
-          name: acceptance-test-results
-          path: gateway-api/test-artefacts/acceptance-tests*
-          retention-days: 30
+          test-type: integration
+          apigee-access-token: ${{ steps.apigee-token.outputs.apigee-access-token }}
 
-      - name: Check acceptance-tests.xml exists
-        id: check-acceptance
-        if: always()
-        run: |
-          [ -f "gateway-api/test-artefacts/acceptance-tests.xml" ] && echo "exists=true" >> "$GITHUB_OUTPUT" || echo "exists=false" >> "$GITHUB_OUTPUT"
-
-      - name: Publish acceptance test results to summary
-        if: ${{ always() && steps.check-acceptance.outputs.exists == 'true' }}
-        uses: test-summary/action@31493c76ec9e7aa675f1585d3ed6f1da69269a86
+      - name: "Run acceptance tests"
+        if: github.event.action != 'closed'
+        uses: ./.github/actions/run-test-suite
         with:
-          paths: gateway-api/test-artefacts/acceptance-tests.xml
+          test-type: acceptance
+          apigee-access-token: ${{ steps.apigee-token.outputs.apigee-access-token }}
 
       # Cleanup after tests
       - name: Remove mTLS temp files