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

How to use setDescription method of org.testng.xml.XmlInclude class

Best Testng code snippet using org.testng.xml.XmlInclude.setDescription

Source:TestNGMethod.java

...75      isDataDriven = doesTestAnnotationHaveADataProvider(testAnnotation);76      setInvocationCount(testAnnotation.getInvocationCount());77      setThreadPoolSize(testAnnotation.getThreadPoolSize());78      setAlwaysRun(testAnnotation.getAlwaysRun());79      setDescription(findDescription(testAnnotation, xmlTest));80      setEnabled(testAnnotation.getEnabled());81      setRetryAnalyzer(cloneInstance(testAnnotation.getRetryAnalyzer()));82      setRetryAnalyzerClass(testAnnotation.getRetryAnalyzerClass());83      setSkipFailedInvocations(testAnnotation.skipFailedInvocations());84      setInvocationTimeOut(testAnnotation.invocationTimeOut());85      setIgnoreMissingDependencies(testAnnotation.ignoreMissingDependencies());86      setPriority(testAnnotation.getPriority());87      m_attributes = testAnnotation.getAttributes();88    }89    // Groups90    initGroups(ITestAnnotation.class);91  }92  private static boolean doesTestAnnotationHaveADataProvider(ITestAnnotation testAnnotation) {93    return !testAnnotation.getDataProvider().trim().isEmpty()94        || testAnnotation.getDataProviderClass() != null;95  }96  private String findDescription(ITestAnnotation testAnnotation, XmlTest xmlTest) {97    String result = testAnnotation.getDescription();98    if (result != null) {99      return result;100    }101    List<XmlClass> classes = xmlTest.getXmlClasses();102    return classes.stream()103        .filter(this::classNameMatcher)104        .flatMap(xmlClass -> xmlClass.getIncludedMethods().stream())105        .filter(this::methodNameMatcher)106        .map(XmlInclude::getDescription)107        .filter(Objects::nonNull)108        .findFirst().orElse("");109  }110  private boolean classNameMatcher(XmlClass xmlClass) {111    return xmlClass.getName().equals(m_method.getMethod().getDeclaringClass().getName());112  }113  private boolean methodNameMatcher(XmlInclude xmlInclude) {114    return xmlInclude.getName().equals(m_method.getName());115  }116  /** {@inheritDoc} */117  @Override118  public int getThreadPoolSize() {119    return m_threadPoolSize;120  }121  /** Sets the number of threads on which this method should be invoked. */122  @Override123  public void setThreadPoolSize(int threadPoolSize) {124    m_threadPoolSize = threadPoolSize;125  }126  /** Sets the number of invocations for this method. */127  @Override128  public void setInvocationCount(int counter) {129    m_invocationCount = counter;130  }131  /**132   * Clones the current <code>TestNGMethod</code> and its @BeforeMethod and @AfterMethod methods.133   *134   * @see org.testng.internal.BaseTestMethod#clone()135   */136  @Override137  public BaseTestMethod clone() {138    TestNGMethod clone =139        new TestNGMethod(140            getConstructorOrMethod().getMethod(),141            getAnnotationFinder(),142            false,143            getXmlTest(),144            getInstance());145    ITestClass tc = getTestClass();146    NoOpTestClass testClass = new NoOpTestClass(tc);147    testClass.setBeforeTestMethods(clone(tc.getBeforeTestMethods()));148    testClass.setAfterTestMethod(clone(tc.getAfterTestMethods()));149    clone.m_testClass = testClass;150    clone.setDate(getDate());151    clone.setGroups(getGroups());152    clone.setGroupsDependedUpon(getGroupsDependedUpon(), Collections.emptyList());153    clone.setMethodsDependedUpon(getMethodsDependedUpon());154    clone.setAlwaysRun(isAlwaysRun());155    clone.m_beforeGroups = getBeforeGroups();156    clone.m_afterGroups = getAfterGroups();157    clone.m_currentInvocationCount = m_currentInvocationCount;158    clone.setMissingGroup(getMissingGroup());159    clone.setThreadPoolSize(getThreadPoolSize());160    clone.setDescription(getDescription());161    clone.setEnabled(getEnabled());162    clone.setParameterInvocationCount(getParameterInvocationCount());163    clone.setInvocationCount(getInvocationCount());164    clone.m_successPercentage = getSuccessPercentage();165    clone.setTimeOut(getTimeOut());166    clone.setRetryAnalyzer(getRetryAnalyzer());167    clone.setRetryAnalyzerClass(getRetryAnalyzerClass());168    clone.setSkipFailedInvocations(skipFailedInvocations());169    clone.setInvocationNumbers(getInvocationNumbers());170    clone.setPriority(getPriority());171    return clone;172  }173  private static ITestNGMethod[] clone(ITestNGMethod[] sources) {174    return Arrays.stream(sources)...

