support email-type usernames for federated users

adorton-adobe · adorton-adobe · commit 530a562daa64 · 2018-08-27T20:20:10.000-06:00
diff --git a/tests/test_functional.py b/tests/test_functional.py
@@ -122,43 +122,55 @@ def test_create_user_enterpriseid():
 
 
 def test_create_user_federatedid():
-    user = UserAction(id_type=IdentityTypes.federatedID, email="dbrotsky@k.on-the-side.net")
-    user.create(first_name="Daniel", last_name="Brotsky", country="US")
-    assert user.wire_dict() == {"do": [{"createFederatedID": {"email": "dbrotsky@k.on-the-side.net",
-                                                              "firstname": "Daniel", "lastname": "Brotsky",
+    """
+    Test federated ID action with email address and no username
+    """
+    user = UserAction(id_type=IdentityTypes.federatedID, email="user@example.com")
+    user.create(first_name="Example", last_name="User", country="US")
+    assert user.wire_dict() == {"do": [{"createFederatedID": {"email": "user@example.com",
+                                                              "firstname": "Example", "lastname": "User",
                                                               "country": "US",
                                                               "option": "ignoreIfAlreadyExists"}}],
-                                "user": "dbrotsky@k.on-the-side.net"}
+                                "user": "user@example.com"}
 
 
-def test_create_user_federated_id_unicode():
-    user = UserAction(id_type=IdentityTypes.federatedID, email=u"lwalesa@k.on-the-side.net")
-    user.create(first_name="Lech", last_name=u"Wałęsa", country="PL")
-    assert user.wire_dict() == {"do": [{"createFederatedID": {"email": u"lwalesa@k.on-the-side.net",
-                                                              "firstname": "Lech", "lastname": u"Wałęsa",
+def test_create_user_federatedid_unicode():
+    """
+    Test federated ID action with email address and no username and unicode in at least one attribute
+    """
+    user = UserAction(id_type=IdentityTypes.federatedID, email=u"user@example.com")
+    user.create(first_name=u"Exampłę", last_name="User", country="PL")
+    assert user.wire_dict() == {"do": [{"createFederatedID": {"email": u"user@example.com",
+                                                              "firstname": u"Exampłę", "lastname": "User",
                                                               "country": "PL",
                                                               "option": "ignoreIfAlreadyExists"}}],
-                                "user": u"lwalesa@k.on-the-side.net"}
+                                "user": u"user@example.com"}
 
 
 def test_create_user_federatedid_username():
-    user = UserAction(id_type=IdentityTypes.federatedID, username="dbrotsky", domain="k.on-the-side.net")
-    user.create(first_name="Daniel", last_name="Brotsky", country="US", email="dbrotsky@k.on-the-side.net")
-    assert user.wire_dict() == {"do": [{"createFederatedID": {"email": "dbrotsky@k.on-the-side.net",
-                                                              "firstname": "Daniel", "lastname": "Brotsky",
+    """
+    Test federated ID with a username (non-email format)
+    """
+    user = UserAction(id_type=IdentityTypes.federatedID, username="user", domain="example.com")
+    user.create(first_name="Example", last_name="User", country="US", email="user@example.com")
+    assert user.wire_dict() == {"do": [{"createFederatedID": {"email": "user@example.com",
+                                                              "firstname": "Example", "lastname": "User",
                                                               "country": "US",
                                                               "option": "ignoreIfAlreadyExists"}}],
-                                "user": "dbrotsky", "domain": "k.on-the-side.net"}
+                                "user": "user", "domain": "example.com"}
 
 
 def test_create_user_federatedid_username_unicode():
-    user = UserAction(id_type=IdentityTypes.federatedID, username=u"lwalesa", domain="k.on-the-side.net")
-    user.create(first_name="Lech", last_name=u"Wałęsa", country="PL", email=u"lwalesa@k.on-the-side.net")
-    assert user.wire_dict() == {"do": [{"createFederatedID": {"email": u"lwalesa@k.on-the-side.net",
-                                                              "firstname": "Lech", "lastname": u"Wałęsa",
+    """
+    Test federated ID with a username and unicode attributes (non-email format)
+    """
+    user = UserAction(id_type=IdentityTypes.federatedID, username=u"user", domain="example.com")
+    user.create(first_name=u"Exampłę", last_name="User", country="PL", email=u"user@example.com")
+    assert user.wire_dict() == {"do": [{"createFederatedID": {"email": u"user@example.com",
+                                                              "firstname": u"Exampłę", "lastname": "User",
                                                               "country": "PL",
                                                               "option": "ignoreIfAlreadyExists"}}],
-                                "user": u"lwalesa", "domain": "k.on-the-side.net"}
+                                "user": u"user", "domain": "example.com"}
 
 
 def test_create_user_federatedid_username_email():
@@ -172,11 +184,49 @@ def test_create_user_federatedid_username_email():
                                 "user": "dbrotsky", "domain": "k.on-the-side.net"}
 
 
-def test_create_user_federatedid_username_mismatch():
+def test_create_user_federatedid_email_format_username():
+    """
+    Create federated ID with username in email format (with email address)
+    :return:
+    """
     user = UserAction(id_type=IdentityTypes.federatedID, username="dbrotsky", domain="k.on-the-side.net",
-                      email="foo@bar.net")
+                      email="dbrotsky@k.on-the-side.net")
+    user.create(first_name="Daniel", last_name="Brotsky", country="US")
+    assert user.wire_dict() == {"do": [{"createFederatedID": {"email": "dbrotsky@k.on-the-side.net",
+                                                              "firstname": "Daniel", "lastname": "Brotsky",
+                                                              "country": "US",
+                                                              "option": "ignoreIfAlreadyExists"}}],
+                                "user": "dbrotsky", "domain": "k.on-the-side.net"}
+
+
+def test_create_user_federatedid_username_mismatch():
+    """
+    Mismatched email in UserAction constructor vs create()
+    """
+    user = UserAction(id_type=IdentityTypes.federatedID, username="user", domain="example.com",
+                      email="user@example.com")
+    with pytest.raises(ValueError):
+        user.create(first_name="Example", last_name="User", country="US", email="user@example.net")
+
+
+def test_different_email_username():
+    """
+    Update a user record so the email address is different than email-type username (federated only)
+    """
+    user = UserAction(id_type=IdentityTypes.federatedID, email="user@example.com")
+    user.update(email="Example.User@example.com", username="user@example.com")
+    assert user.wire_dict() == {"do": [{"update": {"email": "Example.User@example.com",
+                                                   "username": "user@example.com"}}],
+                                "user": "user@example.com"}
+
+
+def test_malformed_email_type_username():
+    """
+    Test email-type username with malformed email address
+    """
+    user = UserAction(id_type=IdentityTypes.federatedID, email="user@example.com")
     with pytest.raises(ValueError):
-        user.create(first_name="Daniel", last_name="Brotsky", country="US", email="foo@bar.com")
+        user.update(username="@user@example.com")
 
 
 def test_update_user_adobeid():
diff --git a/umapi_client/functional.py b/umapi_client/functional.py
@@ -176,7 +176,7 @@ def create(self, first_name=None, last_name=None, country=None, email=None,
             if not self.email:
                 raise ArgumentError("You must specify email when creating a user")
         elif self.email is None:
-            self._validate(email=email)
+            self._validate_email(email=email)
             self.email = email
         elif self.email.lower() != email.lower():
             raise ArgumentError("Specified email (%s) doesn't match user's email (%s)" % (email, self.email))
@@ -210,14 +210,18 @@ def update(self, email=None, username=None, first_name=None, last_name=None, cou
         :return: the User, so you can do User(...).update(...).add_to_groups(...)
         """
         if email:
-            self._validate(email=email)
-        if username:
-            self._validate(username=username)
+            self._validate_email(email=email)
+        # if username contains @ (federated only), validate as email address
+        if self.id_type == IdentityTypes.federatedID and username and '@' in username:
+            self._validate_email(email=username)
+        elif username:
+            self._validate_username(username=username)
         updates = {}
         for k, v in six.iteritems(dict(email=email, username=username,
                                        firstname=first_name, lastname=last_name,
                                        country=country)):
-            if v: updates[k] = v
+            if v:
+                updates[k] = v
         return self.append(update=updates)
 
     def add_to_groups(self, groups=None, all_groups=False, group_type=None):
