pytest-clerk 4.0.3__tar.gz → 4.0.5__tar.gz

{pytest_clerk-4.0.3 → pytest_clerk-4.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pytest-clerk
-Version: 4.0.3
+Version: 4.0.5
 Summary: A set of pytest fixtures to help with integration testing with Clerk.
 License: MIT
 Author: Ryan Causey

{pytest_clerk-4.0.3 → pytest_clerk-4.0.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pytest-clerk"
-version = "4.0.3"
+version = "4.0.5"
 description = "A set of pytest fixtures to help with integration testing with Clerk."
 license = "MIT"
 readme = "README.md"
@@ -28,8 +28,8 @@ email = "ryan.causey@munipal.io"
 
 [tool.poetry.group.dev.dependencies]
 prospector = "^1.10.2"
-black = "^24.0.0"
-isort = "^5.12.0"
+black = "^25.0.0"
+isort = "^6.0.0"
 pre-commit = "^4.0.0"
 
 [project.entry-points."pytest11"]

{pytest_clerk-4.0.3 → pytest_clerk-4.0.5}/pytest_clerk/clerk.py

@@ -7,15 +7,7 @@ import httpx
 import pytest
 from decouple import UndefinedValueError, config
 from limits import RateLimitItemPerSecond, storage, strategies
-from tenacity import retry, retry_if_exception, wait_random_exponential
-
-retryable_status_codes = (
-    httpx.codes.TOO_MANY_REQUESTS,
-    httpx.codes.INTERNAL_SERVER_ERROR,
-    httpx.codes.BAD_GATEWAY,
-    httpx.codes.SERVICE_UNAVAILABLE,
-    httpx.codes.GATEWAY_TIMEOUT,
-)
+from tenacity import retry, stop_after_attempt, wait_random_exponential
 
 logger = logging.getLogger(__name__)
 
@@ -177,16 +169,6 @@ class ClerkRateLimiter:
             sleep(1)
 
 
-def retry_predicate(exception):
-    """Return whether to retry. This depends on getting an exception with a response
-    object, and that response object having one of the status codes that we can retry.
-    """
-    return (
-        hasattr(exception, "response")
-        and exception.response.status_code in retryable_status_codes
-    )
-
-
 @pytest.fixture(scope="session")
 def clerk_rate_limiter():
     """Return an instance of the Clerk rate limiter for use with HTTPX request hooks."""
@@ -234,6 +216,7 @@ def clerk_backend_httpx_client(clerk_secret_key, clerk_rate_limiter):
         headers={"Authorization": f"Bearer {clerk_secret_key}"},
         base_url="https://api.clerk.com/v1",
         event_hooks={"request": [clerk_rate_limiter.rate_limit_hook]},
+        timeout=10,
     )
 
     yield client
@@ -268,7 +251,7 @@ def clerk_frontend_httpx_client(clerk_frontend_api_url, clerk_rate_limiter):
     set via environment variables or in a .env file. This URL can be found under
     Developers -> API Keys -> Show API URLs.
     """
-    with httpx.Client(base_url=f"{clerk_frontend_api_url}/v1") as client:
+    with httpx.Client(base_url=f"{clerk_frontend_api_url}/v1", timeout=10) as client:
         result = client.post(url="/dev_browser")
 
     result.raise_for_status()
@@ -277,6 +260,7 @@ def clerk_frontend_httpx_client(clerk_frontend_api_url, clerk_rate_limiter):
         params={"__dev_session": result.json()["token"]},
         base_url=f"{clerk_frontend_api_url}/v1",
         event_hooks={"request": [clerk_rate_limiter.rate_limit_hook]},
+        timeout=10,
     )
 
     yield client
@@ -294,8 +278,9 @@ def clerk_delete_org(clerk_backend_httpx_client):
     """
 
     @retry(
-        retry=retry_if_exception(predicate=retry_predicate),
+        stop=stop_after_attempt(10),
         wait=wait_random_exponential(multiplier=0.5, max=60),
+        reraise=True,
     )
     def _inner(org_id, **kwargs):
         """Delete the org with the given org ID. Any additional kwargs are passed
@@ -306,9 +291,14 @@ def clerk_delete_org(clerk_backend_httpx_client):
         The API documentation for this call can be found below:
         https://clerk.com/docs/reference/backend-api/tag/Organizations#operation/DeleteOrganization
         """
-        return clerk_backend_httpx_client.delete(
+        result = clerk_backend_httpx_client.delete(
             url=f"/organizations/{org_id}", **kwargs
         )
+        # Ignore 404 errors indicating it was already deleted. Raise other errors.
+        if result.status_code != httpx.codes.NOT_FOUND:
+            result.raise_for_status()
+
+        return result
 
     return _inner
 
@@ -324,8 +314,9 @@ def clerk_create_org(clerk_backend_httpx_client, clerk_delete_org):
     orgs_to_delete = []
 
     @retry(
-        retry=retry_if_exception(predicate=retry_predicate),
+        stop=stop_after_attempt(10),
         wait=wait_random_exponential(multiplier=0.5, max=60),
+        reraise=True,
     )
     def _inner(organization_data, **kwargs):
         """This function creates an Organization with the provided organization_data,
@@ -337,8 +328,6 @@ def clerk_create_org(clerk_backend_httpx_client, clerk_delete_org):
         The API documentation for this call can be found below:
         https://clerk.com/docs/reference/backend-api/tag/Organizations#operation/CreateOrganization
         """
-        nonlocal orgs_to_delete
-
         result = clerk_backend_httpx_client.post(
             url="/organizations", json=organization_data, **kwargs
         )
@@ -365,8 +354,9 @@ def clerk_update_org(clerk_backend_httpx_client):
     """
 
     @retry(
-        retry=retry_if_exception(predicate=retry_predicate),
+        stop=stop_after_attempt(10),
         wait=wait_random_exponential(multiplier=0.5, max=60),
+        reraise=True,
     )
     def _inner(org_id_or_slug, organization_data, **kwargs):
         """This function attempts to update an organization with the provided
@@ -397,8 +387,9 @@ def clerk_get_org(clerk_backend_httpx_client):
     """
 
     @retry(
-        retry=retry_if_exception(predicate=retry_predicate),
+        stop=stop_after_attempt(10),
         wait=wait_random_exponential(multiplier=0.5, max=60),
+        reraise=True,
     )
     def _inner(org_id_or_slug, **kwargs):
         """This function attempts to find and return the org with the given ID or slug.
@@ -428,8 +419,9 @@ def clerk_delete_user(clerk_backend_httpx_client):
     """
 
     @retry(
-        retry=retry_if_exception(predicate=retry_predicate),
+        stop=stop_after_attempt(10),
         wait=wait_random_exponential(multiplier=0.5, max=60),
+        reraise=True,
     )
     def _inner(user_id, **kwargs):
         """Delete the user with the given user ID. All additional kwargs are passed
@@ -440,7 +432,12 @@ def clerk_delete_user(clerk_backend_httpx_client):
         The API documentation for this call can be found below:
         https://clerk.com/docs/reference/backend-api/tag/Users#operation/DeleteUser
         """
-        return clerk_backend_httpx_client.delete(url=f"/users/{user_id}", **kwargs)
+        result = clerk_backend_httpx_client.delete(url=f"/users/{user_id}", **kwargs)
+        # Ignore 404 errors indicating it was already deleted. Raise other errors.
+        if result.status_code != httpx.codes.NOT_FOUND:
+            result.raise_for_status()
+
+        return result
 
     return _inner
 
@@ -456,8 +453,9 @@ def clerk_create_user(clerk_backend_httpx_client, clerk_delete_user):
     users_to_delete = []
 
     @retry(
-        retry=retry_if_exception(predicate=retry_predicate),
+        stop=stop_after_attempt(10),
         wait=wait_random_exponential(multiplier=0.5, max=60),
+        reraise=True,
     )
     def _inner(user_data, **kwargs):
         """This function uses user_data to create a User with the backend API, and
@@ -469,7 +467,6 @@ def clerk_create_user(clerk_backend_httpx_client, clerk_delete_user):
         The API documentation for this call can be found below:
         https://clerk.com/docs/reference/backend-api/tag/Users#operation/CreateUser
         """
-        nonlocal users_to_delete
         result = clerk_backend_httpx_client.post(url="/users", json=user_data, **kwargs)
         result.raise_for_status()
         result = result.json()
@@ -493,8 +490,9 @@ def clerk_add_org_member(clerk_backend_httpx_client):
     """
 
     @retry(
-        retry=retry_if_exception(predicate=retry_predicate),
+        stop=stop_after_attempt(10),
         wait=wait_random_exponential(multiplier=0.5, max=60),
+        reraise=True,
     )
     def _inner(org_id, user_id, role, **kwargs):
         """Add's the provided user ID to the provided org ID with the provided role. All
@@ -527,8 +525,9 @@ def clerk_sign_user_in(clerk_frontend_httpx_client):
     """
 
     @retry(
-        retry=retry_if_exception(predicate=retry_predicate),
+        stop=stop_after_attempt(10),
         wait=wait_random_exponential(multiplier=0.5, max=60),
+        reraise=True,
     )
     def _inner(email, password, **kwargs):
         """Attempts to sign in the user using the provided email and password, and then
@@ -565,8 +564,9 @@ def clerk_touch_user_session(clerk_frontend_httpx_client):
     """
 
     @retry(
-        retry=retry_if_exception(predicate=retry_predicate),
+        stop=stop_after_attempt(10),
         wait=wait_random_exponential(multiplier=0.5, max=60),
+        reraise=True,
     )
     def _inner(session_id, session_data=None, **kwargs):
         """Given a Clerk user session ID and any optional session_data, touch the
@@ -626,8 +626,9 @@ def clerk_get_user_session_token(clerk_frontend_httpx_client):
     """
 
     @retry(
-        retry=retry_if_exception(predicate=retry_predicate),
+        stop=stop_after_attempt(10),
         wait=wait_random_exponential(multiplier=0.5, max=60),
+        reraise=True,
     )
     def _inner(session_id, **kwargs):
         """Retrieves a currently valid session token for the user tied to the provided
@@ -659,8 +660,9 @@ def clerk_end_user_session(clerk_frontend_httpx_client):
     """
 
     @retry(
-        retry=retry_if_exception(predicate=retry_predicate),
+        stop=stop_after_attempt(10),
         wait=wait_random_exponential(multiplier=0.5, max=60),
+        reraise=True,
     )
     def _inner(session_id, **kwargs):
         """Given a Clerk user session ID, ends that session. This passes through any