django - 在 pytest-factoryboy 中参数化具有多表继承的 Django 模型的属性

Question

我正在使用 Django并想使用 pytest 编写测试, pytest-django , pytest-factoryboy和 pytest-lazyfixtures .

我有使用多表继承的 Django 模型，如下所示:

class User(models.Model):
    created = models.DateTimeField()
    active = models.BooleanField()

class Editor(User):
    pass

class Admin(User):
   pass

我还为所有模型创建了工厂并注册了它们，例如:

class UserFactory(factory.django.DjangoModelFactory):
    class Meta:
        model = User

    created = ... # some datetime
    active = factory.Faker("pybool")

class EditorFactory(UserFactory):
    class Meta:
        model = Editor

...

现在我想测试一个可以采用 User 中的任何一个的函数, Editor或 Admin作为输入并使用所有用户类型和 active 的变体对测试进行参数化和 created ，像这样(不幸的是它不能那样工作):

@pytest.mark.parametrize("any_user", [lazy_fixture("user"), lazy_fixture("editor"), lazy_fixture("admin")])
@pytest.mark.parametrize("any_user__active", [True, False])
def test_some_func(any_user):
   ...  # test some stuff

但是失败了 In test_some_func: function uses no argument 'any_user__active' .

知道如何最好地解决这个问题吗？

我当然可以这样做，但它没有那么好:

@pytest.mark.parametrize("any_user", [lazy_fixture("user"), lazy_fixture("editor"), lazy_fixture("admin")])
@pytest.mark.parametrize("active", [True, False])
def test_some_func(any_user, active):
   any_user.active = active
   # save any_user if necessary
   ...  # test some stuff

有什么更好的建议吗？

Answer 1

在这种情况下，pytest-factoryboy 不像我希望的那样具有表现力。很高兴调用 pytest_factoryboy.register使用模型固定装置的替代名称 - 但不幸的是，即使 register需要一个 _name用于此目的的参数，_name被忽略，并且 underscore(factory_class._meta.model.__name__)改为使用。

值得庆幸的是，我们可以欺骗这个逻辑来使用我们想要的模型名称:

@register
class AnyUserFactory(UserFactory):
    class Meta:
        model = type('AnyUser', (User,), {})

本质上，我们创建了一个新的子类 User与名称 AnyUser .这将导致 pytest-factoryboy 创建 any_user模型 fixture ，以及 any_user__active , any_user__created等。现在，我们如何参数化 any_user使用 UserFactory , EditorFactory , 和 AdminFactory ?

再次谢天谢地，模型装置可以通过请求 model_name_factory 来工作。 fixture 与 request.getfixturevalue('model_name_factory') ，而不是直接引用 @register 'd 工厂类。结果是我们可以简单地覆盖 any_user_factory与我们希望的任何工厂!

@pytest.fixture(autouse=True, params=[
    lazy_fixture('user_factory'),
    lazy_fixture('editor_factory'),
    lazy_fixture('admin_factory'),
])
def any_user_factory(request):
    return request.param

注意:pytest 似乎根据测试方法 args 以及 fixture 请求的任何 args 修剪可用 fixture 的图形。当 fixture 使用 request.getfixturevalue , pytest 可能报告无法找到请求的装置——即使它被明确定义——因为它被修剪了。我们通过 autouse=True到我们的装置，强制 pytest 将其包含在依赖关系图中。

现在，我们可以参数化 any_user__active直接上我们的测试，和 any_user将是 User , Editor , 和 Admin每个值都是 active

@pytest.mark.parametrize('any_user__active', [True, False])
def test_some_func(any_user):
    print(f'{type(any_user)=} {any_user.active=}')

哪些输出:

py.test test.py -sq

type(any_user)=<class 'test.User'> any_user.active=True
.type(any_user)=<class 'test.User'> any_user.active=False
.type(any_user)=<class 'test.Editor'> any_user.active=True
.type(any_user)=<class 'test.Editor'> any_user.active=False
.type(any_user)=<class 'test.Admin'> any_user.active=True
.type(any_user)=<class 'test.Admin'> any_user.active=False
.
6 passed in 0.04s

另外，如果 @pytest.fixture与 request.param感觉有点冗长，我可能建议使用 pytest-lambda ( 免责声明: 我是作者)。有时， @pytest.mark.parametrize可能是限制性的，或者可能需要在未使用的测试方法中包含额外的 arg 名称；在这些情况下，无需编写完整的 fixture 方法就可以方便地声明新 fixture 。

from pytest_lambda import lambda_fixture

any_user_factory = lambda_fixture(autouse=True, params=[
    lazy_fixture('user_factory'),
    lazy_fixture('editor_factory'),
    lazy_fixture('admin_factory'),
])

@pytest.mark.parametrize('any_user__active', [True, False])
def test_some_func(any_user):
    print(f'{type(any_user)=} {any_user.active=}')

如果包括 autouse=True在 any_user_factory很麻烦，因为它会导致所有其他测试参数化，我们必须找到其他方法来包含 any_user_factory在 pytest 依赖图中。

不幸的是，我尝试的第一种方法导致错误。我试图覆盖 any_user fixture ，求原版 any_user fixture ，以及我们覆盖的 any_user_factory ， 像这样

@pytest.fixture
def any_user(any_user, any_user_factory):
    return any_user

唉，pytest 不喜欢那样

___________________________ ERROR collecting test.py ___________________________
In test_some_func: function uses no argument 'any_user__active'

幸运的是，pytest-lambda 提供了一个装饰器来包装一个fixture 函数，所以被装饰的方法和被包装的fixture 的参数都被保留了。这允许我们明确添加 any_user_factory到依赖图

from pytest_lambda import wrap_fixture

@pytest.fixture(params=[  # NOTE: no autouse
    lazy_fixture('user_factory'),
    lazy_fixture('editor_factory'),
    lazy_fixture('admin_factory'),
])
def any_user_factory(request):
    return request.param

@pytest.fixture
@wrap_fixture(any_user)
def any_user(any_user_factory, wrapped):
    return wrapped()  # calls the original any_user() fixture method

注意: @wrap_fixture(any_user)直接引用 any_user调用@register 时由pytest_factoryboy 定义的fixture 方法。它会在大多数静态代码检查器/IDE 中显示为未解析的引用；但只要出现在 class AnyUserFactory之后在同一个模块中，它会起作用。

现在，只测试请求 any_user会打 any_user_factory并接收其参数化。

@pytest.mark.parametrize('any_user__active', [True, False])
def test_some_func( any_user):
    print(f'{type(any_user)=} {any_user.active=}')

def test_some_other_func():
    print('some_other_func')

输出:

py.test test.py -sq

type(any_user)=<class 'test.User'> any_user.active=True
.type(any_user)=<class 'test.User'> any_user.active=False
.type(any_user)=<class 'test.Editor'> any_user.active=True
.type(any_user)=<class 'test.Editor'> any_user.active=False
.type(any_user)=<class 'test.Admin'> any_user.active=True
.type(any_user)=<class 'test.Admin'> any_user.active=False
.some_other_func
.
7 passed in 0.06 seconds