factory_boy
1.0.0
factory_boy adalah pengganti perlengkapan berdasarkan factory_bot milik thoughtbot.
Sebagai alat pengganti perlengkapan, alat ini bertujuan untuk menggantikan perlengkapan statis dan sulit dirawat dengan pabrik yang mudah digunakan untuk objek kompleks.
Daripada membangun pengaturan pengujian yang menyeluruh dengan setiap kemungkinan kombinasi kasus sudut, factory_boy memungkinkan Anda menggunakan objek yang disesuaikan untuk pengujian saat ini, sementara hanya mendeklarasikan bidang khusus pengujian:
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 dirancang untuk bekerja dengan baik dengan berbagai ORM (Django, MongoDB, SQLAlchemy), dan dapat dengan mudah diperluas untuk perpustakaan lain.
Fitur utamanya meliputi:
PyPI: https://pypi.org/project/factory-boy/
$ pip install factory_boySumber: https://github.com/FactoryBoy/factory_boy/
$ git clone git://github.com/FactoryBoy/factory_boy/
$ python setup.py installCatatan
Bagian ini memberikan ringkasan singkat tentang fitur factory_boy. Daftar yang lebih rinci tersedia di dokumentasi lengkap.
Pabrik mendeklarasikan sekumpulan atribut yang digunakan untuk membuat instance objek Python. Kelas objek harus didefinisikan dalam bidang model atribut 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 Integrasi factory_boy dengan alat Object Relational Mapping (ORM) disediakan melalui subkelas factory.Factory tertentu:
factory.django.DjangoModelFactoryfactory.mogo.MogoFactoryfactory.mongoengine.MongoEngineFactoryfactory.alchemy.SQLAlchemyModelFactoryDetail lebih lanjut dapat ditemukan di bagian ORM.
factory_boy mendukung beberapa strategi instantiasi yang berbeda: build, create, dan stub:
# 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 ()Anda dapat menggunakan kelas Pabrik sebagai pintasan untuk strategi instantiasi default:
# Same as UserFactory.create()
user = UserFactory ()Apa pun strategi yang digunakan, atribut yang ditentukan dapat diganti dengan meneruskan argumen kata kunci:
# Build a User instance and override first_name
>>> user = UserFactory.build( first_name = ' Joe ' )
>>> user.first_name
"Joe"Dimungkinkan juga untuk membuat banyak objek dalam satu panggilan:
>>> 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"]Demo terlihat lebih baik dengan nilai acak namun realistis; dan nilai-nilai realistis tersebut juga dapat membantu menemukan bug. Untuk ini, factory_boy mengandalkan perpustakaan pemalsu yang luar biasa:
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> Penggunaan data yang diacak sepenuhnya dalam pengujian dengan cepat menjadi masalah dalam mereproduksi build yang rusak. Untuk tujuan tersebut, factory_boy menyediakan pembantu untuk menangani benih acak yang digunakannya, yang terletak di modul factory.random :
import factory . random
def setup_test_environment ():
factory . random . reseed_random ( 'my_awesome_project' )
# Other setup hereSebagian besar atribut pabrik dapat ditambahkan menggunakan nilai statis yang dievaluasi ketika pabrik ditentukan, namun beberapa atribut (seperti bidang yang nilainya dihitung dari elemen lain) akan memerlukan nilai yang ditetapkan setiap kali sebuah instance dibuat.
Atribut "malas" ini dapat ditambahkan sebagai berikut:
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]"Catatan
LazyAttribute memanggil fungsi dengan objek yang sedang dibangun sebagai argumen, ketika LazyFunction tidak mengirimkan argumen apa pun.
Nilai unik dalam format tertentu (misalnya, alamat email) dapat dihasilkan menggunakan urutan. Urutan didefinisikan dengan menggunakan Sequence atau dekorator 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]' Beberapa objek memiliki bidang yang kompleks, yang seharusnya ditentukan dari pabrik khusus. Ini ditangani oleh pembantu SubFactory :
class PostFactory ( factory . Factory ):
class Meta :
model = models . Post
author = factory . SubFactory ( UserFactory )Strategi objek terkait akan digunakan:
# 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 mendukung versi Python aktif serta PyPy3.
Men-debug factory_boy bisa jadi agak rumit karena rangkaian panggilan yang panjang. Pencatatan log terperinci tersedia melalui logger factory .
Helper, factory.debug(), tersedia untuk memudahkan proses debug:
with factory . debug ():
obj = TestModel2Factory ()
import logging
logger = logging . getLogger ( 'factory' )
logger . addHandler ( logging . StreamHandler ())
logger . setLevel ( logging . DEBUG )Ini akan menghasilkan pesan yang mirip dengan pesan tersebut (lekukan buatan):
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 didistribusikan di bawah Lisensi MIT.
Masalah harus dibuka melalui GitHub Issues; bila memungkinkan, permintaan penarikan harus disertakan. Pertanyaan dan saran diterima di milis.
Ketergantungan pengembangan dapat diinstal di virtualenv dengan:
$ pip install --editable ' .[dev] 'Semua permintaan penarikan harus lulus rangkaian pengujian, yang dapat diluncurkan hanya dengan:
$ make testallUntuk menguji cakupan, silakan gunakan:
$ make coverage Untuk menguji dengan versi kerangka kerja tertentu, Anda dapat menggunakan target 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 Bagi pengguna yang tertarik mengemas FactoryBoy ke dalam saluran distribusi hilir (misalnya .deb , .rpm , .ebuild ), tips berikut mungkin bisa membantu:
Dependensi run-time paket tercantum di setup.cfg . Dependensi yang berguna untuk membangun dan menguji perpustakaan dicakup oleh tambahan dev dan doc .
Selain itu, semua tugas pengembangan/pengujian didorong melalui make(1) .
Untuk menjalankan langkah-langkah pembangunan (saat ini hanya untuk dokumen), jalankan:
python setup.py egg_info
make docSaat menguji lingkungan Python aktif, jalankan perintah berikut:
make testCatatan
Anda harus memastikan bahwa modul factory dapat diimpor, karena diimpor dari kode pengujian.
