Merge pull request #437 from NHSDigital/add-option-to-use-token

Add option to use token

Author: jf-x-dev

.env.generic

@@ -1,4 +1,8 @@
+PROGRAMMES_ENABLED=HPV,MENACWY,TD_IPV,FLU
 BASE_URL=https://qa.mavistesting.com
+
+# provide either a token or a username/password pair
 BASIC_AUTH_USERNAME=
 BASIC_AUTH_PASSWORD=
-PROGRAMMES_ENABLED=HPV,MENACWY,TD_IPV,FLU
+
+BASIC_AUTH_TOKEN=

.github/workflows/functional.yaml

@@ -50,8 +50,7 @@ jobs:
         env:
           BASE_URL: ${{ vars.BASE_URL }}
           PROGRAMMES_ENABLED: ${{ vars.PROGRAMMES_ENABLED }}
-          BASIC_AUTH_PASSWORD: ${{ secrets.BASIC_AUTH_PASSWORD }}
-          BASIC_AUTH_USERNAME: ${{ secrets.BASIC_AUTH_USERNAME }}
+          BASIC_AUTH_TOKEN: ${{ secrets.HTTP_AUTH_TOKEN_FOR_TESTS }}
 
       - name: Generate Allure report
         if: always()

.github/workflows/functional_selected_device.yaml

@@ -72,8 +72,7 @@ jobs:
         env:
           BASE_URL: ${{ steps.set-variables.outputs.environment }}
           PROGRAMMES_ENABLED: ${{ steps.set-variables.outputs.programmes }}
-          BASIC_AUTH_PASSWORD: ${{ secrets.BASIC_AUTH_PASSWORD }}
-          BASIC_AUTH_USERNAME: ${{ secrets.BASIC_AUTH_USERNAME }}
+          BASIC_AUTH_TOKEN: ${{ secrets.HTTP_AUTH_TOKEN_FOR_TESTS }}
 
       - name: Generate Allure report
         if: always() && steps.set-variables.outputs.deploy_report == 'true'

mavis/test/__init__.py

@@ -5,7 +5,8 @@
     archive_batch_page,
     archive_consent_response_page,
     base_url,
-    basic_auth,
+    basic_auth_credentials,
+    basic_auth_token,
     browser_context_args,
     browser_type,
     children,
@@ -52,7 +53,8 @@
     "archive_batch_page",
     "archive_consent_response_page",
     "base_url",
-    "basic_auth",
+    "basic_auth_credentials",
+    "basic_auth_token",
     "browser_context_args",
     "browser_type",
     "children",

mavis/test/fixtures/__init__.py

@@ -43,7 +43,13 @@
     unmatched_consent_responses_page,
     vaccines_page,
 )
-from .playwright import base_url, basic_auth, browser_context_args, browser_type
+from .playwright import (
+    base_url,
+    basic_auth_credentials,
+    basic_auth_token,
+    browser_context_args,
+    browser_type,
+)
 
 __all__ = [
     "add_vaccine_batch",
@@ -52,7 +58,8 @@
     "archive_batch_page",
     "archive_consent_response_page",
     "base_url",
-    "basic_auth",
+    "basic_auth_credentials",
+    "basic_auth_token",
     "browser_context_args",
     "browser_type",
     "children_page",

mavis/test/fixtures/playwright.py

@@ -11,13 +11,18 @@ def base_url() -> str:
 
 
 @pytest.fixture(scope="session")
-def basic_auth() -> dict[str, str]:
+def basic_auth_credentials() -> dict[str | None, str | None]:
     return {
-        "username": os.environ["BASIC_AUTH_USERNAME"],
-        "password": os.environ["BASIC_AUTH_PASSWORD"],
+        "username": os.environ.get("BASIC_AUTH_USERNAME"),
+        "password": os.environ.get("BASIC_AUTH_PASSWORD"),
     }
 
 
+@pytest.fixture(scope="session")
+def basic_auth_token() -> str | None:
+    return os.environ.get("BASIC_AUTH_TOKEN")
+
+
 @pytest.fixture(scope="session")
 def browser_type(playwright: Playwright, device: Optional[str]) -> BrowserType:
     device = device or "Desktop Chrome"
@@ -26,5 +31,13 @@ def browser_type(playwright: Playwright, device: Optional[str]) -> BrowserType:
 
 
 @pytest.fixture(scope="session")
-def browser_context_args(browser_context_args, basic_auth):
-    return {**browser_context_args, "http_credentials": basic_auth}
+def browser_context_args(
+    browser_context_args, basic_auth_credentials, basic_auth_token
+) -> dict:
+    if basic_auth_token:
+        return {
+            **browser_context_args,
+            "extra_http_headers": {"Authorization": f"Basic {basic_auth_token}"},
+        }
+
+    return {**browser_context_args, "http_credentials": basic_auth_credentials}