wip

Author: davethepunkyone

.vscode/settings.json

@@ -10,6 +10,9 @@
     "Licence",
     "organisation",
     "pytest",
+    "pytestmark",
+    "retcode",
+    "ruleset",
     "utilise",
     "utilised",
     "Utilising"

tests_utils/test_nhs_number_tools.py

@@ -0,0 +1,21 @@
+import pytest
+from utils.nhs_number_tools import NHSNumberTools, NHSNumberToolsException
+
+
+pytestmark = [pytest.mark.utils]
+
+def test_nhs_number_checks() -> None:
+    assert NHSNumberTools._nhs_number_checks("1234567890") == None
+
+    with pytest.raises(Exception, match=r'The NHS number provided \(A234567890\) is not numeric.'):
+        NHSNumberTools._nhs_number_checks("A234567890")
+    
+    with pytest.raises(NHSNumberToolsException, match=r'The NHS number provided \(123\) is not 10 digits'):
+        NHSNumberTools._nhs_number_checks("123")
+
+def test_spaced_nhs_number() -> None:
+    assert NHSNumberTools.spaced_nhs_number("1234567890") == "123 456 7890"
+    assert NHSNumberTools.spaced_nhs_number(3216549870) == "321 654 9870"
+
+if __name__ == "__main__":
+    retcode = pytest.main(["-m", "utils"])

tests_utils/test_user_tools.py

@@ -0,0 +1,8 @@
+import pytest
+from utils.user_tools import UserTools, UserToolsException
+
+
+pytestmark = [pytest.mark.utils]
+
+def test_nhs_number_checks() -> None:
+    assert UserTools().retrieve_user("Example User 1")

users.json

