search

languagetool-org / languagetool

Style and Grammar Checker for 25+ Languages
https://languagetool.org
GNU Lesser General Public License v2.1
12.46k stars 1.4k forks source link

Patch Flaky Test in `LineExpanderTest` #11024

Closed AmitPr closed 1 week ago

AmitPr commented 1 week ago

Fixes issues found by NonDex, caused by the use of a HashSet in the languagetool internals, whilst test fixtures rely on ordering in serialized data. HashSets and other Hash-based data structures in Java are explicitly nondeterministic, as platform or architecture differences could cause ordering differences.

This PR enforces set equality in the LineExpanderTest, thus guaranteeing that any set of outputs generated using the same inputs to the expand will be valid, without relying on nondeterministic ordering.

For example, before this fix, the test may have generated the following two strings:

[rübermach, rübergemacht, rübermachest, rübermachst, rübermache, rübermachen, rübermachet, rübermachte, rübermachend, rübermachten, rübermacht, rübermachtest, rübermachtet, rüberzumachen, Rübermachens]
[rübermacht, rübermachtet, rübermache, rübermachtest, rübermachten, rübermachend, rübermachte, rübermach, rübergemacht, rübermachen, rübermachst, rübermachet, rübermachest, rüberzumachen, Rübermachens]

Any difference in serialization would cause an erroneous test failure.

To verify the issue, running NonDex via Maven can be done as follows:

mvn edu.illinois:nondex-maven-plugin:2.1.7:nondex -Dtest=org.languagetool.rules.de.LineExpanderTest -pl languagetool-language-modules/de -DnondexRuns=10guage-modules/de/.nondex

Which should fail before this PR, and succeed after this PR.

Depending on seeding, you may need to re-run this command or increase -DnondexRuns before a test failure is observed.

Happy to iterate on this PR.

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

Walkthrough

The changes in the pull request focus on the LineExpanderTest class within the languagetool-language-modules project. The primary modification involves replacing existing assertions with a new method, assertSetsEqual, to compare sets derived from expanded strings, enhancing the clarity of tests by disregarding element order. Additionally, a helper method, parseStringToSet, has been introduced to facilitate the conversion of bracketed strings into sets. The updates include adjustments to various test cases while maintaining existing error handling mechanisms.

Changes

File Path Change Summary
languagetool-language-modules/de/src/test/java/org/languagetool/rules/de/LineExpanderTest.java - Replaced assertThat assertions with assertSetsEqual for set equality checks.
- Added method private void assertSetsEqual(String expected, String actual).
- Added method private Set<String> parseStringToSet(String bracketString).
- Updated test cases to utilize the new assertion method.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.