How to use TestNGUtils class of org.testng package

Best Testng code snippet using org.testng.TestNGUtils

Source:TestNGUtilsTest.java

...5import org.testng.annotations.Test;6import java.util.Arrays;7import java.util.Collections;8import java.util.List;9public class TestNGUtilsTest extends HtsjdkTest {10    public static final Object[] EMPTY_ARRAY = new Object[0];11    @DataProvider12    public Object[][] getArraysAndLists() {13        return new Object[][]{14                {15                        new Object[][]{16                                {1, 2},17                                {3, 4}18                        },19                        Arrays.asList(20                                Arrays.asList(1, 2),21                                Arrays.asList(3, 4)22                        )23                },24                {25                        new Object[][]{26                                {1}27                        },28                        Arrays.asList(29                                Arrays.asList(1)30                        )31                },32                {33                        new Object[][]{34                                {1, 2, 3},35                                {4, 5, 6}36                        },37                        Arrays.asList(38                                Arrays.asList(1, 2, 3),39                                Arrays.asList(4, 5, 6)40                        )41                },42                {43                        new Object[][]{44                                {1},45                                {2},46                                {3},47                                {4}48                        },49                        Arrays.asList(50                                Arrays.asList(1),51                                Arrays.asList(2),52                                Arrays.asList(3),53                                Arrays.asList(4)54                        )55                },56        };57    }58    @Test(dataProvider = "getArraysAndLists")59    public void testObjectsToLists(Object[][] objects, List<List<Object>> lists) {60        Assert.assertEquals(TestNGUtils.nestedArraysToNestedLists(objects), lists);61    }62    @Test(dataProvider = "getArraysAndLists")63    public void testListsToArrays(Object[][] objects, List<List<Object>> lists) {64        final Object[][] convertedObjects = TestNGUtils.nestedListsToNestedArrays(lists);65        assertNestedArraysEqual(objects, convertedObjects);66    }67    private static void assertNestedArraysEqual(Object[][] objects, Object[][] convertedObjects) {68        for (int i = 0; i < objects.length; i++) {69            Assert.assertEquals(convertedObjects[i], objects[i]);70        }71    }72    @DataProvider73    public Object[][] getDataProviders() {74        return new Object[][]{75                {new Object[][]{{1, 2}}, new Object[][]{{3}, {4}}, new Object[][]{{1, 2, 3}, {1, 2, 4}}},76                {new Object[][]{{1}}, new Object[][]{{2}}, new Object[][]{{1, 2}}},77                {new Object[][]{{1}}, new Object[][]{{2, 3}}, new Object[][]{{1, 2, 3}}},78                {new Object[][]{{1}, {2}, {3}}, new Object[][]{{'a', 'b'}, {'c', 'd'}},79                        new Object[][]{{1, 'a', 'b'}, {1, 'c', 'd'},80                                {2, 'a', 'b'}, {2, 'c', 'd'},81                                {3, 'a', 'b'}, {3, 'c', 'd'}}},82                {new Object[][]{{}}, new Object[][]{{}}, new Object[][]{{}}},83                {new Object[][]{{}}, new Object[][]{{1}}, new Object[][]{{1}}},84                {new Object[][]{{}}, new Object[][]{{1, 2}}, new Object[][]{{1, 2}}},85                {new Object[][]{{1}}, new Object[][]{{}}, new Object[][]{{1}}},86                {new Object[][]{{}}, new Object[][]{{1}}, new Object[][]{{1}}},87                {new Object[][]{{EMPTY_ARRAY}}, new Object[][]{{1}}, new Object[][]{{EMPTY_ARRAY, 1}}},88                {new Object[][]{{1}, {2}, {3}}, new Object[][]{{4}, {5}, {6}},89                        new Object[][]{{1,4}, {1,5}, {1,6}, {2, 4}, {2, 5}, {2, 6}, {3, 4}, {3, 5}, {3, 6}}}90        };91    }92    @Test(dataProvider = "getDataProviders")93    public void testProduct(Object[][] dataProvider1, Object[][] dataProvider2, Object[][] expectedResult) {94        final Object[][] actual = TestNGUtils.cartesianProduct(dataProvider1, dataProvider2);95        assertNestedArraysEqual(actual, expectedResult);96    }97    @DataProvider98    public Object[][] getDifferingNumbersOfProviders() {99        final Object[][] p1 = new Object[][]{{1}, {2}};100        final Object[][] p2 = new Object[][]{{"a", "b"}};101        final Object[][] p3 = new Object[][]{{}};102        final Object[][] p4 = new Object[][]{{3}, {4}, {5}};103        final Object[][] expected0 = new Object[][]{{}};104        final Object[][] expected1 = new Object[][]{{1}, {2}};105        final Object[][] expected2 = new Object[][]{{1, "a", "b"}, {2, "a", "b"}};106        final Object[][] expected3 = expected2;107        final Object[][] expected4 = new Object[][]{108                {1, "a", "b", 3},109                {1, "a", "b", 4},110                {1, "a", "b", 5},111                {2, "a", "b", 3},112                {2, "a", "b", 4},113                {2, "a", "b", 5}114        };115        return new Object[][]{116                {Arrays.asList(), expected0},117                {Collections.singletonList(p1), expected1},118                {Arrays.asList(p1, p2), expected2},119                {Arrays.asList(p1, p2, p3), expected3},120                {Arrays.asList(p1, p2, p3, p4), expected4}121        };122    }123    @Test(dataProvider = "getDifferingNumbersOfProviders")124    public void testCartesianProductOfManyProviders(List<Object[]> providers, Object[][] expected){125        final Object[][] product = TestNGUtils.cartesianProduct(providers.toArray(new Object[][][]{}));126        assertNestedArraysEqual(product, expected);127    }128    @Test129    public void testSingleProvider() {130        final Object[][] expected = {{1, 2}};131        final Object[][] product = TestNGUtils.cartesianProduct(expected);132        assertNestedArraysEqual(product, expected);133    }134}...

