[FDS-2386] Add owner id to the credentials to be used later on (#1130)

* Add owner id to the credentials to be used later on

Author: BryanFauble

synapseclient/core/credentials/cred_data.py

@@ -20,6 +20,11 @@ def username(self) -> None:
     def secret(self) -> None:
         """The secret associated with these credentials."""
 
+    @property
+    @abc.abstractmethod
+    def owner_id(self) -> None:
+        """The owner id, or profile id, associated with these credentials."""
+
 
 class SynapseAuthTokenCredentials(SynapseCredentials):
     @classmethod
@@ -69,6 +74,7 @@ def __init__(
         self._token = token
         self.username = username
         self.displayname = displayname
+        self.owner_id = None
 
     @property
     def username(self) -> str:
@@ -88,6 +94,15 @@ def displayname(self) -> str:
     def displayname(self, displayname: str) -> None:
         self._displayname = displayname
 
+    @property
+    def owner_id(self) -> str:
+        """The owner id associated with this token."""
+        return self._owner_id
+
+    @owner_id.setter
+    def owner_id(self, owner_id: str) -> None:
+        self._owner_id = owner_id
+
     @property
     def secret(self) -> str:
         """The bearer token."""
@@ -102,7 +117,8 @@ def __repr__(self):
             f"SynapseAuthTokenCredentials("
             f"username='{self.username}', "
             f"displayname='{self.displayname}', "
-            f"token='{self.secret}')"
+            f"token='{self.secret}', "
+            f"owner_id='{self.owner_id}')"
         )
 
 

synapseclient/core/credentials/credential_provider.py

@@ -91,6 +91,7 @@ def _create_synapse_credential(
                 )
             credentials.username = profile_username
             credentials.displayname = profile_displayname
+            credentials.owner_id = profile.get("ownerId", None)
 
             return credentials
 

tests/unit/synapseclient/core/credentials/unit_test_cred_data.py

@@ -13,9 +13,11 @@ def setup_method(self):
         self.username = "ahhhhhhhhhhhhhh"
         self.auth_token = "opensesame"
         self.displayname = "hhhhhaaaa"
+        self.owner_id = 123
         self.credentials = SynapseAuthTokenCredentials(
             self.auth_token, username=self.username, displayname=self.displayname
         )
+        self.credentials.owner_id = self.owner_id
         self.KEYRING_NAME = "SYNAPSE.ORG_CLIENT_AUTH_TOKEN"
 
     def test_username(self):
@@ -57,8 +59,9 @@ def test_repr(self):
             f"SynapseAuthTokenCredentials("
             f"username='{self.username}', "
             f"displayname='{self.displayname}', "
-            f"token='{self.auth_token}')" == repr(self.credentials)
-        )
+            f"token='{self.auth_token}', "
+            f"owner_id='{self.owner_id}')"
+        ) == repr(self.credentials)
 
     def test_tokens_validated(self, mocker):
         """Validate that tokens are validated when a credentials object is created"""

tests/unit/synapseclient/core/credentials/unit_test_cred_provider.py

@@ -98,6 +98,7 @@ def init_syn(self, syn: Synapse) -> None:
     def setup_method(self) -> None:
         self.username = "username"
         self.auth_token = "auth_token"
+        self.owner_id = 1234567890
         self.user_login_args = UserLoginArgs(
             self.username,
             self.auth_token,
@@ -149,6 +150,7 @@ def test_create_synapse_credential_username_is_None_auth_provided(
         mock_init_auth_creds.return_value = mock_creds
         mock_creds.secret = self.auth_token
         mock_creds.username = self.username
+        mock_creds.owner_id = self.owner_id
         mock_rest_get.return_value = {"userName": self.username}
         creds = self.provider._create_synapse_credential(
             syn=self.syn, username=None, auth_token=self.auth_token
@@ -175,14 +177,15 @@ def test_create_synapse_credential_username_not_None_auth_token_is_not_None(
         assert creds is mock_creds
 
     @pytest.mark.parametrize(
-        "login_username,profile_username,profile_emails,profile_displayname",
+        "login_username,profile_username,profile_emails,profile_displayname,profile_owner_id",
         (
-            ("foo", "foo", ["foo@bar.com"], "foo"),  # username matches
+            ("foo", "foo", ["foo@bar.com"], "foo", 123),  # username matches
             (
                 "foo@bar.com",
                 "foo",
                 ["1@2.com", "foo@bar.com", "3@4.com"],
                 "foo",
+                456,
             ),  # email matches
         ),
     )
@@ -193,6 +196,7 @@ def test_create_synapse_credential__username_auth_token_match(
         profile_username,
         profile_emails,
         profile_displayname,
+        profile_owner_id,
     ) -> None:
         """Verify that if both a username/email and a auth token are provided, the login is successful
         if the token matches either the username or a profile email address."""
@@ -202,6 +206,7 @@ def test_create_synapse_credential__username_auth_token_match(
             "userName": profile_username,
             "emails": profile_emails,
             "displayName": profile_displayname,
+            "ownerId": profile_owner_id,
         }
 
         cred = self.provider._create_synapse_credential(
@@ -210,6 +215,7 @@ def test_create_synapse_credential__username_auth_token_match(
         assert cred.secret == self.auth_token
         assert cred.username == profile_username
         assert cred.displayname == profile_displayname
+        assert cred.owner_id == profile_owner_id
 
     def test_create_synapse_credential__username_auth_token_mismatch(
         self, mocker