adds tests

tests/unit/synapseclient/unit_test_get_user_profile.py

@@ -0,0 +1,108 @@
+import pytest
+from unittest.mock import patch
+
+from synapseclient.team import UserProfile
+
+
+test_user_profile = {
+    "ownerId": "1234567",
+    "etag": "test-etag",
+    "firstName": "Test",
+    "lastName": "User",
+    "emails": ["[email protected]"],
+    "openIds": [],
+    "userName": "test_user",
+    "displayName": "Test User",
+    "summary": "This is a test user",
+    "position": "Test Position",
+    "location": "Test Location",
+    "industry": "Test Industry",
+    "company": "Test Company",
+    "profilePicureFileHandleId": "test-file-handle",
+    "url": "https://example.com",
+    "notificationSettings": {"sendEmailNotifications": False},
+    "createdOn": "2022-01-01T00:00:00.000Z",
+}
+
+
+class TestGetUserProfile:
+    principals = [
+        {
+            "ownerId": "7654321",
+            "firstName": "test",
+            "lastName": "person",
+            "userName": "abc",
+            "isIndividual": True,
+        },
+        {
+            "ownerId": "1234567",
+            "firstName": "test_2",
+            "lastName": "person_2",
+            "userName": "test_user",
+            "isIndividual": True,
+        },
+    ]
+
+    @pytest.fixture(autouse=True, scope="function")
+    def setup_method(self, syn):
+        self.syn = syn
+        self.syn.restGET = patch.object(
+            self.syn, "restGET", return_value=test_user_profile
+        ).start()
+        self.syn._findPrincipals = patch.object(
+            self.syn, "_findPrincipals", return_value=self.principals
+        ).start()
+
+    def teardown_method(self):
+        self.syn.restGET.stop()
+        self.syn._findPrincipals.stop()
+
+    def test_that_get_user_profile_returns_expected_with_no_id(self):
+        result = self.syn.get_user_profile()
+        self.syn.restGET.assert_called_once_with("/userProfile/", headers=None)
+        assert result == test_user_profile
+
+    def test_that_get_user_profile_returns_expected_with_username(self):
+        result = self.syn.get_user_profile("test_user")
+        self.syn.restGET.assert_called_once_with("/userProfile/1234567", headers=None)
+        assert result == test_user_profile
+
+    # def test_that_get_user_profile_returns_expected_with_user_profile(self):
+    #     ...
+
+    # def test_that_get_user_profile_returns_expected_with_team_member(self):
+    #     ...
+
+    def test_that_get_user_profile_raises_value_error_when_user_does_not_exist(
+        self, syn
+    ):
+        with pytest.raises(ValueError, match="Can't find user *"):
+            self.syn.get_user_profile("not_a_user")
+
+    def test_that_get_user_profile_raises_type_error_when_id_is_not_allowed_type(self):
+        with pytest.raises(
+            TypeError, match="id must be a string, UserProfile, or TeamMember"
+        ):
+            self.syn.get_user_profile(1234567)
+
+
+class TestGetUserProfileByID:
+    @pytest.fixture(autouse=True, scope="function")
+    def setup_method(self, syn):
+        self.syn = syn
+        self.syn.restGET = patch.object(
+            self.syn, "restGET", return_value=test_user_profile
+        ).start()
+
+    def teardown_method(self):
+        self.syn.restGET.stop()
+
+    def test_that_get_user_profile_by_id_returns_expected_when_id_id_defined(self):
+        result = self.syn.get_user_profile_by_id(1234567)
+        self.syn.restGET.assert_called_once_with("/userProfile/1234567", headers=None)
+        assert result == test_user_profile
+
+    def test_that_get_user_profile_by_id_raises_type_error_when_id_is_not_defined(self):
+        result = self.syn.get_user_profile_by_id()
+        self.syn.restGET.assert_called_once_with("/userProfile/", headers=None)
+        assert result == test_user_profile