Streamline xml serialisation to string

[krmahadevan]

Closes #3177

Fixes #3177 .

Did you remember to?

• Add test case(s)
• Update CHANGES.txt
• Auto applied styling via ./gradlew autostyleApply

We encourage pull requests that:

• Add new features to TestNG (or)
• Fix bugs in TestNG

If your pull request involves fixing SonarQube issues then we would suggest that you please discuss this with the
TestNG-dev before you spend time working on it.

Note: For more information on contribution guidelines please make sure you refer our Contributing section for detailed set of steps.

Summary by CodeRabbit

• Bug Fixes

  • Resolved thread pool management issues that previously led to errors during test execution.
  • Improved error reporting for test timeouts, helping ensure more reliable test outcomes.

• Enhancements

  • Updated XML configuration to accurately reflect thread management settings.
  • Standardized default values for thread pool usage for greater consistency.

• Tests

  • Added a verification to ensure XML outputs now include the correct thread management attributes.

[coderabbitai]

Walkthrough

This change set updates the TestNG framework by documenting and fixing issues related to XML conversion and thread pool configuration. The modifications include corrections in the XmlSuite#toXml method, enhancements to error propagation for test timeouts, and fixes for a ClassCastException in thread pool handling. Additionally, the XML output functionality has been expanded by adding new thread pool properties in DefaultXmlWeaver and standardizing default initialization in XmlSuite. A new test has been added to verify that the XML output contains the correct thread pool-related attributes.

Changes

File(s)	Change Summary
CHANGES.txt	Updates documentation with bug fixes and enhancements for XmlSuite#toXml, ClassCastException handling, and timeout exception propagation.
testng-core-api/.../DefaultXmlWeaver.java, testng-core-api/.../XmlSuite.java	Introduced new properties and constants for thread pool management, ensuring consistent XML suite configuration (use-global-thread-pool and share-thread-pool-for-data-providers).
testng-core/src/test/java/test/xml/XmlVerifyTest.java	Added a test (testThreadPoolRelatedAttributesPresentInXml) to verify that the XML output correctly includes the thread pool-related attributes.

Sequence Diagram(s)

sequenceDiagram
    participant Test as XmlVerifyTest
    participant Suite as XmlSuite
    participant Weaver as DefaultXmlWeaver
    participant Parser as XML Parser

    Test->>Suite: Configure thread pool attributes (true)
    Test->>Weaver: Invoke asXml(Suite)
    Weaver->>Weaver: Set properties ("use-global-thread-pool", "share-thread-pool-for-data-providers")
    Weaver-->>Test: Return XML String
    Test->>Parser: Parse XML String
    Parser-->>Test: XML Document with attributes
    Test->>Test: Assert attribute values are correct

Loading

Possibly related PRs

• GITHUB-2765: Propagate timeout stack trace to fix testng-team#2765 #3206: Addresses enhancements for ThreadTimeoutException and its stack trace propagation, directly relating to the changes in error reporting.
• Support to execlude somes test in option of command line #3200: Involves modifications to the share-thread-pool-for-data-providers property, aligning with the current adjustments in XML configuration.
• Streamline working of shared thread pools #3207: Focuses on resolving issues with shouldUseGlobalThreadPool(true), which is also a key aspect in this update.

Suggested Reviewers

• juherr

Poem

I'm a rabbit in the code,
Hopping through changes bright and bold,
Threads aligned with XML cheer,
Bugs and errors now disappear,
With each fix, our tests take flight,
Celebrating improvements day and night!
🐇💻

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between df04c65 and 24bd0ad.

📒 Files selected for processing (4)

• CHANGES.txt (1 hunks)
• testng-core-api/src/main/java/org/testng/xml/DefaultXmlWeaver.java (1 hunks)
• testng-core-api/src/main/java/org/testng/xml/XmlSuite.java (1 hunks)
• testng-core/src/test/java/test/xml/XmlVerifyTest.java (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: 21, microsoft, ubuntu, UTC, tr_TR
• GitHub Check: 21, liberica, ubuntu, UTC, de_DE
• GitHub Check: 17, zulu, windows, UTC, fr_FR
• GitHub Check: 17, liberica, macos, Pacific/Chatham, fr_FR, stress JIT
• GitHub Check: 17, corretto, windows, America/New_York, de_DE
• GitHub Check: 11, zulu, same hashcode, macos, Pacific/Chatham, tr_TR, stress JIT

🔇 Additional comments (4)

testng-core/src/test/java/test/xml/XmlVerifyTest.java (1)

52-70: LGTM! Well-structured test for XML serialization.

The test method effectively verifies that thread pool related attributes are correctly serialized to XML. The implementation follows good practices:

• Uses standard XML parsing
• Has clear assertions
• Properly validates both attribute presence and values

testng-core-api/src/main/java/org/testng/xml/DefaultXmlWeaver.java (1)

48-57: LGTM! Clean implementation of XML serialization for thread pool properties.

The implementation follows the established pattern in the class and properly handles default values through XmlUtils.setProperty.

testng-core-api/src/main/java/org/testng/xml/XmlSuite.java (1)

140-144: LGTM! Well-defined constants and fields for thread pool configuration.

The implementation uses appropriate default values and follows the class's pattern for configuration properties.

CHANGES.txt (1)

1-4: LGTM! Clear and well-formatted changelog entry.

The changelog entry properly documents the fix for GITHUB-3177 and follows the established format.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.