test: organizes test by class and adds one for mapping passage error

Author: ctran88

passageidentity/errors.py

@@ -4,40 +4,43 @@
 
 from typing import TYPE_CHECKING
 
+import typing_extensions
+
 if TYPE_CHECKING:
     from passageidentity.openapi_client.exceptions import ApiException
 
 
 class PassageError(Exception):
     """Error class for handling Passage errors."""
 
+    @typing_extensions.deprecated(
+        "This should only be constructed by the Passage SDK. Use this type just for type checking.",
+    )
     def __init__(
         self,
         message: str,
         status_code: int | None = None,
         status_text: str | None = None,
         body: dict | None = None,
+        error_code: str | None = None,
     ) -> None:
         """Initialize the error with a message, status code, status text, and optional body."""
         self.message = message
         self.status_code = status_code
         self.status_text = status_text
+
+        self.error_code = error_code
+        self.error = None
+
         if body is not None:
             self.error = body["error"]
             self.error_code = body["code"]
-        else:
-            self.error = None
-            self.error_code = None
 
-    @staticmethod
-    def from_response_error(response_error: ApiException, message: str | None) -> PassageError:
+    @classmethod
+    def from_response_error(cls, response_error: ApiException, message: str | None = None) -> PassageError:
         """Initialize the error with a response body and optional message."""
         error_code = response_error.body["code"] if response_error.body else None
         error_msg = response_error.body["error"] if response_error.body else None
         msg = ": ".join(filter(None, [message, error_msg]))
 
-        psg_error = PassageError(msg)
-        psg_error.status_code = response_error.status
-        psg_error.error_code = error_code
-
-        return psg_error
+        return cls(message=msg, status_code=response_error.status, error_code=error_code)

tests/authenticate_test.py

@@ -8,12 +8,11 @@
 from passageidentity import PassageError
 from passageidentity.openapi_client.models.app_info import AppInfo
 from passageidentity.openapi_client.models.magic_link import MagicLink
-from passageidentity.openapi_client.models.update_user_request import UpdateUserRequest
-from passageidentity.openapi_client.models.user_info import UserInfo
 from passageidentity.passage import Passage
 
 load_dotenv()
 f = Faker()
+
 PASSAGE_USER_ID = os.environ.get("PASSAGE_USER_ID") or ""
 PASSAGE_APP_ID = os.environ.get("PASSAGE_APP_ID") or ""
 PASSAGE_API_KEY = os.environ.get("PASSAGE_API_KEY") or ""
@@ -57,164 +56,10 @@ def test_create_magic_link() -> None:
     assert magic_link.ttl == 12  # type: ignore[attr-defined]
 
 
