Builder pattern for test data in JUnit - Build an Automation Script

Create and verify a User object using Builder pattern

Preconditions (2)

Step 1: Use the User.Builder to create a User with name 'Alice', age 30, and email '[e-mail]'

Step 2: Verify that the User object has name 'Alice'

Step 3: Verify that the User object has age 30

Step 4: Verify that the User object has email '[e-mail]'

✅ Expected Result: User object is created correctly with the specified attributes

Automation Requirements - JUnit 5

Assertions Needed:

assertEquals for name

assertEquals for age

assertEquals for email

Best Practices:

Use Builder pattern to create test data

Use clear and descriptive assertion messages

Keep test method focused on one scenario

Automated Solution

JUnit

import static org.junit.jupiter.api.Assertions.assertEquals;
import org.junit.jupiter.api.Test;

public class UserTest {

    @Test
    void testUserBuilderCreatesCorrectUser() {
        User user = new User.Builder()
                .name("Alice")
                .age(30)
                .email("[e-mail]")
                .build();

        assertEquals("Alice", user.getName(), "User name should be Alice");
        assertEquals(30, user.getAge(), "User age should be 30");
        assertEquals("[e-mail]", user.getEmail(), "User email should be [e-mail]");
    }
}

// User class with Builder pattern
class User {
    private final String name;
    private final int age;
    private final String email;

    private User(Builder builder) {
        this.name = builder.name;
        this.age = builder.age;
        this.email = builder.email;
    }

    public String getName() {
        return name;
    }

    public int getAge() {
        return age;
    }

    public String getEmail() {
        return email;
    }

    public static class Builder {
        private String name;
        private int age;
        private String email;

        public Builder name(String name) {
            this.name = name;
            return this;
        }

        public Builder age(int age) {
            this.age = age;
            return this;
        }

        public Builder email(String email) {
            this.email = email;
            return this;
        }

        public User build() {
            return new User(this);
        }
    }
}

This test uses the Builder pattern to create a User object with specific attributes.

The User.Builder class allows setting each attribute step-by-step, making the test data creation clear and flexible.

Assertions check that the User object has the expected name, age, and email.

Each assertion includes a message to help understand failures.

This approach keeps the test clean and focused on verifying the builder functionality.

Common Mistakes - 3 Pitfalls

Creating User object directly without using Builder

Not asserting all fields set by the Builder

Using hardcoded strings in multiple places without variables

Bonus Challenge

Now add data-driven testing with 3 different User inputs using JUnit 5 parameterized tests

Show Hint

Practice

1. What is the main benefit of using the Builder pattern for test data in JUnit tests?

easy

A. It automatically runs tests faster without code changes.

B. It generates random test data without any setup.

C. It replaces the need for assertions in tests.

D. It creates test data with clear, readable, and flexible code.

Solution

1. Step 1: Understand Builder pattern purpose

   The Builder pattern helps create objects step-by-step with readable code.

2. Step 2: Relate to test data creation

   Using Builder for test data makes tests clearer and easier to maintain by avoiding repeated setup code.

3. Final Answer:

   It creates test data with clear, readable, and flexible code. -> Option D

4. Quick Check:

   Builder pattern = clear, flexible test data [OK]

Hint: Builder pattern improves test data clarity and flexibility [OK]

Common Mistakes:

• Thinking Builder speeds up test execution
• Believing Builder removes need for assertions
• Confusing Builder with random data generation

2. Which of the following is the correct way to start a Builder for a User object in JUnit?

easy

A. User user = User.builder().setName("Alice").build();

B. User user = new User.Builder().setName("Alice").build();

C. User user = new User().builder().setName("Alice").build();

D. User user = User.build().setName("Alice").builder();

Solution

1. Step 1: Identify common Builder syntax

   Usually, Builder is started with a static method like builder() on the class.

2. Step 2: Check method chaining order

   Correct chaining is User.builder().setName(...).build(). User user = User.builder().setName("Alice").build(); matches this.

3. Final Answer:

   User user = User.builder().setName("Alice").build(); -> Option A

4. Quick Check:

   Static builder() method starts Builder [OK]

Hint: Start Builder with ClassName.builder() static method [OK]

Common Mistakes:

• Using new User.Builder() instead of User.builder()
• Calling builder() on an instance instead of class
• Mixing build() and builder() order

3. Given this Builder code snippet, what will be the value of user.getAge()?

var user = User.builder()
  .setName("Bob")
  .setAge(30)
  .setAge(25)
  .build();

medium

A. 30

B. 25

C. null

D. Compilation error

Solution

1. Step 1: Analyze method calls order

   The Builder sets age first to 30, then overwrites it to 25 before build.

2. Step 2: Understand final value assignment

   The last call to setAge(25) overwrites previous age, so final age is 25.

3. Final Answer:

   25 -> Option B

4. Quick Check:

   Last setter call wins = 25 [OK]

Hint: Last setter call overwrites previous value [OK]

Common Mistakes:

• Assuming first setAge value remains
• Thinking Builder merges values
• Expecting compilation error due to repeated setters

4. Identify the error in this Builder usage for a Product test data:

var product = Product.builder()
  .setName("Book")
  .setPrice(-10)
  .build();

medium

A. Negative price should be rejected or cause error.

B. Missing call to build() method.

C. Builder must be created with new keyword.

D. setName() cannot be called before setPrice().

Solution

1. Step 1: Check Builder method calls

   Builder calls setName, setPrice, then build() correctly.

2. Step 2: Validate data correctness

   Price is set to -10, which is invalid for product price and should be rejected or throw error.

3. Final Answer:

   Negative price should be rejected or cause error. -> Option A

4. Quick Check:

   Invalid data in Builder = error [OK]

Hint: Check for invalid data values in Builder calls [OK]

Common Mistakes:

• Thinking build() call is missing
• Assuming new keyword is required for Builder
• Believing setter order matters

5. You want to create multiple Order test objects with different status but same customerId and amount. How can you best use the Builder pattern to avoid repeating common fields?

hard

A. Use static variables for common fields and set status directly on Order after build.

B. Write separate Builder calls fully for each Order with all fields repeated.

C. Create a base Builder with common fields, then clone and set different statuses before build.

D. Create Orders with default constructor and set fields manually without Builder.

Solution

1. Step 1: Identify repeated data in test objects

   customerId and amount are same for all Orders; status differs.

2. Step 2: Use Builder cloning or base setup

   Create a base Builder setting common fields, then clone or copy it to set different statuses before building each Order.

3. Final Answer:

   Create a base Builder with common fields, then clone and set different statuses before build. -> Option C

4. Quick Check:

   Reuse Builder base to avoid repetition [OK]

Hint: Reuse Builder base, change only differing fields [OK]

Common Mistakes:

• Repeating all fields in each Builder call
• Setting fields after build instead of in Builder
• Avoiding Builder and using manual setters