feat: implement users bulk_remove

Author: jorwoods

tableauserverclient/server/endpoint/users_endpoint.py

@@ -116,6 +116,14 @@ def bulk_add(self, users: Iterable[UserItem]) -> JobItem:
         server_response = self.post_request(url, xml_request, content_type)
         return JobItem.from_response(server_response.content, self.parent_srv.namespace).pop()
 
+    @api(version="3.15")
+    def bulk_remove(self, users: Iterable[UserItem]) -> None:
+        url = f"{self.baseurl}/delete"
+        csv_content = remove_users_csv(users)
+        request, content_type = RequestFactory.User.delete_csv_req(csv_content)
+        server_response = self.post_request(url, request, content_type)
+        return None
+
     @api(version="2.0")
     def create_from_file(self, filepath: str) -> Tuple[List[UserItem], List[Tuple[UserItem, ServerResponseError]]]:
         import warnings
@@ -267,3 +275,23 @@ def create_users_csv(users: Iterable[UserItem], identity_pool=None) -> bytes:
         output.seek(0)
         result = output.read().encode("utf-8")
     return result
+
+
+def remove_users_csv(users: Iterable[UserItem]) -> bytes:
+    with io.StringIO() as output:
+        writer = csv.writer(output, quoting=csv.QUOTE_MINIMAL)
+        for user in users:
+            writer.writerow(
+                (
+                    f"{user.domain_name}\\{user.name}" if user.domain_name else user.name,
+                    None,
+                    None,
+                    None,
+                    None,
+                    None,
+                    None,
+                )
+            )
+        output.seek(0)
+        result = output.read().encode("utf-8")
+    return result

tableauserverclient/server/request_factory.py

@@ -945,6 +945,12 @@ def import_from_csv_req(self, csv_content: bytes, users: Iterable[UserItem]):
         }
         return _add_multipart(parts)
 
+    def delete_csv_req(self, csv_content: bytes):
+        parts = {
+            "tableau_user_delete": ("tsc_users_file.csv", csv_content, "file"),
+        }
+        return _add_multipart(parts)
+
 
 class WorkbookRequest(object):
     def _generate_xml(

test/test_user.py

@@ -355,3 +355,32 @@ def test_bulk_add_no_name(self):
 
             with pytest.raises(ValueError, match="User name must be populated."):
                 self.server.users.bulk_add(users)
+
+    def test_bulk_remove(self):
+        self.server.version = "3.15"
+        users = [
+            TSC.UserItem("Alice"),
+            TSC.UserItem("Bob"),
+        ]
+        users[1]._domain_name = "example.com"
+        with requests_mock.mock() as m:
+            m.post(f"{self.server.users.baseurl}/delete")
+
+            self.server.users.bulk_remove(users)
+
+            assert m.last_request.method == "POST"
+            assert m.last_request.url == f"{self.server.users.baseurl}/delete"
+
+            body = m.last_request.body.replace(b"\r\n", b"\n")
+            assert body.startswith(b"--")  # Check if it's a multipart request
+            boundary = body.split(b"\n")[0].strip()
+
+            content = next(seg for seg in body.split(boundary) if seg.strip())
+            assert b'Content-Disposition: form-data; name="tableau_user_delete"' in content
+            assert b"Content-Type: file" in content
+
+            content = content.replace(b"\r\n", b"\n")
+            csv_data = content.split(b"\n\n")[1].decode("utf-8")
+            for user, row in zip(users, csv_data.split("\n")):
+                name, *_ = row.split(",")
+                assert name == f"{user.domain_name}\\{user.name}" if user.domain_name else user.name