assertEquals in JUnit - Framework Patterns

Framework Mode - assertEquals

Folder Structure for JUnit Test Framework

src/
├── main/
│   └── java/
│       └── com/example/app/
│           └── Calculator.java
└── test/
    └── java/
        └── com/example/app/
            ├── tests/
            │   └── CalculatorTest.java
            ├── utils/
            │   └── TestUtils.java
            └── config/
                └── TestConfig.java

This structure separates production code and test code clearly. Tests live under src/test/java following the package structure.

Test Framework Layers

• Test Classes: Contain test methods using assertEquals to verify expected vs actual results.
• Utility Classes: Helper methods for common test tasks, e.g., data setup or cleanup.
• Configuration: Manage test settings like environment variables or test data paths.
• Application Code: The main code under test, e.g., Calculator.java.

Configuration Patterns

• Use TestConfig.java to centralize environment settings (e.g., test URLs, timeouts).
• Use Java system properties or environment variables to switch between environments (dev, test, prod).
• Keep sensitive data like credentials out of code; use secure environment variables or config files ignored by version control.
• Configure JUnit runner options in pom.xml or build tool for parallel execution or timeout settings.

Test Reporting and CI/CD Integration

• JUnit generates XML reports by default, which CI tools like Jenkins or GitHub Actions can parse.
• Use plugins (e.g., Surefire for Maven) to produce readable HTML reports.
• Integrate tests into CI pipelines to run on every code push, ensuring assertEquals checks keep code correct.
• Failing assertEquals assertions cause test failures, visible in reports and CI dashboards.

Best Practices for Using assertEquals in JUnit Framework

1. Always provide a clear message in assertEquals to explain what failed.
2. Compare expected value first, then actual value: assertEquals(expected, actual).
3. Use precise data types for comparison (e.g., use assertEquals(double expected, double actual, double delta) for floating points).
4. Keep tests small and focused on one behavior per test method.
5. Use setup methods (@BeforeEach) to prepare test data to avoid duplication.

Self Check Question

Where in this folder structure would you add a new test class to verify the add method of the Calculator using assertEquals?

Key Result

Organize JUnit tests under src/test/java with clear layers and use assertEquals to verify expected vs actual results.

Practice

1. What is the main purpose of assertEquals in JUnit testing?

easy

A. To check if two values are equal and fail the test if not

B. To print values during test execution

C. To skip a test case

D. To create a new test method

Solution

1. Step 1: Understand the role of assertEquals

   assertEquals compares two values: expected and actual.

2. Step 2: Identify the test behavior

   If the values differ, the test fails, helping find bugs.

3. Final Answer:

   To check if two values are equal and fail the test if not -> Option A

4. Quick Check:

   assertEquals checks equality [OK]

Hint: assertEquals fails test if values differ [OK]

Common Mistakes:

• Thinking assertEquals prints output
• Confusing assertEquals with skipping tests
• Using assertEquals to create tests

2. Which of the following is the correct syntax for assertEquals with a message in JUnit?

easy

A. assertEquals("Error message", expected, actual);

B. assertEquals(actual, expected, "Error message");

C. assertEquals(expected, actual, "Error message");

D. assertEquals("Error message", actual, expected);

Solution

1. Step 1: Recall assertEquals method signature with message

   The correct order is: message, expected, actual.

2. Step 2: Match options with correct order

   assertEquals("Error message", expected, actual); matches this order exactly.

3. Final Answer:

   assertEquals("Error message", expected, actual); -> Option A

4. Quick Check:

   Message first, then expected, actual [OK]

Hint: Message comes first in assertEquals with message [OK]

Common Mistakes:

• Swapping expected and actual parameters
• Placing message last instead of first
• Using actual before expected

3. What will happen when this JUnit test runs?

int expected = 5;
int actual = 3 + 2;
assertEquals(expected, actual);

medium

A. Compilation error due to wrong assertEquals usage

B. Test fails because expected does not equal actual

C. Test passes because expected equals actual

D. Test is skipped automatically

Solution

1. Step 1: Calculate actual value

   3 + 2 equals 5, so actual is 5.

2. Step 2: Compare expected and actual

   Both expected and actual are 5, so assertEquals passes.

3. Final Answer:

   Test passes because expected equals actual -> Option C

4. Quick Check:

   5 equals 5 means pass [OK]

Hint: Calculate actual before comparing [OK]

Common Mistakes:

• Assuming 3 + 2 is not 5
• Confusing expected and actual values
• Thinking assertEquals causes compilation error here

4. Identify the error in this JUnit assertion:

assertEquals(5, "5");

medium

A. Runtime exception thrown

B. No error, test passes

C. Compilation error due to wrong parameter order

D. Test fails because int and String types differ

Solution

1. Step 1: Check parameter types

   First is int 5, second is String "5".

2. Step 2: Understand assertEquals behavior with different types

   assertEquals compares values and types; int and String differ, so test fails.

3. Final Answer:

   Test fails because int and String types differ -> Option D

4. Quick Check:

   Different types cause failure [OK]

Hint: Types must match for assertEquals to pass [OK]

Common Mistakes:

• Assuming int 5 equals String "5"
• Thinking parameter order is wrong here
• Expecting compilation or runtime error

5. You want to test a method that returns a list of strings. Which assertEquals usage **including a custom error message** correctly checks if the returned list matches List.of("a", "b")?

List<String> expected = List.of("a", "b");
List<String> actual = myMethod();

hard

A. assertEquals(expected, actual);

B. assertEquals("Lists differ", expected, actual);

C. assertEquals(expected.size(), actual.size());

D. assertEquals(expected.toString(), actual.toString());

Solution

1. Step 1: Understand assertEquals for lists

   assertEquals compares lists by content if types match.

2. Step 2: Check options for best practice

   assertEquals("Lists differ", expected, actual); adds a helpful message and uses correct parameter order.

3. Final Answer:

   assertEquals("Lists differ", expected, actual); -> Option B

4. Quick Check:

   Message first, then expected and actual [OK]

Hint: Use message first with expected, actual for clarity [OK]

Common Mistakes:

• Comparing string representations instead of lists
• Only comparing list sizes
• Omitting message for clarity