Test result publishing in JUnit - Build an Automation Script

Verify test result publishing after test execution

Preconditions (2)

Step 1: Run the JUnit test suite using the build tool or IDE

Step 2: Locate the test result report generated (e.g., in target/surefire-reports or build/reports/tests)

Step 3: Open the test result report file (e.g., XML or HTML)

Step 4: Verify that the report contains the executed test names

Step 5: Verify that the report shows the correct pass/fail status for each test

✅ Expected Result: The test result report is generated and correctly shows all executed tests with their pass or fail status.

Automation Requirements - JUnit 5

Assertions Needed:

Verify test methods run and pass/fail as expected

Verify test result report file exists after test execution

Best Practices:

Use @Test annotations for test methods

Use assertions from org.junit.jupiter.api.Assertions

Run tests via Maven or Gradle to generate reports

Do not hardcode file paths; use relative paths

Keep tests independent and repeatable

Automated Solution

JUnit

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.*;
import java.nio.file.Files;
import java.nio.file.Path;

public class SampleTest {

    @Test
    void testAddition() {
        int sum = 2 + 3;
        assertEquals(5, sum, "2 + 3 should equal 5");
    }

    @Test
    void testSubtraction() {
        int diff = 5 - 3;
        assertEquals(2, diff, "5 - 3 should equal 2");
    }

    @Test
    void testFailingCase() {
        assertTrue(false, "This test is designed to fail");
    }

    @Test
    void verifyReportExists() throws Exception {
        // Assuming Maven default surefire report location
        Path reportPath = Path.of("target", "surefire-reports", "TEST-SampleTest.xml");
        assertTrue(Files.exists(reportPath), "Test report file should exist after tests run");
    }
}

This JUnit 5 test class SampleTest contains three test methods: two that pass and one that fails to demonstrate test result variety.

The verifyReportExists test checks if the test report file is generated in the default Maven Surefire reports folder. This confirms that test results are published after execution.

Assertions use JUnit's assertEquals and assertTrue for clarity. The report path uses Path.of with relative folders to avoid hardcoding absolute paths.

Run these tests via Maven or Gradle to generate the reports automatically. The failing test shows how failures appear in reports.

Common Mistakes - 4 Pitfalls

Not running tests via build tool, so no report is generated

Hardcoding absolute file paths for report verification

{'mistake': 'Not including assertions to verify test outcomes', 'why_bad': "Without assertions, tests may pass incorrectly and reports won't reflect real test results", 'correct_approach': 'Always include meaningful assertions in test methods'}

Ignoring test failures and assuming all tests pass

Bonus Challenge

Now add data-driven testing with 3 different input sets for a calculator add method

Show Hint

Practice

1. What does test result publishing in JUnit primarily show?

easy

A. Whether tests pass or fail

B. The source code of the tests

C. The time taken to write tests

D. The number of test files in the project

Solution

1. Step 1: Understand the purpose of test result publishing

   Test result publishing shows the outcome of running tests, mainly if they pass or fail.

2. Step 2: Identify what is displayed after tests run

   JUnit displays test results to inform developers about test success or failure.

3. Final Answer:

   Whether tests pass or fail -> Option A

4. Quick Check:

   Test result publishing = pass/fail status [OK]

Hint: Test results show pass or fail status [OK]

Common Mistakes:

• Confusing test results with source code
• Thinking test results show test writing time
• Assuming test results count files

2. Which JUnit annotation is used to mark a method as a test so its result can be published?

easy

A. @Test

B. @AfterEach

C. @BeforeAll

D. @Ignore

Solution

1. Step 1: Identify the annotation that marks test methods

   The @Test annotation tells JUnit which methods to run as tests and publish results for.

2. Step 2: Differentiate from other lifecycle annotations

   @BeforeAll and @AfterEach are for setup/cleanup, @Ignore skips tests, so they don't mark tests themselves.

3. Final Answer:

   @Test -> Option A

4. Quick Check:

   Test method annotation = @Test [OK]

Hint: Use @Test to mark test methods [OK]

Common Mistakes:

• Using @BeforeAll or @AfterEach as test markers
• Confusing @Ignore with test execution
• Missing @Test annotation on test methods

3. Given this JUnit test method, what will the test result publishing show?

  @Test
  void testSum() {
    assertEquals(5, 2 + 3);
  }

medium

A. Test fails because 2 + 3 is not 5

B. Test throws an error due to syntax

C. Test passes because 2 + 3 equals 5

D. Test is ignored due to missing annotation

Solution

1. Step 1: Evaluate the assertion in the test method

   The assertion checks if 2 + 3 equals 5, which is true.

2. Step 2: Determine the test outcome based on assertion

   Since the assertion is true, the test passes and JUnit publishes a pass result.

3. Final Answer:

   Test passes because 2 + 3 equals 5 -> Option C

4. Quick Check:

   2 + 3 = 5 means test passes [OK]

Hint: Check if assertion condition is true for pass [OK]

Common Mistakes:

• Assuming 2 + 3 is not 5
• Thinking missing annotation causes ignore here
• Confusing syntax errors with assertion failures

4. This JUnit test method is supposed to check if a list is empty, but the test result publishing shows failure. What is the error?

  @Test
  void testEmptyList() {
    List<String> list = new ArrayList<>();
    assertTrue(list.isEmpty());
  }

medium

A. assertTrue is used incorrectly; should be assertFalse

B. No error; test should pass and publish success

C. The list is not initialized properly

D. Missing import for List causes failure

Solution

1. Step 1: Analyze the list initialization

   The list is created as a new empty ArrayList, so list.isEmpty() returns true.

2. Step 2: Check the assertion logic

   assertTrue(list.isEmpty()) expects true, which matches the empty list state, so the test passes.

3. Final Answer:

   No error; test should pass and publish success -> Option B

4. Quick Check:

   Empty list means assertTrue(list.isEmpty()) passes [OK]

Hint: Empty list means isEmpty() returns true [OK]

Common Mistakes:

• Thinking list is not empty after initialization
• Confusing assertTrue with assertFalse
• Assuming missing imports cause test failure without error

5. You want to publish test results in a JUnit project and generate a report file automatically after tests run. Which approach is best?

hard

A. Add @Report annotation to test classes to auto-generate reports

B. Manually write test results to a file inside each test method

C. Print test results to console and copy them manually to a file

D. Use a build tool like Maven or Gradle with JUnit plugins to generate reports

Solution

1. Step 1: Understand automated test result publishing

   Build tools like Maven or Gradle integrate with JUnit to run tests and generate reports automatically.

2. Step 2: Evaluate other options for report generation

   Manually writing or copying results is error-prone and inefficient; @Report annotation does not exist in JUnit.

3. Final Answer:

   Use a build tool like Maven or Gradle with JUnit plugins to generate reports -> Option D

4. Quick Check:

   Automate reports with build tools [OK]

Hint: Use Maven/Gradle plugins for automatic reports [OK]

Common Mistakes:

• Trying to write results manually inside tests
• Copying console output instead of automating
• Assuming non-existent annotations generate reports