fix(import ownership): Support emails with uppercase characters (#348)

* Add logging + write to file
* Adding more logging
* Normalizing emails as lowercase
* Improving logic
* Adding test coverage
* Improving test coverage

Author: Vitor-Avila

src/preset_cli/api/clients/preset.py

@@ -153,14 +153,15 @@ def export_users(self, workspace_url: URL) -> Iterator[UserType]:
             validate_response(response)
             payload = response.json()
 
+            # Teams with SAML SSO might have emails with uppercase characters
             team_members: List[UserType] = [
                 {
                     "id": 0,
                     "username": payload["user"]["username"],
                     "role": [],  # TODO (betodealmeida)
                     "first_name": payload["user"]["first_name"],
                     "last_name": payload["user"]["last_name"],
-                    "email": payload["user"]["email"],
+                    "email": payload["user"]["email"].lower(),
                 }
                 for payload in payload["payload"]
             ]
@@ -189,8 +190,12 @@ def export_users(self, workspace_url: URL) -> Iterator[UserType]:
             if not payload["result"]:
                 break
 
+            # Teams with SAML SSO might have emails with uppercase characters
             ids.update(
-                {user["extra"]["email"]: user["value"] for user in payload["result"]},
+                {
+                    user["extra"]["email"].lower(): user["value"]
+                    for user in payload["result"]
+                },
             )
 
             page += 1

src/preset_cli/api/clients/superset.py

@@ -492,6 +492,7 @@ def update_resource(
         if query_args:
             url %= query_args
 
+        _logger.debug("PUT %s\n%s", url, json.dumps(kwargs, indent=4))
         response = self.session.put(url, json=kwargs)
         validate_response(response)
 
@@ -1189,7 +1190,7 @@ def import_ownership(
         """
         if ownership["uuid"] in resource_ids:
             resource_id = resource_ids[ownership["uuid"]]
-            owner_ids = [user_ids[email] for email in ownership["owners"]]
+            owner_ids = [user_ids[email.lower()] for email in ownership["owners"]]
             self.update_resource(resource_name, resource_id, owners=owner_ids)
         else:
             raise Exception(

src/preset_cli/cli/superset/import_.py

@@ -116,7 +116,13 @@ def import_ownership(  # pylint: disable=too-many-locals
                             users,
                             resource_ids,
                         )
-                    except Exception:  # pylint: disable=broad-except
+                    except Exception as exc:  # pylint: disable=broad-except
+                        _logger.debug(
+                            "Failed to import ownership for %s %s: %s",
+                            resource_name,
+                            ownership["name"],
+                            str(exc),
+                        )
                         if not continue_on_error:
                             raise
                         asset_log["status"] = "FAILED"

tests/api/clients/superset_test.py

@@ -1897,7 +1897,7 @@ def test_export_users_preset(requests_mock: Mocker) -> None:
                         "username": "bdoe",
                         "first_name": "Bob",
                         "last_name": "Doe",
-                        "email": "bdoe@example.com",
+                        "email": "BDoe@example.com",
                     },
                 },
             ],
@@ -1950,7 +1950,7 @@ def test_export_users_preset(requests_mock: Mocker) -> None:
                 {
                     "extra": {
                         "active": True,
-                        "email": "cdoe@example.com",
+                        "email": "CDoe@example.com",
                     },
                     "text": "Clarisse Doe",
                     "value": 3,
@@ -3529,7 +3529,7 @@ def test_import_ownership(requests_mock: Mocker) -> None:
         "dataset",
         {
             "name": "another_table",
-            "owners": ["[email protected]", "other_adoe@example.com"],
+            "owners": ["[email protected]", "Other_Adoe@example.com"],
             "uuid": "1192072c-4bee-4535-b8ee-e9f5fc4eb6a2",
         },
         users,