Re-enable end-to-end tests, sourcing status endpoint from github secret, rather than fetching from APIM

Author: stevebux

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

@@ -19,4 +19,5 @@ runs:
         export PROXY_NAME=nhs-notify-supplier--internal-dev--nhs-notify-supplier
         export API_ENVIRONMENT=internal-dev
         export NON_PROD_PRIVATE_KEY="${GITHUB_WORKSPACE}/internal-dev-test-1.pem"
+        export STATUS_ENDPOINT_API_KEY="${STATUS_ENDPOINT_API_KEY}"
         make .internal-dev-test

.github/workflows/stage-4-acceptance.yaml

@@ -90,11 +90,9 @@ jobs:
       - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
       - name: "Run e2e tests"
-        #uses: ./.github/actions/e2e-tests
+        uses: ./.github/actions/e2e-tests
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NON_PROD_API_KEY: ${{ secrets.NON_PROD_API_KEY }}
           INTERNAL_DEV_TEST_PEM: ${{ secrets.INTERNAL_DEV_TEST_PEM }}
-        shell: bash
-        run: |
-          echo "E2E tests are currently disabled. See CCM-14778"
+          STATUS_ENDPOINT_API_KEY: ${{ secrets.STATUS_ENDPOINT_API_KEY }}

Makefile

@@ -131,6 +131,7 @@ ${VERBOSE}.SILENT: \
 #####################
 
 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 \

tests/e2e-tests/README.md

@@ -1,24 +1,5 @@
 # E2E Tests
 
-## Generate An Apigee Access Token
-
-To generate authentication using Apigee, you must have access to an Apigee account and use `get_token` via the command line and generate an Apigee access token.
-
-**Tokens expire once per day and require refreshing.**
-
-* Install [`get_token`](https://docs.apigee.com/api-platform/system-administration/auth-tools#install)
-* Run the following command and log in with your Apigee credentials when prompted:
-
-```shell
-export APIGEE_ACCESS_TOKEN=$(SSO_LOGIN_URL=https://login.apigee.com get_token)
-```
-
-* If your token does not refresh, try clearing the cache:
-
-```shell
-export APIGEE_ACCESS_TOKEN=$(SSO_LOGIN_URL=https://login.apigee.com get_token --clear-sso-cache)
-```
-
 ### Set Proxy Name
 
 Set the `PROXY_NAME` environment variable to specify the environment for test execution. You can find the proxy name by logging into [Apigee](https://apigee.com/edge), navigating to 'API Proxies' and searching for 'supplier-api' for lower environments like internal-dev.
@@ -31,3 +12,14 @@ Available values for `PROXY_NAME` include:
 
 * `nhs-notify-supplier--internal-dev--nhs-notify-supplier`
 * `nhs-notify-supplier--internal-dev--nhs-notify-supplier-pr<num>`
+
+### Set Up API Keys
+
+Set the following environment variables to use the Apigee API keys:
+
+```shell
+export NON_PROD_API_KEY=******
+export STATUS_ENDPOINT_API_KEY=******
+```
+
+The values have been redacted here but you can obtain them from another team member.

tests/e2e-tests/api/test_endpoint.py

@@ -1,22 +1,19 @@
 import pytest
 import requests
-from os import getenv
 from lib.errorhandler import ErrorHandler
-
-def _get(url, headers=None, timeout=10):
-    return requests.get(url, headers=headers or {}, timeout=timeout)
+from lib.fixtures import *  # NOSONAR
 
 @pytest.mark.smoketest
-def test_ping(nhsd_apim_proxy_url):
-    resp = requests.get(nhsd_apim_proxy_url + "/_ping")
+def test_ping(url):
+    resp = requests.get(url + "/_ping")
     assert resp.status_code == 200
 
 @pytest.mark.smoketest
 @pytest.mark.sandboxtest
 @pytest.mark.devtest
-def test_status(nhsd_apim_proxy_url, status_endpoint_auth_headers):
+def test_status(url, status_endpoint_api_key):
     resp = requests.get(
-        f"{nhsd_apim_proxy_url}/_status", headers=status_endpoint_auth_headers
+        f"{url}/_status", headers={"apikey": status_endpoint_api_key}
     )
 
     ErrorHandler.handle_retry(resp)
@@ -25,9 +22,9 @@ def test_status(nhsd_apim_proxy_url, status_endpoint_auth_headers):
 @pytest.mark.smoketest
 @pytest.mark.sandboxtest
 @pytest.mark.devtest
-def test_401_status_without_api_key(nhsd_apim_proxy_url):
+def test_401_status_without_api_key(url):
     resp = requests.get(
-        f"{nhsd_apim_proxy_url}/_status"
+        f"{url}/_status"
     )
 
     ErrorHandler.handle_retry(resp)

tests/e2e-tests/lib/fixtures.py

@@ -62,3 +62,7 @@ def bearer_token(authentication_cache):
     else:
         url = f"https://{environment}.api.service.nhs.uk/nhs-notify-supplier"
     return authentication_cache.generate_authentication(environment, url)
+
+@pytest.fixture(scope='session')
+def status_endpoint_api_key():
+    return os.environ["STATUS_ENDPOINT_API_KEY"]