pytest-clerk-mock 0.0.2__py3-none-any.whl

pytest_clerk_mock-0.0.2.dist-info/METADATA

@@ -0,0 +1,251 @@
+Metadata-Version: 2.4
+Name: pytest-clerk-mock
+Version: 0.0.2
+Summary: A pytest plugin for mocking Clerk authentication
+License-File: LICENSE
+Author: Julien Kmec
+Author-email: me@julien.dev
+Requires-Python: >=3.11
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: clerk-backend-api (>=1.0.0)
+Requires-Dist: pydantic (>=2.0.0)
+Project-URL: Homepage, https://github.com/julien777z/pytest-mock-clerk
+Project-URL: Repository, https://github.com/julien777z/pytest-mock-clerk
+Description-Content-Type: text/markdown
+
+# pytest-clerk-mock
+
+A pytest plugin for mocking [Clerk](https://clerk.com/) authentication in your tests.
+
+## Installation
+
+```bash
+pip install pytest-clerk-mock
+```
+
+Or with Poetry:
+
+```bash
+poetry add --group dev pytest-clerk-mock
+```
+
+## Usage
+
+The plugin provides a `mock_clerk` fixture that you can use in your tests:
+
+```python
+def test_create_user(mock_clerk):
+    user = mock_clerk.users.create(
+        email_address=["test@example.com"],
+        first_name="John",
+        last_name="Doe",
+    )
+
+    assert user.id is not None
+    assert user.first_name == "John"
+
+    fetched = mock_clerk.users.get(user.id)
+    assert fetched.email_addresses[0].email_address == "test@example.com"
+```
+
+### Async API
+
+All methods have async variants with an `_async` suffix, matching the clerk-backend-api SDK:
+
+```python
+async def test_create_user_async(mock_clerk):
+    user = await mock_clerk.users.create_async(
+        email_address=["test@example.com"],
+        first_name="John",
+        last_name="Doe",
+    )
+
+    assert user.id is not None
+
+    fetched = await mock_clerk.users.get_async(user.id)
+    assert fetched.first_name == "John"
+```
+
+## Authentication
+
+The mock client provides full authentication state management:
+
+### Configure Auth State
+
+```python
+def test_with_auth(mock_clerk):
+    mock_clerk.configure_auth("user_123", org_id="org_456", org_role="org:admin")
+
+    result = mock_clerk.authenticate_request(request, options)
+    assert result.is_signed_in
+    assert result.payload["sub"] == "user_123"
+```
+
+### Temporary User Context
+
+Use the `as_user` context manager to temporarily switch users:
+
+```python
+def test_as_different_user(mock_clerk):
+    with mock_clerk.as_user("user_456", org_id="org_789"):
+        result = mock_clerk.authenticate_request(request, options)
+        assert result.payload["sub"] == "user_456"
+```
+
+### Predefined User Types
+
+Use `MockClerkUser` for common test scenarios:
+
+```python
+from pytest_clerk_mock import MockClerkUser
+
+def test_with_predefined_user(mock_clerk):
+    with mock_clerk.as_clerk_user(MockClerkUser.TEAM_OWNER, org_id="org_123"):
+        # Authenticated as team owner
+        pass
+
+    with mock_clerk.as_clerk_user(MockClerkUser.GUEST):
+        # Authenticated as guest
+        pass
+```
+
+Available predefined users:
+- `MockClerkUser.TEAM_OWNER`
+- `MockClerkUser.TEAM_MEMBER`
+- `MockClerkUser.GUEST`
+- `MockClerkUser.UNAUTHENTICATED`
+
+## Organization Memberships
+
+```python
+def test_organization_memberships(mock_clerk):
+    user = mock_clerk.users.create(email_address=["test@example.com"])
+
+    mock_clerk.add_organization_membership(
+        user_id=user.id,
+        org_id="org_123",
+        role="org:admin",
+        org_name="My Organization",
+    )
+
+    memberships = mock_clerk.users.get_organization_memberships(user.id)
+    assert memberships.total_count == 1
+    assert memberships.data[0].organization.id == "org_123"
+```
+
+## Custom Fixture Configuration
+
+Create a custom fixture with different defaults:
+
+```python
+# conftest.py
+from pytest_clerk_mock import create_mock_clerk_fixture
+
+mock_clerk = create_mock_clerk_fixture(
+    default_user_id="user_custom",
+    default_org_id="org_custom",
+    default_org_role="org:member",
+    autouse=True,
+)
+```
+
+## Context Manager API
+
+For use outside of pytest fixtures:
+
+```python
+from pytest_clerk_mock import mock_clerk_backend
+
+def test_with_context_manager():
+    with mock_clerk_backend(default_user_id="user_123") as mock:
+        mock.configure_auth("user_456")
+        # Your test code here
+```
+
+## Supported Operations
+
+### Users
+
+| Sync | Async |
+|------|-------|
+| `create()` | `create_async()` |
+| `get()` | `get_async()` |
+| `list()` | `list_async()` |
+| `update()` | `update_async()` |
+| `delete()` | `delete_async()` |
+| `count()` | `count_async()` |
+| `get_organization_memberships()` | `get_organization_memberships_async()` |
+
+### Authentication
+
+| Method | Description |
+|--------|-------------|
+| `authenticate_request()` | Mock Clerk's authenticate_request |
+| `configure_auth()` | Set current auth state |
+| `configure_auth_from_user()` | Set auth using MockClerkUser |
+| `as_user()` | Context manager for temporary user |
+| `as_clerk_user()` | Context manager with MockClerkUser |
+| `add_organization_membership()` | Add org membership for a user |
+| `reset()` | Reset all mock state |
+
+## Helper Functions
+
+Low-level helpers for specific mocking scenarios:
+
+```python
+from pytest_clerk_mock import (
+    mock_clerk_user_creation,
+    mock_clerk_user_creation_failure,
+    mock_clerk_user_exists,
+)
+
+def test_user_creation():
+    with mock_clerk_user_creation("myapp.clerk.users.create_async", "user_123") as mock:
+        # Your code that creates a user
+        mock.assert_called_once()
+
+def test_creation_failure():
+    with mock_clerk_user_creation_failure("myapp.clerk.users.create_async"):
+        # Your code that handles creation failure
+        pass
+
+def test_duplicate_email():
+    with mock_clerk_user_exists(
+        "myapp.clerk.users.create_async",
+        "myapp.clerk.users.list_async",
+        "user_existing_123",
+    ) as (mock_create, mock_list):
+        # Your code that handles duplicate email scenario
+        pass
+```
+
+## Exceptions
+
+The mock raises appropriate exceptions matching Clerk's behavior:
+
+- `UserNotFoundError` - When getting/updating/deleting a non-existent user
+- `ClerkErrors` - When creating a user with a duplicate email (matches real Clerk API)
+
+```python
+from pytest_clerk_mock import UserNotFoundError
+from clerk_backend_api.models import ClerkErrors
+
+def test_user_not_found(mock_clerk):
+    with pytest.raises(UserNotFoundError):
+        mock_clerk.users.get("nonexistent_user")
+
+def test_duplicate_email(mock_clerk):
+    mock_clerk.users.create(email_address=["test@example.com"])
+
+    with pytest.raises(ClerkErrors):
+        mock_clerk.users.create(email_address=["test@example.com"])
+```
+
+## License
+
+MIT
+

pytest_clerk_mock-0.0.2.dist-info/RECORD

@@ -0,0 +1,16 @@
+pytest_clerk_mock/__init__.py,sha256=p5sY3Scfv9AfZYLj8FjZVCXLwgLCgAq4mzeNplLuiTQ,1164
+pytest_clerk_mock/client.py,sha256=6f2MAc67uuHuafFjRbzmgAq5XRx1HJDepSrG2roWk48,5621
+pytest_clerk_mock/helpers.py,sha256=ofdoiYMaZ0fN-V2sSt6Db45aeg3KvW3L1urMBVmAZ2Q,4558
+pytest_clerk_mock/models/__init__.py,sha256=-2bUPYrm5cOAgBHBEW-f-0qkWFC0k0vHg9Cicc7g8Qs,529
+pytest_clerk_mock/models/auth.py,sha256=L2IgReu1ldMIqsGLp6Rhh8LwQKSntSB7DZm_z_okTfY,1191
+pytest_clerk_mock/models/organization.py,sha256=braNZGVafW2VDVokCt-7CZZEMNKmkHauuYsTTSM074U,721
+pytest_clerk_mock/models/user.py,sha256=VgmM9IWoYMDQ6t07GD5amv_kvRRBZVIRnI0n-2L5OP0,3044
+pytest_clerk_mock/plugin.py,sha256=Y8vJJtrzL6wfwKOtKibyHxQYjpyNy376oOkg5wrDamg,6207
+pytest_clerk_mock/services/__init__.py,sha256=R7_O0dZGltOKZnuMgT4_3LUtYZ3yaVeyg4_jtJYkd6k,315
+pytest_clerk_mock/services/auth.py,sha256=jsOMl7HtuUOlEdjHyYUD7ReE3_m-MTFcoKpKKRKvrnA,1790
+pytest_clerk_mock/services/users.py,sha256=Pfj4GjFXwHkZNWDLmfTEVVHBj3j0Wz5xw9WQC6V17zM,16503
+pytest_clerk_mock-0.0.2.dist-info/METADATA,sha256=UItf6kTFlw6YXwhh7RQfy7LTA2twsIw-SezriLhPGko,6638
+pytest_clerk_mock-0.0.2.dist-info/WHEEL,sha256=M5asmiAlL6HEcOq52Yi5mmk9KmTVjY2RDPtO4p9DMrc,88
+pytest_clerk_mock-0.0.2.dist-info/entry_points.txt,sha256=u1-5SRz1tzuKx2ZWe4rtaRrrf82P3PbofwsVTu2oHZ4,48
+pytest_clerk_mock-0.0.2.dist-info/licenses/LICENSE,sha256=nz5adr2tudZA3ZTRDj2lolnY1DKGr7oVUVUra5KMnbU,1068
+pytest_clerk_mock-0.0.2.dist-info/RECORD,,

pytest_clerk_mock-0.0.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.2.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pytest_clerk_mock-0.0.2.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[pytest11]
+mock_clerk=pytest_clerk_mock.plugin
+

pytest_clerk_mock-0.0.2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Julien Kmec
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.