fixturify 0.1.9__tar.gz

fixturify-0.1.9/.github/workflows/publish.yml

@@ -0,0 +1,40 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload dist
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download dist
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

fixturify-0.1.9/.gitignore

@@ -0,0 +1,210 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+.claude
+.idea

fixturify-0.1.9/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: fixturify
+Version: 0.1.9
+Summary: A collection of convenient testing utilities for Python
+Project-URL: Homepage, https://github.com/eleven-sea/pytools
+Project-URL: Repository, https://github.com/eleven-sea/pytools
+Project-URL: Issues, https://github.com/eleven-sea/pytools/issues
+Author: eleven-sea
+License-Expression: MIT
+Keywords: fixtures,json,mocking,pytest,sql,testing
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Requires-Dist: deepdiff>=6.0
+Description-Content-Type: text/markdown
+
+# pytools
+
+A collection of Python testing utilities.
+
+## Installation
+
+```bash
+pip install fixturify
+```
+
+## Modules
+
+| Module | Description | Docs |
+|--------|-------------|------|
+| [sql](docs/sql.md) | Execute SQL files before/after tests | [docs/sql.md](docs/sql.md) |
+| [read](docs/read.md) | Inject JSON fixtures into test functions | [docs/read.md](docs/read.md) |
+| [http](docs/http.md) | Record and replay HTTP calls | [docs/http.md](docs/http.md) |
+| [JsonAssert](docs/json_assert.md) | Compare objects to JSON files | [docs/json_assert.md](docs/json_assert.md) |
+| [ObjectMapper](docs/object_mapper.md) | Bidirectional object-JSON mapping | [docs/object_mapper.md](docs/object_mapper.md) |
+
+## Quick examples
+
+### sql
+
+```python
+from fixturify import sql, Phase
+
+@sql(path="./setup.sql")
+@sql(path="./cleanup.sql", phase=Phase.AFTER)
+def test_database():
+    # SQL executed before and after test
+    pass
+```
+
+### read
+
+```python
+from fixturify import read
+
+@read.fixture(path="./fixtures/user.json", fixture_name="user", object_class=User)
+def test_user(user: User):
+    assert user.name == "John"
+```
+
+### http
+
+```python
+from fixturify import http
+
+@http(path="./fixtures/api.json")
+def test_api():
+    # First run: records HTTP calls
+    # Next runs: replays from file
+    response = requests.get("https://api.example.com/users")
+    assert response.status_code == 200
+```
+
+### JsonAssert
+
+```python
+from fixturify import JsonAssert
+
+def test_response():
+    data = {"name": "John", "age": 30}
+    JsonAssert(data).ignore("age").compare_to_file("./expected.json")
+```
+
+### ObjectMapper
+
+```python
+from fixturify import ObjectMapper
+
+# Object to JSON
+user = User(name="John", age=30)
+data = ObjectMapper(user).to_json()
+
+# JSON to object
+data = {"name": "John", "age": 30}
+user = ObjectMapper(data).to_object(User)
+```
+
+## Public API
+
+```python
+from fixturify import (
+    # Decorators
+    sql,
+    read,
+    http,
+    # Enums
+    Phase,
+    # Config
+    SqlTestConfig,
+    HttpTestConfig,
+    # Classes
+    JsonAssert,
+    ObjectMapper,
+)
+```

fixturify-0.1.9/README.md

