merge main

Author: Vlasis-Perdikidis

.env.template

@@ -1,15 +1,27 @@
+# Your github Personal Access Token (PAT)
 PR_NUMBER=prxx # remove if needs to run against main
-GITHUB_TOKEN= # Your github Personal Access Token (PAT)
+GITHUB_TOKEN=
 
+# Apigee proxy name to be used for test execution
+# nhs-notify-supplier--internal-dev--nhs-notify-supplier-PR-XX
+PROXY_NAME=
 
-# The variables below are used for End to End tests
-PROXY_NAME= # information about the proxy name can be found in the tests/e2e-tests/README.md
+# APIM env to run e2e tests against, other options are: ref, int, prod
+API_ENVIRONMENT=internal-dev
 
+# Used for component and e2e tests
+# Account group controls default account id mapping for tests.
+# If omitted, tests default to dev:
+# TARGET_ACCOUNT_GROUP=nhs-notify-supplier-api-dev
+# Mapping used by tests:
+# nhs-notify-supplier-api-dev -> 820178564574
+# nhs-notify-supplier-api-nonprod -> 885964308133
+# nhs-notify-supplier-api-prod -> blocked (tests are intentionally disabled for prod)
+TARGET_ACCOUNT_GROUP=nhs-notify-supplier-api-dev
 
-
-# * nhs-notify-supplier--internal-dev--nhs-notify-supplier
-# * nhs-notify-supplier--internal-dev--nhs-notify-supplier-PR-XX
-# * nhs-notify-supplier--ref--nhs-notify-supplier -- ref env
+# Resource namespace used to resolve AWS resource names for tests (main, pr123)
+# remove if needs to run against main
+TARGET_ENVIRONMENT=prxx
 
 # API Keys
 # ========
@@ -25,9 +37,9 @@ export STATUS_ENDPOINT_API_KEY=xxx
 
 # Private Keys
 # ============
-# private key used to generate authentication for tests ran against the internal-dev and internal-qa
-export NON_PROD_PRIVATE_KEY=xxx # path to the private key file
-# private key used to generate authentication for tests ran against the int environment
+# private key path used to generate authentication for tests ran against the internal-dev and internal-qa
+export NON_PROD_PRIVATE_KEY=xxx
+# private key path used to generate authentication for tests ran against the int environment
 export INTEGRATION_PRIVATE_KEY=xxx
-# private key used to generate authentication for tests ran against the prod environment
+# private key path used to generate authentication for tests ran against the prod environment
 export PRODUCTION_PRIVATE_KEY=xxx

.github/actions/acceptance-tests-components/action.yml

@@ -0,0 +1,48 @@
+name: Acceptance tests - component
+description: "Run component acceptance tests for this repo"
+
+inputs:
+  testType:
+    description: Type of test to run
+    required: true
+
+  targetEnvironment:
+    description: Name of the environment under test
+    required: true
+
+  targetComponent:
+    description: Name of the component under test
+    required: true
+
+  targetAccountGroup:
+    description: Name of the account group under test (e.g. nhs-notify-supplier-api-dev)
+    required: true
+
+runs:
+  using: "composite"
+
+  steps:
+
+    - name: Repo setup
+      uses: ./.github/actions/node-install
+      with:
+        GITHUB_TOKEN: ${{ env.GITHUB_TOKEN }}
+
+    - name: Fetch terraform output
+      uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5
+      with:
+        name: terraform-output-${{ inputs.targetComponent }}
+
+    - name: Get Node version
+      id: nodejs_version
+      shell: bash
+      run: |
+        echo "nodejs_version=$(grep "^nodejs\s" .tool-versions | cut -f2 -d' ')" >> $GITHUB_OUTPUT
+
+    - name: Run test - ${{ inputs.testType }}
+      shell: bash
+      env:
+        TARGET_ENVIRONMENT: ${{ inputs.targetEnvironment }}
+        TARGET_ACCOUNT_GROUP: ${{ inputs.targetAccountGroup }}
+      run: |
+        make test-${{ inputs.testType }}

.github/actions/acceptance-tests-e2e/action.yml

@@ -5,6 +5,9 @@ inputs:
   targetEnvironment:
     description: Name of the environment under test
     required: true
+  targetAccountGroup:
+    description: Name of the account group under test
+    required: true
 
 runs:
   using: "composite"
@@ -65,6 +68,10 @@ runs:
       env:
         TARGET_ENVIRONMENT: ${{ inputs.targetEnvironment }}
         PR_NUMBER: ${{ steps.set_pr_number.outputs.pr_number }}
+<<<<<<< HEAD
+=======
+        TARGET_ACCOUNT_GROUP: ${{ inputs.targetAccountGroup }}
+>>>>>>> main
       run: |
         echo "$DEV_E2E_KEYS_PRIVATE" > "${GITHUB_WORKSPACE}/internal-dev-test-1.pem"
         chmod 600 "${GITHUB_WORKSPACE}/internal-dev-test-1.pem"

