Update to fix testing in auth

Author: Pasarus

fia_auth/auth.py

@@ -11,7 +11,7 @@
 
 logger = logging.getLogger(__name__)
 UOWS_URL = os.environ.get("UOWS_URL", "https://devapi.facilities.rl.ac.uk/users-service")
-UOWS_API_KEY = os.environ.get("UOWS_API_KEY", "")
+
 
 
 def authenticate(credentials: UserCredentials) -> User:
@@ -31,10 +31,11 @@ def authenticate(credentials: UserCredentials) -> User:
     if response.status_code == HTTPStatus.CREATED:
         logger.info("Session created with UOWS")
         user_id = response.json()["userId"]
+        uows_api_key = os.environ.get("UOWS_API_KEY", "")
         details_response = requests.post(
             f"{UOWS_URL}/v1/basic-person-details?userNumbers={user_id}",
             json=data,
-            headers={"Authorization": f"Api-key {UOWS_API_KEY}", "Content-Type": "application/json"},
+            headers={"Authorization": f"Api-key {uows_api_key}", "Content-Type": "application/json"},
             timeout=30,
         )
         return User(user_number=user_id, users_name=details_response.json()["displayName"])

test/e2e/test_auth.py

@@ -18,7 +18,7 @@
 def test_successful_login(mock_auth_requests, is_instrument_scientist):
     mock_auth_response = Mock()
     mock_auth_response.status_code = HTTPStatus.CREATED
-    mock_auth_response.json.return_value = {"userId": 1234}
+    mock_auth_response.json.return_value = {"userId": 1234, "displayName": "Mr Cool"}
     mock_auth_requests.post.return_value = mock_auth_response
     is_instrument_scientist.return_value = False
 
@@ -53,7 +53,7 @@ def test_unsuccessful_login_uows_failure(mock_post):
 @patch("fia_auth.model.is_instrument_scientist")
 def test_verify_success(is_instrument_scientist):
     is_instrument_scientist.return_value = False
-    user = User(123)
+    user = User(123, str(Mock()))
     access_token = generate_access_token(user)
     response = client.post("/api/jwt/checkToken", json={"token": access_token.jwt})
 
@@ -74,7 +74,7 @@ def test_verify_fail_bad_signature():
 @patch("fia_auth.model.is_instrument_scientist")
 def test_token_refresh_success(is_instrument_scientist):
     is_instrument_scientist.return_value = False
