addres PR comments and make more use of constants

Author: RossFaulds171

README.md

@@ -122,7 +122,7 @@ New developers of the NHS Notify Supplier API should understand the below.
 
 ##### SDKs
 
-- The [SDK](sdk) folder is excluded from all pre requisites
+- The [SDK](sdk) folder is excluded from all pre reqs
 - DO NOT make manual changes to the [SDK](sdk), instead [build](#build) it
 - The SDK folder is excluded from git commits,
   and will be built as part of the CI/CD pipeline and released as a GitHub

tests/e2e-tests/api/mi/test_get_mi_information.py

@@ -41,9 +41,9 @@ def test_404_mi_does_not_exist(url, authentication_secret):
 @pytest.mark.devtest
 @pytest.mark.inttest
 @pytest.mark.prodtest
-def test_404_mi_miId_from_different_supplier_returns_does_not_exist(url, authentication_secret, supplier1_authentication_secret):
+def test_404_mi_miId_from_different_supplier_returns_does_not_exist(url, authentication_secret, secondary_supplier_authentication_secret):
     headers = Generators.generate_valid_headers(authentication_secret)
-    other_supplier_headers = Generators.generate_valid_headers(supplier1_authentication_secret) # secondary_auth
+    other_supplier_headers = Generators.generate_valid_headers(secondary_supplier_authentication_secret)
     data = Generators.generate_valid_mi_record_body()
     create_mi = requests.post(
         f"{url}/{MI_ENDPOINT}",

tests/e2e-tests/lib/authentication.py

@@ -4,6 +4,7 @@
 import jwt
 import requests
 import json
+from .constants import SUPPLIER, SECONDARY_SUPPLIER
 from .secret import Secret
 
 
@@ -32,38 +33,39 @@ def generate_authentication(self, env, base_url, path, supplier_id = None):
         # the backend. The test will only check that the API doesn't return a 401,
         # a 404 response means the authentication is working.
         test_url = f"{base_url}{path}"
+        api_key = None
 
         if env == "internal-dev":
-            if (supplier_id == "TestSupplier1"):
+            if (supplier_id == SECONDARY_SUPPLIER):
                 api_key = os.environ["NON_PROD_SECONDARY_API_KEY"]
-            else:
+            elif (supplier_id == SUPPLIER):
                 api_key = os.environ["NON_PROD_API_KEY"]
 
             private_key = os.environ["NON_PROD_PRIVATE_KEY"]
             url = "https://internal-dev.api.service.nhs.uk/oauth2/token"
             kid = "internal-dev-test-1"
         elif env == "ref":
-            if (supplier_id == "TestSupplier1"):
+            if (supplier_id == SECONDARY_SUPPLIER):
                 api_key = os.environ["NON_PROD_SECONDARY_API_KEY"]
-            else:
+            elif (supplier_id == SUPPLIER):
                 api_key = os.environ["NON_PROD_API_KEY"]
 
             private_key = os.environ["NON_PROD_PRIVATE_KEY"]
             url = "https://ref.api.service.nhs.uk/oauth2/token"
             kid = "internal-dev-test-1"
         elif env == "int":
-            if (supplier_id == "TestSupplier1"):
+            if (supplier_id == SECONDARY_SUPPLIER):
                 api_key = os.environ["INTEGRATION_SECONDARY_API_KEY"]
-            else:
+            elif (supplier_id == SUPPLIER):
                 api_key = os.environ["INTEGRATION_API_KEY"]
 
             private_key = os.environ.get("INTEGRATION_PRIVATE_KEY")
             url = "https://int.api.service.nhs.uk/oauth2/token"
             kid = "internal-dev-test-1"
         elif env == "prod":
-            if (supplier_id == "TestSupplier1"):
+            if (supplier_id == SECONDARY_SUPPLIER):
                 api_key = os.environ.get("PRODUCTION_SECONDARY_API_KEY")
-            else:
+            elif (supplier_id == SUPPLIER):
                 api_key = os.environ.get("PRODUCTION_API_KEY")
 
             private_key = os.environ.get("PRODUCTION_PRIVATE_KEY")
@@ -82,10 +84,10 @@ def generate_authentication(self, env, base_url, path, supplier_id = None):
         _, latest_token_expiry = self.tokens.get(env, (None, 0))
 
         # Generate new token if latest token will expire in 15 seconds
-        if env not in self.tokens or latest_token_expiry < int(time()) + 15:
-            self.tokens[env] = self.generate_and_test_new_token(api_key, private_key, url, kid, test_url)
+        if (env, supplier_id) not in self.tokens or latest_token_expiry < int(time()) + 15:
+            self.tokens[(env, supplier_id)] = self.generate_and_test_new_token(api_key, private_key, url, kid, test_url)
 
-        authentication_secret = self.tokens[env][0]
+        authentication_secret = self.tokens[(env, supplier_id)][0]
         return Secret(authentication_secret)
 
     def generate_and_test_new_token(self, api_key, private_key, url, kid, test_url):

tests/e2e-tests/lib/constants.py

@@ -3,5 +3,5 @@
 DEFAULT_CONTENT_TYPE = "application/vnd.api+json"
 LETTERS_ENDPOINT = "/letters"
 MI_ENDPOINT = "/mi"
-SUPPLIER = "TestSupplier1"
-SECONDARY_SUPPLIER = "supplier1"
+SUPPLIER = "supplier1"
+SECONDARY_SUPPLIER = "TestSupplier1"

tests/e2e-tests/lib/fixtures.py

@@ -1,6 +1,7 @@
 import pytest
 import os
 import re
+from .constants import SUPPLIER, SECONDARY_SUPPLIER
 from .authentication import AuthenticationCache
 
 # for now this is the same as PROXY_NAME
@@ -54,7 +55,7 @@ def authentication_cache():
 @pytest.fixture()
 def authentication_secret(url, authentication_cache):
     environment = os.environ['API_ENVIRONMENT']
-    return authentication_cache.generate_authentication(environment, url, "/", "TestSupplier1")
+    return authentication_cache.generate_authentication(environment, url, "/", SUPPLIER)
 
 @pytest.fixture()
 def status_authentication_secret(url, authentication_cache):
@@ -66,6 +67,6 @@ def status_endpoint_api_key():
     return os.environ["STATUS_ENDPOINT_API_KEY"]
 
 @pytest.fixture()
-def supplier1_authentication_secret(url, authentication_cache):
+def secondary_supplier_authentication_secret(url, authentication_cache):
     environment = os.environ['API_ENVIRONMENT']
-    return authentication_cache.generate_authentication(environment, url, "/", "supplier1")
+    return authentication_cache.generate_authentication(environment, url, "/", SECONDARY_SUPPLIER)

tests/e2e-tests/lib/letters.py

@@ -3,12 +3,12 @@
 import pathlib
 import time
 import requests
+from .constants import SUPPLIER
 from lib.errorhandler import ErrorHandler
 
 
 _REPO_ROOT = pathlib.Path(__file__).resolve().parents[3]
 _CLI_WORKSPACE = "nhs-notify-supplier-api-letter-test-data-utility"
-_SUPPLIER_ID = "TestSupplier1"
 
 
 def create_test_data(count: int = 10) -> None:
@@ -28,7 +28,7 @@ def create_test_data(count: int = 10) -> None:
         "cli",
         "--",
         "create-letter-batch",
-        "--supplier-id", _SUPPLIER_ID,
+        "--supplier-id", SUPPLIER,
         "--environment", environment,
         "--awsAccountId", aws_account_id,
         "--group-id", "TestGroupID",