@@ -0,0 +1,99 @@
+# pytools
+
+A collection of Python testing utilities.
+
+## Installation
+
+```bash
+pip install fixturify
+```
+
+## Modules
+
+| Module | Description | Docs |
+|--------|-------------|------|
+| [sql](docs/sql.md) | Execute SQL files before/after tests | [docs/sql.md](docs/sql.md) |
+| [read](docs/read.md) | Inject JSON fixtures into test functions | [docs/read.md](docs/read.md) |
+| [http](docs/http.md) | Record and replay HTTP calls | [docs/http.md](docs/http.md) |
+| [JsonAssert](docs/json_assert.md) | Compare objects to JSON files | [docs/json_assert.md](docs/json_assert.md) |
+| [ObjectMapper](docs/object_mapper.md) | Bidirectional object-JSON mapping | [docs/object_mapper.md](docs/object_mapper.md) |
+
+## Quick examples
+
+### sql
+
+```python
+from fixturify import sql, Phase
+
+@sql(path="./setup.sql")
+@sql(path="./cleanup.sql", phase=Phase.AFTER)
+def test_database():
+    # SQL executed before and after test
+    pass
+```
+
+### read
+
+```python
+from fixturify import read
+
+@read.fixture(path="./fixtures/user.json", fixture_name="user", object_class=User)
+def test_user(user: User):
+    assert user.name == "John"
+```
+
+### http
+
+```python
+from fixturify import http
+
+@http(path="./fixtures/api.json")
+def test_api():
+    # First run: records HTTP calls
+    # Next runs: replays from file
+    response = requests.get("https://api.example.com/users")
+    assert response.status_code == 200
+```
+
+### JsonAssert
+
+```python
+from fixturify import JsonAssert
+
+def test_response():
+    data = {"name": "John", "age": 30}
+    JsonAssert(data).ignore("age").compare_to_file("./expected.json")
+```
+
+### ObjectMapper
+
+```python
+from fixturify import ObjectMapper
+
+# Object to JSON
+user = User(name="John", age=30)
+data = ObjectMapper(user).to_json()
+
+# JSON to object
+data = {"name": "John", "age": 30}
+user = ObjectMapper(data).to_object(User)
+```
+
+## Public API
+
+```python
+from fixturify import (
+    # Decorators
+    sql,
+    read,
+    http,
+    # Enums
+    Phase,
+    # Config
+    SqlTestConfig,
+    HttpTestConfig,
+    # Classes
+    JsonAssert,
+    ObjectMapper,
+)
+```

fixturify-0.1.9/docker-compose.yml

@@ -0,0 +1,48 @@
+services:
+  localstack:
+    image: localstack/localstack:latest
+    ports:
+      - "4566:4566"
+    environment:
+      - SERVICES=s3,sts
+      - DEBUG=0
+      - DOCKER_HOST=unix:///var/run/docker.sock
+    volumes:
+      - localstack_data:/var/lib/localstack
+      - /var/run/docker.sock:/var/run/docker.sock
+
+  postgres:
+    image: postgres:16-alpine
+    ports:
+      - "5432:5432"
+    environment:
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
+      - POSTGRES_DB=pytools
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres -d pytools"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
+
+  mysql:
+    image: mysql:8.0
+    ports:
+      - "3306:3306"
+    environment:
+      - MYSQL_ALLOW_EMPTY_PASSWORD=yes
+      - MYSQL_DATABASE=pytools
+    volumes:
+      - mysql_data:/var/lib/mysql
+    healthcheck:
+      test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
+
+volumes:
+  localstack_data:
+  postgres_data:
+  mysql_data:

fixturify-0.1.9/docs/http.md

