initial work

Author: davethepunkyone

.gitignore

@@ -16,3 +16,4 @@ __pycache__/
 .pytest_cache/
 test-results/
 axe-reports/
+local.env

README.md

@@ -33,8 +33,6 @@ To utilise the blueprint code, you will need to have the following installed:
 
 - [Python](https://www.python.org/downloads/) 3.12 or greater
 
-> NOTE: There are currently known issues with Python 3.13 and Playwright, so if you encounter issues running this project whilst using Python 3.13 it is recommended to downgrade to Python 3.12 in the interim.
-
 Whilst not required to get started, you may also want to [configure a Python virtual environment for your project](https://docs.python.org/3/library/venv.html) before proceeding with
 the configuration.  If you are using an IDE such as Visual Studio Code or PyCharm, you will normally be prompted to do this automatically.
 

conftest.py

@@ -0,0 +1,21 @@
+"""
+This is a conftest.py file for pytest, which is used to set up fixtures and hooks for testing.
+This file is used to define fixtures that can be used across multiple test files.
+It is also used to define hooks that can be used to modify the behavior of pytest.
+"""
+
+import pytest
+import os
+from dotenv import load_dotenv
+from pathlib import Path
+
+LOCAL_ENV_PATH = Path(os.getcwd()) / 'local.env'
+
+
+@pytest.fixture(autouse=True, scope="session")
+def import_local_env_file() -> None:
+    """
+    This fixture is used to import the local.env file into the test environment, if the file is present.
+    """
+    if Path.is_file(LOCAL_ENV_PATH):
+        load_dotenv(LOCAL_ENV_PATH, override=False)

requirements.txt

@@ -2,3 +2,4 @@ pytest-playwright>=0.5.1
 pytest-html>=4.1.1
 pytest-json-report>=1.5.0
 pytest-playwright-axe>=4.10.3
+python-dotenv>=1.1.0

setup_env_file.py

@@ -0,0 +1,30 @@
+"""
+This script creates a local.env file that can be used to populate secrets such as passwords or API keys
+locally. This is useful for local development and testing, as it allows you to keep sensitive information 
+out of your codebase.
+
+This is designed to be generated when setting up this project, so if new variables are required, these
+should be added to the REQUIRED_KEYS list below to automatically populate the local.env file with the
+keys required to run this project.
+"""
+
+import os
+from pathlib import Path
+
+REQUIRED_KEYS = ["USER_PASS"]
+DEFAULT_LOCAL_ENV_PATH = Path(os.getcwd()) / 'local.env'
+
+def create_env_file():
+    """
+    Create a .env file with the required keys.
+    """
+    with open(DEFAULT_LOCAL_ENV_PATH, 'w') as f:
+        f.write("# Use this file to populate secrets without committing them to the codebase (as this file is set in .gitignore).\n")
+        f.write("# To retrieve values as part of your tests, use os.getenv('VARIABLE_NAME').\n")
+        f.write("# Note: When running in a pipeline or workflow, you should pass these variables in at runtime.\n\n")
+        for key in REQUIRED_KEYS:
+            f.write(f'{key}=\n')
+
+
+if __name__ == "__main__":
+    create_env_file()