Skip to content

KAFKA-10789: Streamlining Tests in ChangeLoggingKeyValueBytesStoreTest #15

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

Open
wants to merge 7 commits into
base: trunk
Choose a base branch
from

Conversation

arvi18
Copy link

@arvi18 arvi18 commented Apr 26, 2025

  1. use mocked InMemoryKeyValueStore to streamlined the unit test
  2. minor refactor including remove unnecessary public and rename the variable inside the method with a different name with outside of the method.

Committer Checklist (excluded from commit message)

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

JUnit5 test classes and methods should have default package visibility
Local variables should not shadow class fields
fix import static org.mockito.ArgumentMatchers.anyString;
revert remove unnecessary public
 insert empty lines between methods
@arvi18
Copy link
Author

arvi18 commented Apr 26, 2025

Pr needs a tag about Ci, I can't do it. sorry

@arvi18
Copy link
Author

arvi18 commented Apr 26, 2025

A label of 'needs-attention' was automatically added to this PR in order to raise the
attention of the committers. Once this issue has been triaged, the triage label
should be removed to prevent this automation from happening again.

2 similar comments
@arvi18
Copy link
Author

arvi18 commented Apr 26, 2025

A label of 'needs-attention' was automatically added to this PR in order to raise the
attention of the committers. Once this issue has been triaged, the triage label
should be removed to prevent this automation from happening again.

@arvi18
Copy link
Author

arvi18 commented Apr 26, 2025

A label of 'needs-attention' was automatically added to this PR in order to raise the
attention of the committers. Once this issue has been triaged, the triage label
should be removed to prevent this automation from happening again.

Copy link

coderabbitai bot commented Apr 26, 2025

Warning

Rate limit exceeded

@arvi18 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 39 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between ed79212 and d205133.

📒 Files selected for processing (1)
  • streams/src/test/java/org/apache/kafka/streams/state/internals/ChangeLoggingKeyValueBytesStoreTest.java (12 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, 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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Hello @arvi18, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request focuses on streamlining the tests in ChangeLoggingKeyValueBytesStoreTest by using a mocked InMemoryKeyValueStore. It also includes minor refactoring, such as removing unnecessary public modifiers and renaming variables to avoid naming conflicts.

Highlights

  • Test Streamlining: The core change involves replacing the concrete InMemoryKeyValueStore with a mocked version (innerMock) to simplify and isolate the unit tests.
  • Refactoring: Minor refactoring includes removing unnecessary public access modifiers and renaming variables for clarity.
  • Mocking: The pull request introduces several mock... methods to configure the behavior of the mocked InMemoryKeyValueStore for different test scenarios.

Changelog

  • streams/src/test/java/org/apache/kafka/streams/state/internals/ChangeLoggingKeyValueBytesStoreTest.java
    • Replaced InMemoryKeyValueStore with a @Mock annotated innerMock.
    • Added mockPosition, mockGet, mockPut, mockPutAll, mockDelete, mockPutIfAbsent, and mockPrefixScan methods to define the behavior of the mocked store.
    • Modified test methods to use the mocked store and verify interactions with it.
    • Removed the import for org.apache.kafka.streams.state.KeyValueStore as it's no longer directly used.
    • Renamed local variable streamsConfig to mockedStreamsConfig in streamsConfigMock method to avoid shadowing the class member.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.


A mock to test,
Isolation's best,
Bugs flee in fright.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

The pull request aims to streamline tests in ChangeLoggingKeyValueBytesStoreTest by using a mocked InMemoryKeyValueStore and performing minor refactoring. The changes seem reasonable and improve the testability of the component. However, there are a few areas that could be improved for clarity and completeness.

Summary of Findings

  • Missing Mock Behavior Definitions: The tests rely heavily on mock objects, but some tests are missing necessary mock behavior definitions, potentially leading to incomplete or incorrect test scenarios. Each test should have all the mock behaviors defined that it needs to execute properly.
  • Incomplete Mocking: The approximateNumEntries method is not mocked, which could lead to incorrect assertions in tests that rely on this method. All methods that are used in the tests should be mocked.
  • Duplicated Mocking Logic: The mocking logic is repeated across multiple tests. Consider centralizing the mock setup to reduce code duplication and improve maintainability. This also makes it easier to understand the overall mocking strategy.

Merge Readiness

The pull request introduces valuable improvements to the test suite. However, the identified issues regarding mock behavior definitions and potential code duplication should be addressed before merging. I am unable to approve this pull request, and recommend that another reviewer also reviews this code before merging. At a minimum, the high severity issues should be addressed before merging.

@mjsax
Copy link

mjsax commented Apr 29, 2025

@arvi18 -- I am confused. This PR is not again kafka/trunk but a fork of it, and it seems to duplicate apache#18816.

I am not going to review this PR. Does not make sense.

@chia7712
Copy link

It seems the robot copies all comments from the PR. I hope the maintainers can fix it ASAP.

@arvi18
Copy link
Author

arvi18 commented Apr 29, 2025

@arvi18 -- I am confused. This PR is not again kafka/trunk but a fork of it, and it seems to duplicate apache#18816.

I am not going to review this PR. Does not make sense.

Hi,
We were testing our internal code reviewer bot on a few open source projects and unintentionally duplicated some PRs, including tagging users from prior threads. We overlooked the fact that this could be interpreted as spammy behavior.

Please rest assured that this activity has been stopped, and we will ensure it does not happen again.

Thank you for your understanding, and sorry once again for the inconvenience.

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.

4 participants