Streamline xml serialisation to string

Closes #3177
testng-team · Feb 20, 2025 · 44b0f23 · 44b0f23
1 parent df04c65
commit 44b0f23
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 2 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -1,4 +1,5 @@
 Current (7.12.0)
+Fixed: GITHUB-3177: Method org.testng.xml.XmlSuite#toXml do not save new properties like "share-thread-pool-for-data-providers" (Krishnan Mahadevan)
 Fixed: GITHUB-3179: ClassCastException when use shouldUseGlobalThreadPool(true) property (Krishnan Mahadevan)
 Fixed: GITHUB-2765: Test timeouts using existing Executor now propagate the stack trace to the ThreadTimeoutException (Charlie Hayes)
 

diff --git a/testng-core-api/src/main/java/org/testng/xml/DefaultXmlWeaver.java b/testng-core-api/src/main/java/org/testng/xml/DefaultXmlWeaver.java
@@ -45,6 +45,16 @@ public String asXml(XmlSuite xmlSuite) {
     if (parallel != null && !XmlSuite.DEFAULT_PARALLEL.equals(parallel)) {
       p.setProperty("parallel", parallel.toString());
     }
+    XmlUtils.setProperty(
+        p,
+        "use-global-thread-pool",
+        String.valueOf(xmlSuite.useGlobalThreadPool()),
+        DEFAULT_SHARE_THREAD_POOL.toString());
+    XmlUtils.setProperty(
+        p,
+        "share-thread-pool-for-data-providers",
+        String.valueOf(xmlSuite.isShareThreadPoolForDataProviders()),
+        DEFAULT_SHARE_THREAD_POOL_FOR_DATA_PROVIDERS.toString());
     XmlUtils.setProperty(
         p,
         "group-by-instances",

diff --git a/testng-core-api/src/main/java/org/testng/xml/XmlSuite.java b/testng-core-api/src/main/java/org/testng/xml/XmlSuite.java
@@ -137,9 +137,11 @@ public String toString() {
   public static final Boolean DEFAULT_SKIP_FAILED_INVOCATION_COUNTS = Boolean.FALSE;
   private Boolean m_skipFailedInvocationCounts = DEFAULT_SKIP_FAILED_INVOCATION_COUNTS;
 
-  private boolean shareThreadPoolForDataProviders = false;
+  public static final Boolean DEFAULT_SHARE_THREAD_POOL_FOR_DATA_PROVIDERS = Boolean.FALSE;
+  private boolean shareThreadPoolForDataProviders = DEFAULT_SHARE_THREAD_POOL_FOR_DATA_PROVIDERS;
 
-  private boolean useGlobalThreadPool = false;
+  public static final Boolean DEFAULT_SHARE_THREAD_POOL = Boolean.FALSE;
+  private boolean useGlobalThreadPool = DEFAULT_SHARE_THREAD_POOL;
 
   /** The thread count. */
   public static final Integer DEFAULT_THREAD_COUNT = 5;

diff --git a/testng-core/src/test/java/test/xml/XmlVerifyTest.java b/testng-core/src/test/java/test/xml/XmlVerifyTest.java
@@ -2,8 +2,11 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+import java.io.StringReader;
 import java.lang.reflect.Method;
 import java.util.Collections;
+import javax.xml.parsers.DocumentBuilder;
+import javax.xml.parsers.DocumentBuilderFactory;
 import org.testng.Assert;
 import org.testng.ITestNGListener;
 import org.testng.TestListenerAdapter;
@@ -14,6 +17,11 @@
 import org.testng.xml.XmlClass;
 import org.testng.xml.XmlSuite;
 import org.testng.xml.XmlTest;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+import org.xml.sax.InputSource;
 import test.SimpleBaseTest;
 
 public class XmlVerifyTest extends SimpleBaseTest {
@@ -41,6 +49,26 @@ public void testToXmlWithoutComments() {
     assertThat(xml).doesNotContain(DEFAULT_SUITE);
   }
 
+  @Test(description = "GITHUB-3177")
+  public void testThreadPoolRelatedAttributesPresentInXml() throws Exception {
+    XmlSuite suite = createSuite();
+    suite.setShareThreadPoolForDataProviders(true);
+    suite.shouldUseGlobalThreadPool(true);
+    String xml = suite.toXml();
+    DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
+    DocumentBuilder builder = factory.newDocumentBuilder();
+    Document document = builder.parse(new InputSource(new StringReader(xml)));
+    document.getDocumentElement().normalize();
+    NodeList allSuites = document.getElementsByTagName("suite");
+    assertThat(allSuites.getLength()).isEqualTo(1);
+    Node xmlSuite = allSuites.item(0);
+    assertThat(xmlSuite.getNodeType()).isEqualTo(Node.ELEMENT_NODE);
+    Element element = (Element) xmlSuite;
+    assertThat(element.getAttribute("use-global-thread-pool")).isEqualTo(Boolean.TRUE.toString());
+    assertThat(element.getAttribute("share-thread-pool-for-data-providers"))
+        .isEqualTo(Boolean.TRUE.toString());
+  }
+
   @AfterMethod
   public void reset(Method method) {
     if (method.getName().equals("testToXmlWithoutComments")) {