APM-6127 initial changes to refactor tests

Author: sophieclayton12-nhs

.gitignore

@@ -1,4 +1,5 @@
 node_modules/
+
 bin/
 dist/
 build/
@@ -12,5 +13,6 @@ __pycache__/
 .envrc
 .idea/
 .venv/
+.direnv/
 
 smoketest-report.xml

Makefile

@@ -45,10 +45,18 @@ release: clean publish build-proxy
 	mkdir -p dist
 	for f in $(_dist_include); do cp -r $$f dist; done
 
+TEST_CMD := @APIGEE_ACCESS_TOKEN=$(APIGEE_ACCESS_TOKEN) \
+		poetry run pytest -v \
+		--color=yes \
+		--api-name=splunk-monitor \
+		--proxy-name=$(PROXY_NAME) \
+		-s
+
 test:
-#	this target should be used for local unit tests ..  runs as part of the build pipeline
-	make --no-print-directory -C test
+	$(TEST_CMD) \
+	--junitxml=test-report.xml \
 
 smoketest:
-#	this target is for end to end smoketests this would be run 'post deploy' to verify an environment is working
-	poetry run pytest -v --junitxml=smoketest-report.xml -s -m smoketest
+	$(TEST_CMD) \
+	--junitxml=smoketest-report.xml \
+	-m smoketest

azure/templates/run-smoke-tests.yml

@@ -5,11 +5,9 @@ steps:
     displayName: Setup pytests
 
   - bash: |
-      export RELEASE_RELEASEID=$(Build.BuildId)
-      export SOURCE_COMMIT_ID=$(Build.SourceVersion)
-      export APIGEE_ENVIRONMENT="$(ENVIRONMENT)"
-      export SERVICE_BASE_PATH="$(SERVICE_BASE_PATH)"
-      export STATUS_ENDPOINT_API_KEY="$(status-endpoint-api-key)"
+      export PROXY_NAME="$(FULLY_QUALIFIED_SERVICE_NAME)"
+      export APIGEE_ACCESS_TOKEN="$(secret.AccessToken)"
+      export SOURCE_COMMIT_ID="$(Build.SourceVersion)"
 
       make smoketest
     workingDirectory: $(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)

poetry.lock

@@ -15,6 +15,8 @@ package-mode = false
 
 [tool.poetry.dependencies]
 python = "^3.9"
+pytest-nhsd-apim = "^4.0.1"
+requests = "^2.32.3"
 
 [tool.poetry.group.dev.dependencies]
 flake8 = "^7.1.2"
@@ -26,10 +28,9 @@ docopt = "^0.6.2"
 jsonpath-rw = "^1.4.0"
 semver = "^3.0.2"
 gitpython = "^3.1.34"
-pytest = "^6.1.2"
+pytest = "^8.2.0"
 coverage = "^5.5"
 aiohttp = "^3.10.11"
 pytest-asyncio = "^0.14.0"
-api-test-utils = {url = "https://github.com/NHSDigital/apim-test-utils/releases/download/v1.1.43-alpha/api_test_utils-1.1.43a0-py3-none-any.whl"}
 
 [tool.poetry.scripts]

pyproject.toml

@@ -1,78 +1,31 @@
-from functools import partial
+from os import getenv
 
 import pytest
-from aiohttp import ClientResponse
-from api_test_utils.api_session_client import APISessionClient
-from api_test_utils.api_test_session_config import APITestSessionConfig
-from api_test_utils import poll_until, env
-
-
-async def _is_deployed(resp: ClientResponse, api_test_config: APITestSessionConfig) -> bool:
-
-    if resp.status != 200:
-        return False
-    body = await resp.json()
-
-    return body.get("commitId") == api_test_config.commit_id
-
-
-async def is_401(resp: ClientResponse) -> bool:
-    return resp.status == 401
-
-
-async def is_200(resp: ClientResponse) -> bool:
-    return resp.status == 200
-
-
-@pytest.mark.e2e
-@pytest.mark.smoketest
-def test_output_test_config(api_test_config: APITestSessionConfig):
-    print(api_test_config)
+import requests
 
 
 @pytest.mark.e2e
 @pytest.mark.smoketest
 @pytest.mark.asyncio
-async def test_wait_for_ping(api_client: APISessionClient, api_test_config: APITestSessionConfig):
-    """
-        test for _ping ..  this uses poll_until to wait until the correct SOURCE_COMMIT_ID ( from env var )
-        is available
-    """
-
-    is_deployed = partial(_is_deployed, api_test_config=api_test_config)
-
-    await poll_until(
-        make_request=lambda: api_client.get('_ping'),
-        until=is_deployed,
-        timeout=120
-    )
-
-
-@pytest.mark.e2e
-@pytest.mark.smoketest
-@pytest.mark.asyncio
-@pytest.mark.skip(reason="There is no _status endpoint configured on this proxy.")
-async def test_check_status_is_secured(api_client: APISessionClient):
-
-    await poll_until(
-        make_request=lambda: api_client.get('_status'),
-        until=is_401,
-        timeout=120
-    )
-
-
-@pytest.mark.e2e
-@pytest.mark.smoketest
-@pytest.mark.asyncio
-@pytest.mark.skip(reason="There is no _status endpoint configured on this proxy.")
-async def test_wait_for_status(api_client: APISessionClient, api_test_config: APITestSessionConfig):
-
+async def test_wait_for_ping(nhsd_apim_proxy_url):
     """
-        test for _status ..  this uses poll_until to wait until the correct SOURCE_COMMIT_ID ( from env var )
+        test for _ping, this waits until the correct SOURCE_COMMIT_ID ( from env var )
         is available
     """
-    await poll_until(
-        make_request=lambda: api_client.get('_status', headers={'apikey': env.status_endpoint_api_key()}),
-        until=is_200,
-        timeout=120
-    )
+    retries = 0
+    resp = requests.get(f"{nhsd_apim_proxy_url}/_ping")
+    deployed_commit_id = resp.json().get("commitId")
+
+    while (deployed_commit_id != getenv('SOURCE_COMMIT_ID')
+            and retries <= 30
+            and resp.status_code == 200):
+        resp = requests.get(f"{nhsd_apim_proxy_url}/_ping")
+        deployed_commit_id = resp.json().get("commitId")
+        retries += 1
+
+    if resp.status_code != 200:
+        pytest.fail(f"Status code {resp.status_code}, expecting 200")
+    elif retries >= 30:
+        pytest.fail("Timeout Error - max retries")
+
+    assert deployed_commit_id == getenv('SOURCE_COMMIT_ID')