Test Data Builders

Purpose

Before the framework, adding a required field to a shared object such as Account could break every test that created one. Tests also repeated default values and manually assembled related records, making setup brittle and difficult to maintain.

Implementation

Builders provide defaults for required and common fields for each object. They can return unsaved records for composition or save related records while resolving lookup relationships. Tests specify only the values relevant to the scenario, while builders create and connect dependent records as needed.

The user builder creates a test user with the profile and permissions needed for the scenario.

@TestSetup
static void testSetup() {
    TestUtil.user(UserConstant.PROFILE_READ_ONLY)
        .permissionSet(UserConstant.PERMISSION_SET_FINANCIAL_FEED)
        .permissionSet(UserConstant.PERMISSION_SET_PAYROLL)
        .save();
}

The test can then create and verify related records in that user context.

@IsTest
static void testContact() {
    System.runAs(TestUtil.testUser) {
        Account accountRecord = new AccountBuilder()
            .recordType(AccountConstant.RECORD_TYPE_HOUSEHOLD)
            .build();

        Contact contactRecord = new ContactBuilder()
            .account(accountRecord)
            .save();

        Assert.isNotNull(accountRecord.Name, 'Default value is provided for required Name field');
        Assert.isNotNull(accountRecord.Id, 'Account was saved with the contact');
        Assert.isNotNull(contactRecord.Id, 'Contact is saved');
        Assert.areEqual(accountRecord.Id, contactRecord.AccountId, 'Contact is linked to account');
    }
}

Test benefits

• Changes to required fields and default values are updated once in the appropriate builder.
• Tests focus on the values and relationships that matter to the scenario.
• Builders coordinate related records and avoid repeated setup for individual records.
• Test users receive a unique username for each test run, avoiding collisions when tests run in parallel.