.github/actions/acceptance-tests/action.yml

@@ -11,8 +11,7 @@ inputs:
     required: true
 
   targetAccountGroup:
-    description: Name of the account group under test
-    default: nhs-notify-template-management-dev
+    description: Name of the account group under test (e.g. nhs-notify-supplier-api-dev)
     required: true
 
   targetComponent:
@@ -24,16 +23,18 @@ runs:
 
   steps:
 
-    - name: Run component tests
+    - name: Run components tests (sandbox and component tests)
       if: ${{ inputs.testType != 'e2e' }}
-      uses: ./.github/actions/acceptance-tests-component
+      uses: ./.github/actions/acceptance-tests-components
       with:
         testType: ${{ inputs.testType }}
         targetEnvironment: ${{ inputs.targetEnvironment }}
         targetComponent: ${{ inputs.targetComponent }}
+        targetAccountGroup: ${{ inputs.targetAccountGroup }}
 
     - name: Run e2e tests
-      if: ${{ inputs.testType == 'e2e' && inputs.targetEnvironment == 'main' }}
+      if: ${{ inputs.testType == 'e2e' }}
       uses: ./.github/actions/acceptance-tests-e2e
       with:
         targetEnvironment: ${{ inputs.targetEnvironment }}
+        targetAccountGroup: ${{ inputs.targetAccountGroup }}

.github/workflows/deploy-dynamic-env-proxy.yaml

@@ -29,7 +29,8 @@ jobs:
 
       - name: Resolve nodejs version
         id: toolversions
-        run: echo "nodejs_version=$(grep '^nodejs\s' .tool-versions | cut -f2 -d' ')" >>
+        run:
+          echo "nodejs_version=$(grep '^nodejs\s' .tool-versions | cut -f2 -d' ')" >>
           "$GITHUB_OUTPUT"
 
       - name: "Check if pull request exists for this branch and set

Makefile

@@ -2,6 +2,7 @@
 # the project as automated steps to be executed on locally and in the CD pipeline.
 
 include scripts/init.mk
+-include .env # Load environment variables from .env file if it exists
 
 # ==============================================================================
 
@@ -130,11 +131,14 @@ ${VERBOSE}.SILENT: \
 # E2E Test commands #
 #####################
 
+# https://pytest-xdist.readthedocs.io/en/stable/known-limitations.html#output-stdout-and-stderr-from-workers means pytest won't print to stdout even with -s
+PYTEST_WORKERS := 4 # set to 0 to see stdout/stderr when debugging e2e tests
+
 TEST_CMD := APIGEE_ACCESS_TOKEN="$(APIGEE_ACCESS_TOKEN)" \
 	STATUS_ENDPOINT_API_KEY="$(STATUS_ENDPOINT_API_KEY)" \
 	PYTHONPATH=. poetry run pytest --disable-warnings -vv \
 	--color=yes \
-	-n 4 \
+		-n $(PYTEST_WORKERS) \
 	--api-name=nhs-notify-supplier \
 	--proxy-name="$(PROXY_NAME)" \
 	-s \
@@ -145,7 +149,6 @@ TEST_CMD := APIGEE_ACCESS_TOKEN="$(APIGEE_ACCESS_TOKEN)" \
 	--only-rerun 'AssertionError: Unexpected 502' \
 	--junitxml=test-report.xml
 
-
 .internal-dev-test:
 	@cd tests/e2e-tests && \
 	$(TEST_CMD) \
@@ -161,7 +164,7 @@ TEST_CMD := APIGEE_ACCESS_TOKEN="$(APIGEE_ACCESS_TOKEN)" \
 PROD_CMD := APIGEE_ACCESS_TOKEN="$(APIGEE_ACCESS_TOKEN)" \
 	PYTHONPATH=. poetry run pytest --disable-warnings -vv \
 	--color=yes \
-	-n 4 \
+	-n $(PYTEST_WORKERS) \
 	--api-name=nhs-notify-supplier \
 	--proxy-name="$(PROXY_NAME)" \
 	-s \

eslint.config.mjs

@@ -56,6 +56,7 @@ export default defineConfig([
     '**/node_modules',
     '**/dist',
     '**/test-results',
+    '**/target/**',
     '**/playwright-report*',
     'eslint.config.mjs',
     // newly ignored generated/build artifacts
@@ -91,6 +92,22 @@ export default defineConfig([
     },
   },
   { files: ['**/*.json'], extends: [tseslint.configs.disableTypeChecked] },
+  {
+    files: ['**/*.js', '**/*.cjs', '**/*.mjs'],
+    extends: [tseslint.configs.disableTypeChecked],
+  },
+  {
+    files: ['**/*.cjs'],
+    languageOptions: {
+      globals: {
+        module: 'readonly',
+        require: 'readonly',
+        exports: 'readonly',
+        __dirname: 'readonly',
+        __filename: 'readonly',
+      },
+    },
+  },
 
   {
     settings: {