Failure notification setup in JUnit - Test Execution Trace

Test Overview

This test checks that a failure notification is sent when a test fails. It verifies the notification system triggers correctly on test failure.

Test Code - JUnit 5

JUnit

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.junit.jupiter.api.extension.TestWatcher;
import org.junit.jupiter.api.extension.ExtensionContext;
import static org.junit.jupiter.api.Assertions.assertEquals;

class FailureNotificationExtension implements TestWatcher {
    private static boolean notificationSent = false;

    @Override
    public void testFailed(ExtensionContext context, Throwable cause) {
        notificationSent = true;
        System.out.println("Failure notification sent for test: " + context.getDisplayName());
    }

    public boolean isNotificationSent() {
        return notificationSent;
    }
}

@ExtendWith(FailureNotificationExtension.class)
public class FailureNotificationTest {

    // Changed to static to reflect the static notificationSent flag
    static FailureNotificationExtension extension = new FailureNotificationExtension();

    @Test
    void testThatFails() {
        assertEquals(1, 2, "This test is designed to fail");
    }

    @Test
    void verifyNotificationSent() {
        // This test runs after testThatFails to check notification
        assertEquals(true, extension.isNotificationSent(), "Notification should be sent on failure");
    }
}

Execution Trace - 4 Steps

Step	Action	System State	Assertion	Result
1	Test runner starts and loads FailureNotificationTest class	JUnit test environment initialized	—	PASS
2	Runs testThatFails method	Test method executing	assertEquals(1, 2) fails	FAIL
3	FailureNotificationExtension.testFailed called with test context and failure cause	Notification flag set to true, message printed	—	PASS
4	Runs verifyNotificationSent method	Test method executing	assertEquals(true, extension.isNotificationSent()) verifies notification was sent	PASS

Failure Scenario

Failing Condition: FailureNotificationExtension.testFailed method is not called on test failure

Execution Trace Quiz - 3 Questions

What causes the failure notification to be sent in this test?

A A test method fails an assertion

B A test method passes successfully

C The test class is loaded

D The notification is sent manually in the test

Key Result

Use JUnit extensions like TestWatcher to hook into test lifecycle events and trigger actions such as failure notifications automatically.

Practice

1. What is the primary purpose of setting up failure notification in JUnit tests?

easy

A. To get alerts immediately when a test fails

B. To speed up test execution

C. To automatically fix failed tests

D. To skip tests that might fail

Solution

1. Step 1: Understand failure notification purpose

   Failure notification is designed to alert developers right when a test fails so they can act quickly.

2. Step 2: Eliminate unrelated options

   Speeding tests, auto-fixing, or skipping tests are not related to failure notifications.

3. Final Answer:

   To get alerts immediately when a test fails -> Option A

4. Quick Check:

   Failure notification = Immediate alerts [OK]

Hint: Failure notification means alerts on test failure [OK]

Common Mistakes:

• Thinking it speeds up tests
• Assuming it fixes tests automatically
• Believing it skips tests

2. Which JUnit feature is commonly used to detect test failures and trigger notifications?

easy

A. TestRule

B. TestSuite

C. TestWatcher

D. TestRunner

Solution

1. Step 1: Identify JUnit classes for failure detection

   TestWatcher is a JUnit rule designed to watch test execution and detect failures.

2. Step 2: Compare with other options

   TestRule is a general interface, TestSuite groups tests, TestRunner runs tests but does not notify failures.

3. Final Answer:

   TestWatcher -> Option C

4. Quick Check:

   Failure detection = TestWatcher [OK]

Hint: TestWatcher watches tests and detects failures [OK]

Common Mistakes:

• Confusing TestRule interface with TestWatcher
• Thinking TestSuite handles failure notifications
• Assuming TestRunner sends alerts

3. Given the following JUnit snippet, what will happen when the test fails?

public class MyTest {
  @Rule
  public TestWatcher watcher = new TestWatcher() {
    @Override
    protected void failed(Throwable e, Description d) {
      System.out.println("Test failed: " + d.getMethodName());
    }
  };

  @Test
  public void testFail() {
    assertEquals(1, 2);
  }
}

medium

A. Sends an email automatically

B. Test passes silently without output

C. Throws a runtime exception and stops tests

D. Prints 'Test failed: testFail' to the console

Solution

1. Step 1: Understand TestWatcher failed() method

   The failed() method runs when a test fails and prints the method name.

2. Step 2: Analyze the testFail() method

   assertEquals(1, 2) fails, triggering failed() to print the message.

3. Final Answer:

   Prints 'Test failed: testFail' to the console -> Option D

4. Quick Check:

   Failed test triggers failed() print [OK]

Hint: Failed test triggers failed() print message [OK]

Common Mistakes:

• Thinking test passes silently
• Expecting automatic email without code
• Assuming runtime exception stops all tests

4. Identify the error in this JUnit failure notification setup:

public class NotifyTest {
  @Rule
  public TestWatcher watcher = new TestWatcher() {
    @Override
    protected void failed() {
      System.out.println("Failure detected");
    }
  };

  @Test
  public void testExample() {
    fail();
  }
}

medium

A. Missing parameters in failed() method override

B. @Rule annotation is misplaced

C. fail() method is undefined

D. TestWatcher cannot be used with @Rule

Solution

1. Step 1: Check failed() method signature

   TestWatcher.failed() requires parameters (Throwable, Description) to override correctly.

2. Step 2: Verify other parts

   @Rule is correctly placed, fail() is a JUnit method, TestWatcher works with @Rule.

3. Final Answer:

   Missing parameters in failed() method override -> Option A

4. Quick Check:

   Override failed() with correct parameters [OK]

Hint: Override failed(Throwable, Description) exactly [OK]

Common Mistakes:

• Omitting parameters in failed() override
• Misplacing @Rule annotation
• Confusing fail() method usage

5. You want to send an email alert whenever a JUnit test fails. Which approach correctly integrates this using TestWatcher?

public class EmailAlertTest {
  @Rule
  public TestWatcher watcher = new TestWatcher() {
    @Override
    protected void failed(Throwable e, Description d) {
      // What should go here?
    }
  };

  @Test
  public void testEmail() {
    assertTrue(false);
  }
}

hard

A. Use @After annotation to send email after all tests

B. Call a method to send email inside failed(), passing e and d

C. Throw a new exception inside failed() to trigger email

D. Print stack trace only; email sending is automatic

Solution

1. Step 1: Understand TestWatcher failed() role

   failed() runs on test failure; it is the right place to trigger email sending.

2. Step 2: Choose correct action inside failed()

   Calling a method to send email with failure details is correct; throwing exceptions or relying on @After is incorrect.

3. Final Answer:

   Call a method to send email inside failed(), passing e and d -> Option B

4. Quick Check:

   Send email in failed() method [OK]

Hint: Send email inside failed() override [OK]

Common Mistakes:

• Throwing exceptions to send email
• Using @After for failure alerts
• Assuming email sends automatically without code