pytest-factoryboy 2.7.0

安装 pytest-factoryboy

pip install pytest-factoryboy

概念

库导出一个函数，用于注册作为 fixtures 的工厂。fixtures 被贡献到调用注册函数的同一模块。

模型 fixtures

模型 fixture 实现了工厂创建的模型实例。命名约定为模型的下划线小写类名。

import factory
from pytest_factoryboy import register

@register
class AuthorFactory(factory.Factory):
    class Meta:
        model = Author

    name = "Charles Dickens"


def test_model_fixture(author):
    assert author.name == "Charles Dickens"

属性是 Fixtures

自动创建了工厂属性的 fixtures。属性名称以模型 fixture 名称和双下划线（类似于 factory_boy 使用的约定）开头。

@pytest.mark.parametrize("author__name", ["Bill Gates"])
def test_model_fixture(author):
    assert author.name == "Bill Gates"

多个 fixtures

模型 fixtures 可以用特定的名称进行注册。例如，如果您用“first”、“second”或另一个父对象的名称来引用某些集合的实例

register(AuthorFactory)  # author
register(AuthorFactory, "second_author")  # second_author


@register  # book
@register(_name="second_book")  # second_book
@register(_name="other_book")  # other_book, book of another author
class BookFactory(factory.Factory):
    class Meta:
        model = Book


@pytest.fixture
def other_book__author(second_author):
    """Make the relation of the `other_book.author` to `second_author`."""
    return second_author


def test_book_authors(book, second_book, other_book, author, second_author):
    assert book.author == second_book.author == author
    assert other_book.author == second_author

子工厂

子工厂属性指向子工厂的模型 fixture。子工厂的属性作为依赖注入到模型 fixture 中，并且可以通过参数化进行覆盖。

相关工厂

相关工厂属性指向相关工厂的模型 fixture。相关工厂的属性作为依赖注入到模型 fixture 中，并且可以通过参数化进行覆盖。

后生成

后生成属性 fixture 仅实现后生成函数的提取值。

工厂 fixture

pytest-factoryboy 还注册了工厂 fixtures，以允许在没有导入它们的情况下使用它们。fixture 名称约定是使用类名的小写下划线形式。

import factory
from pytest_factoryboy import register

class AuthorFactory(factory.Factory):
    class Meta:
        model = Author


register(AuthorFactory)  # => author_factory


def test_factory_fixture(author_factory):
    author = author_factory(name="Charles Dickens")
    assert author.name == "Charles Dickens"

集成

factory_boy 和 pytest 集成的示例。

# tests/factories.py

import factory
from app import models
from faker import Factory as FakerFactory

faker = FakerFactory.create()


class AuthorFactory(factory.django.DjangoModelFactory):
    class Meta:
        model = models.Author

    name = factory.LazyFunction(lambda: faker.name())


class BookFactory(factory.django.DjangoModelFactory):
    class Meta:
        model = models.Book

    title = factory.LazyFunction(lambda: faker.sentence(nb_words=4))
    author = factory.SubFactory(AuthorFactory)

# tests/conftest.py

from pytest_factoryboy import register

from . import factories

register(factories.AuthorFactory)
register(factories.BookFactory)

# tests/test_models.py

from app.models import Book
from .factories import BookFactory


def test_book_factory(book_factory):
    """Factories become fixtures automatically."""
    assert book_factory is BookFactory


def test_book(book):
    """Instances become fixtures automatically."""
    assert isinstance(book, Book)


@pytest.mark.parametrize("book__title", ["PyTest for Dummies"])
@pytest.mark.parametrize("author__name", ["Bill Gates"])
def test_parametrized(book):
    """You can set any factory attribute as a fixture using naming convention."""
    assert book.title == "PyTest for Dummies"
    assert book.author.name == "Bill Gates"

Fixture 部分特化

可以通过传递关键字参数来传递，以在 fixture 注册期间覆盖工厂属性值。这在您的测试用例请求大量 fixture 风味时很有用。太多对于常规的 pytest 参数化。在这种情况下，您可以在本地测试模块中注册 fixture 风味，并在 register 函数调用中指定值偏差。

register(AuthorFactory, "male_author", gender="M", name="John Doe")
register(AuthorFactory, "female_author", gender="F")


@pytest.fixture
def female_author__name():
    """Override female author name as a separate fixture."""
    return "Jane Doe"


@pytest.mark.parametrize("male_author__age", [42])  # Override even more
def test_partial(male_author, female_author):
    """Test fixture partial specialization."""
    assert male_author.gender == "M"
    assert male_author.name == "John Doe"
    assert male_author.age == 42

    assert female_author.gender == "F"
    assert female_author.name == "Jane Doe"

Fixture 属性

有时需要将另一个 fixture 的实例作为属性值传递给工厂。可以在需要的位置覆盖生成的属性 fixture，以便可以请求作为 fixture 依赖项的所需值。还有一个用于 fixture 的懒加载包装器，可以在参数化中使用，而不需要在模块中定义 fixtures。

LazyFixture 构造函数接受现有 fixture 名称或带有依赖项的可调用对象

import pytest
from pytest_factoryboy import register, LazyFixture


@pytest.mark.parametrize("book__author", [LazyFixture("another_author")])
def test_lazy_fixture_name(book, another_author):
    """Test that book author is replaced with another author by fixture name."""
    assert book.author == another_author


@pytest.mark.parametrize("book__author", [LazyFixture(lambda another_author: another_author)])
def test_lazy_fixture_callable(book, another_author):
    """Test that book author is replaced with another author by callable."""
    assert book.author == another_author


# Can also be used in the partial specialization during the registration.
register(BookFactory, "another_book", author=LazyFixture("another_author"))

通用容器类作为模型

通常很有用为 dict 或其他通用容器类创建工厂。在这种情况下，您应该将容器类包装在 named_model(...) 中，以便 pytest-factoryboy 可以在将其用于 SubFactory 或 RelatedFactory 时正确确定模型名称。

否则，pytest-factoryboy 将引发警告。

例如

import factory
from pytest_factoryboy import named_model, register

@register
class JSONPayload(factory.Factory):
    class Meta:
        model = named_model("JSONPayload", dict)

    name = "foo"


def test_foo(json_payload):
    assert json_payload.name == "foo"

作为额外的好处，工厂自动注册了 json_payload fixture（而不是 dict），因此无需覆盖 @register(_name="json_payload"))。

钩子

pytest-factoryboy公开了几个pytest钩子，这些钩子可能对例如控制数据库事务、报告等很有帮助。

• pytest_factoryboy_done(request) - 在所有基于工厂的固定和它们的生成后操作评估完成后调用。

许可协议

本软件遵循MIT许可证。

© 2015 Oleg Pidsadnyi, Anatoly Bubenkov和其他人