Merge pull request #761 from CitrineInformatics/PLA-9736-list-parent-team-members-for-projects-v3

Pla 9736 list parent team members for projects v3

Author: zoesyang

docs/source/FAQ/team_management_migration.rst

@@ -103,10 +103,23 @@ The ``Team`` equivalent:
 
 .. code-block:: python
 
-	team.add_user(user_uid)
-	team.remove_user(user_uid)
-	team.update_user_action(user_uid=user_uid, actions=[WRITE, READ, SHARE])
-	team.list_members()
+  # adding a user to a team
+  team.add_user(user_uid)
+
+  # removing a user from a team
+  team.remove_user(user_uid)
+
+  # overwriting a user's permissions on a team
+  team.update_user_action(user_id=user_uid, actions=[WRITE, READ, SHARE])
+	
+  # listing user's and their permissions on a team
+  team.list_members()
 
 As shown above, with the introduction of teams, roles are replaced by specifying a user's actions
 as any combination of ``READ``, ``WRITE``, and ``SHARE``.
+
+User permissions should be modified using the ``Team`` object, but for backward compatibility 
+purposes, listing project members via ``project.list_members()`` will simply list members of 
+the project's parent team.
+
+

src/citrine/__version__.py

@@ -1 +1 @@
-__version__ = '1.32.1'
+__version__ = '1.33.0'

src/citrine/resources/project.py

@@ -504,19 +504,29 @@ def owned_table_config_ids(self) -> List[str]:
         result = self.session.get_resource(f"{self._path()}/table_definition_ids")
         return result["table_definition_ids"]
 
-    @use_teams("team.list_members")
-    def list_members(self) -> List[ProjectMember]:
+    def list_members(self) -> Union[List[ProjectMember], List["TeamMember"]]:
         """
         List all of the members in the current project.
 
         Returns
         -------
-        List[ProjectMember]
-            The members of the current project
+        List[ProjectMember] | List[TeamMember]
+            The members of the current project, or the members of the team
+            containing the project if teams have been released.
 
         """
-        members = self.session.get_resource(f"{self._path()}/users")["users"]
-        return [ProjectMember(user=User.build(m), project=self, role=m["role"]) for m in members]
+        from citrine.resources.team import TeamCollection
+
+        if self.session._accounts_service_v3:
+            team_collection = TeamCollection(self.session)
+            parent_team = team_collection.get(self.team_id)
+            return parent_team.list_members()
+        else:
+            members = self.session.get_resource(f"{self._path()}/users")["users"]
+            return [ProjectMember(user=User.build(m),
+                                  project=self,
+                                  role=m["role"])
+                    for m in members]
 
     @use_teams("team.update_user_action")
     def update_user_role(self, *, user_uid: Union[str, UUID], role: ROLES, actions: ACTIONS = []):

src/citrine/resources/team.py

@@ -149,7 +149,7 @@ def add_user(self, user_id: Union[str, UUID], *,
     def update_user_action(self, user_id: Union[str, UUID], *,
                            actions: List[TEAM_ACTIONS]) -> bool:
         """
-        Update a User's action permissions in the Team.
+        Overwrites a User's action permissions in the Team.
 
         Parameters
         ----------

tests/resources/test_project.py

@@ -14,8 +14,9 @@
 from citrine.resources.project import Project, ProjectCollection
 from citrine.resources.project_member import ProjectMember
 from citrine.resources.project_roles import MEMBER, LEAD, WRITE
-from tests.utils.factories import ProjectDataFactory, UserDataFactory
+from tests.utils.factories import ProjectDataFactory, UserDataFactory, TeamDataFactory
 from tests.utils.session import FakeSession, FakeCall, FakePaginatedSession, FakeRequestResponse
+from citrine.resources.team import  READ, TeamMember
 
 logger = getLogger(__name__)
 
@@ -814,9 +815,34 @@ def test_update_project(collection: ProjectCollection, project):
         collection.update(project)
 
 
-def test_list_members_v3(project_v3):
-    with pytest.raises(NotImplementedError):
-        project_v3.list_members()
+def test_list_members_v3(project_v3, session_v3):
+    # Given
+    user = UserDataFactory()
+    user["actions"] = READ
+    user.pop("position")
+
+    team_data = TeamDataFactory(
+        id=str(project_v3.team_id),
+    )
+
+    session_v3.set_responses(
+        {'team': team_data},
+        {'users': [user]}
+    )
+
+    # When
+    members = project_v3.list_members()
+
+    # Then
+    assert 2 == session_v3.num_calls
+    expect_call_1 = FakeCall(
+        method='GET',
+        path='/teams/{}'.format(team_data['id']),
+    )
+    expect_call_2 = FakeCall(method='GET', path='/teams/{}/users'.format(project_v3.team_id))
+    assert expect_call_1 == session_v3.calls[0]
+    assert expect_call_2 == session_v3.calls[1]
+    assert isinstance(members[0], TeamMember)
 
 
 def test_list_members(project, session):