Factory Boy for test data in Django - Mini Project: Build & Apply

Factory Boy for test data

📖 Scenario: You are building a Django app for a bookstore. You want to create test data easily for your Book model using Factory Boy.

🎯 Goal: Create a Factory Boy factory for the Book model to generate test data with fixed values and then use it to create a book instance.

📋 What You'll Learn

Create a Django model called Book with fields title (string) and author (string).

Create a Factory Boy factory class called BookFactory for the Book model.

Set default values for title and author in the factory.

Use the factory to create a Book instance.

💡 Why This Matters

🌍 Real World

Factories help developers quickly create realistic test data for Django models, making testing easier and more reliable.

💼 Career

Knowing how to use Factory Boy is valuable for Django developers writing automated tests and maintaining code quality.

1

Create the Book model

Create a Django model called Book in models.py with two fields: title as CharField with max length 100, and author as CharField with max length 100.

Django

from django.db import models

# Define the Book model below
# Your code here

Hint

Use models.CharField(max_length=100) for both fields.

2

Create the BookFactory class

In a new file factories.py, import factory and the Book model. Create a factory class called BookFactory that inherits from factory.django.DjangoModelFactory. Set the title field to 'The Great Gatsby' and the author field to 'F. Scott Fitzgerald'.

Django

from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=100)
    author = models.CharField(max_length=100)

import factory
from .models import Book

# Define BookFactory below
# Your code here

Hint

Remember to set class Meta with model = Book.

3

Use BookFactory to create a Book instance

In a test file or script, import BookFactory and create a book instance by calling BookFactory(). Assign it to a variable called book.

Django

from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=100)
    author = models.CharField(max_length=100)

import factory
from .models import Book

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

    title = 'The Great Gatsby'
    author = 'F. Scott Fitzgerald'

# Create a book instance using BookFactory
# Your code here

Hint

Call BookFactory() and assign it to book.

4

Add __str__ method to Book model

Add a __str__ method to the Book model that returns the book's title. This helps display the book nicely in Django admin and shell.

Django

from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=100)
    author = models.CharField(max_length=100)

    # Add __str__ method below
    # Your code here

import factory
from .models import Book

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

    title = 'The Great Gatsby'
    author = 'F. Scott Fitzgerald'

book = BookFactory()

Hint

Define def __str__(self): inside Book and return self.title.

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