Shared Test Factory Package for all Platform Django repos
Project description
iil-testkit
Shared Test Factory Package for all Platform Django repos — ADR-100
Installation
pip install iil-testkit
In requirements-test.txt:
iil-testkit>=0.4.0
With DRF support:
iil-testkit[drf]>=0.4.0
Extras / Optional Dependencies
| Extra | Additional deps | Purpose |
|---|---|---|
drf |
djangorestframework>=3.14 | DRF APIClient fixtures (drf_api_client, drf_auth_client) |
django |
django>=4.2, pytest-django>=4.8 | Explicit Django pin (normally pulled transitively) |
smoke |
django, beautifulsoup4>=4.12 | HTML smoke assertions |
Quick Setup
In your tests/conftest.py:
pytest_plugins = ["iil_testkit.fixtures"]
Factories
# tests/factories.py — import shared, extend repo-specific
from iil_testkit.factories import UserFactory # noqa: F401
import factory
class MyModelFactory(factory.django.DjangoModelFactory):
class Meta:
model = "myapp.MyModel"
user = factory.SubFactory(UserFactory)
For multi-tenant repos:
from iil_testkit.contrib.tenants import TenantFactory # noqa: F401
Fixtures
| Fixture | Description |
|---|---|
db_user |
Standard active user, saved to DB |
staff_user |
User with is_staff=True |
admin_user |
User with is_superuser=True |
api_client |
Unauthenticated Django Client |
auth_client |
Django Client logged in as db_user |
staff_client |
Django Client logged in as staff_user |
drf_api_client |
Unauthenticated DRF APIClient (skips if DRF missing) |
drf_auth_client |
DRF APIClient authenticated as db_user (skips if DRF missing) |
def test_should_view_dashboard(auth_client):
response = auth_client.get("/dashboard/")
assert response.status_code == 200
def test_should_require_auth(api_client):
from iil_testkit.assertions import assert_redirects_to_login
response = api_client.get("/protected/")
assert_redirects_to_login(response)
Assertion Helpers
from iil_testkit.assertions import (
assert_redirects_to_login,
assert_htmx_response,
assert_no_n_plus_one,
assert_form_error,
)
| Helper | Description |
|---|---|
assert_redirects_to_login(response) |
Asserts 301/302 to /login or /accounts/login |
assert_htmx_response(response) |
Asserts no full <html> page in HTMX partial |
assert_no_n_plus_one(queries, threshold=5) |
Asserts query count within threshold |
assert_form_error(response, field, message) |
Asserts form field error in context |
Naming Convention Plugin (ADR-057)
Auto-registered when installed. All test functions must follow test_should_*:
Naming convention violations — 1 test(s) must start with 'test_should_':
tests/test_foo.py::test_login
Opt-out per test:
@pytest.mark.no_naming_convention
def test_legacy_name(): ...
Opt-out globally: pytest --relax-naming
Warn instead of error: iil_naming_mode = "warn" in pyproject.toml
Architecture
See ADR-100.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file iil_testkit-0.5.0.tar.gz.
File metadata
- Download URL: iil_testkit-0.5.0.tar.gz
- Upload date:
- Size: 33.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1b368a58aadf778968204dc10a262db469848e78ac20a3d2cd43274365e04b9d
|
|
| MD5 |
994c515962f7d3e125a501461696e986
|
|
| BLAKE2b-256 |
6aed89849db329af00a080959212d18872fcd4b65280ce361efa4886c0584e65
|
File details
Details for the file iil_testkit-0.5.0-py3-none-any.whl.
File metadata
- Download URL: iil_testkit-0.5.0-py3-none-any.whl
- Upload date:
- Size: 21.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8bb79940792d0ea89c93c5f6405ea6833ffb1ccc06e85674bd9deedd51539b0f
|
|
| MD5 |
d20969499f125962746e1f29b6fdb324
|
|
| BLAKE2b-256 |
0a1af4862712b93a99a72096da2f968034958d66612d60984f8b07ce4a16d689
|