Source:VerifyInterceptor.java

2import org.testng.IMethodInstance;3import org.testng.IMethodInterceptor;4import org.testng.ITestContext;5import org.testng.ITestNGMethod;6import org.testng.TestNGUtils;7import org.testng.collections.Maps;8import java.lang.annotation.Annotation;9import java.lang.reflect.Method;10import java.util.ArrayList;11import java.util.List;12import java.util.Map;13public class VerifyInterceptor implements IMethodInterceptor {14  /**15   * @return the list of methods received in parameters with all methods16   * annotated with @Verify inserted after each of these test methods.17   *18   * This happens in two steps:19   * - Find all the methods annotated with @Verify in the classes that contain test methods20   * - Insert these verify methods after each method passed in parameter21   * These @Verify methods are stored in a map keyed by the class in order to avoid looking them22   * up more than once on the same class.23   */24  @Override25  public List<IMethodInstance> intercept(List<IMethodInstance> methods,26      ITestContext context) {27    List<IMethodInstance> result = new ArrayList<>();28    Map<Class<?>, List<IMethodInstance>> verifyMethods = Maps.newHashMap();29    for (IMethodInstance mi : methods) {30      ITestNGMethod tm = mi.getMethod();31      List<IMethodInstance> verify = verifyMethods.get(tm.getRealClass());32      if (verify == null) {33        verify = findVerifyMethods(tm.getRealClass(), tm);34      }35      result.add(mi);36      result.addAll(verify);37    }38    return result;39  }40  /**41   * @return all the @Verify methods found on @code{realClass}42   */43  private List<IMethodInstance> findVerifyMethods(Class realClass, final ITestNGMethod tm) {44    List<IMethodInstance> result = new ArrayList<>();45    for (final Method m : realClass.getDeclaredMethods()) {46      Annotation a = m.getAnnotation(Verify.class);47      if (a != null) {48        final ITestNGMethod vm = TestNGUtils.createITestNGMethod(tm, m);49        result.add(new IMethodInstance() {50          @Override51          public Object[] getInstances() {52            return tm.getInstances();53          }54          @Override55          public ITestNGMethod getMethod() {56            return vm;57          }58          public int compareTo(IMethodInstance o) {59            if (getInstances()[0] == o.getInstances()[0]) {60              return 0;61            } else {62              return -1;...

Source:TestCaseInvokedMethodListener.java

1package com.itinvolve.itsm.framework.listeners;2import static com.itinvolve.itsm.framework.env.Setup.TESTLINK_TICKET_URL;3import org.testng.IInvokedMethod;4import org.testng.IInvokedMethodListener;5import org.testng.ITestResult;6import org.testng.Reporter;7import com.itinvolve.itsm.framework.annotations.AnnotationParser;8import com.itinvolve.itsm.framework.logs.Log;9import com.itinvolve.itsm.framework.logs.Log4jPropertiesHandler;10import com.itinvolve.itsm.framework.logs.TestCaseLogger;11import com.itinvolve.itsm.framework.utils.TestngUtils;12public class TestCaseInvokedMethodListener implements IInvokedMethodListener {13    @Override14    public void afterInvocation(IInvokedMethod method, ITestResult testResult) {15        Log.LOGGER.info("-> The " + TestngUtils.getFullMethodName(testResult) + " test has FINISHED");16        AnnotationParser.parseAfterTestMethod(testResult.getInstance(), TestngUtils.getMethodName(testResult));17    }18    @Override19    public void beforeInvocation(IInvokedMethod method, ITestResult testResult) {20        TestCaseLogger.reset();21        String logFileName = TestngUtils.buildFileName(testResult);22        Log4jPropertiesHandler.swithTestCaseLogFileName(logFileName);//only name23        Log.LOGGER.info("-> The " + TestngUtils.getFullMethodName(testResult) + " test has STARTED");24        Reporter.setCurrentTestResult(testResult);25        String annotationTestName = TestngUtils.getTestNameValue(testResult);26        if (!annotationTestName.isEmpty()) {27            Reporter.log("<a href='" + TESTLINK_TICKET_URL + annotationTestName + "'>" + annotationTestName + "</a><br/>");28        }29        String annotationTestDescription = TestngUtils.getDescriptionValue(testResult);30        if (!annotationTestDescription.isEmpty()) {31            Reporter.log(annotationTestDescription + "<br/>");32        }33        AnnotationParser.parseBeforeTestMethod(testResult.getInstance(), TestngUtils.getMethodName(testResult));34    }35}...

Source:TmpInvokedMethodListener.java

...4import org.testng.IInvokedMethod;5import org.testng.IInvokedMethodListener;6import org.testng.ITestResult;7import org.testng.Reporter;8import TestNGUtils.TestngUtils;9public class TmpInvokedMethodListener implements IInvokedMethodListener {10    @Override11    public void beforeInvocation(IInvokedMethod method, ITestResult testResult) {12        System.out.println("-------------------------------------------------------------------------------------------");13        System.out.println("Before From Invoked Method Listener ::: Method: " + testResult.getMethod().getConstructorOrMethod().getName() + " Class: " + testResult.getTestClass().getName());14        String testMethodName = testResult.getMethod().getConstructorOrMethod().getName();15        //String logFileName = (testClassName + testMethodName).replaceAll("\\.", "");16        Log4jPropertiesHandler.instance().swithLogFileName(testMethodName);17        Log.LOGGER.info("Starting test with" + TestngUtils.getFullNameMethod(testResult) + " method");18        Reporter.setCurrentTestResult(testResult);19        Reporter.log(testMethodName + ": <a href=logs/" + testMethodName + ".log>Log File</a><br/>");20    }21    @Override22    public void afterInvocation(IInvokedMethod method, ITestResult testResult) {...

Source:TestCaseTestListener.java

1package com.itinvolve.itsm.framework.listeners;2import org.testng.ITestResult;3import org.testng.Reporter;4import org.testng.TestListenerAdapter;5import com.itinvolve.itsm.framework.env.ScreenshotHandler;6import com.itinvolve.itsm.framework.env.Setup;7import com.itinvolve.itsm.framework.logs.Log;8import com.itinvolve.itsm.framework.logs.TestCaseLogger;9import com.itinvolve.itsm.framework.utils.TestngUtils;10public class TestCaseTestListener extends TestListenerAdapter  {11    @Override12    public void onTestFailure(ITestResult testResult) {13        Reporter.setCurrentTestResult(testResult);14        Log.LOGGER.error("-> The " + TestngUtils.getFullMethodName(testResult) + " test has FAILED because "  + testResult.getThrowable().getMessage());15        if (Setup.USE_BROWSER_FOR_TEST) {16            String fileName = TestngUtils.buildFileName(testResult);17            Reporter.log("<a href='logs/" + fileName + ".log'>Test Case Log</a>&nbsp &nbsp");18            Reporter.log("<a href='logs/catchAll.log'>General Log</a><br/>");19            ScreenshotHandler.takeScreenshotAddToReport(fileName, testResult);20            TestCaseLogger.logsToReport();21            ScreenshotHandler.compareImageFileToReport();22        }23    }24    @Override25    public void onTestSkipped(ITestResult testResult) {26        Log.LOGGER.warn("-> The " + TestngUtils.getFullMethodName(testResult) + " test has SKIPPED");27    }28    @Override29    public void onTestSuccess(ITestResult testResult) {30        Reporter.setCurrentTestResult(testResult);31        Log.LOGGER.info("-> The " + TestngUtils.getFullMethodName(testResult) + " test has PASSED");32        if (Setup.USE_BROWSER_FOR_TEST) {33            ScreenshotHandler.compareImageFileToReport();34        }35    }36}...

Source:TestListener.java

1package base;2import org.testng.ITestContext;3import org.testng.ITestListener;4import org.testng.ITestResult;5import org.testng.TestNGUtils;6public class TestListener implements ITestListener {7	TestNGUtils utils = new TestNGUtils();8	9	public void onTestFailure(ITestResult result) {10	}11	@Override12	public void onTestStart(ITestResult result) {13	}14	@Override15	public void onTestSuccess(ITestResult result) {16		17	}18	@Override19	public void onTestSkipped(ITestResult result) {20	}21	@Override...

TestNGUtils

Using AI Code Generation

1import org.testng.TestNGUtils;2import org.testng.TestNG;3import org.testng.Suite;4import org.testng.Test;5import org.testng.ITestNGListener;6import org.testng.ITestContext;7import org.testng.ITestResult;8import org.testng.IInvokedMethod;9import org.testng.IInvokedMethodListener;10import org.testng.IMethodInterceptor;11import org.testng.IMethodInstance;12import org.testng.IAnnotationTransformer;13import org.testng.IClassListener;14import org.testng.IClassTransformer;15import org.testng.IExecutionListener;16import org.testng.IHookable;17import org.testng.IHookCallBack;18import org.testng.IHookable;19import org.testng.IHookCallBack;20import org.testng.IHookable;21import org.testng.IHookCallBack;22import org.testng.IHookable;23import org.testng.IHookCallBack;24import org.testng.IHookable;25import org.testng.IHookCallBack;

TestNGUtils

Using AI Code Generation

1import org.testng.TestNGUtils;2import org.testng.TestNGUtils;3public class TestNGUtilsExample {4    public static void main(String[] args) {5        TestNGUtils testNGUtils = new TestNGUtils();6        TestNGUtils testNGUtils = new TestNGUtils();7        List<String> failedTestCases = testNGUtils.getFailedTestCases();8        List<String> failedTestCases = testNGUtils.getFailedTestCases();9        System.out.println("Failed Test Cases: " + failedTestCases);10        System.out.println("Failed Test Cases: " + failedTestCases);11    }12}

TestNG tutorial

TestNG is a Java-based open-source framework for test automation that includes various test types, such as unit testing, functional testing, E2E testing, etc. TestNG is in many ways similar to JUnit and NUnit. But in contrast to its competitors, its extensive features make it a lot more reliable framework. One of the major reasons for its popularity is its ability to structure tests and improve the scripts' readability and maintainability. Another reason can be the important characteristics like the convenience of using multiple annotations, reliance, and priority that make this framework popular among developers and testers for test design. You can refer to the TestNG tutorial to learn why you should choose the TestNG framework.

Chapters

JUnit 5 vs. TestNG: Compare and explore the core differences between JUnit 5 and TestNG from the Selenium WebDriver viewpoint.
Installing TestNG in Eclipse: Start installing the TestNG Plugin and learn how to set up TestNG in Eclipse to begin constructing a framework for your test project.
Create TestNG Project in Eclipse: Get started with creating a TestNG project and write your first TestNG test script.
Automation using TestNG: Dive into how to install TestNG in this Selenium TestNG tutorial, the fundamentals of developing an automation script for Selenium automation testing.
Parallel Test Execution in TestNG: Here are some essential elements of parallel testing with TestNG in this Selenium TestNG tutorial.
Creating TestNG XML File: Here is a step-by-step tutorial on creating a TestNG XML file to learn why and how it is created and discover how to run the TestNG XML file being executed in parallel.
Automation with Selenium, Cucumber & TestNG: Explore for an in-depth tutorial on automation using Selenium, Cucumber, and TestNG, as TestNG offers simpler settings and more features.
JUnit Selenium Tests using TestNG: Start running your regular and parallel tests by looking at how to run test cases in Selenium using JUnit and TestNG without having to rewrite the tests.
Group Test Cases in TestNG: Along with the explanation and demonstration using relevant TestNG group examples, learn how to group test cases in TestNG.
Prioritizing Tests in TestNG: Get started with how to prioritize test cases in TestNG for Selenium automation testing.
Assertions in TestNG: Examine what TestNG assertions are, the various types of TestNG assertions, and situations that relate to Selenium automated testing.
DataProviders in TestNG: Deep dive into learning more about TestNG's DataProvider and how to effectively use it in our test scripts for Selenium test automation.
Parameterization in TestNG: Here are the several parameterization strategies used in TestNG tests and how to apply them in Selenium automation scripts.
TestNG Listeners in Selenium WebDriver: Understand the various TestNG listeners to utilize them effectively for your next plan when working with TestNG and Selenium automation.
TestNG Annotations: Learn more about the execution order and annotation attributes, and refer to the prerequisites required to set up TestNG.
TestNG Reporter Log in Selenium: Find out how to use the TestNG Reporter Log and learn how to eliminate the need for external software with TestNG Reporter Class to boost productivity.
TestNG Reports in Jenkins: Discover how to generate TestNG reports in Jenkins if you want to know how to create, install, and share TestNG reports in Jenkins.

Certification

You can push your abilities to do automated testing using TestNG and advance your career by earning a TestNG certification. Check out our TestNG certification.