TestNG Annotations

 

Testng is a testing framework inspired by JUnit and NUnit, designed for test configuration flexibility and powerful reporting in Java. Annotations in TestNG control how and when test methods are executed.

TestNG annotations are special markers that you use to logically structure and control the execution flow of your tests. They tell the framework what a particular method is for and when it should be run relative to other tests, groups, classes, or the entire test suite.

Common Testng Annotations

Annotation	Description
@BeforeSuite	Runs once before all tests in the suite
@AfterSuite	Runs once after all tests in the suite
@BeforeTest	Runs before <test> tag in TestNG XML file
@AfterTest	Runs after <test> tag in TestNG XML file
@BeforeClass	Runs before the first method in the current class
@AfterClass	Runs after all methods in the current class
@BeforeMethod	Runs before each @Test method
@AfterMethod	Runs after each @Test method
@Test	Marks a method as a test case
@DataProvider	Provides data for parameterized tests
@Parameters	Injects parameters from XML into test methods
@BeforeGroups	Runs before the first method of the specified group
@AfterGroups	Runs after the last method of the specified group

Example java code of Testng Annotations:

Below is the TestNG test class contains all annotations as mentioned above. Statement will be printed on console on execution of particular annotation. @BeforeMethod and @AfterMethod will execute with each test associated with @Test. 

Below in table order of annotations is also mentioned, that in which order annotations will be executed.

import org.testng.annotations.*;

public class TestNGAnnotationsExample {

    @BeforeSuite
    public void beforeSuite() {
        System.out.println("→ @BeforeSuite: Runs before the entire test suite");
    }

    

    @BeforeTest
    public void beforeTest() {
        System.out.println("→ @BeforeTest: Runs before <test> section in XML");
    }



    @BeforeClass
    public void beforeClass() {
        System.out.println("→ @BeforeClass: Runs before the first method of the class");
    }

   
    @BeforeMethod
    public void beforeMethod() {
        System.out.println("→ @BeforeMethod: Runs before each @Test method");
    }

   

    @Test
    public void testCase1() {
        System.out.println("✔ Running Test Case 1");
    }

    @Test
    public void testCase2() {
        System.out.println("✔ Running Test Case 2");
    }


    @AfterMethod
    public void afterMethod() {
        System.out.println("→ @AfterMethod: Runs after each @Test method");
    }

    @AfterClass
    public void afterClass() {
        System.out.println("→ @AfterClass: Runs after all test methods of the class");
    }

    @AfterTest
    public void afterTest() {
        System.out.println("→ @AfterTest: Runs after <test> section in XML");
    }

    @AfterSuite
    public void afterSuite() {
        System.out.println("→ @AfterSuite: Runs after the entire test suite");
    }

}



Order of Execution of TestNG Annotations

Order
Annotation
Executed When
1
@BeforeSuite
Once before the entire test suite starts
2
@BeforeTest
Before <test> tag in the XML file
3
@BeforeGroups
Before any test method belonging to a specified group
4
@BeforeClass
Before the first test method in the current class
5
@BeforeMethod
Before each test method (@Test)
6
@Test
Actual test case
7
@AfterMethod
After each test method (@Test)
8
@AfterClass
After all test methods in the current class
9
@AfterGroups
After all test methods belonging to a specified group
10
@AfterTest
After <test> tag in the XML file
11
@AfterSuite
Once after the entire test suite finishes







Execution Flow of Testng annotations

Below is the flow of TestNG annotations, we can see @BeforeMethod and 
@AfterMethod executed with each Test associated with @Test annotation. Since we 
have, two test cases which are annotated with @Test so @BeforeMethod and 
@AfterMethod executed two times.

@BeforeSuite
@BeforeTest
@BeforeGroups
@BeforeClass

@BeforeMethod
@Test
@AfterMethod

@BeforeMethod
@Test
@AfterMethod

@AfterClass
@AfterGroups
@AfterTest
@AfterSuite

Suggested Posts:

1. First TestNG Script
2. TestNG Dependent Tests
3. TestNG Reports
4. Parameterization in TestNG
5. TestNG Reporter Log