factory_boy
1.0.0
Factory_boy — это замена приспособлений, основанная на Factory_bot от thinkbot.
В качестве инструмента замены приспособлений он предназначен для замены статических, сложных в обслуживании приспособлений простыми в использовании фабриками для сложных объектов.
Вместо создания исчерпывающей настройки теста со всеми возможными комбинациями крайних случаев, factory_boy позволяет вам использовать объекты, настроенные для текущего теста, объявляя только поля, специфичные для теста:
class FooTests ( unittest . TestCase ):
def test_with_factory_boy ( self ):
# We need a 200€, paid order, shipping to australia, for a VIP customer
order = OrderFactory (
amount = 200 ,
status = 'PAID' ,
customer__is_vip = True ,
address__country = 'AU' ,
)
# Run the tests here
def test_without_factory_boy ( self ):
address = Address (
street = "42 fubar street" ,
zipcode = "42Z42" ,
city = "Sydney" ,
country = "AU" ,
)
customer = Customer (
first_name = "John" ,
last_name = "Doe" ,
phone = "+1234" ,
email = "[email protected]" ,
active = True ,
is_vip = True ,
address = address ,
)
# etc.Factory_boy разработан для хорошей работы с различными ORM (Django, MongoDB, SQLAlchemy) и может быть легко расширен для других библиотек.
Его основные особенности включают в себя:
PyPI: https://pypi.org/project/factory-boy/
$ pip install factory_boyИсточник: https://github.com/FactoryBoy/factory_boy/
$ git clone git://github.com/FactoryBoy/factory_boy/
$ python setup.py installПримечание
В этом разделе представлен краткий обзор возможностей Factory_boy. Более подробный список доступен в полной документации.
Фабрики объявляют набор атрибутов, используемых для создания экземпляра объекта Python. Класс объекта должен быть определен в поле model атрибута class Meta: :
import factory
from . import models
class UserFactory ( factory . Factory ):
class Meta :
model = models . User
first_name = 'John'
last_name = 'Doe'
admin = False
# Another, different, factory for the same object
class AdminFactory ( factory . Factory ):
class Meta :
model = models . User
first_name = 'Admin'
last_name = 'User'
admin = True Интеграция Factory_boy с инструментами реляционного сопоставления объектов (ORM) обеспечивается через определенные подклассы factory.Factory :
factory.django.DjangoModelFactoryfactory.mogo.MogoFactoryfactory.mongoengine.MongoEngineFactoryfactory.alchemy.SQLAlchemyModelFactoryБолее подробную информацию можно найти в разделе ORM.
Factory_boy поддерживает несколько различных стратегий создания экземпляров: сборку, создание и заглушку:
# Returns a User instance that's not saved
user = UserFactory . build ()
# Returns a saved User instance.
# UserFactory must subclass an ORM base class, such as DjangoModelFactory.
user = UserFactory . create ()
# Returns a stub object (just a bunch of attributes)
obj = UserFactory . stub ()Вы можете использовать класс Factory как ярлык для стратегии создания экземпляров по умолчанию:
# Same as UserFactory.create()
user = UserFactory ()Независимо от того, какая стратегия используется, определенные атрибуты можно переопределить, передав аргументы ключевого слова:
# Build a User instance and override first_name
>>> user = UserFactory.build( first_name = ' Joe ' )
>>> user.first_name
"Joe"Также возможно создать группу объектов за один вызов:
>>> users = UserFactory.build_batch( 10 , first_name = " Joe " )
>>> len (users)
10
>>> [user.first_name for user in users]
["Joe", "Joe", "Joe", "Joe", "Joe", "Joe", "Joe", "Joe", "Joe", "Joe"]Демо-версии выглядят лучше со случайными, но реалистичными значениями; и эти реалистичные значения также могут помочь обнаружить ошибки. Для этого Factory_boy использует отличную библиотеку фейкеров:
class RandomUserFactory ( factory . Factory ):
class Meta :
model = models . User
first_name = factory . Faker ( 'first_name' )
last_name = factory . Faker ( 'last_name' )>>> RandomUserFactory()
<User: Lucy Murray> Использование полностью рандомизированных данных в тестах быстро становится проблемой для воспроизведения неработающих сборок. Для этой цели Factory_boy предоставляет помощники для обработки используемых им случайных начальных значений, расположенные в модуле factory.random :
import factory . random
def setup_test_environment ():
factory . random . reseed_random ( 'my_awesome_project' )
# Other setup hereБольшинство атрибутов фабрики можно добавить с использованием статических значений, которые оцениваются при определении фабрики, но для некоторых атрибутов (например, полей, значение которых вычисляется на основе других элементов) потребуются значения, присваиваемые каждый раз при создании экземпляра.
Эти «ленивые» атрибуты можно добавить следующим образом:
class UserFactory ( factory . Factory ):
class Meta :
model = models . User
first_name = 'Joe'
last_name = 'Blow'
email = factory . LazyAttribute ( lambda a : '{}.{}@example.com' . format ( a . first_name , a . last_name ). lower ())
date_joined = factory . LazyFunction ( datetime . now )>>> UserFactory().email
"[email protected]"Примечание
LazyAttribute вызывает функцию с конструируемым объектом в качестве аргумента, когда LazyFunction не отправляет никаких аргументов.
Уникальные значения в определенном формате (например, адреса электронной почты) можно генерировать с помощью последовательностей. Последовательности определяются с помощью Sequence или sequence декораторов:
class UserFactory ( factory . Factory ):
class Meta :
model = models . User
email = factory . Sequence ( lambda n : 'person{}@example.com' . format ( n ))
> >> UserFactory (). email
'[email protected]'
> >> UserFactory (). email
'[email protected]' Некоторые объекты имеют сложное поле, которое само должно быть определено с помощью специальной фабрики. Это обрабатывается помощником SubFactory :
class PostFactory ( factory . Factory ):
class Meta :
model = models . Post
author = factory . SubFactory ( UserFactory )Будет использоваться стратегия связанного объекта:
# Builds and saves a User and a Post
> >> post = PostFactory ()
> >> post . id is None # Post has been 'saved'
False
> >> post . author . id is None # post.author has been saved
False
# Builds but does not save a User, and then builds but does not save a Post
> >> post = PostFactory . build ()
> >> post . id is None
True
> >> post . author . id is None
True factory_boy поддерживает активные версии Python, а также PyPy3.
Отладка Factory_boy может быть довольно сложной из-за длинных цепочек вызовов. Подробная регистрация доступна через factory регистратор.
Для облегчения отладки доступен помощник Factory.debug():
with factory . debug ():
obj = TestModel2Factory ()
import logging
logger = logging . getLogger ( 'factory' )
logger . addHandler ( logging . StreamHandler ())
logger . setLevel ( logging . DEBUG )Это приведет к появлению сообщений, подобных этим (искусственный отступ):
BaseFactory: Preparing tests.test_using.TestModel2Factory( extra ={})
LazyStub: Computing values for tests.test_using.TestModel2Factory( two =<OrderedDeclarationWrapper for <factory.declarations.SubFactory object at 0x1e15610>>)
SubFactory: Instantiating tests.test_using.TestModelFactory( __containers =(<LazyStub for tests.test_using.TestModel2Factory>,), one =4), create =True
BaseFactory: Preparing tests.test_using.TestModelFactory( extra ={ ' __containers ' : (<LazyStub for tests.test_using.TestModel2Factory>,), ' one ' : 4})
LazyStub: Computing values for tests.test_using.TestModelFactory( one =4)
LazyStub: Computed values, got tests.test_using.TestModelFactory( one =4)
BaseFactory: Generating tests.test_using.TestModelFactory( one =4)
LazyStub: Computed values, got tests.test_using.TestModel2Factory( two =<tests.test_using.TestModel object at 0x1e15410>)
BaseFactory: Generating tests.test_using.TestModel2Factory( two =<tests.test_using.TestModel object at 0x1e15410>)Factory_boy распространяется по лицензии MIT.
Проблемы следует открывать через GitHub Issues; по возможности следует включать запрос на включение. Вопросы и предложения приветствуются в списке рассылки.
Зависимости разработки могут быть установлены в виртуальном окружении с помощью:
$ pip install --editable ' .[dev] 'Все запросы на включение должны пройти набор тестов, который можно запустить просто с помощью:
$ make testallДля проверки покрытия используйте:
$ make coverage Чтобы протестировать конкретную версию платформы, вы можете использовать цель tox :
# list all tox environments
$ tox --listenvs
# run tests inside a specific environment (django/mongoengine/SQLAlchemy are not installed)
$ tox -e py310
# run tests inside a specific environment (django)
$ tox -e py310-djangomain
# run tests inside a specific environment (alchemy)
$ tox -e py310-alchemy
# run tests inside a specific environment (mongoengine)
$ tox -e py310-mongo Для пользователей, заинтересованных в упаковке FactoryBoy в последующие каналы распространения (например, .deb , .rpm , .ebuild ), могут быть полезны следующие советы:
Зависимости пакета во время выполнения перечислены в setup.cfg . Зависимости, полезные для создания и тестирования библиотеки, описаны в дополнительных материалах dev и doc .
Более того, все задачи разработки/тестирования выполняются через make(1) .
Чтобы запустить этапы сборки (пока только для документации), запустите:
python setup.py egg_info
make docПри тестировании активной среды Python выполните следующее:
make testПримечание
Вы должны убедиться, что factory модуль можно импортировать, поскольку он импортируется из тестового кода.
