TestNG Annotations and Their Uses in Selenium Automation

What’s the secret behind making automation testing with Selenium not just effective but also seamless? It’s all about structure and strategy—and that’s where TestNG annotations come into play. Imagine running a marathon without clear checkpoints or a well-marked path. That’s how testing would feel without the structured guidance TestNG provides.

In this blog, we’ll take a closer look at TestNG annotations, unraveling their types and practical applications in Selenium. These annotations help simplify setting up test environments, managing workflows, and organizing test flows efficiently. Let’s explore how mastering these tools can transform your automation journey into a streamlined process.

Quick Answer: TestNG annotations are special markers in Java that tell the TestNG framework how to execute test methods. The most commonly used TestNG annotations are @BeforeSuite, @BeforeTest, @BeforeClass, @BeforeMethod, @Test, @AfterMethod, @AfterClass, @AfterTest, @AfterSuite, @DataProvider, @Parameters, @Listeners, and @Factory. Together, these TestNG annotations control the full test lifecycle, from environment setup to cleanup, data-driven testing, and parallel execution.

What Are TestNG Annotations?

TestNG annotations are special markers in Java that provide instructions to the TestNG framework about how to execute the test methods. These annotations define the life cycle of the test execution, such as before a test, after a test, or when the test should be skipped.

TestNG annotations are defined by the @TestNG library and help organize the execution sequence of test methods, facilitating modular and scalable automation testing.

Why TestNG Annotations Matter in Selenium Automation

Before jumping into each annotation, here is a quick reference of all the major TestNG annotations and what they do:

Commonly Used TestNG Annotations

Below are the most commonly used TestNG annotations, their purposes, and how they can be leveraged in Selenium test scripts:

1. @BeforeSuite

Purpose: The @BeforeSuite annotation is executed once before any of the tests in the test suite are run. This is typically used to set up the environment for the entire suite, such as initializing WebDriver or reading configuration files.

Use Case:

• Initializing Selenium WebDriver before running all tests in a suite.
• Setting up test environment (e.g., creating a database connection).

Example:

@BeforeSuite
public void setupSuite() {
    // Code to initialize WebDriver or setup suite-level configurations
    System.out.println(“Before Suite: Setting up environment…”);
}

2. @BeforeTest

Purpose: This annotation is executed before any test methods inside a <test> tag are executed. It is useful for setting up preconditions for specific tests, like configuring a test database or logging into the application.

Use Case:

• Logging in to the application before a set of tests runs.
• Configuring test-specific settings.

Example:

@BeforeTest
public void setupTest() {
    // Code to setup test-specific configurations
    System.out.println(“Before Test: Setting up test environment…”);
}

Also: Top Selenium Interview Questions and Answers for 2025

3. @BeforeClass

Purpose: The @BeforeClass annotation is executed once before the first method in the current class is run. It is used for setting up resources needed specifically for the class.

Use Case:

• Setting up a browser window or WebDriver before running all tests within the class.
• Initializing a set of data or configurations that are required for all tests in the class.

Example:

@BeforeClass
public void beforeClass() {
    // Code to initialize browser or setup configurations
    System.out.println(“Before Class: Setting up browser…”);
}

4. @Test

Purpose: The @Test annotation marks a method as a test case. This is the most commonly used annotation in TestNG. You can have multiple test methods in a class, each marked with the @Test annotation.

Use Case:

• Writing actual test cases to validate functionalities like form submissions, login, navigation, etc.
• It can be used with parameters, assertions, and expected exceptions.

Key @Test attributes you should know:

Example:

@Test
public void testLoginFunctionality() {
    // Selenium WebDriver code for testing login functionality
    Assert.assertTrue(driver.findElement(By.id(“loginButton”)).isDisplayed());
    System.out.println(“Login test passed”);
}

5. @AfterClass

Purpose: The @AfterClass annotation is executed after all the test methods in the current class have been run. It is used for cleanup tasks, such as closing the WebDriver or releasing any resources allocated for the class.

Use Case:

• Closing the browser window after all tests in a class are complete.
• Clearing test data or disconnecting resources.

Example:

@AfterClass
public void afterClass() {
    // Code to close browser
    driver.quit();
    System.out.println(“After Class: Closing browser…”);
}

Explore: Essential Steps to Becoming a Selenium Expert: Key Foundations

6. @AfterTest

