feat: add as_reference method to groupset

Author: jorwoods

tableauserverclient/models/groupset_item.py

@@ -4,6 +4,7 @@
 from defusedxml.ElementTree import fromstring
 
 from tableauserverclient.models.group_item import GroupItem
+from tableauserverclient.models.reference_item import ResourceReference
 
 
 class GroupSetItem:
@@ -46,3 +47,7 @@ def get_group(group_xml: ET.Element) -> GroupItem:
         ]
 
         return group_set_item
+
+    @staticmethod
+    def as_reference(id_: str) -> ResourceReference:
+        return ResourceReference(id_, GroupSetItem.tag_name)

tableauserverclient/models/permissions_item.py

@@ -3,10 +3,11 @@
 
 from defusedxml.ElementTree import fromstring
 
-from .exceptions import UnknownGranteeTypeError, UnpopulatedPropertyError
-from .group_item import GroupItem
-from .reference_item import ResourceReference
-from .user_item import UserItem
+from tableauserverclient.models.exceptions import UnknownGranteeTypeError, UnpopulatedPropertyError
+from tableauserverclient.models.group_item import GroupItem
+from tableauserverclient.models.groupset_item import GroupSetItem
+from tableauserverclient.models.reference_item import ResourceReference
+from tableauserverclient.models.user_item import UserItem
 
 from tableauserverclient.helpers.logging import logger
 
@@ -142,6 +143,8 @@ def _parse_grantee_element(grantee_capability_xml: ET.Element, ns: Optional[Dict
             grantee = UserItem.as_reference(grantee_id)
         elif grantee_type == "group":
             grantee = GroupItem.as_reference(grantee_id)
+        elif grantee_type == "groupSet":
+            grantee = GroupSetItem.as_reference(grantee_id)
         else:
             raise UnknownGranteeTypeError("No support for grantee type of {}".format(grantee_type))
 

test/assets/flow_populate_permissions.xml

@@ -11,5 +11,12 @@
                 <capability name="Read" mode="Allow"/>
             </capabilities>
         </granteeCapabilities>
+        <granteeCapabilities>
+            <groupSet id="7ea95a1b-6872-44d6-a969-68598a7df4a0"/>
+            <capabilities>
+                <capability name="Write" mode="Allow"/>
+                <capability name="Read" mode="Allow"/>
+            </capabilities>
+        </granteeCapabilities>
     </permissions>
-</tsResponse>
+</tsResponse>

test/test_flow.py

@@ -142,6 +142,16 @@ def test_populate_permissions(self) -> None:
                 },
             )
 
+            self.assertEqual(permissions[1].grantee.tag_name, "groupSet")
+            self.assertEqual(permissions[1].grantee.id, "7ea95a1b-6872-44d6-a969-68598a7df4a0")
+            self.assertDictEqual(
+                permissions[1].capabilities,
+                {
+                    TSC.Permission.Capability.Write: TSC.Permission.Mode.Allow,
+                    TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow,
+                },
+            )
+
     def test_publish(self) -> None:
         with open(PUBLISH_XML, "rb") as f:
             response_xml = f.read().decode("utf-8")

test/test_groupsets.py

@@ -5,6 +5,7 @@
 import requests_mock
 
 import tableauserverclient as TSC
+from tableauserverclient.models.reference_item import ResourceReference
 
 TEST_ASSET_DIR = Path(__file__).parent / "assets"
 GROUPSET_CREATE = TEST_ASSET_DIR / "groupsets_create.xml"
@@ -128,3 +129,11 @@ def test_remove_group(self) -> None:
         assert len(history) == 1
         assert history[0].method == "DELETE"
         assert history[0].url == f"{self.baseurl}/{groupset.id}/groups/{group._id}"
+
+    def test_as_reference(self) -> None:
+        groupset = TSC.GroupSetItem()
+        groupset.id = "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
+        ref = groupset.as_reference(groupset.id)
+        assert ref.id == groupset.id
+        assert ref.tag_name == groupset.tag_name
+        assert isinstance(ref, ResourceReference)