Changes based on review changed tests using pytest parametrize, created more user friendly messages, added docstring

Author: DanChov

mergin/client.py

@@ -1338,7 +1338,7 @@ def create_user(
         self.check_collaborators_members_support()
         role_enum = normalize_role(workspace_role, WorkspaceRole)
         if role_enum is None:
-            raise ValueError("bad role")
+            raise ValueError(f'Invalid role: {workspace_role}')
 
         params = {
             "email": email,
@@ -1384,7 +1384,7 @@ def update_workspace_member(
 
         role_enum = normalize_role(workspace_role, WorkspaceRole)
         if role_enum is None:
-            raise ValueError("bad role")
+            raise ValueError(f'Invalid role: {workspace_role}')
 
         params = {
             "reset_projects_roles": reset_projects_roles,
@@ -1419,7 +1419,7 @@ def add_project_collaborator(self, project_id: str, user: str, project_role: Uni
 
         role_enum = normalize_role(project_role, ProjectRole)
         if role_enum is None:
-            raise ValueError("bad role")
+            raise ValueError(f'Invalid role: {project_role}')
 
         params = {"role": project_role.value, "user": user}
         project_collaborator = self.post(f"v2/projects/{project_id}/collaborators", params, json_headers)
@@ -1434,7 +1434,7 @@ def update_project_collaborator(self, project_id: str, user_id: int, project_rol
 
         role_enum = normalize_role(project_role, ProjectRole)
         if role_enum is None:
-            raise ValueError("bad role")
+            raise ValueError(f'Invalid role: {project_role}')
         params = {"role": project_role.value}
 
         project_collaborator = self.patch(f"v2/projects/{project_id}/collaborators/{user_id}", params, json_headers)
@@ -1522,7 +1522,7 @@ def create_invitation(self, workspace_id: int, email: str, workspace_role: Union
 
         role_enum = normalize_role(workspace_role, WorkspaceRole)
         if role_enum is None:
-            raise ValueError("bad role")
+            raise ValueError(f'Invalid role: {workspace_role}')
 
         params = {"email": email, "role": role_enum.value}
         ws_inv = self.post(f"v2/workspaces/{workspace_id}/invitations", params, json_headers)

mergin/test/test_client.py

@@ -3029,14 +3029,23 @@ def test_server_type(mc):
             mc.server_type()
 
 
-def test_string_roles():
-    assert normalize_role("guest", WorkspaceRole) == WorkspaceRole.GUEST
-    assert normalize_role("  GuEsT  ", WorkspaceRole) == WorkspaceRole.GUEST
-    assert normalize_role("writer", ProjectRole) == ProjectRole.WRITER
-    assert normalize_role("  WRITER ", ProjectRole) == ProjectRole.WRITER
-
-    assert normalize_role("guuuest", WorkspaceRole) is None
-    assert normalize_role("ownerr", ProjectRole) is None
-    assert normalize_role("", WorkspaceRole) is None
-    assert normalize_role(None, WorkspaceRole) is None
-    assert normalize_role(123, WorkspaceRole) is None
+@pytest.mark.parametrize(
+    "value, role_enum, expected",
+    [
+        ("guest", WorkspaceRole, WorkspaceRole.GUEST),
+        ("  GuEsT  ", WorkspaceRole, WorkspaceRole.GUEST),
+        ("writer", ProjectRole, ProjectRole.WRITER),
+        ("  WRITER ", ProjectRole, ProjectRole.WRITER),
+        ("guuuest", WorkspaceRole, None),
+        ("ownerr", ProjectRole, None),
+        ("", WorkspaceRole, None),
+        (None, WorkspaceRole, None),
+        (123, WorkspaceRole, None),
+    ],
+)
+def test_normalize_role_parametrized(value, role_enum, expected):
+    result = normalize_role(value, role_enum)
+    if expected is None:
+        assert result is None
+    else:
+        assert result == expected

mergin/utils.py

@@ -314,6 +314,10 @@ def cleanup_tmp_dir(mp, tmp_dir: tempfile.TemporaryDirectory):
 
 
 def normalize_role(role: Union[str, Enum], enum_cls: Type[Enum]) -> Optional[Enum]:
+    """
+    Takes a role as a string or an Enum member and returns the corresponding Enum member
+    from the given enum class. Returns None if the input is invalid or no match is found.
+    """
     if isinstance(role, enum_cls):
         return role