Add support for dynamic apps across more environments

Author: dlzhry2nhs

.github/workflows/run-e2e-automation-tests.yml

@@ -41,14 +41,12 @@ on:
           - internal-qa
           - int
           - ref
-          - prod
       environment:
         type: string
         description: Select the backend environment
         options:
           - dev
           - preprod
-          - prod
       sub_environment:
         type: string
         description: Set the sub environment name e.g. pr-xxx, or green/blue in higher environments
@@ -71,6 +69,7 @@ on:
           - proxy_smoke
 
 env:
+  APIGEE_AUTH_ENV: ${{ inputs.apigee_environment == 'int' && inputs.apigee_environment || 'internal-dev' }}
   APIGEE_ENVIRONMENT: ${{ inputs.apigee_environment }}
   ENVIRONMENT: ${{ inputs.environment }}
   SUB_ENVIRONMENT: ${{ inputs.sub_environment }}
@@ -211,14 +210,14 @@ jobs:
         working-directory: tests/e2e_automation
         env:
           S3_env: ${{ inputs.sub_environment }}
-          auth_url: https://${{ inputs.apigee_environment }}.api.service.nhs.uk/oauth2-mock/authorize
-          token_url: https://${{ inputs.apigee_environment }}.api.service.nhs.uk/oauth2-mock/token
+          auth_url: https://${{ env.APIGEE_AUTH_ENV }}.api.service.nhs.uk/oauth2-mock/authorize
+          token_url: https://${{ env.APIGEE_AUTH_ENV }}.api.service.nhs.uk/oauth2-mock/token
           baseUrl: https://${{ inputs.apigee_environment }}.api.service.nhs.uk/${{env.SERVICE_BASE_PATH}}
           callback_url: "https://oauth.pstmn.io/v1/callback"
-          Postman_Auth_client_Id: ${{ secrets.Postman_Auth_client_Id }}
-          Postman_Auth_client_Secret: ${{ secrets.Postman_Auth_client_Secret }}
           username: ${{ secrets.CIS2_E2E_USERNAME }}
           scope: "nhs-cis2"
+          Postman_Auth_client_Id: ${{ secrets.Postman_Auth_client_Id }} # The following static app values are only needed in INT
+          Postman_Auth_client_Secret: ${{ secrets.Postman_Auth_client_Secret }}
           RAVS_client_Id: ${{ secrets.RAVS_client_Id }}
           RAVS_client_Secret: ${{ secrets.RAVS_client_Secret }}
           MAVIS_client_Id: ${{ secrets.MAVIS_client_Id }}

tests/e2e_automation/.env.example.pr

@@ -21,3 +21,4 @@ PROXY_NAME=immunisation-fhir-api-pr-123
 # See README for details on how to obtain this
 APIGEE_ACCESS_TOKEN={use-the-apigee-get-token-utility}
 APIGEE_USERNAME={your-apigee-developer-email}
+APIGEE_ENVIRONMENT={the-relevant-apigee-env}  # E.g. internal-dev, internal-qa

tests/e2e_automation/README.md

@@ -4,6 +4,8 @@ This directory contains End-to-end Automation Tests for the Immunisation FHIR AP
 
 ## Setting up e2e_automation tests to run locally
 
