Flaky test detection in JUnit - Build an Automation Script

Detect flaky test by running a test multiple times

Preconditions (2)

Step 1: Create a test method that runs the flaky test 5 times

Step 2: In each run, execute the flaky test logic

Step 3: Record if the test passes or fails each time

Step 4: After all runs, check if there were both passes and failures

Step 5: If yes, mark the test as flaky

✅ Expected Result: The test detects if the flaky test passes sometimes and fails sometimes, indicating flakiness

Automation Requirements - JUnit 5

Assertions Needed:

Assert that the flaky test passes at least once

Assert that the flaky test fails at least once to confirm flakiness

Best Practices:

Use @RepeatedTest or loop inside test to run multiple times

Use assertions to track pass/fail counts

Keep flaky test logic isolated for clarity

Avoid hardcoding sleep or waits

Use descriptive test method names

Automated Solution

JUnit

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

public class FlakyTestDetection {

    // Simulated flaky test method
    boolean flakyTest() {
        // Randomly pass or fail
        return Math.random() > 0.5;
    }

    @Test
    void detectFlakyTest() {
        int passCount = 0;
        int failCount = 0;
        int runs = 5;

        for (int i = 0; i < runs; i++) {
            if (flakyTest()) {
                passCount++;
            } else {
                failCount++;
            }
        }

        assertTrue(passCount > 0, "Test should pass at least once");
        assertTrue(failCount > 0, "Test should fail at least once to confirm flakiness");
    }
}

This code defines a flakyTest() method that randomly passes or fails to simulate flakiness.

The detectFlakyTest() method runs this flaky test 5 times in a loop.

It counts how many times the test passes and fails.

Then it asserts that the test passed at least once and failed at least once.

This confirms the test is flaky because it does not always behave the same.

Using a loop inside a single test method keeps the code simple and clear.

Common Mistakes - 3 Pitfalls

{'mistake': 'Running flaky test only once', 'why_bad': "You cannot detect flakiness if you run the test a single time because you won't see intermittent failures.", 'correct_approach': 'Run the test multiple times in a loop or use @RepeatedTest to observe different outcomes.'}

Using Thread.sleep to fix flakiness

Not asserting both pass and fail outcomes

Bonus Challenge

Now add data-driven testing with 3 different flaky test scenarios using @ParameterizedTest

Show Hint

Practice

1.

What is a flaky test in JUnit?

easy

A. A test that runs only once

B. A test that sometimes passes and sometimes fails without code changes

C. A test that always fails

D. A test that always passes

Solution

1. Step 1: Understand flaky test behavior

   A flaky test is one that does not have consistent results; it may pass or fail unpredictably even if the code hasn't changed.

2. Step 2: Identify the correct definition

   Among the options, only D describes this behavior accurately.

3. Final Answer:

   A test that sometimes passes and sometimes fails without code changes -> Option B

4. Quick Check:

   Flaky test = inconsistent pass/fail [OK]

Hint: Flaky tests fail unpredictably without code changes [OK]

Common Mistakes:

• Thinking flaky tests always fail
• Confusing flaky tests with slow tests
• Assuming flaky tests run only once

2.

Which JUnit feature helps detect flaky tests by rerunning failed tests automatically?

easy

A. JUnit RetryRule or @RepeatedTest

B. JUnit @BeforeAll annotation

C. JUnit @Test timeout parameter

D. JUnit @Ignore annotation

Solution

1. Step 1: Identify rerun features in JUnit

   JUnit provides RetryRule or can use @RepeatedTest to rerun tests multiple times to detect flaky behavior.

2. Step 2: Eliminate unrelated options

   @BeforeAll runs setup once, @Test timeout limits test time, and @Ignore skips tests, so they don't detect flaky tests.

3. Final Answer:

   JUnit RetryRule or @RepeatedTest -> Option A

4. Quick Check:

   RetryRule reruns tests to detect flakes [OK]

Hint: RetryRule reruns failed tests automatically [OK]

Common Mistakes:

• Confusing @BeforeAll with retry logic
• Using @Ignore to detect flaky tests
• Thinking timeout detects flakiness

3.

Consider this JUnit test snippet using a retry rule to detect flaky tests:

public class FlakyTest {
  private int runCount = 0;

  @Rule
  public RetryRule retryRule = new RetryRule(3);

  @Test
  public void testFlaky() {
    runCount++;
    assertTrue(runCount >= 2);
  }
}

What will be the test result when run?

medium

A. Test fails after all retries

B. Test fails immediately

C. Test passes on first try

D. Test passes after retrying once

Solution

1. Step 1: Analyze runCount increment and assertion

   On first run, runCount is 1, so assertTrue(runCount >= 2) fails. RetryRule reruns test up to 3 times.

2. Step 2: Check retry behavior

   On second run, runCount is 2, assertion passes, so test passes after one retry.

3. Final Answer:

   Test passes after retrying once -> Option D

4. Quick Check:

   Retry allows flaky test to pass on retry [OK]

Hint: Check runCount and retries to predict pass/fail [OK]

Common Mistakes:

• Assuming test passes on first try
• Ignoring retry rule effect
• Thinking test fails after all retries

4.

Identify the problem in this JUnit test intended to detect flaky tests by retrying:

@Rule
public RetryRule retryRule = new RetryRule(3);

@Test
public void testFlaky() {
  int count = 0;
  count++;
  assertTrue(count > 1);
}

medium

A. assertTrue condition is always true

B. RetryRule is not applied correctly without @Retry annotation

C. The count variable resets on each test run, so retry never passes

D. Test method lacks @Before annotation

Solution

1. Step 1: Analyze count variable scope

   Count is a local variable inside the test method, so it resets to 0 on every retry.

2. Step 2: Understand retry effect on count

   Since count resets each time, count++ makes it 1, so assertTrue(count > 1) always fails, retry won't help.

3. Final Answer:

   The count variable resets on each test run, so retry never passes -> Option C

4. Quick Check:

   Local variables reset each retry causing failure [OK]

Hint: Check variable scope to ensure state persists across retries [OK]

Common Mistakes:

• Assuming retry fixes all failures
• Ignoring variable reset on retries
• Confusing retry annotations

5.

You want to detect flaky tests in your JUnit suite by running each test 5 times and marking it flaky if it fails at least once. Which approach is best?

hard

A. Use @RepeatedTest(5) and record failures to identify flaky tests

B. Use @Ignore on all tests and run manually

C. Use @BeforeEach to reset test state only

D. Use @Timeout to fail slow tests

Solution

1. Step 1: Understand flaky test detection by multiple runs

   Running tests multiple times helps catch intermittent failures indicating flakiness.

2. Step 2: Choose correct JUnit feature

   @RepeatedTest(5) runs the test 5 times; by recording failures during these runs, flaky tests can be detected.

3. Final Answer:

   Use @RepeatedTest(5) and record failures to identify flaky tests -> Option A

4. Quick Check:

   Multiple runs with @RepeatedTest detect flaky tests [OK]

Hint: Run tests multiple times with @RepeatedTest to find flakes [OK]

Common Mistakes:

• Using @Ignore disables tests instead of detecting flakes
• Relying on @Timeout for flaky detection
• Resetting state without multiple runs