feat: groups all fields

Author: jorwoods

tableauserverclient/models/group_item.py

@@ -65,6 +65,7 @@ def __init__(self, name=None, domain_name=None) -> None:
         self._users: Optional[Callable[..., "Pager"]] = None
         self.name: Optional[str] = name
         self.domain_name: Optional[str] = domain_name
+        self._user_count: Optional[int] = None
 
     def __repr__(self):
         return f"{self.__class__.__name__}({self.__dict__!r})"
@@ -118,6 +119,10 @@ def users(self) -> "Pager":
     def _set_users(self, users: Callable[..., "Pager"]) -> None:
         self._users = users
 
+    @property
+    def user_count(self) -> Optional[int]:
+        return self._user_count
+
     @classmethod
     def from_response(cls, resp, ns) -> list["GroupItem"]:
         all_group_items = list()
@@ -127,6 +132,7 @@ def from_response(cls, resp, ns) -> list["GroupItem"]:
             name = group_xml.get("name", None)
             group_item = cls(name)
             group_item._id = group_xml.get("id", None)
+            group_item._user_count = int(count) if (count := group_xml.get("userCount", None)) else None
 
             # Domain name is returned in a domain element for some calls
             domain_elem = group_xml.find(".//t:domain", namespaces=ns)

test/assets/group_get_all_fields.xml

@@ -0,0 +1,14 @@
+<ns0:tsResponse xmlns:ns0="http://tableau.com/api" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://tableau.com/api https://help.tableau.com/samples/en-us/rest_api/ts-api_3_25.xsd">
+  <ns0:pagination pageNumber="1" pageSize="100" totalAvailable="3" />
+  <ns0:groups>
+    <ns0:group id="28c5b855-16df-482f-ad0b-428c1df58859" name="All Users" userCount="2">
+      <ns0:domain name="local" />
+    </ns0:group>
+    <ns0:group id="ace1ee2d-e7dd-4d7a-9504-a1ccaa5212ea" name="group1" userCount="1">
+      <ns0:domain name="local" />
+    </ns0:group>
+    <ns0:group id="baf0ed9d-c25d-4114-97ed-5232b8a732fd" name="test" userCount="0">
+      <ns0:domain name="local" />
+    </ns0:group>
+  </ns0:groups>
+</ns0:tsResponse>

test/test_group.py

@@ -10,6 +10,7 @@
 # TEST_ASSET_DIR = os.path.join(os.path.dirname(__file__), "assets")
 
 GET_XML = os.path.join(TEST_ASSET_DIR, "group_get.xml")
+GET_XML_ALL_FIELDS = TEST_ASSET_DIR / "group_get_all_fields.xml"
 POPULATE_USERS = os.path.join(TEST_ASSET_DIR, "group_populate_users.xml")
 POPULATE_USERS_EMPTY = os.path.join(TEST_ASSET_DIR, "group_populate_users_empty.xml")
 ADD_USER = os.path.join(TEST_ASSET_DIR, "group_add_user.xml")
@@ -310,3 +311,25 @@ def test_update_ad_async(self) -> None:
         self.assertEqual(job.id, "c2566efc-0767-4f15-89cb-56acb4349c1b")
         self.assertEqual(job.mode, "Asynchronous")
         self.assertEqual(job.type, "GroupSync")
+
+    def test_get_all_fields(self) -> None:
+        ro = TSC.RequestOptions()
+        ro.all_fields = True
+        self.server.version = "3.21"
+        self.baseurl = self.server.groups.baseurl
+        with requests_mock.mock() as m:
+            m.get(f"{self.baseurl}?fields=_all_", text=GET_XML_ALL_FIELDS.read_text())
+            groups, pages = self.server.groups.get(req_options=ro)
+
+        assert pages.total_available == 3
+        assert len(groups) == 3
+        assert groups[0].id == "28c5b855-16df-482f-ad0b-428c1df58859"
+        assert groups[0].name == "All Users"
+        assert groups[0].user_count == 2
+        assert groups[0].domain_name == "local"
+        assert groups[1].id == "ace1ee2d-e7dd-4d7a-9504-a1ccaa5212ea"
+        assert groups[1].name == "group1"
+        assert groups[1].user_count == 1
+        assert groups[2].id == "baf0ed9d-c25d-4114-97ed-5232b8a732fd"
+        assert groups[2].name == "test"
+        assert groups[2].user_count == 0