[Fix] Test user APIs (#609)

Author: LioriE

descope/management/user.py

@@ -250,6 +250,7 @@ def invite(
         additional_login_ids: Optional[List[str]] = None,
         sso_app_ids: Optional[List[str]] = None,
         template_id: str = "",
+        test: bool = False,
     ) -> dict:
         """
         Create a new user and invite them via an email / text message.
@@ -278,7 +279,7 @@ def invite(
                 role_names,
                 user_tenants,
                 True,
-                False,
+                test,
                 picture,
                 custom_attributes,
                 verified_email,
@@ -346,6 +347,7 @@ def update(
         verified_phone: Optional[bool] = None,
         additional_login_ids: Optional[List[str]] = None,
         sso_app_ids: Optional[List[str]] = None,
+        test: bool = False,
     ) -> dict:
         """
         Update an existing user with the given various fields. IMPORTANT: All parameters are used as overrides
@@ -367,6 +369,7 @@ def update(
         picture (str): Optional url for user picture
         custom_attributes (dict): Optional, set the different custom attributes values of the keys that were previously configured in Descope console app
         sso_app_ids (List[str]): Optional, list of SSO applications IDs to be associated with the user.
+        test (bool, optional): Set to True to update a test user. Defaults to False.
 
         Return value (dict):
         Return dict in the format
@@ -391,7 +394,7 @@ def update(
                 family_name,
                 role_names,
                 user_tenants,
-                False,
+                test,
                 picture,
                 custom_attributes,
                 verified_email,
@@ -420,6 +423,7 @@ def patch(
         verified_email: Optional[bool] = None,
         verified_phone: Optional[bool] = None,
         sso_app_ids: Optional[List[str]] = None,
+        test: bool = False,
     ) -> dict:
         """
         Patches an existing user with the given various fields. Only the given fields will be used to update the user.
@@ -439,6 +443,7 @@ def patch(
         picture (str): Optional url for user picture
         custom_attributes (dict): Optional, set the different custom attributes values of the keys that were previously configured in Descope console app
         sso_app_ids (List[str]): Optional, list of SSO applications IDs to be associated with the user.
+        test (bool, optional): Set to True to update a test user. Defaults to False.
 
         Return value (dict):
         Return dict in the format
@@ -465,6 +470,7 @@ def patch(
                 verified_email,
                 verified_phone,
                 sso_app_ids,
+                test,
             ),
             pswd=self._auth.management_key,
         )
@@ -1936,6 +1942,7 @@ def _compose_patch_body(
         verified_email: Optional[bool],
         verified_phone: Optional[bool],
         sso_app_ids: Optional[List[str]],
+        test: bool = False,
     ) -> dict:
         res: dict[str, Any] = {
             "loginId": login_id,
@@ -1966,4 +1973,6 @@ def _compose_patch_body(
             res["verifiedPhone"] = verified_phone
         if sso_app_ids is not None:
             res["ssoAppIds"] = sso_app_ids
+        if test:
+            res["test"] = test
         return res

tests/management/test_user.py

@@ -2419,7 +2419,9 @@ def test_generate_sign_up_embedded_link(self):
         with patch("requests.post") as mock_post:
             mock_post.return_value.ok = False
             self.assertRaises(
-                AuthException, self.client.mgmt.user.generate_sign_up_embedded_link, "login-id"
+                AuthException,
+                self.client.mgmt.user.generate_sign_up_embedded_link,
+                "login-id",
             )
 
         # Test success flow
@@ -2519,3 +2521,73 @@ def test_history(self):
                 params=None,
                 timeout=DEFAULT_TIMEOUT_SECONDS,
             )
+
+    def test_update_test_user(self):
+        with patch("requests.post") as mock_post:
+            network_resp = mock.Mock()
+            network_resp.ok = True
+            network_resp.json.return_value = json.loads('{"user": {"id": "u1"}}')
+            mock_post.return_value = network_resp
+            resp = self.client.mgmt.user.update(
+                "id",
+                display_name="test-user",
+                test=True,
+            )
+            user = resp["user"]
+            self.assertEqual(user["id"], "u1")
+            mock_post.assert_called_with(
+                f"{common.DEFAULT_BASE_URL}{MgmtV1.user_update_path}",
+                headers={
+                    **common.default_headers,
+                    "Authorization": f"Bearer {self.dummy_project_id}:{self.dummy_management_key}",
+                    "x-descope-project-id": self.dummy_project_id,
+                },
+                params=None,
+                json={
+                    "loginId": "id",
+                    "email": None,
+                    "phone": None,
+                    "displayName": "test-user",
+                    "roleNames": [],
+                    "userTenants": [],
+                    "test": True,
+                    "picture": None,
+                    "customAttributes": None,
+                    "additionalLoginIds": None,
+                    "ssoAppIDs": None,
+                },
+                allow_redirects=False,
+                verify=True,
+                timeout=DEFAULT_TIMEOUT_SECONDS,
+            )
+
+    def test_patch_test_user(self):
+        with patch("requests.patch") as mock_patch:
+            network_resp = mock.Mock()
+            network_resp.ok = True
+            network_resp.json.return_value = json.loads('{"user": {"id": "u1"}}')
+            mock_patch.return_value = network_resp
+            resp = self.client.mgmt.user.patch(
+                "id",
+                display_name="test-user",
+                test=True,
+            )
+            user = resp["user"]
+            self.assertEqual(user["id"], "u1")
+            mock_patch.assert_called_with(
+                f"{common.DEFAULT_BASE_URL}{MgmtV1.user_patch_path}",
+                headers={
+                    **common.default_headers,
+                    "Authorization": f"Bearer {self.dummy_project_id}:{self.dummy_management_key}",
+                    "x-descope-project-id": self.dummy_project_id,
+                },
+                params=None,
+                json={
+                    "loginId": "id",
+                    "displayName": "test-user",
+                    "test": True,
+                },
+                allow_redirects=False,
+                verify=True,
+                timeout=DEFAULT_TIMEOUT_SECONDS,
+            )