Report deadlocks when running in sharedthreadpool

[krmahadevan]

Closes #3028

Fixes #3028

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
  • Fixed a stalling issue when using "use-global-thread-pool" in version 7.11.0.
  • Resolved a malfunction with ListenerComparator in version 7.10.2.
• New Features
  • Introduced deadlock detection for data-driven tests running in parallel to enhance reliability.
• Tests
  • Added tests to ensure deadlock conditions are detected in data-driven tests running in parallel.

[coderabbitai]

Walkthrough

This update primarily addresses deadlock issues in TestNG when using shared thread pools for data-driven tests. It introduces a new exception class to handle deadlock scenarios and implements logic in TestRunner to detect and prevent deadlocks by comparing thread counts with the number of tests.

Changes

File Path	Change Summary
testng-core-api/.../TestNGDeadLockException.java	Introduces TestNGDeadLockException to represent deadlock conditions in TestNG.
testng-core/.../TestRunner.java	Adds logic to detect and prevent deadlocks in data-driven tests using shared thread pools.
testng-core/.../SharedThreadPoolTest.java	Adds tests to ensure deadlocks are detectable in parallel data-driven tests.
testng-core/.../issue3028/AnotherDataDrivenTestSample.java	Adds data-driven testing functionality with parallel execution capabilities.
testng-core/.../issue3028/DataDrivenTestSample.java	Introduces a test class for parallel data-driven testing.
testng-core/.../issue3028/FactoryPoweredDataDrivenTestSample.java	Demonstrates data-driven testing with @Factory and @DataProvider annotations.

Possibly related issues

• Execution stalls when using "use-global-thread-pool" #3028: This PR directly addresses the deadlock issue described here by introducing new handling for thread pool deadlocks.
• How to dynamically adjust the number of TestNG threads after IExecutorFactory is deprecated? #3066: Although not directly addressing dynamic thread adjustment, the changes in deadlock detection may influence how thread pools are managed, potentially impacting this issue.

🐰🌟
A hop, a skip, in the code we dive,
Fixing deadlocks, keeping tests alive.
Threads in a dance, now they play nice,
No more freezing, that's our advice.
Cheers to smooth runs, our code does thrive!
🌟🐰

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 43af2cf and 88cb15f.

Files selected for processing (7)

• CHANGES.txt (1 hunks)
• testng-core-api/src/main/java/org/testng/internal/TestNGDeadLockException.java (1 hunks)
• testng-core/src/main/java/org/testng/TestRunner.java (3 hunks)
• testng-core/src/test/java/test/thread/SharedThreadPoolTest.java (2 hunks)
• testng-core/src/test/java/test/thread/issue3028/AnotherDataDrivenTestSample.java (1 hunks)
• testng-core/src/test/java/test/thread/issue3028/DataDrivenTestSample.java (1 hunks)
• testng-core/src/test/java/test/thread/issue3028/FactoryPoweredDataDrivenTestSample.java (1 hunks)

Files skipped from review as they are similar to previous changes (6)

• CHANGES.txt
• testng-core/src/main/java/org/testng/TestRunner.java
• testng-core/src/test/java/test/thread/SharedThreadPoolTest.java
• testng-core/src/test/java/test/thread/issue3028/AnotherDataDrivenTestSample.java
• testng-core/src/test/java/test/thread/issue3028/DataDrivenTestSample.java
• testng-core/src/test/java/test/thread/issue3028/FactoryPoweredDataDrivenTestSample.java

Additional comments not posted (1)

testng-core-api/src/main/java/org/testng/internal/TestNGDeadLockException.java (1)

5-10: The implementation of TestNGDeadLockException is clear and adheres to the objectives of the PR. The class is well-documented and correctly extends TestNGException.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.