|
| 1 | +"""Unit tests for the Users resource.""" |
| 2 | + |
| 3 | +import copy |
| 4 | +from unittest.mock import Mock |
| 5 | + |
| 6 | +import pytest |
| 7 | + |
| 8 | +from pytfe.models.user import User, UserPermissions, UserUpdateCurrentOptions |
| 9 | +from pytfe.resources.user import Users |
| 10 | + |
| 11 | + |
| 12 | +class TestUsers: |
| 13 | + """Test suite for user resource operations.""" |
| 14 | + |
| 15 | + @pytest.fixture |
| 16 | + def mock_transport(self): |
| 17 | + """Mock HTTP transport.""" |
| 18 | + return Mock() |
| 19 | + |
| 20 | + @pytest.fixture |
| 21 | + def users_service(self, mock_transport): |
| 22 | + """Create users service with mocked transport.""" |
| 23 | + return Users(mock_transport) |
| 24 | + |
| 25 | + @pytest.fixture |
| 26 | + def sample_user_response(self): |
| 27 | + """Sample JSON:API response for a user.""" |
| 28 | + return { |
| 29 | + "data": { |
| 30 | + "id": "user-MA4GL63FmYRpSFxa", |
| 31 | + "type": "users", |
| 32 | + "attributes": { |
| 33 | + "username": "admin", |
| 34 | + "email": "admin@example.com", |
| 35 | + "is-service-account": False, |
| 36 | + "auth-method": "hcp_sso", |
| 37 | + "avatar-url": "https://example.com/avatar.png", |
| 38 | + "v2-only": True, |
| 39 | + "permissions": { |
| 40 | + "can-create-organizations": False, |
| 41 | + "can-change-email": True, |
| 42 | + "can-change-username": True, |
| 43 | + }, |
| 44 | + }, |
| 45 | + } |
| 46 | + } |
| 47 | + |
| 48 | + def test_read_user(self, users_service, mock_transport, sample_user_response): |
| 49 | + """Test reading a specific user by ID.""" |
| 50 | + mock_transport.request.return_value.json.return_value = sample_user_response |
| 51 | + |
| 52 | + user_id = "user-MA4GL63FmYRpSFxa" |
| 53 | + user = users_service.read(user_id) |
| 54 | + |
| 55 | + mock_transport.request.assert_called_once_with( |
| 56 | + "GET", f"/api/v2/users/{user_id}" |
| 57 | + ) |
| 58 | + assert isinstance(user, User) |
| 59 | + assert user.id == user_id |
| 60 | + assert user.username == "admin" |
| 61 | + assert user.email == "admin@example.com" |
| 62 | + assert user.is_service_account is False |
| 63 | + assert user.auth_method == "hcp_sso" |
| 64 | + assert user.avatar_url == "https://example.com/avatar.png" |
| 65 | + assert user.v2_only is True |
| 66 | + assert isinstance(user.permissions, UserPermissions) |
| 67 | + assert user.permissions is not None |
| 68 | + assert user.permissions.can_create_organizations is False |
| 69 | + assert user.permissions.can_change_email is True |
| 70 | + assert user.permissions.can_change_username is True |
| 71 | + assert user.permissions.can_manage_user_tokens is False |
| 72 | + assert user.permissions.can_view_2fa_settings is False |
| 73 | + assert user.permissions.can_manage_hcp_account is False |
| 74 | + |
| 75 | + def test_read_user_invalid_id(self, users_service): |
| 76 | + """Test reading a user with an invalid user ID.""" |
| 77 | + with pytest.raises(ValueError, match="invalid user id"): |
| 78 | + users_service.read("") |
| 79 | + |
| 80 | + def test_read_user_with_null_unconfirmed_email( |
| 81 | + self, users_service, mock_transport, sample_user_response |
| 82 | + ): |
| 83 | + """Test reading a user when unconfirmed-email is null.""" |
| 84 | + sample_user_response["data"]["attributes"]["unconfirmed-email"] = None |
| 85 | + mock_transport.request.return_value.json.return_value = sample_user_response |
| 86 | + |
| 87 | + user = users_service.read("user-MA4GL63FmYRpSFxa") |
| 88 | + |
| 89 | + assert isinstance(user, User) |
| 90 | + assert user.unconfirmed_email is None |
| 91 | + |
| 92 | + def test_read_user_two_factor_parsing( |
| 93 | + self, users_service, mock_transport, sample_user_response |
| 94 | + ): |
| 95 | + """Test reading a user with two-factor data.""" |
| 96 | + modified_response = copy.deepcopy(sample_user_response) |
| 97 | + modified_response["data"]["attributes"]["two-factor"] = { |
| 98 | + "enabled": True, |
| 99 | + "verified": False, |
| 100 | + } |
| 101 | + mock_transport.request.return_value.json.return_value = modified_response |
| 102 | + |
| 103 | + user_id = "user-MA4GL63FmYRpSFxa" |
| 104 | + user = users_service.read(user_id) |
| 105 | + |
| 106 | + assert user.two_factor is not None |
| 107 | + assert user.two_factor.enabled is True |
| 108 | + assert user.two_factor.verified is False |
| 109 | + |
| 110 | + def test_read_user_nullable_bools( |
| 111 | + self, users_service, mock_transport, sample_user_response |
| 112 | + ): |
| 113 | + """Test reading a user when pointer-style boolean fields are null.""" |
| 114 | + modified_response = copy.deepcopy(sample_user_response) |
| 115 | + modified_response["data"]["attributes"]["is-site-admin"] = None |
| 116 | + modified_response["data"]["attributes"]["is-admin"] = None |
| 117 | + modified_response["data"]["attributes"]["is-sso-login"] = None |
| 118 | + mock_transport.request.return_value.json.return_value = modified_response |
| 119 | + |
| 120 | + user_id = "user-MA4GL63FmYRpSFxa" |
| 121 | + user = users_service.read(user_id) |
| 122 | + |
| 123 | + assert user.is_site_admin is None |
| 124 | + assert user.is_admin is None |
| 125 | + assert user.is_sso_login is None |
| 126 | + |
| 127 | + def test_read_current_user( |
| 128 | + self, users_service, mock_transport, sample_user_response |
| 129 | + ): |
| 130 | + """Test reading the currently authenticated user.""" |
| 131 | + mock_transport.request.return_value.json.return_value = sample_user_response |
| 132 | + |
| 133 | + user = users_service.read_current() |
| 134 | + |
| 135 | + mock_transport.request.assert_called_once_with("GET", "/api/v2/account/details") |
| 136 | + assert isinstance(user, User) |
| 137 | + assert user.id == "user-MA4GL63FmYRpSFxa" |
| 138 | + assert user.username == "admin" |
| 139 | + assert user.email == "admin@example.com" |
| 140 | + |
| 141 | + def test_update_current_user( |
| 142 | + self, users_service, mock_transport, sample_user_response |
| 143 | + ): |
| 144 | + """Test updating the currently authenticated user.""" |
| 145 | + mock_transport.request.return_value.json.return_value = sample_user_response |
| 146 | + options = UserUpdateCurrentOptions( |
| 147 | + username="new-admin", |
| 148 | + email="new-admin@example.com", |
| 149 | + ) |
| 150 | + |
| 151 | + user = users_service.update_current(options) |
| 152 | + |
| 153 | + mock_transport.request.assert_called_once_with( |
| 154 | + "PATCH", |
| 155 | + "/api/v2/account/update", |
| 156 | + json_body={ |
| 157 | + "data": { |
| 158 | + "type": "users", |
| 159 | + "attributes": { |
| 160 | + "username": "new-admin", |
| 161 | + "email": "new-admin@example.com", |
| 162 | + }, |
| 163 | + } |
| 164 | + }, |
| 165 | + ) |
| 166 | + assert isinstance(user, User) |
| 167 | + assert user.id == "user-MA4GL63FmYRpSFxa" |
0 commit comments