TestNG Cheatsheet: Annotations, Suites and DataProviders Reference

  org.testng
  testng
  7.10.2
  test




  maven-surefire-plugin
  3.2.5
  
    
      src/test/resources/testng.xml
    
  


# Gradle — build.gradle.kts
# testImplementation("org.testng:testng:7.10.2")
# tasks.test { useTestNG { suiteXmlFiles += file("testng.xml") } }

# Run
mvn test                                    # all tests in the suite
mvn test -Dgroups="smoke,api"               # group filter
mvn test -Dtest=LoginTest#testValid         # single method
mvn test -DsuiteXmlFile=integration.xml     # alternate suite
gradle test --tests com.acme.LoginTest

import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;
import static org.testng.Assert.assertEquals;

public class BillingTest {

    // Static, in-class data table
    @DataProvider(name = "plans")
    public Object[][] plans() {
        return new Object[][] {
            { "free", 0 },
            { "pro", 10 },
            { "max", 50 },
        };
    }

    // Use it — TestNG matches arity / types
    @Test(dataProvider = "plans", groups = {"smoke"})
    public void feeForPlan(String plan, int expected) {
        assertEquals(Billing.feeFor(plan), expected);
    }

    // Parallel data-provider — N parametrized runs in parallel
    @DataProvider(name = "skus", parallel = true)
    public Object[][] skus() {
        return new Object[][] { {"a"}, {"b"}, {"c"}, {"d"} };
    }

    // Cross-class: dataProviderClass points to a static method elsewhere
    @Test(dataProvider = "users", dataProviderClass = TestData.class)
    public void roleIsAssigned(User u, Role r) { /* ... */ }

    // Stream-friendly: return Iterator for big or lazy datasets
    @DataProvider(name = "csv")
    public java.util.Iterator rows() throws Exception {
        return CsvLoader.load("users.csv").iterator();
    }
}

package com.acme.tests;

import org.testng.annotations.*;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import org.openqa.selenium.chrome.ChromeOptions;
import static org.testng.Assert.*;

public class LoginTest {

    private WebDriver driver;

    @BeforeClass(alwaysRun = true)
    public void setUpBrowser() {
        ChromeOptions opts = new ChromeOptions();
        opts.addArguments("--headless=new", "--window-size=1280,800");
        driver = new ChromeDriver(opts);
    }

    @AfterClass(alwaysRun = true)
    public void tearDown() {
        if (driver != null) driver.quit();           // always clean up
    }

    @DataProvider(name = "users")
    public Object[][] users() {
        return new Object[][] {
            { "ana@x.com", "secret", true  },
            { "bob@x.com", "wrong",  false },
        };
    }

    @Test(groups = {"smoke"}, dataProvider = "users",
          description = "Login with valid + invalid creds")
    public void canLogIn(String email, String pw, boolean ok) {
        driver.get("https://example.com/login");
        new LoginPage(driver).fill(email, pw).submit();
        assertEquals(driver.getCurrentUrl().contains("/dashboard"), ok);
    }

    @Test(dependsOnMethods = "canLogIn", groups = {"regression"})
    public void canViewDashboard() {
        assertTrue(driver.getPageSource().contains("Welcome"));
    }
}