-    user = User(123)
+    user = User(123, str(Mock()))
     access_token = generate_access_token(user)
     refresh_token = generate_refresh_token()
     response = client.post(
@@ -87,7 +87,7 @@ def test_token_refresh_success(is_instrument_scientist):
 @patch("fia_auth.model.is_instrument_scientist")
 def test_token_refresh_no_refresh_token_given(is_instrument_scientist):
     is_instrument_scientist.return_value = False
-    user = User(123)
+    user = User(123, str(Mock()))
     access_token = generate_access_token(user)
     response = client.post(
         "/api/jwt/refresh",
@@ -101,7 +101,7 @@ def test_token_refresh_no_refresh_token_given(is_instrument_scientist):
 @patch("fia_auth.model.is_instrument_scientist")
 def test_token_refresh_expired_refresh_token(is_instrument_scientist):
     is_instrument_scientist.return_value = False
-    user = User(123)
+    user = User(123, str(Mock()))
     access_token = generate_access_token(user)
     refresh_token = (
         "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MTgwMjEyNDB9.iHITGf2RyX_49pY7Xy8xdutYE4Pc6k9mfKWQjxCKgOk"  # noqa: S105

test/test_auth.py

@@ -1,6 +1,8 @@
 # ruff: noqa: D100, D103
+import os
 from http import HTTPStatus
-from unittest.mock import Mock, patch
+from unittest import mock
+from unittest.mock import Mock, patch, call
 
 import pytest
 
@@ -11,21 +13,31 @@
 
 @patch("requests.post")
 def test_authenticate_success(mock_post):
-    mock_response = Mock(status_code=HTTPStatus.CREATED, json=lambda: {"userId": "12345"})
+    uows_api_key = str(mock.MagicMock())
+    os.environ["UOWS_API_KEY"] = uows_api_key
+    mock_response = Mock(status_code=HTTPStatus.CREATED, json=lambda: {"userId": "12345", "displayName": "Mr Cool"})
     mock_post.return_value = mock_response
 
     credentials = UserCredentials(username="valid_user", password="valid_password")  # noqa: S106
 
     user = authenticate(credentials)
 
     assert user.user_number == "12345"
+    assert user.users_name == "Mr Cool"
 
-    mock_post.assert_called_once_with(
+    assert call(
         "https://devapi.facilities.rl.ac.uk/users-service/v1/sessions",
         json={"username": "valid_user", "password": "valid_password"},
         headers={"Content-Type": "application/json"},
         timeout=30,
-    )
+    ) in mock_post.mock_calls
+    assert call(
+        "https://devapi.facilities.rl.ac.uk/users-service/v1/basic-person-details?userNumbers=12345",
+        json={"username": "valid_user", "password": "valid_password"},
+        headers={"Authorization": f"Api-key {uows_api_key}", "Content-Type": "application/json"},
+        timeout=30,
+    ) in mock_post.mock_calls
+    assert mock_post.call_count == 2  # noqa: PLR2004
 
 
 @patch("requests.post")

test/test_model.py

@@ -1,6 +1,6 @@
 """Model Tests"""
 
-from unittest.mock import patch
+from unittest.mock import patch, MagicMock
 
 from fia_auth.model import Role, User
 
@@ -12,7 +12,7 @@ def test_role_is_user(mock_is_staff_user, mock_is_instrument_scientist):
     mock_is_staff_user.return_value = False
     mock_is_instrument_scientist.return_value = False
 
-    user = User(user_number=1234)
+    user = User(user_number=1234, users_name=MagicMock())
     assert user.role == Role.USER
 
 
@@ -23,7 +23,7 @@ def test_role_is_staff_in_db(mock_is_staff_user, mock_is_instrument_scientist):
     mock_is_staff_user.return_value = True
     mock_is_instrument_scientist.return_value = False
 
-    user = User(user_number=1234)
+    user = User(user_number=1234, users_name=MagicMock())
     assert user.role == Role.STAFF
 
 
@@ -34,7 +34,7 @@ def test_role_is_staff_in_db_and_inst_scientist(mock_is_staff_user, mock_is_inst
     mock_is_staff_user.return_value = True
     mock_is_instrument_scientist.return_value = True
 
-    user = User(user_number=1234)
+    user = User(user_number=1234, users_name=MagicMock())
     assert user.role == Role.STAFF
 
 
@@ -45,5 +45,5 @@ def test_role_is_staff_inst_scientist(mock_is_staff_user, mock_is_instrument_sci
     mock_is_staff_user.return_value = False
     mock_is_instrument_scientist.return_value = True
 
-    user = User(user_number=1234)
+    user = User(user_number=1234, users_name=MagicMock())
     assert user.role == Role.STAFF

test/test_tokens.py

@@ -172,6 +172,7 @@ def test_refresh_token_with_invalid_jwt(mock_decode):
 def test_generate_access_token(mock_datetime):
     user = Mock()
     user.user_number = 12345
+    user.users_name = "Mr Cool"
     user.role = Role.USER
     user.role = Role.USER
     fixed_time = datetime(2000, 12, 12, 12, 0, tzinfo=UTC)
@@ -181,7 +182,7 @@ def test_generate_access_token(mock_datetime):
     expected_payload = {
         "usernumber": 12345,
         "role": "user",
-        "username": "foo",
+        "username": "Mr Cool",
         "exp": fixed_time + timedelta(minutes=10),
     }