Purpose: This annotation is executed after all test methods in the <test> tag have been executed. It is useful for test-specific cleanup, such as logging out or resetting configurations that were set up before the test.

Use Case:

• Logging out of an application after the tests are complete.
• Cleaning up or resetting configurations for the next test.

Example:

@AfterTest
public void afterTest() {
    // Code to logout or clean up after the test
    System.out.println(“After Test: Cleaning up…”);
}

7. @AfterSuite

Purpose: The @AfterSuite annotation is executed after all tests in the suite have been run. It is useful for performing cleanup tasks at the suite level, such as reporting or releasing suite-wide resources.

Use Case:

• Generating a test report after all tests in the suite have completed.
• Closing connections or releasing suite-level resources.

Example:

@AfterSuite
public void teardownSuite() {
    // Code to generate reports or cleanup after the entire suite
    System.out.println(“After Suite: Cleaning up after suite…”);
}

8. @DataProvider

Purpose: The @DataProvider annotation is used to provide data to a test method. It allows a test method to run multiple times with different inputs, which is useful for data-driven testing.

Use Case:

• Running the same test with different sets of data, such as validating form submissions with various input values.

Example:

@DataProvider(name = “loginData”)
public Object[][] loginDataProvider() {
    return new Object[][] {
        { “user1”, “password1” },
        { “user2”, “password2” }
    };
}

@Test(dataProvider = “loginData”)
public void testLogin(String username, String password) {
    // Selenium WebDriver code to perform login with provided data
    Assert.assertTrue(login(username, password));
}

9. @BeforeMethod and @AfterMethod

These annotations are executed before and after each individual test method in a class.

• @BeforeMethod: Used to set up any preconditions before each test method.
• @AfterMethod: Used for cleanup tasks after each test method.

Use Case:

• Setting up and tearing down individual tests, such as clearing cookies or logging in before each test.

Example:

@BeforeMethod
public void beforeMethod() {
    // Code to initialize WebDriver or log in
    System.out.println(“Before Method: Logging in before each test…”);
}

@AfterMethod
public void afterMethod() {
    // Code to logout or clear browser cache
    System.out.println(“After Method: Logging out after each test…”);
}

10. @Parameters

Purpose: The @Parameters TestNG annotation injects values from the testng.xml configuration file directly into a test method. This is useful when you want to run the same tests against different browsers, environments, or configurations without changing code.

Use Cases:

• Passing browser name (Chrome, Firefox) from testng.xml
• Passing base URL for different test environments (QA, staging, production)

Example:

@Parameters({“browser”, “url”}) @BeforeTest public void setup(String browser, String url) {     if (browser.equals(“chrome”)) {         driver = new ChromeDriver();     } else if (browser.equals(“firefox”)) {         driver = new FirefoxDriver();     }     driver.get(url); }

testng.xml configuration: <parameter name=”browser” value=”chrome”/> <parameter name=”url” value=”https://your-app.com”/>

11. @Listeners

Purpose: The @Listeners TestNG annotation attaches one or more listener classes to your test class. Listeners are used to generate custom reports, log test events, take screenshots on failure, or integrate with third-party reporting tools like ExtentReports.

Use Cases:

• Auto-capturing screenshots on test failure
• Integrating with ExtentReports or Allure for rich HTML reports
• Sending Slack or email notifications on test completion

Example:

