TestNG - Basic Annotations - BeforeGroups



@BeforeGroups annotated method will run only once before all the test methods belonging to a specified group have been executed.

The following is a list of attributes supported by the @BeforeGroups annotation:

Attribute Description

alwaysRun

For before methods (beforeSuite, beforeTest, beforeTestClass and beforeTestMethod, but not beforeGroups): If set to true, this configuration method will be run regardless of what groups it belongs to.

For after methods (afterSuite, afterClass, ...): If set to true, this configuration method will be run even if one or more methods invoked previously failed or was skipped.

dependsOnGroups

The list of groups this method depends on.

dependsOnMethods

The list of methods this method depends on.

enabled

Whether methods on this class/method are enabled.

groups

The list of groups this class/method belongs to.

inheritGroups

If true, this method will belong to groups specified in the @Test annotation at the class level.

onlyForGroups

Only for @BeforeMethod and @AfterMethod. If specified, then this setup/teardown method will only be invoked if the corresponding test method belongs to one of the listed groups.

Create a Class

Create a java class to be tested, say, MessageUtil.java in /work/testng/src.

/*
* This class prints the given message on console.
*/

public class MessageUtil {

   private String message;

   //Constructor
   //@param message to be printed
   public MessageUtil(String message) {
      this.message = message;
   }

   // prints the message
   public String printMessage() {
      System.out.println(message);
      return message;
   }
}

Create Test Case Class

  • Create a java test class, say, TestAnnotationBeforeGroups.java in /work/testng/src.

  • Add a test method testMethod() to your test class.

  • Add an Annotation @Test to method testMethod() and add this method to a group testOne.

  • Add a method beforeGroups to the test class with annotation @BeforeGroups and execute it before the testOne group by adding this annotation @BeforeGroups("testOne")

  • Implement the test condition and check the behaviour of @BeforeGroups annotation.

Following are the TestAnnotationBeforeGroups.java contents:

  import org.testng.Assert;
  import org.testng.annotations.Test;
  import org.testng.annotations.BeforeGroups;

  public class TestAnnotationBeforeGroups {
    MessageUtil messageUtil = new MessageUtil("Test method");
    @BeforeGroups("testOne")
    public void beforeGroups(){
      System.out.println("beforeGroups method executed before testOne group");
    }
    @Test(groups={"testOne"})
    public void testMethod(){
      Assert.assertEquals("Test method helooo", messageUtil.printMessage());
    }
  }

Create testng.xml

Next, let's create testng.xml file in /work/testng/src, to execute test case(s). This file captures your entire testing in XML. This file makes it easy to describe all your test suites and their parameters in one file, which you can check in your code repository or e-mail to coworkers. It also makes it easy to extract subsets of your tests or split several runtime configurations (e.g., testngdatabase.xml would run only tests that exercise your database).

  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE suite SYSTEM "https://testng.org/testng-1.0.dtd">
  <suite name="Suite">
    <test thread-count="5" name="Test">
      <classes>
        <class name="TestAnnotationBeforeGroups"/>
      </classes>
    </test> <!-- Test -->
  </suite> <!-- Suite -->

Compile the test case using javac.

/work/testng/src$ javac TestAnnotationBeforeGroups.java MessageUtil.java

Now, run the testng.xml, which will run the test case defined in <test> tag. As you can see the @BeforeGroups is called before all other test cases.

/work/testng/src$ java org.testng.TestNG testng.xml

Verify the output.

  beforeGroups method executed before testOne group
  Test method

  ===============================================
  Suite
  Total tests run: 1, Passes: 0, Failures: 1, Skips: 0
  ===============================================
Advertisements