@@ -0,0 +1,189 @@
+# http
+
+Decorator for recording and replaying HTTP calls in tests.
+
+## Import
+
+```python
+from fixturify import http, HttpTestConfig
+```
+
+## Basic usage
+
+```python
+import requests
+
+@http(path="./fixtures/api_calls.json")
+def test_api():
+    response = requests.get("https://api.example.com/users")
+    assert response.status_code == 200
+```
+
+**First run**: makes real HTTP calls and saves them to JSON file.
+
+**Subsequent runs**: replays saved responses (no network calls).
+
+## Supported HTTP libraries
+
+- `requests` (sync)
+- `httpx` (sync and async)
+
+## Async functions
+
+```python
+import httpx
+
+@http(path="./fixtures/api.json")
+async def test_async_api():
+    async with httpx.AsyncClient() as client:
+        response = await client.get("https://api.example.com/users")
+        assert response.status_code == 200
+```
+
+## Configuration
+
+### Via pytest fixture (recommended)
+
+```python
+# conftest.py
+import pytest
+from fixturify import HttpTestConfig
+
+@pytest.fixture
+def http_config() -> HttpTestConfig:
+    return HttpTestConfig(
+        ignore_request_headers=["Authorization"],
+        exclude_request_headers=["Authorization", "X-API-Key"],
+    )
+```
+
+### Directly in decorator
+
+```python
+config = HttpTestConfig(
+    ignore_request_headers=["Authorization"],
+    strict_order=True,
+)
+
+@http(path="./fixtures/api.json", config=config)
+def test_api():
+    pass
+```
+
+## HttpTestConfig
+
+| Field | Type | Default | Description |
+|-------|------|---------|-------------|
+| `ignore_request_headers` | `List[str]` | `[]` | Headers to ignore when matching requests |
+| `ignore_response_headers` | `List[str]` | `[]` | Headers to ignore when comparing responses |
+| `exclude_request_headers` | `List[str]` | `[]` | Headers to remove from recordings |
+| `exclude_response_headers` | `List[str]` | `[]` | Headers to remove from response recordings |
+| `exclude_hosts` | `List[str]` | `[]` | Hosts excluded from recording/playback |
+| `match_request_body` | `bool` | `True` | Whether to match request body |
+| `strict_order` | `bool` | `False` | Whether requests must occur in same order |
+
+## Default ignored headers
+
+**Request (ignored during matching)**:
+- `user-agent`, `date`, `accept-encoding`, `content-length`, `connection`, `host`
+
+**Request (excluded from recordings)**:
+- `user-agent`, `accept-encoding`, `connection`, `host`
+
+**Response (excluded from recordings)**:
+- `date`, `server`, `x-request-id`, `x-correlation-id`, `set-cookie`, `transfer-encoding`, `content-length`
+
+## Configuration examples
+
+### Ignoring Authorization header
+
+```python
+config = HttpTestConfig(
+    ignore_request_headers=["Authorization"],    # don't compare during playback
+    exclude_request_headers=["Authorization"],   # don't save to file
+)
+```
+
+### Enforcing request order
+
+```python
+config = HttpTestConfig(strict_order=True)
+
+@http(path="./fixtures/api.json", config=config)
+def test_ordered():
+    requests.get("https://api.example.com/first")   # must be first
+    requests.get("https://api.example.com/second")  # must be second
+```
+
+### Excluding host from mocking
+
+```python
+config = HttpTestConfig(
+    exclude_hosts=["testserver", "localhost:8000"],
+)
+
+@http(path="./fixtures/api.json", config=config)
+def test_with_local_server():
+    # These calls go to real server:
+    requests.get("http://testserver/api/health")
+
+    # These are recorded/replayed:
+    requests.get("https://external-api.com/data")
+```
+
+### Ignoring request body
+
+```python
+config = HttpTestConfig(match_request_body=False)
+```
+
+## Exceptions
+
+| Exception | When |
+|-----------|------|
+| `NoMatchingRecordingError` | Request doesn't match any recording |
+| `UnusedRecordingsError` | Some recordings were not used |
+| `RequestMismatchError` | Details about request mismatch |
+
+## Re-recording
+
+Delete the JSON recordings file and run test again:
+
+```bash
+rm tests/fixtures/api_calls.json
+pytest tests/test_api.py
+```
+
+## Recording file format
+
+```json
+{
+  "mappings": [
+    {
+      "request": {
+        "method": "GET",
+        "url": "https://api.example.com/users",
+        "headers": {"Accept": "application/json"},
+        "queryParameters": {},
+        "body": null
+      },
+      "response": {
+        "statusCode": 200,
+        "headers": {"Content-Type": "application/json"},
+        "body": [{"id": 1, "name": "John"}]
+      }
+    }
+  ]
+}
+```
+
+## Path resolution
+
+Paths are resolved relative to the test file:
+
+```
+tests/
+  test_api.py            <- @http(path="./fixtures/api.json")
+  fixtures/
+    api.json             <- recordings saved here
+```