updates

Author: davethepunkyone

.vscode/settings.json

@@ -7,6 +7,7 @@
   "cSpell.words": [
     "addopts",
     "codegen",
+    "initialise",
     "Licence",
     "organisation",
     "pytest",

docs/utility-guides/UserTools.md

@@ -0,0 +1,34 @@
+# Utility Guide: User Tools
+
+The User Tools utility provided by this blueprint allows for the easy management of test users via a json file included
+at the base of the repository.
+
+## Table of Contents
+
+- [Utility Guide: User Tools](#utility-guide-user-tools)
+  - [Table of Contents](#table-of-contents)
+  - [Using the User Tools class](#using-the-user-tools-class)
+  - [Managing Users](#managing-users)
+
+## Using the User Tools class
+
+You can initialise the User Tools class by using the following code in your test file:
+
+    from utils.user_tools import UserTools
+
+This module has been designed as a static class, so you do not need to instantiate it when you want to retrieve any user information.
+
+## Managing Users
+
+For this class, users are managed via the [users.json](../../users.json) file provided with this repository. For any new users you need to
+add, the idea is to just add a new record, with any appropriate metadata you need for the user whilst they interact with your application.
+
+For example, adding a record like so (this example shows the entire `users.json` file):
+
+    {
+        "Documentation User": {
+            "username": "DOC_USER",
+            "roles": ["Example Role A"],
+            "unique_id": 42
+        }
+    }

tests_utils/resources/test_users.json

@@ -0,0 +1,10 @@
+{  
+    "Test User": {
+        "username": "TEST_USER1",
+        "test_key": "TEST A"
+    },
+    "Test User 2": {
+        "username": "TEST_USER2",
+        "test_key": "TEST B"
+    }
+}

tests_utils/test_nhs_number_tools.py

@@ -16,6 +16,3 @@ def test_nhs_number_checks() -> None:
 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

@@ -1,8 +1,21 @@
 import pytest
+import utils.user_tools
 from utils.user_tools import UserTools, UserToolsException
+from pathlib import Path
 
 
 pytestmark = [pytest.mark.utils]
 
-def test_nhs_number_checks() -> None:
-    assert UserTools().retrieve_user("Example User 1")
+def test_retrieve_user(monkeypatch: object) -> None:
+    monkeypatch.setattr(utils.user_tools, "USERS_FILE", Path(__file__).parent / "resources" / "test_users.json")
+
+    test_user = UserTools().retrieve_user("Test User")
+    assert test_user["username"] == "TEST_USER1"
+    assert test_user["test_key"] == "TEST A"
+
+    test_user2 = UserTools().retrieve_user("Test User 2")
+    assert test_user2["username"] == "TEST_USER2"
+    assert test_user2["test_key"] == "TEST B"
+
+    with pytest.raises(UserToolsException, match=r'User \[Invalid User\] is not present in users.json'):
+        UserTools().retrieve_user("Invalid User")