chore: split csv add creation to own test

Author: jorwoods

test/test_user.py

@@ -12,6 +12,7 @@
 
 import tableauserverclient as TSC
 from tableauserverclient.datetime_helpers import format_datetime
+from tableauserverclient.server.endpoint.users_endpoint import create_users_csv, remove_users_csv
 
 TEST_ASSET_DIR = Path(__file__).resolve().parent / "assets"
 
@@ -29,6 +30,26 @@
 USERS = os.path.join(TEST_ASSET_DIR, "Data", "user_details.csv")
 
 
+def make_user(
+    name: str,
+    site_role: str = "",
+    auth_setting: str = "",
+    domain: str = "",
+    fullname: str = "",
+    email: str = "",
+) -> TSC.UserItem:
+    user = TSC.UserItem(name, site_role or None)
+    if auth_setting:
+        user.auth_setting = auth_setting
+    if domain:
+        user._domain_name = domain
+    if fullname:
+        user.fullname = fullname
+    if email:
+        user.email = email
+    return user
+
+
 class UserTests(unittest.TestCase):
     def setUp(self) -> None:
         self.server = TSC.Server("http://test", False)
@@ -244,26 +265,64 @@ def test_get_users_from_file(self):
         assert users[0].name == "Cassie", users
         assert failures == []
 
-    def test_bulk_add(self):
-        def make_user(
-            name: str,
-            site_role: str = "",
-            auth_setting: str = "",
-            domain: str = "",
-            fullname: str = "",
-            email: str = "",
-        ) -> TSC.UserItem:
-            user = TSC.UserItem(name, site_role or None)
-            if auth_setting:
-                user.auth_setting = auth_setting
-            if domain:
-                user._domain_name = domain
-            if fullname:
-                user.fullname = fullname
-            if email:
-                user.email = email
-            return user
+    def test_create_users_csv(self):
+        users = [
+            make_user("Alice", "Viewer"),
+            make_user("Bob", "Explorer"),
+            make_user("Charlie", "Creator", "SAML"),
+            make_user("Dave"),
+            make_user("Eve", "ServerAdministrator", "OpenID", "example.com", "Eve Example", "Eve@example.com"),
+            make_user("Frank", "SiteAdministratorExplorer", "TableauIDWithMFA", email="Frank@example.com"),
+            make_user("Grace", "SiteAdministratorCreator", "SAML", "example.com", "Grace Example", "gex@example.com"),
+            make_user("Hank", "Unlicensed"),
+        ]
+
+        license_map = {
+            "Viewer": "Viewer",
+            "Explorer": "Explorer",
+            "ExplorerCanPublish": "Explorer",
+            "Creator": "Creator",
+            "SiteAdministratorExplorer": "Explorer",
+            "SiteAdministratorCreator": "Creator",
+            "ServerAdministrator": "Creator",
+            "Unlicensed": "Unlicensed",
+        }
+        publish_map = {
+            "Unlicensed": 0,
+            "Viewer": 0,
+            "Explorer": 0,
+            "Creator": 1,
+            "ExplorerCanPublish": 1,
+            "SiteAdministratorExplorer": 1,
+            "SiteAdministratorCreator": 1,
+            "ServerAdministrator": 1,
+        }
+        admin_map = {
+            "SiteAdministratorExplorer": "Site",
+            "SiteAdministratorCreator": "Site",
+            "ServerAdministrator": "System",
+        }
+
+        csv_columns = ["name", "password", "fullname", "license", "admin", "publish", "email"]
+        csv_data = create_users_csv(users)
+        csv_file = io.StringIO(csv_data.decode("utf-8"))
+        csv_reader = csv.reader(csv_file)
+        for user, row in zip(users, csv_reader):
+            with self.subTest(user=user):
+                site_role = user.site_role or "Unlicensed"
+                name = f"{user.domain_name}\\{user.name}" if user.domain_name else user.name
+                csv_user = dict(zip(csv_columns, row))
+                assert name == csv_user["name"]
+                assert (user.fullname or "") == csv_user["fullname"]
+                assert (user.email or "") == csv_user["email"]
+                assert license_map[site_role] == csv_user["license"]
+                assert admin_map.get(site_role, "") == csv_user["admin"]
+                assert publish_map[site_role] == int(csv_user["publish"])
 
+
+
+
+    def test_bulk_add(self):
         self.server.version = "3.15"
         users = [
             make_user("Alice", "Viewer"),
@@ -307,45 +366,8 @@ def make_user(
                 assert user.name == xml_user.get("name")
                 assert xml_user.get("authSetting") == (user.auth_setting or "ServerDefault")
 
-            license_map = {
-                "Viewer": "Viewer",
-                "Explorer": "Explorer",
-                "ExplorerCanPublish": "Explorer",
-                "Creator": "Creator",
-                "SiteAdministratorExplorer": "Explorer",
-                "SiteAdministratorCreator": "Creator",
-                "ServerAdministrator": "Creator",
-                "Unlicensed": "Unlicensed",
-            }
-            publish_map = {
-                "Unlicensed": 0,
-                "Viewer": 0,
-                "Explorer": 0,
-                "Creator": 1,
-                "ExplorerCanPublish": 1,
-                "SiteAdministratorExplorer": 1,
-                "SiteAdministratorCreator": 1,
-                "ServerAdministrator": 1,
-            }
-            admin_map = {
-                "SiteAdministratorExplorer": "Site",
-                "SiteAdministratorCreator": "Site",
-                "ServerAdministrator": "System",
-            }
-
-            csv_columns = ["name", "password", "fullname", "license", "admin", "publish", "email"]
-            csv_file = io.StringIO(segments[0].split(b"\n\n")[1].decode("utf-8"))
-            csv_reader = csv.reader(csv_file)
-            for user, row in zip(users, csv_reader):
-                site_role = user.site_role or "Unlicensed"
-                name = f"{user.domain_name}\\{user.name}" if user.domain_name else user.name
-                csv_user = dict(zip(csv_columns, row))
-                assert name == csv_user["name"]
-                assert (user.fullname or "") == csv_user["fullname"]
-                assert (user.email or "") == csv_user["email"]
-                assert license_map[site_role] == csv_user["license"]
-                assert admin_map.get(site_role, "") == csv_user["admin"]
-                assert publish_map[site_role] == int(csv_user["publish"])
+            csv_data = create_users_csv(users).replace(b"\r\n", b"\n")
+            assert csv_data.strip() == segments[0].split(b"\n\n")[1].strip()
 
     def test_bulk_add_no_name(self):
         self.server.version = "3.15"