TestNG Annotations Explained In Detail

In this article, I will be explaining some of the important TestNG annotations.

Introduction

TestNG is a popular unit testing framework. It allows creating and running tests. Though largely inspired by JUNIT, it has many advanced features like generating HTML reports, running parametrized tests, and so on.

One of the key features of TestNG is its ability to be configured via annotations. Annotations can be embedded within the TestNG code and help to control the flow of test execution.

TestNG Annotations

Let us now take a closer look at the TestNG annotations.

@Test

Designates a method as a TestNG test. Thus, you need to specify this annotation on any method that you want to run as a TestNG test. The @Test annotation has several attributes. Some of these are as follows:

  • group: Specifies the group that the test belongs to. (TestNG allows creating test groups, so you can group related tests and run them in one go)
  • description: Specifies the test description
  • enabled: Specifies whether tests are enabled or not. By default, tests are enabled. A false value disables the test
  • timeout: Specifies the maximum time that the test should run. If the test does not complete within the specified time, a ThreadTimeoutException is thrown.
  • priority: Specifies a priority for this test. If not specified, tests are executed in the sequence in which they occur
  • dependsOnMethod: Specifies the test that this test depends on. So, this test will only be executed after the specified test is executed successfully.
  • dependsOnGroups: Specifies the group that this test depends on. So, this test will only be executed after the specified group is executed successfully.
  • alwaysRun: Specifies that the test should always run, even if the method that it depends on fails

@BeforeMethod

Can be used to specify code that needs to be executed before each test. Thus, a method that has this annotation is executed before every test method.

@AfterMethod

Can be used to specify code that needs to be executed after each test. Thus, a method that has this annotation is executed after every test method.

@BeforeClass

Can be used to specify code that needs to be executed before executing all the tests in a class. Thus, a method that has this annotation is executed before executing the first test method of the class.

@AfterClass

Can be used to specify code that needs to be executed after executing all the tests in a class. Thus, a method that has this annotation is executed after executing the last test method of the class.

@BeforeTest

Can be used to specify code that needs to be executed before executing all the tests in a package. Thus, a method that has this annotation is executed before executing the first test method of the first class.

@AfterTest

Can be used to specify code that needs to be executed after executing all the tests in a package. Thus, a method that has this annotation is executed after executing the last test method of the last class.

@BeforeGroups

Can be used to specify code that needs to be executed before executing a particular test group. Thus, a method that has this annotation is executed before executing tests within the specified test group.

@AfterGroups

Can be used to specify code that needs to be executed after executing a particular test group. Thus, a method that has this annotation is executed after executing all the tests within the specified test group.

@BeforeSuite

Can be used to specify code that needs to be executed before executing a particular test suite.  (TestNG allows creating a test suite that is nothing but a list of tests. You can create a test suite via the TestNG XML configuration file). Thus, a method that has this annotation is executed before executing tests within the specified test suite.

@AfterSuite

Can be used to specify code that needs to be executed after executing a particular test suite. Thus, a method that has this annotation is executed after executing tests within the specified test suite.

Code Sample

The following code demonstrates all the TestNG annotations:

public class Test1 {    @BeforeSuite  public void beforeSuite() {    System.out.println("Before suite");  }	  @AfterSuite  public void afterSuite() {    System.out.println("After suite");  }	    @BeforeGroups("group1")  public void beforeGroups() {    System.out.println("Before groups group1");  }    @AfterGroups("group1")  public void afterGroups() {    System.out.println("after groups group1");  }	    @BeforeClass  public void beforeClass() {    System.out.println("Before class");  }    @AfterClass  public void afterClass() {    System.out.println("After class");  }	    @BeforeMethod  public void beforeMethod() {    System.out.println("Before method");  }    @AfterMethod  public void afterMethod() {    System.out.println("After method");  }    @Test(groups="group1")  public void test1() {    System.out.println("This is test1");  }      @BeforeTest  public void beforeTest() {    System.out.println("Before test");  }	    @AfterTest  public void afterTest() {    System.out.println("After test");  }	    @Test(groups="group2")  public void test2() {    System.out.println("This is test2");  }}

This code produces the following output:

Before suiteBefore testBefore classBefore groups group1Before methodThis is test1After methodafter groups group1Before methodThis is test2After methodAfter classAfter testPASSED: test1PASSED: test2

 

Further Learning

Conclusion

So, in this article, we learned about the different TestNG annotations like @Test, @BeforeMethod, @AfterMethod, and so forth.

Comments

Post a Comment

Popular posts from this blog

How to use logging in SpringBoot with code samples

Image
In this article, we will learn how to use logging in SpringBoot. Introduction There are several Java logging frameworks like logback, log4j, and so on. Spring Boot supports out-of-the-box support for logback. Let us learn how to use logging in SpringBoot with logback. Step 1 – Create a New Maven Project Create a new Maven project. (Refer to  this  blog post). This will create a project in Eclipse as follows:   Step 2 – Add the Spring Boot Dependencies Add the spring-boot-starter-web dependency to the pom.xml . So, the pom.xml should look as follows: <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.learnjava</groupId> <artifactId>learnjava-springboot-logging-example</artifactId> <version>0.0.1-SNAPSHOT&
Read more

Python While Loop with code samples

Much like a Java while loop, you can use a Python while loop to repeatedly execute a block of code as long as a condition is true. In this article, we will learn more about the Python while loop. Python While loop Syntax A while loop in Python has the following syntax: while <condition>: loop body The while keyword is followed by a condition. If the condition evaluates to true, the body of the loop is executed. Once the body of the loop is completed, the condition is checked again and this is repeated until the condition evaluates to false at which point the loop is exited. While loop Sample Code The following code demonstrates how you can use the while loop: num=10counter=1total=0while counter<=num: total += counter counter+=1print("sum of first 10 numbers is",total) This code adds the numbers from 1 to 10 and prints the sum. It uses a while loop to iterate from 1 to 10. The while loop checks the condition counter <= num and if so adds the current value of count
Read more

How to convert a List to a Set

In this blog post ,I will be showing you how you can convert a List to a Set. Consider the following code snippet: public class ListToSetDemo {public static void main(String[] args) {List<Integer> list = Arrays.asList(5,3,11,15,9);//Method 1Set<Integer> set = new HashSet<Integer>(list);System.out.println("Set is "+set);//method 2Set<Integer> set2 = new HashSet<Integer>();set2.addAll(list);System.out.println("Set is "+set2);}} This code demonstrates two ways to convert a List to a Set. Method 1 Here, we are creating a new HashSet . We are invoking the constructor that accepts a Collection object. Here, we are passing in the input list to this constructor.   Method 2 Here again, we are creating a new HashSet . However, we are using the default constructor. We are then invoking the addAll method and passing in the input list.   When you run this code, it will print the following output: Set is [3, 5, 9, 11, 15]Set is [3, 5, 9, 11, 15] No
Read more