+Update README with the changes to use get_token
+
 1. Follow the instructions in the root level README.md to setup the [dependencies](../../README.md#environment-setup) and create a [virtual environment](../../README.md#setting-up-a-virtual-environment-with-poetry) for this folder (`e2e_automation`).
 
 2. Add values to the .env file.
@@ -62,6 +64,8 @@ This directory contains End-to-end Automation Tests for the Immunisation FHIR AP
 
 ## Running e2e_automation tests against PR environments
 
+Need to update this in PR and explain how to use static apps if desired locally.
+
 The environment variables define a client ID and client secret for each of the Apigee test apps we use in static
 environments such as `internal-dev`, `internal-qa` and so on.
 

tests/e2e_automation/features/conftest.py

@@ -7,7 +7,7 @@
 from utilities.api_fhir_immunization_helper import empty_folder
 from utilities.api_gen_token import get_tokens
 from utilities.api_get_header import get_delete_url_header
-from utilities.apigee.apigee_env_helpers import is_pr_env
+from utilities.apigee.apigee_env_helpers import use_temp_apigee_apps
 from utilities.apigee.ApigeeApp import ApigeeApp
 from utilities.apigee.ApigeeOnDemandAppManager import ApigeeOnDemandAppManager
 from utilities.aws_token import refresh_sso_token, set_aws_session_token
@@ -58,7 +58,7 @@ def global_context():
 
 @pytest.fixture(scope="session")
 def temp_apigee_apps():
-    if is_pr_env():
+    if use_temp_apigee_apps():
         apigee_app_mgr = ApigeeOnDemandAppManager()
         created_apps = apigee_app_mgr.setup_apps_and_product()
 

tests/e2e_automation/utilities/apigee/ApigeeOnDemandAppManager.py

@@ -4,27 +4,33 @@
 
 import requests
 
-from utilities.apigee.apigee_env_helpers import get_apigee_access_token, get_apigee_username, get_proxy_name
+from utilities.apigee.apigee_env_helpers import (
+    get_apigee_access_token,
+    get_apigee_environment,
+    get_apigee_username,
+    get_proxy_name,
+)
 from utilities.apigee.ApigeeApp import ApigeeApp
 
 
 class ApigeeOnDemandAppManager:
-    """Manager class that provides required Apigee functionality for PR env e2e tests. E.g. creating an app, subscribing it to
-    products and teardown"""
+    """Manager class that provides required Apigee functionality for Apigee non-prod env e2e tests. E.g. creating an
+    app, subscribing it to products and teardown"""
 
-    # We only use the Apigee API in the non-prod organisation and the internal-dev environment
+    # We only use the Apigee API in the non-prod organisation i.e. all environments except INT and PROD
     _BASE_URL = "https://api.enterprise.apigee.com/v1/organizations/nhsd-nonprod"
     _APPS_PATH = "apps"
     _DEVELOPERS_PATH = "developers"
     _PRODUCTS_PATH = "apiproducts"
-    _INTERNAL_DEV_ENV_NAME = "internal-dev"
+    _INTERNAL_DEV_ID_SERVICE_PRODUCT = "identity-service-internal-dev"
     _TEST_APP_SUPPLIERS = ("EMIS", "MAVIS", "MEDICUS", "Postman_Auth", "RAVS", "SONAR", "TPP")
 
     def __init__(self):
-        self.pr_proxy_name = get_proxy_name()
+        self.proxy_name = get_proxy_name()
+        self.apigee_environment = get_apigee_environment()
         self.created_product_name_uuid: str = ""
         self.created_app_name_uuids = []
-        self.display_name = f"test-{self.pr_proxy_name}"
+        self.display_name = f"test-{self.proxy_name}"
 
         self.logged_in_username = get_apigee_username()
         self.access_token = get_apigee_access_token()
@@ -42,7 +48,7 @@ def _create_app(self, target_product_name: str, supplier_name: str) -> ApigeeApp
                 {"name": "DisplayName", "value": f"{self.display_name}-{supplier_name}"},
                 {"name": "SupplierSystem", "value": supplier_name},
             ],
-            "apiProducts": [target_product_name, "identity-service-internal-dev"],
+            "apiProducts": [target_product_name, self._INTERNAL_DEV_ID_SERVICE_PRODUCT],
         }
 
         response = self.requests_session.post(
@@ -68,11 +74,11 @@ def _create_product(self) -> str:
             "approvalType": "auto",
             "description": "Autogenerated API product for E2E tests",
             "displayName": self.display_name,
-            "environments": [self._INTERNAL_DEV_ENV_NAME],
-            "proxies": [self.pr_proxy_name],
+            "environments": [self.apigee_environment],
+            "proxies": [self.proxy_name],
             "scopes": [
-                f"urn:nhsd:apim:app:level3:{self.pr_proxy_name}",
-                f"urn:nhsd:apim:user-nhs-cis2:aal3:{self.pr_proxy_name}",
+                f"urn:nhsd:apim:app:level3:{self.proxy_name}",
+                f"urn:nhsd:apim:user-nhs-cis2:aal3:{self.proxy_name}",
             ],
         }
 

tests/e2e_automation/utilities/apigee/apigee_env_helpers.py

@@ -1,5 +1,8 @@
 import os
 
+PROXY_PR_PREFIX = "immunisation-fhir-api-pr-"
+INT_PROXY_NAME = "immunisation-fhir-api-int"
+
 
 def get_env_var(var_name: str) -> str:
     value = os.getenv(var_name)
@@ -18,11 +21,31 @@ def get_proxy_name() -> str:
     return get_env_var("PROXY_NAME")
 
 
+def use_temp_apigee_apps() -> bool:
+    """
+    Determines if temporary Apigee Apps are required for the test run based on the following business logic:
+    - dynamic PR environments always require temporary apps
+    - Apigee non-prod environments (everything except INT and PROD) use dynamic apps unless the user provides the
+    USE_STATIC_APPS env var to override this
+    """
+    if is_pr_env():
+        return True
+
+    if get_proxy_name() == INT_PROXY_NAME:
+        return False
+
+    return os.getenv("USE_STATIC_APPS", "false") != "true"
+
+
 def is_pr_env() -> bool:
     """Checks if the tests are running against a dynamic PR environment"""
     proxy_name = get_proxy_name()
-    return proxy_name.startswith("immunisation-fhir-api-pr-")
+    return proxy_name.startswith(PROXY_PR_PREFIX)
 
 
 def get_apigee_access_token() -> str:
     return get_env_var("APIGEE_ACCESS_TOKEN")
+
+
+def get_apigee_environment() -> str:
+    return get_env_var("APIGEE_ENVIRONMENT")