A model instance factory for pytest-django
Project description
pytest-django-ifactory
A model instance factory for pytest-django.
Motivation
pytest-django-ifactory makes it easy to create model instances for your test cases even if they contain a lot of non-nullable fields and complex foreign key relationships. If you every felt like you spent too much time coming up with dummy values for you models' fields just to get an instance into the database to use in a test then pytest-django-ifactory might be for you.
pytest's fixtures are great and perfect if you want to have a static model instance available in the database for your tests. Problems arise however when you want to vary one of its fields. To reuse your fixture in that case you need to modify the field and save the instance back to the database (assuming your test needs it in the database, of course). This results in at least two lines of extra setup code in you test case and an extra call to the database.
pytest-django-ifactory is simply an instance factory (hence ifactory) function that automatically detects your Django models and tries to come up with acceptable defaults for the fields you don't care about. This includes generating unique values for fields marked as unique and to create related instances for non-nullable foreign keys.
Usage
This plugin comes with two fixtures: ifactory
and
transactional_ifactory
. Use them when you need to put model
instances in the database. ifactory
and transactional_ifactory
are identical except that the latter uses pytest-django's
transactional_db
fixture instead of the db
fixture. See
pytest-django's and Django's documentation for when you would want to
use it. Below is a contrived example to test a function that finds
duplicate names of your users:
from itertools import groupby
from operator import methodcaller
from django.contrib.auth.models import User
def get_duplicate_names():
all_users = User.objects.order_by("last_name", "first_name")
users_by_name = groupby(all_users, methodcaller("get_full_name"))
return [full_name for full_name, users in users_by_name if len(list(users)) > 1]
def test_get_duplicate_names(ifactory):
ifactory.auth.user(first_name="Albert", last_name="Einstein")
ifactory.auth.user(first_name="Albert", last_name="Einstein")
ifactory.auth.user(first_name="Erwin", last_name="Schrodinger")
ifactory.auth.user(first_name="Richard", last_name="Feynman")
assert get_duplicate_names() == ["Albert Einstein"]
assert User.objects.count() == 4
You find you models namespaced by the application name and the model
name on the ifactory
instance. For instance, if you have created a
Book
model in a library
application (and put your library
application in INSTALLED_APPS), its factory function will be
ifactory.library.book()
. This function accepts the same arguments as
your model constructor does and returns the created instance.
Notice in the example above that we create four new users without specifying their unique usernames. The goal of this project is that you should never have to specify the value of a field if you're not interested in that value in your test. Conversely, you should never rely on a value you haven't explicity set. This library gives no guarantees that the value it chooses for a field will be the same the next time the test is run. It just tries to make sure that the instance can be saved to the database without any integrity errors.
If you're running a type checker on your code, prefer the create()
method on ifactory
to get the correct return type:
ifactory.create(User, first_name="Albert", last_name="Einstein")
While I would recommend against it, if you do want to know which
default value will be used, you can use the
pytest_django_ifactory_configure
hook. A good place to put it is in
your conftest.py:
def pytest_django_ifactory_configure(ifactory):
ifactory.configure_defaults(
"auth.user", first_name="Albert", last_name="Einstein"
)
From now on, all users in your tests will be Albert Einstein unless you say otherwise:
def test_albert_by_default(ifactory):
albert = ifactory.auth.user()
assert albert.get_full_name() == "Albert Einstein"
not_albert = ifactory.auth.user(first_name="Erwin", last_name="Schrodinger")
assert not_albert.full_name() == "Erwin Schrodinger"
While the above example might not be the best idea as your test suit grows the hook can be used to enforce constraints in your models that this library is unaware of, e.g., validation errors raised by your models that depend on the model's field values.
Development
This project uses black to auto-format the code, ruff to lint it, mypy to type check it, pytest to test it, and finally check-manifest to check the project's MANIFEST.in. To facilitate (and remember) to actually run all these tools, pre-commit is used. Hence, the only hard development requirement is pre-commit. Install it and run
$ pre-commit install
once the first time you check out the repo and from now on all checks except the type and unit tests will be run everytime a commit is made. The type checking is run manually with mypy,
$ mypy .
and the unit tests are run with pytest
$ pytest
Gitlab CI is configured to run the tests with Python 3.8-3.11 and all supported Django LTS versions.
If you want to install all development requirements to run them
manually (and without using pre-commit run --all-files
), use the
optional dev
requirement group:
$ python -m pip install -e .[dev]
License
Like pytest-django, pytest-django-ifactory is released under the BSD 3-clause license.
Project details
Release history Release notifications | RSS feed
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
Hashes for pytest-django-ifactory-1.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4219f12053dfd17b358950dc10aded6ef5fbd37b51301c0dd2e731440da07bfc |
|
MD5 | 5e113d76f9780f57a8b7ae3a064dc8de |
|
BLAKE2b-256 | dff4b5b064167159e3c3021655902c3ece9d83d4c5b4f6f76d9184833c9a4e96 |
Hashes for pytest_django_ifactory-1.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4897991ce6bd9e122f577fecc9cfbf153e2c2e8a0d9d4e65473e02cdce6ee380 |
|
MD5 | 3d8a82b20aa4f40431771511fb6ceef1 |
|
BLAKE2b-256 | 748ce93d25f46c734313bd361812662e439374d0a152919432710165ce0baae7 |