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

Fix assertEqualsDeep(Set, Set, String) wrong comparison and add variant without message #3150

Merged

Conversation

vuriaval
Copy link

@vuriaval vuriaval commented Jul 15, 2024

Fixes #3140.

This PR intends to fix the error reported in #3140, while also introducing another method assertEqualsDeep(Set, Set), in the same fashion as other methods in the class.

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

    • Corrected the deep comparison issue in assertEqualsDeep for Sets to ensure accurate expected value matching.
  • New Features

    • Introduced new assertEqualsDeep methods for Sets with optional custom error messages to improve assertion capabilities.

Copy link

coderabbitai bot commented Jul 15, 2024

Walkthrough

This update to TestNG introduces fixes for the assertEqualsDeep method in the Assert class, specifically addressing issues with deep comparisons on Sets. It includes new public methods and corresponding test cases to ensure deep equality checks function correctly, aligning with expected behavior and resolving the problem identified in GITHUB-3140.

Changes

File Path Change Summary
CHANGES.txt Added a summary of changes in version 7.11.0, highlighting the fix for assertEqualsDeep with Sets.
testng-asserts/src/main/java/org/testng/Assert.java Added new public methods for assertEqualsDeep to handle deep comparison of Sets correctly.
testng-asserts/src/test/java/org/testng/AssertTest.java Introduced new test methods to validate the behavior of assertEqualsDeep with different Sets.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Assert
    participant AssertTest

    User->>Assert: Calls assertEqualsDeep(Set actual, Set expected)
    Assert->>Assert: Calls internal areEqualImpl(value, expectedValue)
    Assert->>User: Returns result of deep comparison

    User->>AssertTest: Runs testAssertEqualsDeepSet
    AssertTest->>Assert: Calls assertEqualsDeep(Set actual, Set expected)
    Assert->>AssertTest: Returns result (pass)

    User->>AssertTest: Runs testAssertEqualsDeepSetFail
    AssertTest->>Assert: Calls assertEqualsDeep(Set actual, Set expected)
    Assert->>AssertTest: Returns result (fail)
Loading

Assessment against linked issues

Objective Addressed Explanation
Fix deep comparison for Sets in assertEqualsDeep (GITHUB-3140)
Ensure new methods for assertEqualsDeep are public and testable (GITHUB-3140)

Poem

In code's deep woods, where values peek,
A bug was found, a fix we'd seek.
With Sets compared in layers deep,
TestNG now can truly keep,
Assertions true, no longer weak.
🌟🐇


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 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.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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.

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.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d1a96af and 2df6a79.

Files selected for processing (3)
  • CHANGES.txt (1 hunks)
  • testng-asserts/src/main/java/org/testng/Assert.java (1 hunks)
  • testng-asserts/src/test/java/org/testng/AssertTest.java (1 hunks)
Additional comments not posted (5)
testng-asserts/src/test/java/org/testng/AssertTest.java (2)

583-592: LGTM! The test function testAssertEqualsDeepSet is correctly implemented.

The function verifies the deep equality of Sets with nested arrays and objects.


594-603: LGTM! The test function testAssertEqualsDeepSetFail is correctly implemented.

The function verifies the deep inequality of Sets with nested arrays and objects.

testng-asserts/src/main/java/org/testng/Assert.java (2)

2070-2075: LGTM! Deep comparison for sets is correctly implemented.

The addition of areEqualImpl for deep comparison of set elements is appropriate and aligns with the PR objectives.


2078-2081: LGTM! New methods for deep comparison of sets are correctly implemented.

The new overloaded methods assertEqualsDeep(Set<?> actual, Set<?> expected) and assertEqualsDeep(Set<?> actual, Set<?> expected, String message) provide the required functionality for deep comparison of sets.

CHANGES.txt (1)

5-5: LGTM!

The changelog entry for GITHUB-3140 is correctly formatted and provides a brief description of the fix.

@vuriaval vuriaval force-pushed the fix-assertequalsdeep-wrong-comparison branch from 2df6a79 to 1c8e230 Compare July 15, 2024 07:51
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.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2df6a79 and 1c8e230.

Files selected for processing (3)
  • CHANGES.txt (1 hunks)
  • testng-asserts/src/main/java/org/testng/Assert.java (1 hunks)
  • testng-asserts/src/test/java/org/testng/AssertTest.java (1 hunks)
Files skipped from review as they are similar to previous changes (3)
  • CHANGES.txt
  • testng-asserts/src/main/java/org/testng/Assert.java
  • testng-asserts/src/test/java/org/testng/AssertTest.java

@krmahadevan krmahadevan merged commit 8771fdd into testng-team:master Jul 15, 2024
7 of 9 checks passed
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.

assertEqualsDeep(Set, Set, String) fails when it shouldn't
3 participants