Files
saqel/backend/.claude/skills/testing-best-practices/rules/test-data.md
T

2.6 KiB

Factories and Test Data

Each Test Makes Its Own Data

Create mutable records inside each test or through a private helper that the test calls. This keeps setup visible and lets each test select its factory state.

Use setUp() only for configuration that applies to every test in the class. Do not create records in it, because its objects remain in memory until the suite ends.

Record Construction

  • Use create() if the test needs the record in the database.
  • Use make() only if the test does not need the database. Examples include rendering a notification and testing a value object's behavior.
  • Use a named factory state instead of a raw attribute. User::factory()->unverified()->create() gives the state meaning; create(['email_verified_at' => null]) gives only its value.
  • Use for() or the relationship helper of the project to declare the owner of a record.
  • Use recycle() if several records must share one parent record.
  • Use sequence() if several records need different attributes.
$organization = Organization::factory()->onPlan(BillingPlan::PRO)->create();

$environment = Environment::factory()->recycle($organization)->create();

$organizations = Organization::factory()
    ->count(3)
    ->sequence(
        ['created_at' => now()->setSeconds(30)],
        ['created_at' => now()->setSeconds(1)],
    )
    ->create();

Create only the records required to arrange the behavior or support an assertion.

The Data Providers

Use a data provider when the setup, test body, and assertions remain the same across input values.

public static function nonAdminRoles(): array
{
    return collect(Role::cases())
        ->reject(fn (Role $role): bool => $role === Role::ADMIN)
        ->mapWithKeys(fn (Role $role): array => [$role->value => [$role]])
        ->all();
}

#[DataProvider('nonAdminRoles')]
public function test_forbids_roles_other_than_admin(Role $role): void
{
    $this->actingAs(User::factory()->hasOrganization($role)->create())
        ->post('/settings')
        ->assertForbidden();
}

Declare each data provider method as public static.

Use parameterized tests for:

  • the cases of an enum
  • the roles and the plans
  • the boundary values
  • the input values that are not valid in the same way
  • the pairs of an input value and an output value

Write separate tests if the cases need a different setup, a different behavior, or different assertions. One test function with a branch in the body is two tests in one function.

Give each data-provider case a key that states the difference. A failure then identifies the case without requiring you to count positions.