Question 1

How do I generate test data for Wagtail pages with wagtail-factories?

Accepted Answer

Use the PageFactory class to create Wagtail Page instances; define a factory subclass with your model and customize fields via keyword arguments, as shown in the MyTestPageFactory example in the README. This simplifies setting parent pages, titles, and nested StreamField data.

Question 2

Can wagtail-factories handle Wagtail's ImageChooserBlock?

Accepted Answer

Yes, it provides an ImageChooserBlockFactory for generating image instances in tests. You can nest it within other factories, like in the MyCarouselItemFactory example, and customize attributes such as image titles using deep object syntax.

Question 3

What's the best way to create nested StreamField blocks with wagtail-factories?

Accepted Answer

Use StreamBlockFactory subclasses with SubFactory wrappers for child blocks, as demonstrated in the MyStreamBlockFactory example. This allows building complex StreamValues with declarative syntax, though note that nested stream blocks require the new syntax from version 3.0.

Question 4

How does wagtail-factories compare to using Django's built-in test fixtures?

Accepted Answer

Wagtail-factories is programmatic and dynamic, ideal for generating varied test data on-the-fly, while Django fixtures are static files better for consistent data. For Wagtail's complex models, factories reduce maintenance, but fixtures might be simpler for basic, unchanging data.

Question 5

Is there a guide for upgrading wagtail-factories to version 3.0?

Accepted Answer

The README highlights key changes, such as requiring SubFactory wrappers for block factories in StreamFieldFactory definitions. Review the 'Alternative StreamFieldFactory declaration syntax' section and update old code to wrap factories like MyBlockFactory in factory.SubFactory() to avoid errors.

Question 6

Does wagtail-factories work with custom Wagtail block models?

Accepted Answer

Yes, you can create custom factory classes by subclassing StructBlockFactory or other block factories and setting the model attribute in Meta, as shown with MyCarouselFactory. This allows generating instances of any Wagtail block type with customizable fields.

Wagtail Factories

What is Wagtail Factories?

Overview

Use Cases

Best For

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions