Test case failure

[krmahadevan]

Fixing failure for the test

test.retryAnalyzer.RetryAnalyzerTest.ensureRetryDoesntRunEndlesslyForDataDrivenTests

Github actions failure on master branch:

https://github.com/testng-team/testng/actions/runs/8307524777/job/22736819681

Gradle scan results link:

https://scans.gradle.com/s/wap5a5bvq3qgq/tests/task/:testng-core:test/details/test.retryAnalyzer.RetryAnalyzerTest/ensureRetryDoesntRunEndlesslyForDataDrivenTests?top-execution=1

Prerequisites for failure:

The below JVM arguments should be used:

• -Duser.timezone="America/New_York”
• -Duser.country=RU
• -Duser.language=ru
• -XX:+UnlockExperimentalVMOptions
• -XX:hashCode=2

Root cause:

We are using hashCode() to create Key that is used to determine if a RetryAnalyzer instance should be created or not.

When we run the tests using -XX:hashCode=2
it causes the JVM to generate the same hashcode (value 1) And this messes up the RetryAnalyzer object creation.

Fix:

Addressed this by wrapping the parameters into an object which will contain a unique id that can be used to represent the same set of parameters.

Summary by CodeRabbit

• Refactor
  • Improved caching mechanism in test methods for better performance.
• New Features
  • Introduced a new class for handling arrays with unique identifiers, enhancing object management and comparison capabilities.

[coderabbitai]

Walkthrough

The recent modifications focus on enhancing efficiency and reliability in handling test parameters within TestNG. By introducing a ConcurrentHashMap for caching and a new IdentifiableArrayObject class for better parameter management, these changes aim to improve test execution speed and ensure thread safety across various testing scenarios.

Changes

File Path	Change Summary
.../internal/BaseTestMethod.java	- Introduced ConcurrentHashMap and Function imports. - Enhanced parameter caching mechanism.
.../internal/IObject.java	- Added IdentifiableArrayObject class for unique parameter identification and management.

🐰✨
In the land of tests and code,
Where parameters oft' implode,
A map concurrent, threads in harmony,
And a unique ID for each array's spree.
With each run, so swift and sure,
Our tests now faster, and secure.
🌟🐾

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-tests 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 tests 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 tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 15874ea and 3505e4b.

Files selected for processing (2)

• testng-core/src/main/java/org/testng/internal/BaseTestMethod.java (3 hunks)
• testng-core/src/main/java/org/testng/internal/IObject.java (2 hunks)

Additional comments: 3

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

• 122-148: The introduction of the IdentifiableArrayObject class is a strategic move to address the issue with hash code manipulation under specific JVM settings. This class ensures that each set of parameters is uniquely identified, which is crucial for the correct operation of the RetryAnalyzer in data-driven tests. The implementation of equals and hashCode methods based on the parameters array is appropriate for this use case. However, consider documenting the potential impact of using Arrays.hashCode(parameters) in hashCode and Arrays.equals(parameters, that.parameters) in equals for large arrays, as these operations could become performance bottlenecks in certain scenarios.

testng-core/src/main/java/org/testng/internal/BaseTestMethod.java (2)

• 836-836: The modification to use a ConcurrentHashMap for caching IRetryAnalyzer instances based on a unique parameter ID is a robust solution to the problem of hash code manipulation under specific JVM settings. This change ensures that retries are handled correctly for parameterized tests, addressing the core issue of endless retries in data-driven tests. The use of parameterId as a key is a clever approach to uniquely identify test method invocations.
• 849-852: The introduction of the parameterId method, which generates a unique ID for test parameters, is a key part of the solution to ensure the correct operation of the RetryAnalyzer in the face of hash code manipulation. By caching IdentifiableArrayObject instances in a ConcurrentHashMap, this method efficiently handles parameter uniqueness. This approach significantly improves the reliability of retries in parameterized tests.