-def test_get_user_info_valid() -> None:
-    psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
-    user = cast(UserInfo, psg.getUser(PASSAGE_USER_ID))
-    assert user.id == PASSAGE_USER_ID
-
-
-def test_get_user_info_by_identifier_valid() -> None:
-    psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
-
-    email = f.email()
-    new_user = cast(UserInfo, psg.createUser({"email": email}))  # type: ignore[arg-type]
-    assert new_user.email == email
-
-    user_by_identifier = cast(UserInfo, psg.getUserByIdentifier(email))
-    assert user_by_identifier.id == new_user.id
-
-    user = cast(UserInfo, psg.getUser(new_user.id))
-    assert user.id == new_user.id
-
-    assert user_by_identifier == user
-    assert psg.deleteUser(new_user.id)
-
-
-def test_get_user_info_by_identifier_valid_upper_case() -> None:
-    psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
-
-    email = f.email()
-    new_user = cast(UserInfo, psg.createUser({"email": email}))  # type: ignore[arg-type]
-    assert new_user.email == email
-
-    user_by_identifier = cast(UserInfo, psg.getUserByIdentifier(email.upper()))
-    assert user_by_identifier.id == new_user.id
-
-    user = cast(UserInfo, psg.getUser(new_user.id))
-    assert user.id == new_user.id
-
-    assert user_by_identifier == user
-    assert psg.deleteUser(new_user.id)
-
-
-def test_get_user_info_by_identifier_phone_valid() -> None:
-    psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
-
-    phone = "+15005550030"
-    new_user = cast(UserInfo, psg.createUser({"phone": phone}))  # type: ignore[arg-type]
-    assert new_user.phone == phone
-
-    user_by_identifier = cast(UserInfo, psg.getUserByIdentifier(phone))
-    assert user_by_identifier.id == new_user.id
-
-    user = cast(UserInfo, psg.getUser(new_user.id))
-    assert user.id == new_user.id
-
-    assert user_by_identifier == user
-    assert psg.deleteUser(new_user.id)
-
-
-def test_get_user_info_by_identifier_error() -> None:
-    psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
-
-    with pytest.raises(PassageError, match="Could not find user with identifier"):
-        psg.getUserByIdentifier("error@passage.id")
-
-
-def test_activate_user() -> None:
-    psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
-    user = cast(UserInfo, psg.activateUser(PASSAGE_USER_ID))
-    assert user.status == "active"
-
-
-def test_deactivate_user() -> None:
-    psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
-
-    user = cast(UserInfo, psg.getUser(PASSAGE_USER_ID))
-    user = cast(UserInfo, psg.deactivateUser(user.id))
-    assert user.status == "inactive"
-
-
-def test_list_user_devices() -> None:
-    psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
-
-    devices = cast(list, psg.listUserDevices(PASSAGE_USER_ID))
-    assert len(devices) == 2
-
-
-def test_update_user_phone() -> None:
-    psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
-
-    phone = "+15005550021"
-    new_user = cast(UserInfo, psg.createUser({"phone": phone}))  # type: ignore[arg-type]
-
-    phone = "+15005550022"
-    user = cast(UserInfo, psg.updateUser(new_user.id, {"phone": phone}))  # type: ignore[arg-type]
-    assert user.phone == phone
-    assert psg.deleteUser(new_user.id)
-
-
-def test_update_user_email() -> None:
-    psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
-
-    email = f.email()
-    req = UpdateUserRequest(email=email)
-    user = cast(UserInfo, psg.updateUser(PASSAGE_USER_ID, req))
-    assert user.email == email
-
-
-def test_update_user_with_metadata() -> None:
-    psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
-
-    email = f.email()
-    user = cast(UserInfo, psg.updateUser(PASSAGE_USER_ID, {"email": email, "user_metadata": {"example1": "qwe"}}))  # type: ignore[arg-type]
-    assert user.email == email
-    assert user.user_metadata["example1"] == "qwe"  # type: ignore[index]
-
-    user = cast(UserInfo, psg.updateUser(PASSAGE_USER_ID, {"email": email, "user_metadata": {"example1": "asd"}}))  # type: ignore[arg-type]
-    assert user.email == email
-    assert user.user_metadata["example1"] == "asd"  # type: ignore[index]
-
-
-def test_create_user_with_metadata() -> None:
-    psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
-
-    email = f.email()
-    user = cast(UserInfo, psg.createUser({"email": email, "user_metadata": {"example1": "qwe"}}))  # type: ignore[arg-type]
-    assert user.email == email
-    assert user.user_metadata["example1"] == "qwe"  # type: ignore[index]
-    assert psg.deleteUser(user.id)
-
-
-def test_get_user_info_user_does_not_exist() -> None:
-    pass
-
-
-def test_create_and_delete_user() -> None:
-    psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
-
-    email = f.email()
-    new_user = cast(UserInfo, psg.createUser({"email": email}))  # type: ignore[arg-type]
-    assert new_user.email == email
-    assert psg.deleteUser(new_user.id)
-
-
 def test_smart_link_valid() -> None:
     psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
 
     email = f.email()
     magic_link = cast(MagicLink, psg.createMagicLink({"email": email}))  # type: ignore[arg-type]
     assert magic_link.identifier == email
     assert not magic_link.activated
-
-
-def test_sign_out() -> None:
-    psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
-
-    assert psg.signOut(PASSAGE_USER_ID)
-
-
-def test_revoke_user_refresh_tokens() -> None:
-    psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
-
-    assert psg.revokeUserRefreshTokens(PASSAGE_USER_ID)

tests/errors_test.py

@@ -1,4 +1,11 @@
 from passageidentity import PassageError
+from passageidentity.openapi_client.exceptions import ApiException
+
+
+class MockApiException(ApiException):
+    def __init__(self, status: int, body: dict) -> None:
+        self.status = status
+        self.body = body
 
 
 def test_error_with_all_values() -> None:
@@ -17,3 +24,31 @@ def test_error_with_only_message() -> None:
     assert error.status_text is None
     assert error.error is None
     assert error.error_code is None
+
+
+def test_from_response_error() -> None:
+    response_error = MockApiException(
+        status=400,
+        body={"error": "some error", "code": "some_error_code"},
+    )
+
+    error = PassageError.from_response_error(response_error, "some message")
+    assert error.message == "some message: some error"
+    assert error.status_code == 400
+    assert error.error_code == "some_error_code"
+    assert error.status_text is None
+    assert error.error is None
+
+
+def test_from_response_error_without_message() -> None:
+    response_error = MockApiException(
+        status=400,
+        body={"error": "some error", "code": "some_error_code"},
+    )
+
+    error = PassageError.from_response_error(response_error)
+    assert error.message == "some error"
+    assert error.status_code == 400
+    assert error.error_code == "some_error_code"
+    assert error.status_text is None
+    assert error.error is None