GITHUB-2765: Propagate timeout stack trace to fix testng-team#2765

[idontusenumbers]

Fixes #2765 .

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

  • Improved error handling for test timeouts, ensuring that detailed stack trace information is now available for easier debugging.

• Tests

  • Added and updated tests to confirm that timeout errors correctly capture comprehensive details in different execution contexts.

• Chores

  • Upgraded the framework version from 7.11.0 to 7.12.0.

[coderabbitai]

Walkthrough

The pull request updates the TestNG framework from version 7.11.0 to 7.12.0. The primary change is related to error handling for test timeouts. Enhancements in the ThreadTimeoutException class now allow propagation of a cause through new constructor overloads. Additionally, the exception invocation in the method invocation helper has been modified to include the original exception. Finally, test cases have been updated and expanded to cover both executor and no-executor timeout scenarios, ensuring more comprehensive validation of the new error handling behavior.

Changes

File(s)	Change Summary
CHANGES.txt	Updated version from 7.11.0 to 7.12.0; added fix for timeout stack trace propagation (GITHUB-2765).
testng-core-api/.../ThreadTimeoutException.java	Added new constructors that accept a Throwable cause to enhance exception propagation.
testng-core/.../MethodInvocationHelper.java	Modified exception handling in the timeout invocation to pass the underlying exception as an additional parameter.
testng-core/.../TimeoutStacktraceTest.java	Renamed an existing test method and added a new test for no executor scenario to validate stack trace correctness using the causal chain.

Sequence Diagram(s)

sequenceDiagram
    participant Test as TimeoutStacktraceTest
    participant Helper as MethodInvocationHelper
    participant Exception as ThreadTimeoutException

    Test->>Helper: Invoke test method (with/without executor)
    Helper->>Exception: Timeout occurs, create exception with cause
    Exception-->>Helper: Exception constructed and propagated
    Helper-->>Test: Exception caught and processed
    Test->>Test: Analyze causal chain for stack trace

Loading

Poem

Oh, hop along the code, so bright,
Errors now show the whole insight.
Fixed timeouts with a clever twist,
A cause in the trace you can't resist.
I'm a rabbit dancing in the light 🐇✨
Debugging smoothly through the 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 9f44f6e and 0c99cf1.

📒 Files selected for processing (4)

• CHANGES.txt (1 hunks)
• testng-core-api/src/main/java/org/testng/internal/thread/ThreadTimeoutException.java (1 hunks)
• testng-core/src/main/java/org/testng/internal/invokers/MethodInvocationHelper.java (1 hunks)
• testng-core/src/test/java/test/timeout/github2672/TimeoutStacktraceTest.java (3 hunks)

✅ Files skipped from review due to trivial changes (1)

• CHANGES.txt

🔇 Additional comments (7)

testng-core-api/src/main/java/org/testng/internal/thread/ThreadTimeoutException.java (4)

10-12: LGTM! Good refactoring of the constructor.

The constructor now properly delegates to the new constructor that accepts a cause, following Java's exception handling best practices.

---

14-16: LGTM! Well-designed constructor for cause propagation.

The new constructor properly calls super with both message and cause, enabling proper exception chaining.

---

22-24: LGTM! Good refactoring of the method-specific constructor.

The constructor now properly delegates to the new constructor that accepts a cause, maintaining consistency.

---

26-30: LGTM! Well-structured method-specific constructor with cause.

The constructor properly formats the error message and chains the cause, providing clear context for timeout failures.

testng-core/src/test/java/test/timeout/github2672/TimeoutStacktraceTest.java (2)

28-42: LGTM! Clear and focused test for new executor scenario.

The test method has been renamed to better reflect its specific test case, improving test clarity.

---

44-59: LGTM! Comprehensive test for no-executor scenario.

The new test method effectively:

1. Tests timeout behavior without an executor
2. Uses Guava's Throwables for thorough stack trace analysis
3. Sets appropriate thread pool size for the scenario

testng-core/src/main/java/org/testng/internal/invokers/MethodInvocationHelper.java (1)

368-368: LGTM! Improved error context by propagating the original exception.

The change properly utilizes the new ThreadTimeoutException constructor to include the original exception as the cause, enhancing debugging capabilities.

✨ 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.