Factory Boy for test data in Django - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Factory Boy used for in Django testing?

Factory Boy helps create test data easily by defining blueprints (factories) for your models. It saves time and keeps tests clean.

beginner

How do you define a simple Factory Boy factory for a Django model?

You create a class inheriting from <code>factory.django.DjangoModelFactory</code> and set the model inside a <code>class Meta</code>. Then define fields with default values.

beginner

What method do you call to create and save an instance using Factory Boy?

Use FactoryClass.create() to make and save an instance to the database.

intermediate

How can Factory Boy help with related models in Django?

You can use SubFactory to create related model instances automatically when creating the main model instance.

beginner

Why is Factory Boy better than manually creating test data in Django tests?

Factory Boy reduces repetitive code, makes test data consistent, and improves test readability and maintenance.

Which class should a Factory Boy factory inherit from for Django models?

A factory.ModelFactory

B factory.Factory

C django.test.TestCase

D factory.django.DjangoModelFactory

For Django models, factories inherit from factory.django.DjangoModelFactory to integrate with Django ORM.

What does the create() method do in Factory Boy?

A Creates and saves an instance to the database

B Only creates an instance without saving

C Deletes a test instance

D Updates an existing instance

create() makes a new instance and saves it to the database.

How do you define a related model inside a Factory Boy factory?

A Using SubFactory

B Using ForeignKeyField

C Using RelatedFactory

D Using RelatedModel

SubFactory is used to create related model instances automatically.

Which of these is NOT a benefit of using Factory Boy?

A Improves test readability

B Reduces repetitive test data code

C Automatically runs tests

D Keeps test data consistent

Factory Boy helps with test data but does not run tests automatically.

Where do you specify the Django model inside a Factory Boy factory?

A As a class attribute named model_class

B Inside the Meta class as model

C In the factory's __init__ method

D In the factory's create method

The Django model is set inside a nested Meta class as the model attribute.

Explain how to create a Factory Boy factory for a Django model and use it to generate test data.

Think about the class structure and how to call the factory.

Describe how Factory Boy handles related models when creating test data in Django.

Focus on how factories connect to other factories.

Practice

1. What is the main purpose of using Factory Boy in Django testing?

easy

A. To create reusable fake data for tests easily

B. To speed up the Django server

C. To replace Django's ORM

D. To deploy Django applications automatically

Solution

1. Step 1: Understand Factory Boy's role

   Factory Boy is designed to generate fake data for tests, making test setup easier and less repetitive.

2. Step 2: Eliminate unrelated options

   Speeding up the server, replacing ORM, or deployment are unrelated to test data creation.

3. Final Answer:

   To create reusable fake data for tests easily -> Option A

4. Quick Check:

   Factory Boy = reusable fake test data [OK]

Hint: Factory Boy = fake test data creator [OK]

Common Mistakes:

• Thinking Factory Boy speeds up the server
• Confusing Factory Boy with deployment tools
• Assuming Factory Boy replaces Django ORM

2. Which of the following is the correct way to define a basic factory for a Django model Book using Factory Boy?

easy

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

B. class BookFactory(factory.Factory): model = Book

C. class BookFactory(factory.ModelFactory): model = Book

D. class BookFactory(factory.DjangoFactory): class Meta: model = Book

Solution

1. Step 1: Identify correct base class

   Factory Boy uses DjangoModelFactory as the base class for Django models.

2. Step 2: Check Meta class usage

   The model must be specified inside a nested Meta class with attribute model.

3. Final Answer:

   class BookFactory(factory.DjangoModelFactory): class Meta: model = Book -> Option A

4. Quick Check:

   DjangoModelFactory + Meta.model = correct syntax [OK]

Hint: Use DjangoModelFactory with Meta.model for Django models [OK]

Common Mistakes:

• Using factory.Factory instead of DjangoModelFactory
• Not using a Meta class for model assignment
• Using incorrect base class names

3. Given this factory definition:

class UserFactory(factory.DjangoModelFactory):
    class Meta:
        model = User
    username = factory.Faker('user_name')
    email = factory.Faker('email')

What will UserFactory().username return?

medium

A. None, because username is not set

B. The literal string 'user_name'

C. An error because Faker is not imported

D. A random username string generated by Faker

Solution

1. Step 1: Understand Faker usage in Factory Boy

   Using factory.Faker('user_name') generates a random username string each time the factory is called.

2. Step 2: Evaluate the expression UserFactory().username

   Calling UserFactory() creates a User instance with a random username, so .username returns that random string.

3. Final Answer:

   A random username string generated by Faker -> Option D

4. Quick Check:

   Faker('user_name') = random username string [OK]

Hint: Faker fields produce random data, not literals [OK]

Common Mistakes:

• Thinking Faker returns the field name as string
• Assuming missing imports cause runtime error here
• Expecting None if not explicitly set

4. What is wrong with this factory code?

class ProductFactory(factory.DjangoModelFactory):
    class Meta:
        model = Product
    name = factory.Faker('product_name')
    price = factory.Faker('float')

medium

A. Faker does not have a 'product_name' provider

B. The 'float' provider requires arguments to specify range

C. Missing import of factory module

D. Meta class should be outside the factory class

Solution

1. Step 1: Check Faker providers used

   Faker has no built-in 'product_name' provider, but this is a common custom name; however, 'float' requires arguments like min and max.

2. Step 2: Identify the error cause

   Using factory.Faker('float') without arguments causes an error because Faker's float provider needs parameters.

3. Final Answer:

   The 'float' provider requires arguments to specify range -> Option B

4. Quick Check:

   Faker float needs min/max args [OK]

Hint: Faker float needs range arguments to work [OK]

Common Mistakes:

• Assuming 'product_name' is always valid
• Ignoring required arguments for Faker float
• Thinking Meta class placement is wrong

5. You want to create a factory for a Django model Order that has a foreign key to User. How do you correctly define the user field in OrderFactory to use UserFactory?

hard

A. user = UserFactory()

B. user = factory.RelatedFactory(UserFactory)

C. user = factory.SubFactory(UserFactory)

D. user = factory.Faker('user')

Solution

1. Step 1: Understand foreign key factory usage

   To link a foreign key to another factory, use factory.SubFactory with the related factory class.

2. Step 2: Evaluate options

   Directly calling UserFactory() assigns an instance at class load time, not per object. RelatedFactory is for reverse relations. Faker does not create model instances.

3. Final Answer:

   user = factory.SubFactory(UserFactory) -> Option C

4. Quick Check:

   Foreign key uses SubFactory [OK]

Hint: Use SubFactory for foreign key relations [OK]

Common Mistakes:

• Calling UserFactory() directly in factory field
• Using RelatedFactory for foreign keys
• Using Faker for model relations