Source:GenerateTestngXml.java

...66            if (myClasses.get(index).getName().equalsIgnoreCase(tempClass.getName())) {67              methods = myClasses.get(index).getIncludedMethods();68              for(int i =0;i<tlist.size()-1;i++){69                XmlInclude methodInclude = new XmlInclude(tlist.get(i+1));70                methodInclude.setDescription(entry.getKey());71                methods.add(methods.size(), methodInclude);72              }73              //            methods.get(methods.size()-1).setDescription(entry.getKey()); /*74              // Currently issue with TestNG to update method level description. Will revisit it,75              // once resolved from TestNG team. */76              tempClass = myClasses.get(index);77              tempClass.setIncludedMethods(methods);78              foundClass = true;79            }80          }81        }82        if (foundClass) {83          continue;84        } else {85          methods = new ArrayList<XmlInclude>();86          for(int i =0;i<tlist.size()-1;i++){87            XmlInclude methodInclude = new XmlInclude(tlist.get(i+1));88            methodInclude.setDescription(entry.getKey());89            methods.add(methods.size(), methodInclude);90          }91          tempClass.setIncludedMethods(methods);92          myClasses.add(tempClass);93        }94      }95    }96    //     Assign that to the XmlTest Object created earlier.97    myTest.setXmlClasses(myClasses);98    // Add the suite to the list of suites.99    List<XmlSuite> mySuites = new ArrayList<XmlSuite>();100    mySuites.add(mySuite);101    // Set the list of Suites to the testNG object you created earlier.102    myTestNG.setXmlSuites(mySuites);...

Source:XmlInclude.java

...27    m_name = n;28    m_invocationNumbers = list;29    m_index = index;30  }31  public void setDescription(String description) {32    m_description = description;33  }34  public String getDescription() {35    return m_description;36  }37  public String getName() {38    return m_name;39  }40  public List<Integer> getInvocationNumbers() {41    return m_invocationNumbers;42  }43  public int getIndex() {44    return m_index;45  }...

Source:Test1.java

...36        //     Object obj = testData[0];37        //     if(obj instanceof TUser){38        //         System.out.println("AAAAAAAAA");39        //         TUser u = (TUser) obj;40        //         xmlInclude.setDescription(u.getName());41        //     }42        // }43    }44    @DataProvider45    public Object[] getData(ITestContext context, Method method){46        // context.getCurrentXmlTest().setName("AAAAAAA");47        return new Object[]{48                new TUser("zw1",12,"æµè¯1"),49                new TUser("zw2",13,"æµè¯2"),50                new TUser("zw3",14,"æµè¯3"),51        };52    }53    @Story("æµè¯1")54    @Test(description = "AAA",dependsOnMethods = {"test12"})...

setDescription

Using AI Code Generation

