Skip to main content

Shared Test Factory Package for all Platform Django repos

Project description

iil-testkit

Shared Test Factory Package for all Platform Django reposADR-100

PyPI

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iil_testkit-0.5.3.tar.gz (34.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iil_testkit-0.5.3-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

Details for the file iil_testkit-0.5.3.tar.gz.

File metadata

  • Download URL: iil_testkit-0.5.3.tar.gz
  • Upload date:
  • Size: 34.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for iil_testkit-0.5.3.tar.gz
Algorithm Hash digest
SHA256 e495b4a8f76e79d8e92ca95dc838f5393bef547ab4824ea5078460310d8d666d
MD5 6b9baaf5b0f7835503e12828673df58a
BLAKE2b-256 3d76a93d5a9772192a86aff37d2a1756de8e6942885a79a9df849b983dd3ce57

See more details on using hashes here.

File details

Details for the file iil_testkit-0.5.3-py3-none-any.whl.

File metadata

  • Download URL: iil_testkit-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 21.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for iil_testkit-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 372ac03bc281a96af5a45511d59e3503281cf9ac06c8a91b8b6f35372431a60d
MD5 db2c46741b888c9ec5312f2983271644
BLAKE2b-256 1e3428312bcffd506bab0d2c2568e7d86eb6c78da581ee289dfb888a2fc18236

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page