@Listeners(CustomTestListener.class) public class LoginTest {     @Test     public void testLogin() {         // your test code     } }

12. @Factory

Purpose: The @Factory TestNG annotation creates test object instances dynamically at runtime. It is used when you want to run the same test class with different configurations without duplicating code.

Use Cases:

• Running the same test class with different user roles (admin, guest, editor)
• Cross-browser testing with dynamically created test instances

Example:

@Factory public Object[] createInstances() {     return new Object[] {         new LoginTest(“admin”, “admin123”),         new LoginTest(“user”, “user456”)     }; }

TestNG Annotations Execution Order

One of the most frequently asked questions about TestNG annotations is: in what order do they actually run? Here is the complete execution order for a single test class:

@BeforeSuite → @BeforeTest → @BeforeClass → @BeforeMethod → @Test → @AfterMethod → @AfterClass → @AfterTest → @AfterSuite

For a complete suite with multiple classes, TestNG annotations fire as follows:

Key Uses of TestNG Annotations in Selenium Automation

1. Test Organization and Setup: Annotations like @BeforeSuite, @BeforeClass, and @BeforeTest help organize the setup for a test suite, class, or individual test cases, allowing for better maintainability and structure.
2. Efficient Test Execution: Annotations like @Test allow you to define multiple test methods, which can be run in parallel or sequentially. The use of @DataProvider further enhances test execution by running tests with different data sets.
3. Resource Management: Annotations like @AfterSuite, @AfterTest, and @AfterClass make it easy to perform cleanup tasks such as closing WebDriver sessions or releasing any external resources after tests have run.
4. Flexible and Scalable: TestNG allows you to group tests, run them in parallel, and apply different annotations depending on your needs. This makes it highly flexible and scalable for large test suites.
5. Error Handling and Reporting: TestNG provides mechanisms for handling test failures, generating reports, and capturing logs. The annotations allow testers to structure their tests in a way that enhances visibility and debugging.

TestNG annotations streamline automation by managing test execution, parallel runs, and exception handling. But theory alone isn’t enough, real-world application is key.

Looking to master Selenium automation? Get hands-on with this Selenium Automation Testing Course and learn to implement TestNG effectively in scalable frameworks.

Common Mistakes to Avoid with TestNG Annotations

These are the mistakes that break automation frameworks in real projects:

• Putting WebDriver initialization in @BeforeMethod when it should be in @BeforeClass: If each @Test creates and destroys a browser, your suite will be slow and unstable. Initialize WebDriver at the class level unless each test truly needs a fresh browser.
• Not using @AfterMethod for screenshot capture: Skipping this means you have no visual evidence when a test fails in a CI pipeline.
• Using @BeforeSuite for test-specific logic: @BeforeSuite runs once for everything. Test-specific setup belongs in @BeforeTest or @BeforeClass.
• Ignoring the priority attribute of @Test: Without priorities, TestNG annotations execute test methods alphabetically by default, which often produces incorrect results for ordered workflows like checkout flows.
• Not using groups with @Test: In large suites, running all tests every time is wasteful. Using groups like “smoke”, “regression”, “sanity” with @Test and targeting them in testng.xml speeds up feedback loops dramatically.

Conclusion

Mastering TestNG annotations isn’t just about ticking technical boxes—it’s about creating a well-oiled testing framework that can adapt to real-world complexities. By strategically using annotations like @BeforeSuite or @DataProvider, you’re not just managing tests but optimizing workflows for better results.

Think of TestNG as the backbone of your Selenium automation—helping you execute tests with precision while ensuring your framework remains robust and scalable. The more fluently you incorporate these annotations into your testing strategy, the more seamless and effective your automation efforts will become. Here’s to building better testing processes, one annotation at a time!

TestNG annotations streamline automation by managing test execution, parallel runs, and exception handling. But theory alone is not enough, real-world application is key. Looking to master Selenium automation? Get hands-on with HCL GUVI’s Selenium Automation Testing Course and learn to implement TestNG annotations effectively in scalable frameworks.

FAQs

1. What are TestNG annotations?

TestNG annotations are special markers in Java prefixed with @ that tell the TestNG framework how to manage the lifecycle of test execution. Each TestNG annotation has a specific role: @Test marks a method as a test case, @BeforeSuite sets up the environment before any test runs, and @DataProvider feeds multiple data sets to a single test method.

2. What is the execution order of TestNG annotations?

The execution order of TestNG annotations is: @BeforeSuite, @BeforeTest, @BeforeClass, @BeforeMethod, @Test, @AfterMethod, @AfterClass, @AfterTest, and @AfterSuite. Understanding this order is essential for writing stable Selenium test frameworks.

3. What is the difference between @BeforeMethod and @BeforeClass in TestNG?

@BeforeClass runs once before all test methods in a class. @BeforeMethod runs before every individual @Test method. Use @BeforeClass for one-time setup like browser initialization. Use @BeforeMethod for per-test setup like logging in or clearing cookies before each test case.

4. How does @DataProvider work in TestNG?

The @DataProvider TestNG annotation returns a two-dimensional Object array. Each row in the array is passed as a separate set of arguments to the linked @Test method, causing it to run multiple times with different data. This is the foundation of data-driven testing in Selenium with TestNG.

5. What is the use of @Parameters in TestNG annotations?

The @Parameters TestNG annotation reads values from the testng.xml file and injects them into a test method at runtime. This allows you to run the same test against different browsers, environments, or configurations without modifying your test code. It is widely used for cross-browser testing.