Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use TestNamesMatcher class of org.testng.xml.internal package

Best Testng code snippet using org.testng.xml.internal.TestNamesMatcher

Source:TestNamesMatcherTest.java

...11import java.util.Arrays;12import java.util.Collections;13import java.util.List;14import static org.assertj.core.api.Assertions.assertThat;15public class TestNamesMatcherTest extends SimpleBaseTest {16  @Test17  public void testCloneIfContainsTestsWithNamesMatchingAny() {18    XmlSuite suite = createDummySuiteWithTestNamesAs("test1", "test2");19    TestNamesMatcher testNamesMatcher =20        new TestNamesMatcher(suite, Collections.singletonList("test2"));21    List<XmlTest> xmlTests = testNamesMatcher.getMatchedTests();22    assertThat(suite.getTests()).hasSameElementsAs(xmlTests);23  }24  @Test(description = "GITHUB-1594", dataProvider = "getTestnames")25  public void testCloneIfContainsTestsWithNamesMatchingAnyChildSuites(26      String testname, boolean foundInParent, boolean foundInChildOfChild) {27    XmlSuite parentSuite = createDummySuiteWithTestNamesAs("test1", "test2");28    parentSuite.setName("parent_suite");29    XmlSuite childSuite = createDummySuiteWithTestNamesAs("test3", "test4");30    childSuite.setName("child_suite");31    parentSuite.getChildSuites().add(childSuite);32    XmlSuite childOfChildSuite = createDummySuiteWithTestNamesAs("test5", "test6");33    childSuite.getChildSuites().add(childOfChildSuite);34    TestNamesMatcher testNamesMatcher =35        new TestNamesMatcher(parentSuite, Collections.singletonList(testname));36    List<XmlTest> xmlTests = testNamesMatcher.getMatchedTests();37    if (foundInParent) {38      assertThat(xmlTests).hasSameElementsAs(parentSuite.getTests());39    } else if (!foundInChildOfChild) {40      assertThat(xmlTests).hasSameElementsAs(childSuite.getTests());41    } else {42      assertThat(xmlTests).hasSameElementsAs(childOfChildSuite.getTests());43    }44  }45  @Test(46      expectedExceptions = TestNGException.class,47      expectedExceptionsMessageRegExp = "\nPlease provide a valid list of names to check.",48      dataProvider = "getData")49  public void testCloneIfContainsTestsWithNamesMatchingAnyNegativeCondition(50      XmlSuite xmlSuite, List<String> names) {51    TestNamesMatcher testNamesHelper = new TestNamesMatcher(xmlSuite, names);52  }53  @Test54  public void testIfTestnamesComesFromDifferentSuite() {55    XmlSuite parentSuite = createDummySuiteWithTestNamesAs("test1", "test2");56    parentSuite.setName("parent_suite");57    XmlSuite childSuite = createDummySuiteWithTestNamesAs("test3", "test4");58    childSuite.setName("child_suite");59    parentSuite.getChildSuites().add(childSuite);60    XmlSuite childOfChildSuite = createDummySuiteWithTestNamesAs("test5", "test6");61    childSuite.getChildSuites().add(childOfChildSuite);62    TestNamesMatcher testNamesMatcher =63        new TestNamesMatcher(64            parentSuite, new ArrayList<>(Arrays.asList("test1", "test3", "test5")));65    List<String> matchedTestnames = Lists.newArrayList();66    for (XmlTest xmlTest : testNamesMatcher.getMatchedTests()) {67      matchedTestnames.add(xmlTest.getName());68    }69    assertThat(matchedTestnames).hasSameElementsAs(Arrays.asList("test1", "test3", "test5"));70  }71  @Test(72      expectedExceptions = TestNGException.class,73      expectedExceptionsMessageRegExp = "\nThe test\\(s\\) \\<\\[test3\\]\\> cannot be found.")74  public void testCloneIfContainsTestsWithNamesMatchingAnyWithoutMatch() {75    XmlSuite xmlSuite = createDummySuiteWithTestNamesAs("test1", "test2");76    TestNamesMatcher testNamesMatcher =77        new TestNamesMatcher(xmlSuite, Collections.singletonList("test3"));78    List<XmlSuite> clonedSuites = testNamesMatcher.getSuitesMatchingTestNames();79    if (!CollectionUtils.hasElements(clonedSuites)) {80      throw new TestNGException(81          "The test(s) <" + Collections.singletonList("test3").toString() + "> cannot be found.");82    }83  }84  @DataProvider(name = "getTestnames")85  public Object[][] getTestnameToSearchFor() {86    return new Object[][] {87      {"test4", false, false},88      {"test1", true, false},89      {"test5", false, true}90    };91  }...

Source:JarFileUtils.java

...5import org.testng.util.Strings;6import org.testng.xml.IPostProcessor;7import org.testng.xml.Parser;8import org.testng.xml.XmlSuite;9import org.testng.xml.internal.TestNamesMatcher;10import org.testng.xml.internal.XmlSuiteUtils;11import java.io.File;12import java.io.IOException;13import java.io.InputStream;14import java.util.Collection;15import java.util.Enumeration;16import java.util.List;17import java.util.jar.JarEntry;18import java.util.jar.JarFile;19/** A Utility for extracting {@link XmlSuite} from a jar. */20class JarFileUtils {21  private final IPostProcessor processor;22  private final String xmlPathInJar;23  private final List<String> testNames;24  private final List<XmlSuite> suites = Lists.newLinkedList();25  private final XmlSuite.ParallelMode mode;26  JarFileUtils(IPostProcessor processor, String xmlPathInJar, List<String> testNames) {27    this(processor, xmlPathInJar, testNames, XmlSuite.ParallelMode.NONE);28  }29  JarFileUtils(30      IPostProcessor processor,31      String xmlPathInJar,32      List<String> testNames,33      XmlSuite.ParallelMode mode) {34    this.processor = processor;35    this.xmlPathInJar = xmlPathInJar;36    this.testNames = testNames;37    this.mode = mode == null ? XmlSuite.ParallelMode.NONE : mode;38  }39  List<XmlSuite> extractSuitesFrom(File jarFile) {40    try {41      Utils.log("TestNG", 2, "Trying to open jar file:" + jarFile);42      List<String> classes = Lists.newArrayList();43      boolean foundTestngXml = testngXmlExistsInJar(jarFile, classes);44      if (!foundTestngXml) {45        Utils.log(46            "TestNG",47            1,48            "Couldn't find the " + xmlPathInJar + " in the jar file, running all the classes");49        XmlSuite suite = XmlSuiteUtils.newXmlSuiteUsing(classes);50        suite.setParallel(this.mode);51        suites.add(suite);52      }53    } catch (IOException ex) {54      throw new TestNGException(ex);55    }56    return suites;57  }58  private boolean testngXmlExistsInJar(File jarFile, List<String> classes) throws IOException {59    try (JarFile jf = new JarFile(jarFile)) {60      Enumeration<JarEntry> entries = jf.entries();61      File file = java.nio.file.Files.createTempDirectory("testngXmlPathInJar-").toFile();62      file.deleteOnExit();63      String suitePath = null;64      while (entries.hasMoreElements()) {65        JarEntry je = entries.nextElement();66        String jeName = je.getName();67        if (Parser.canParse(jeName.toLowerCase())) {68          InputStream inputStream = jf.getInputStream(je);69          File copyFile = new File(file, jeName);70          Files.copyFile(inputStream, copyFile);71          if (matchesXmlPathInJar(je)) {72            suitePath = copyFile.toString();73          }74        } else if (isJavaClass(je)) {75          classes.add(constructClassName(je));76        }77      }78      if (Strings.isNullOrEmpty(suitePath)) {79        return false;80      }81      Collection<XmlSuite> parsedSuites = Parser.parse(suitePath, processor);82      for (XmlSuite suite : parsedSuites) {83        // If test names were specified, only run these test names84        if (testNames != null) {85          TestNamesMatcher testNamesMatcher = new TestNamesMatcher(suite, testNames);86          List<String> missMatchedTestname = testNamesMatcher.getMissMatchedTestNames();87          if (!missMatchedTestname.isEmpty()) {88            throw new TestNGException("The test(s) <" + missMatchedTestname + "> cannot be found.");89          }90          suites.addAll(testNamesMatcher.getSuitesMatchingTestNames());91        } else {92          suites.add(suite);93        }94        return true;95      }96    }97    return false;98  }99  private boolean matchesXmlPathInJar(JarEntry je) {...

Source:TestNamesMatcher.java

...4import org.testng.collections.Lists;5import org.testng.xml.XmlSuite;6import org.testng.xml.XmlTest;7/** The class to work with "-testnames" */8public final class TestNamesMatcher {9  private final List<XmlSuite> cloneSuites = Lists.newArrayList();10  private final List<String> matchedTestNames = Lists.newArrayList();11  private final List<XmlTest> matchedTests = Lists.newArrayList();12  private final List<String> testNames;13  public TestNamesMatcher(XmlSuite xmlSuite, List<String> testNames) {14    this.testNames = testNames;15    cloneIfContainsTestsWithNamesMatchingAny(xmlSuite, this.testNames);16  }17  /**18   * Recursive search the given testNames from the current {@link XmlSuite} and its child suites.19   *20   * @param xmlSuite The {@link XmlSuite} to work with.21   * @param testNames The list of testnames to iterate through22   */23  private void cloneIfContainsTestsWithNamesMatchingAny(XmlSuite xmlSuite, List<String> testNames) {24    if (testNames == null || testNames.isEmpty()) {25      throw new TestNGException("Please provide a valid list of names to check.");26    }27    // Start searching in the current suite....

Source:SuiteparallelRun.java

1package com.project;2import java.util.Arrays;3import org.testng.TestNG;4import org.testng.xml.internal.TestNamesMatcher;5public class SuiteparallelRun {6	public static void main(String[] args) {7		//String s1[]= {"r1","r2"};8		9		//String s[]=new String[2];10		//s[0]="r1";11		//s[1]="r2";12		13		//String s3[]=new String[] {"r1","r2"};14		15		TestNG obj=new TestNG();16		obj.setTestSuites(Arrays.asList(new String[]{System.getProperty("user.dir")+"//megasuite.xml"}));17		obj.setSuiteThreadPoolSize(2);18		obj.run();...

TestNamesMatcher

Using AI Code Generation

1package org.testng.xml.internal;2import java.util.ArrayList;3import java.util.List;4import java.util.regex.Matcher;5import java.util.regex.Pattern;6import org.testng.TestNGException;7import org.testng.collections.Lists;8public class TestNamesMatcher {9  private final Pattern m_pattern;10  private final boolean m_include;11  private final boolean m_includeGroups;12  public TestNamesMatcher(String pattern, boolean include, boolean includeGroups) {13    if (pattern == null) {14      throw new TestNGException("Pattern cannot be null");15    }16    m_pattern = Pattern.compile(pattern);17    m_include = include;18    m_includeGroups = includeGroups;19  }20  public List<String> filterTestNames(List<String> testNames) {21    List<String> result = Lists.newArrayList();22    for (String testName : testNames) {23      if (m_include == shouldInclude(testName)) {24        result.add(testName);25      }26    }27    return result;28  }29  public List<String> filterTestGroups(List<String> testGroups) {30    List<String> result = Lists.newArrayList();31    for (String testGroup : testGroups) {32      if (m_includeGroups == shouldInclude(testGroup)) {33        result.add(testGroup);34      }35    }36    return result;37  }38  private boolean shouldInclude(String testName) {39    Matcher matcher = m_pattern.matcher(testName);40    return matcher.find();41  }42}43public class TestNamesMatcherTest {44  @DataProvider(name = "testNames")45  public Object[][] testNames() {46    return new Object[][]{47        {"test1", "test2", "test3", "test4", "test5", "test6", "test7", "test8", "test9", "test10"},48        {"test1", "test2", "test3", "test4", "test5", "test6",

TestNamesMatcher

Using AI Code Generation

1TestNG testNG = new TestNG();2testNG.setTestClasses(new Class[] { TestNamesMatcher.class });3testNG.run();4System.out.println("TestNamesMatcher.testNames="+TestNamesMatcher.testNames);5StringBuffer sb = new StringBuffer();6sb.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r7");8");9sb.append("10");11sb.append("<suite name=\"TestSuite\" parallel=\"none\" thread-count=\"1\">\r12");13sb.append(" <test name=\"Test\">\r14");15sb.append("  <classes>\r16");17for (String name : TestNamesMatcher.testNames) {18    sb.append("   <class name=\""+name+"\"/>\r19");20}21sb.append("  </classes>\r22");23sb.append(" </test>\r24");25sb.append("</suite>\r26");27FileWriter fw = new FileWriter("testng.xml");28fw.write(sb.toString());29fw.close();30testNG = new TestNG();31testNG.setTestSuites(new String[] { "testng.xml" });32testNG.run();33}34}35package org.testng.xml.internal;36import java.util.ArrayList;37import java.util.List;38import java.util.regex.Pattern;39import java.util.regex.PatternSyntaxException;40import org.testng.TestNG;41import org.testng.annotations.Test;42import org.testng.xml.XmlClass;43import org.testng.xml.XmlSuite;44import org.testng.xml.XmlTest;45public class TestNamesMatcher {46public static List<String> testNames = new ArrayList<String>();47public void testNamesMatcher() throws PatternSyntaxException {48    XmlSuite suite = new XmlSuite();49    suite.setName("TestSuite");50    suite.setParallel(XmlSuite.ParallelMode.NONE);51    suite.setThreadCount(1);52    XmlTest test = new XmlTest(suite);

TestNamesMatcher

Using AI Code Generation

1package com.test;2import java.io.File;3import java.util.ArrayList;4import java.util.List;5import org.testng.TestNG;6import org.testng.xml.Parser;7import org.testng.xml.XmlSuite;8import org.testng.xml.internal.TestNamesMatcher;9import org.testng.xml.internal.XmlSuiteUtils;10public class TestNGParameterization {11public static void main(String[] args) {12TestNG testng = new TestNG();13List<XmlSuite> suites = new ArrayList<XmlSuite>();14Parser parser = new Parser("C:\\Users\\test\\Desktop\\testng.xml");15XmlSuite suite = parser.parseToList().get(0);16TestNamesMatcher matcher = new TestNamesMatcher(suite);17List<String> testNames = matcher.getTestNames();18List<String> testNamesParameter = new ArrayList<String>();19for (String testName : testNames) {20testNamesParameter.add(testName);21}22List<String> parameterNames = suite.getParameters();23List<String> parameterNamesParameter = new ArrayList<String>();24for (String parameterName : parameterNames) {25parameterNamesParameter.add(parameterName);26}27List<List<String>> suiteParameters = XmlSuiteUtils.getSuiteParameters(suite);28testNamesParameter.addAll(suiteParameters.get(0));29parameterNamesParameter.addAll(suiteParameters.get(1));30suite.setTestNames(testNamesParameter);31suite.setParameters(parameterNamesParameter);32suites.add(suite);33testng.setXmlSuites(suites);

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.