Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Streamline Guice Module creation in concurrency. #3062

Merged
merged 1 commit into from Feb 10, 2024

Conversation

krmahadevan
Copy link
Member

@krmahadevan krmahadevan commented Feb 10, 2024

Closes #3048
Closes #3050

Fixes #3048
Fixes #3050

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 ConcurrentModificationException and race conditions in dependency injection.
    • Addressed issues with custom listener factory injection and method result handling.
  • New Features
    • Introduced new test methods to ensure no duplicate Guice modules are created.
    • Added functionality to retry tests based on certain conditions using EvidenceRetryAnalyzer.
  • Tests
    • Implemented new tests to validate the correct behavior of Guice modules and retry analyzers in various scenarios.

Copy link

coderabbitai bot commented Feb 10, 2024

Walkthrough

The recent updates focus on enhancing TestNG's stability by fixing ConcurrentModificationException and race conditions during Guice Module creation and injection. These changes ensure that Guice Modules are instantiated once per suite, mitigating issues with custom listener factory injection and method result handling. The introduction of locking mechanisms and new test cases further solidifies the framework's reliability for developers.

Changes

Files Changes
.../internal/objects/GuiceBasedObjectDispenser.java Added ReentrantLock to synchronize object dispensing.
.../test/java/test/guice/GuiceTest.java
.../test/java/test/guice/issue3050/*.java
Added tests to validate no duplicate Guice Modules are created and handle retry logic with Guice injection.

Assessment against linked issues

Objective Addressed Explanation
Prevent ConcurrentModificationException during test suite execution (#3048)
Ensure Guice Module is instantiated only once during the Suite execution (#3050)
Investigate and resolve race condition in GuiceHelper#getModules (#3050)
Confirm proper Singleton behavior for randomUUID in EvidenceModule (#3050)
Ensure correct dependency injection in EvidenceRetryAnalyzer (#3050)

Poem

In the field of green, under the bright lights, 🏈
Two teams clash, in the ultimate fight.
Chiefs and 49ers, a spirited dance,
With every play, they seize their chance.
But here in code, we too celebrate, 🎉
Fixing bugs, making TestNG great.
Like touchdowns scored, our changes win,
A victory for all, let the games begin!

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

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.
  • 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 from git 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3b3d67c and def5fd0.
Files selected for processing (8)
  • CHANGES.txt (1 hunks)
  • testng-core/src/main/java/org/testng/internal/objects/GuiceBasedObjectDispenser.java (3 hunks)
  • testng-core/src/test/java/test/guice/GuiceTest.java (3 hunks)
  • testng-core/src/test/java/test/guice/issue3050/EvidenceModule.java (1 hunks)
  • testng-core/src/test/java/test/guice/issue3050/EvidenceRetryAnalyzer.java (1 hunks)
  • testng-core/src/test/java/test/guice/issue3050/EvidenceTestOneSample.java (1 hunks)
  • testng-core/src/test/java/test/guice/issue3050/EvidenceTestThreeSample.java (1 hunks)
  • testng-core/src/test/java/test/guice/issue3050/EvidenceTestTwoSample.java (1 hunks)
Additional comments: 10
testng-core/src/test/java/test/guice/issue3050/EvidenceModule.java (1)
  • 1-15: LGTM!
testng-core/src/test/java/test/guice/issue3050/EvidenceRetryAnalyzer.java (1)
  • 1-27: LGTM!
testng-core/src/test/java/test/guice/issue3050/EvidenceTestOneSample.java (1)
  • 1-31: LGTM!
testng-core/src/test/java/test/guice/issue3050/EvidenceTestTwoSample.java (1)
  • 1-31: LGTM!
testng-core/src/test/java/test/guice/issue3050/EvidenceTestThreeSample.java (1)
  • 1-31: LGTM!
testng-core/src/main/java/org/testng/internal/objects/GuiceBasedObjectDispenser.java (1)
  • 22-71: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-68]

LGTM!

testng-core/src/test/java/test/guice/GuiceTest.java (1)
  • 112-128: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-127]

LGTM!

CHANGES.txt (3)
  • 3-3: The change log mentions fixing a ConcurrentModificationException when injecting values. Ensure all references and calls to the affected methods or classes throughout the codebase have been updated to align with this fix.
  • 4-4: The log mentions addressing a race condition when creating Guice Modules. Confirm that the synchronization mechanism introduced does not negatively impact performance or introduce deadlocks.
  • 4-4: The entry about fixing a race condition in Guice Module creation should be followed by tests specifically designed to verify that the race condition has been effectively resolved. Confirm that such tests have been added.
Verification successful

The search successfully identified a test case named ensureNoDuplicateGuiceModulesAreCreated within GuiceTest.java, which is designed to verify the resolution of the race condition in Guice Module creation. This confirms that the necessary tests have been added as per the review comment.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Search for new test cases related to Guice Module creation race condition.
rg --type java 'ensureNoDuplicateGuiceModulesAreCreated' tests/

Length of output: 110



Script:

#!/bin/bash
# Broaden the search for test cases related to Guice Module creation race condition across the entire project.
rg --type java 'ensureNoDuplicateGuiceModulesAreCreated'

Length of output: 166

@krmahadevan krmahadevan merged commit 1774b2c into testng-team:master Feb 10, 2024
6 of 9 checks passed
@krmahadevan krmahadevan deleted the bugfix/3050 branch February 10, 2024 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Race condition when creating Guice Modules ConcurrentModificationException when injecting values
2 participants