@@ -1,10 +1,11 @@
-{
-    "Example User": {
+{  
+    "_comment": "This file can be used to store data on users for your application, and then pulled through using the utils.user_tools UserTools utility. The documentation for this utility explains how this file is read.",
+    "Example User 1": {
         "username": "EXAMPLE_USER1",
-        "roles": "Example Role A"
+        "roles": ["Example Role A"]
     },
     "Example User 2": {
         "username": "EXAMPLE_USER2",
-        "roles": "Example Role B"
+        "roles": ["Example Role B", "Example Role C"]
     }
 }

utils/axe.py

@@ -6,6 +6,7 @@
 from pathlib import Path
 
 
+logger = logging.getLogger(__name__)
 AXE_PATH = Path(__file__).parent / "resources" / "axe.js"
 PATH_FOR_REPORT = Path(__file__).parent.parent / "axe-reports"
 DEFAULT_WCAG_RULESET = ['wcag2a', 'wcag21a', 'wcag2aa', 'wcag21aa', 'wcag22a', 'wcag22aa', 'best-practice']
@@ -36,13 +37,16 @@ def run(page: Page,
             strict_mode (bool): [Optional] If true, raise an exception if a violation is detected. If false (default), proceed with test execution.
             html_report_generated (bool): [Optional] If true (default), generates a html report for the page scanned. If false, no html report is generated.
             json_report_generated (bool): [Optional] If true (default), generates a json report for the page scanned. If false, no json report is generated.
+        
+        Returns:
+            dict: A Python dictionary with the axe-core output of the page scanned.
         """
 
         page.evaluate(AXE_PATH.read_text(encoding="UTF-8"))
 
         response = page.evaluate("axe." + Axe._build_run_command(ruleset) + ".then(results => {return results;})")
 
-        logging.info(f"""Axe scan summary of [{response["url"]}]: Passes = {len(response["passes"])},
+        logger.info(f"""Axe scan summary of [{response["url"]}]: Passes = {len(response["passes"])},
                     Violations = {len(response["violations"])}, Inapplicable = {len(response["inapplicable"])},
                     Incomplete = {len(response["incomplete"])}""")
 
@@ -81,6 +85,9 @@ def run_list(page: Page,
             strict_mode (bool): [Optional] If true, raise an exception if a violation is detected. If false (default), proceed with test execution.
             html_report_generated (bool): [Optional] If true (default), generates a html report for the page scanned. If false, no html report is generated.
             json_report_generated (bool): [Optional] If true (default), generates a json report for the page scanned. If false, no json report is generated.
+        
+        Returns:
+            dict: A Python dictionary with the axe-core output of all the pages scanned, with the page list used as the key for each report.
         """
         results = {}
         for selected_page in page_list:
@@ -120,24 +127,24 @@ def _create_path_for_report(filename: str) -> Path:
         return PATH_FOR_REPORT / filename
 
     @staticmethod
-    def _create_json_report(data: dict, filename_overide: str = "") -> None:
-        filename = f"{Axe._modify_filename_for_report(data["url"])}.json" if filename_overide == "" else f"{filename_overide}.json"
+    def _create_json_report(data: dict, filename_override: str = "") -> None:
+        filename = f"{Axe._modify_filename_for_report(data["url"])}.json" if filename_override == "" else f"{filename_override}.json"
         full_path = Axe._create_path_for_report(filename)
 
         with open(full_path, 'w') as file:
             file.writelines(json.dumps(data))
 
-        logging.info(f"JSON report generated: {full_path}")
+        logger.info(f"JSON report generated: {full_path}")
 
     @staticmethod
-    def _create_html_report(data: dict, filename_overide: str = "") -> None:
-        filename = f"{Axe._modify_filename_for_report(data["url"])}.html" if filename_overide == "" else f"{filename_overide}.html"
+    def _create_html_report(data: dict, filename_override: str = "") -> None:
+        filename = f"{Axe._modify_filename_for_report(data["url"])}.html" if filename_override == "" else f"{filename_override}.html"
         full_path = Axe._create_path_for_report(filename)
 
         with open(full_path, 'w') as file:
             file.writelines(Axe._generate_html(data))
 
-        logging.info(f"HTML report generated: {full_path}")
+        logger.info(f"HTML report generated: {full_path}")
 
     @staticmethod
     def _generate_html(data: dict) -> str:

utils/date_time_utils.py

@@ -2,6 +2,10 @@
 
 
 class DateTimeUtils:
+    """
+    A utility class for doing common actions with datetimes.
+    """
+
     def __init__(self):
         pass
 
@@ -13,8 +17,7 @@ def current_datetime(format_date: str = "%d/%m/%Y %H:%M") -> str:
             format_date (str): [Optional] The format to return the current datetime in. Defaults to dd/mm/yyyy hh:mm if not provided.
 
         Returns:
-            current_date (str): The current datetime in the specified format.
-
+            str: The current datetime in the specified format.
         """
         return datetime.now().strftime(format_date)
 
@@ -27,9 +30,8 @@ def format_date(date: datetime, format_date: str = "%d/%m/%Y") -> str:
             format_date (str): [Optional] The format to return the datetime in. Defaults to dd/mm/yyyy if not provided.
 
         Returns:
-            format_date (str): The formatted date in the specified format.
-
-            """
+            str: The formatted date in the specified format.
+        """
         return date.strftime(format_date)
 
     @staticmethod
@@ -41,9 +43,8 @@ def add_days(date: datetime, days: float) -> datetime:
             days (float): The number of days to add to the specified date.
 
         Returns:
-            new_date (datetime): The specified date plus the number of specified days (year, month, day, hour, minute, second, microsecond).
-
-            """
+            datetime: The specified date plus the number of specified days (year, month, day, hour, minute, second, microsecond).
+        """
         return date + timedelta(days=days)
 
     @staticmethod
@@ -54,9 +55,8 @@ def get_day_of_week_for_today(date: datetime) -> str:
             date (datetime): The current date using the now function
 
         Returns:
-            day_of_week (str): The day of the week relating to the specified date.
-
-            """
+            str: The day of the week relating to the specified date.
+        """
         return date.strftime("%A")
 
     @staticmethod
@@ -67,7 +67,6 @@ def get_a_day_of_week(date: datetime) -> str:
             date (datetime): The date for which the day of the week will be returned.
 
         Returns:
-            day_of_week (str): The day of the week relating to the specified date.
-
-            """
+            str: The day of the week relating to the specified date.
+        """
         return date.strftime("%A")

utils/nhs_number_tools.py

@@ -1,30 +1,45 @@
 import logging
+
+
 logger = logging.getLogger(__name__)
 
+
 class NHSNumberTools:
     """
     A utility class providing functionality around NHS numbers.
     """
-    def _nhs_number_checks(self, nhs_number: str) -> None:
+    def __init__(self) -> None:
+        pass
+
+    @staticmethod
+    def _nhs_number_checks(nhs_number: str) -> None:
         """
-        This does basic checks on NHS number values provided and outputs information or exceptions if applicable.
+        This does basic checks on NHS number values provided and raises an exception if the number is not valid.
 
         Args:
             nhs_number (str): The NHS number to check.
         """
         if not nhs_number.isnumeric():
-            raise Exception("The NHS number provided ({}) is not numeric.".format(nhs_number))
+            raise NHSNumberToolsException("The NHS number provided ({}) is not numeric.".format(nhs_number))
+        if not len(nhs_number) == 10:
+            raise NHSNumberToolsException("The NHS number provided ({}) is not 10 digits.".format(nhs_number))
 
-
-    def spaced_nhs_number(self, nhs_number: int | str) -> str:
+    @staticmethod
+    def spaced_nhs_number(nhs_number: int | str) -> str:
         """
-        This will space out a provided NHS number in the format nnn nnn nnnn.
+        This will space out a provided NHS number in the format: nnn nnn nnnn.
 
         Args:
             nhs_number (int | str): The NHS number to space out.
 
         Returns:
             str: The NHS number in "nnn nnn nnnn" format.
         """
-        self._nhs_number_checks(str(nhs_number))
-        return "{} {} {}".format(str(nhs_number)[:3], str(nhs_number)[3:6], str(nhs_number)[6:])
+        formatted_nhs_number = str(nhs_number).replace(" ", "")
+        NHSNumberTools._nhs_number_checks(formatted_nhs_number)
+
+        return f"{formatted_nhs_number[:3]} {formatted_nhs_number[3:6]} {formatted_nhs_number[6:]}"
+
+
+class NHSNumberToolsException(Exception):
+    pass

utils/user_tools.py

@@ -1,8 +1,9 @@
 import json
-import os
 import logging
 from pathlib import Path
 
+
+logger = logging.getLogger(__name__)
 USERS_FILE = Path(__file__).parent.parent / "users.json"
 
 
@@ -18,11 +19,19 @@ def retrieve_user(user: str) -> dict:
 
         Args:
             user (str): The user details required, using the record key from users.json.
+        
+        Returns:
+            dict: A Python dictionary with the details of the user requested, if present.
         """
         with open(USERS_FILE, 'r') as file:
             user_data = json.loads(file.read())
 
         if not user in user_data:
-            raise Exception(f"User [{user}] is not present in users.json")
+            raise UserToolsException(f"User [{user}] is not present in users.json")
 
+        logger.debug(f"Returning user: {user_data[user]}")
         return user_data[user]
+
+
+class UserToolsException(Exception):
+    pass