1import org.testng.TestNG;2import org.testng.xml.XmlInclude;3import org.testng.xml.XmlSuite;4import org.testng.xml.XmlTest;5import java.util.ArrayList;6import java.util.List;7public class TestNGSetDescription {8    public static void main(String[] args) {9        TestNG myTestNG = new TestNG();10        XmlSuite mySuite = new XmlSuite();11        mySuite.setName("MySuite");12        XmlTest myTest = new XmlTest(mySuite);13        myTest.setName("MyTest");14        myTest.setPreserveOrder("true");15        List<XmlInclude> methodsToRun = new ArrayList<XmlInclude>();16        XmlInclude method1 = new XmlInclude("testMethod1");17        method1.setDescription("This is testMethod1");18        methodsToRun.add(method1);19        XmlInclude method2 = new XmlInclude("testMethod2");20        method2.setDescription("This is testMethod2");21        methodsToRun.add(method2);22        myTest.setIncludedMethods(methodsToRun);23        List<XmlTest> myTests = new ArrayList<XmlTest>();24        myTests.add(myTest);25        mySuite.setTests(myTests);26        List<XmlSuite> mySuites = new ArrayList<XmlSuite>();27        mySuites.add(mySuite);28        myTestNG.setXmlSuites(mySuites);29        myTestNG.run();30    }31    public void testMethod1() {32        System.out.println("TestNG testMethod1");33    }34    public void testMethod2() {35        System.out.println("TestNG testMethod

setDescription

Using AI Code Generation

1public class TestNGXmlIncludeSetDescription {2public static void main(String[] args) {3XmlSuite xmlSuite = new XmlSuite();4xmlSuite.setName("TestNGXmlIncludeSetDescription");5xmlSuite.setParallel(XmlSuite.ParallelMode.TESTS);6XmlTest xmlTest = new XmlTest(xmlSuite);7xmlTest.setName("TestNGXmlIncludeSetDescription Test");8List<XmlInclude> methodsToRun = new ArrayList<XmlInclude>();9XmlInclude method1 = new XmlInclude("testMethod1");10XmlInclude method2 = new XmlInclude("testMethod2");11XmlInclude method3 = new XmlInclude("testMethod3");12methodsToRun.add(method1);13methodsToRun.add(method2);14methodsToRun.add(method3);15xmlTest.setIncludedMethods(methodsToRun);16method1.setDescription("This is test method 1");17method2.setDescription("This is test method 2");18method3.setDescription("This is test method 3");19XmlClass testClass = new XmlClass("test.TestNGXmlIncludeSetDescription");20xmlTest.setXmlClasses(Arrays.asList(testClass));21List<XmlTest> myTests = new ArrayList<XmlTest>();22myTests.add(xmlTest);23xmlSuite.setTests(myTests);24List<XmlSuite> mySuites = new ArrayList<XmlSuite>();25mySuites.add(xmlSuite);26TestNG myTestNG = new TestNG();27myTestNG.setXmlSuites(mySuites);28myTestNG.run();29}30public void testMethod1() {31System.out.println("TestNGXmlIncludeSetDescription.testMethod1");32}33public void testMethod2() {34System.out.println("TestNGXmlIncludeSetDescription.testMethod2");35}36public void testMethod3() {37System.out.println("TestNGXmlIncludeSetDescription.testMethod3");38}39}

setDescription

Using AI Code Generation

1XmlInclude include = new XmlInclude("testMethod");2include.setDescription("description for test method");3XmlClass testClass = new XmlClass("com.test.TestClass");4testClass.setIncludedMethods(Arrays.asList(include));5XmlSuite suite = new XmlSuite();6suite.setName("test suite");7suite.setTests(Arrays.asList(new XmlTest(suite).setClasses(Arrays.asList(testClass))));8XmlTest test = new XmlTest(suite);9test.addIncludedGroup("test group");10test.setXmlClasses(Arrays.asList(testClass));11suite.setDescription("description for test suite");12XmlPackage testPackage = new XmlPackage("com.test");13testPackage.setXmlTest(Arrays.asList(test));14suite.setXmlPackages(Arrays.asList(testPackage));15XmlPackage testPackage = new XmlPackage("com.test");16testPackage.setXmlTest(Arrays.asList(test));17suite.setXmlPackages(Arrays.asList(testPackage));18XmlTest test = new XmlTest(suite);19test.addParameter("test parameter", "value for test parameter");20suite.setDescription("description for test suite");21XmlPackage testPackage = new XmlPackage("com.test");22testPackage.setXmlTest(Arrays.asList(test));23suite.setXmlPackages(Arrays.asList(testPackage));24XmlPackage testPackage = new XmlPackage("com.test");25testPackage.setXmlTest(Arrays.asList(test));26suite.setXmlPackages(Arrays.asList(testPackage));27XmlTest test = new XmlTest(suite);28test.addParameter("test parameter", "value for test parameter");29suite.setDescription("description for test suite");30XmlPackage testPackage = new XmlPackage("com.test");31testPackage.setXmlTest(Arrays.asList(test));32suite.setXmlPackages(Arrays.asList(testPackage));33XmlPackage testPackage = new XmlPackage("com.test");34testPackage.setXmlTest(Arrays.asList(test));35suite.setXmlPackages(Arrays.asList(testPackage));36XmlTest test = new XmlTest(suite);37test.addParameter("test parameter", "value for test parameter");38suite.setDescription("description for test suite");

setDescription

Using AI Code Generation

1XmlInclude include = new XmlInclude("test");2include.setDescription("This is a test method");3XmlTest test = new XmlTest(suite);4test.setName("Test");5List<XmlInclude> methodsToRun = new ArrayList<>();6methodsToRun.add(include);7XmlClass testClass = new XmlClass("com.foo.TestClass");8testClass.setIncludedMethods(methodsToRun);9List<XmlClass> classes = new ArrayList<>();10classes.add(testClass);11test.setXmlClasses(classes);12List<XmlSuite> suites = new ArrayList<>();13suites.add(suite);14TestNG tng = new TestNG();15tng.setXmlSuites(suites);16tng.run();

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.