What is the use of @Listener annotation in TestNG?

TestNG's @Listeners annotation is used to define listeners in test classes. Listeners are classes that implement specific interfaces, which define a series of methods to be invoked at specific points during the test lifecycle. By using listeners, we can insert custom behaviors or logic at various stages of test execution, such as before the test starts, after test method execution, or when a test fails.

Specifically, the commonly used listener interfaces in TestNG are:

• ITestListener: Used to execute code at various stages of the test (e.g., test start, success, failure).
• ISuiteListener: Listens to the start and end of the entire test suite.
• IReporter: Generates custom test reports.

For example, if we want to record information after each test method execution or capture screenshots when a test fails, we can achieve this by implementing the ITestListener interface.

Here is a simple example using the @Listeners annotation:

java
import org.testng.annotations.Listeners;
import org.testng.annotations.Test;

@Listeners(CustomListener.class)
public class SampleTest {

    @Test
    public void testMethodOne() {
        // Test logic
    }

    @Test
    public void testMethodTwo() {
        // Test logic
    }
}

public class CustomListener implements ITestListener {
    @Override
    public void onTestStart(ITestResult result) {
        System.out.println("Test started: " + result.getName());
    }

    @Override
    public void onTestSuccess(ITestResult result) {
        System.out.println("Test successful: " + result.getName());
    }

    @Override
    public void onTestFailure(ITestResult result) {
        System.out.println("Test failed: " + result.getName());
        // You can add screenshot code or other logic here
    }
}

In this example, the CustomListener class implements the ITestListener interface and defines the actions to be performed when the test starts, succeeds, or fails. By applying the @Listeners(CustomListener.class) annotation to the test class SampleTest, TestNG will use this listener when executing the test class. Consequently, whenever a test method starts, succeeds, or fails, the corresponding methods in CustomListener will be automatically invoked.