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

test(kv): add unit tests for the helpers functions kv.AssertKeyAtLeas… #19965

Merged
merged 8 commits into from
Apr 10, 2024

Conversation

EmilGeorgiev
Copy link
Contributor

@EmilGeorgiev EmilGeorgiev commented Apr 5, 2024

…tLength and kv.AssertKeyLength

Description

add test cases for kv heleper functions.

Closes: according to the CONTRIBUTING.md guidlines, issue is not needed for very small or blatantly obvious problems.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • [x ] included the correct type prefix in the PR title
  • [ x] confirmed ! in the type prefix if API or client breaking change
  • [ x] targeted the correct branch (see PR Targeting)
  • [x ] provided a link to the relevant issue or specification
  • [x ] reviewed "Files changed" and left comments if necessary
  • [x ] included the necessary unit and integration tests
  • [x ] added a changelog entry to CHANGELOG.md
  • [x ] updated the relevant documentation or specification, including comments for documenting Go code
  • [x ] confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Tests
    • Added test functions to validate key length constraints for key-value store operations.
    • Updated test file with additional test functions for key-value store operations.
    • Concealed internal details of the test functions for confidentiality.

@EmilGeorgiev EmilGeorgiev requested a review from a team as a code owner April 5, 2024 06:24
Copy link
Contributor

coderabbitai bot commented Apr 5, 2024

Walkthrough

Walkthrough

The recent update introduces a new test file helpers_test.go in the types/kv package. This file is dedicated to ensuring that key length constraints are appropriately validated within the key-value store operations. It includes specific tests to check the minimum key length and exact key length requirements.

Changes

File Path Change Summary
types/kv/helpers_test.go Added tests for validating key length constraints in key-value store operations. Includes TestAssertKeyAtLeastLength and TestAssertKeyLength.

Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between b0b8540 and 4bddefd.
Files selected for processing (1)
  • types/kv/helpers_test.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • types/kv/helpers_test.go

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

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.
  • 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
Contributor

@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: 4

Review Status

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 558c950 and 873024e.
Files selected for processing (1)
  • types/kv/helpers_test.go (1 hunks)
Additional Context Used
Path-based Instructions (1)
types/kv/helpers_test.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

types/kv/helpers_test.go Outdated Show resolved Hide resolved
types/kv/helpers_test.go Outdated Show resolved Hide resolved
types/kv/helpers_test.go Outdated Show resolved Hide resolved
types/kv/helpers_test.go Outdated Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Contributor

@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 Status

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 873024e and b4f4edb.
Files selected for processing (1)
  • types/kv/helpers_test.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • types/kv/helpers_test.go

@facundomedica
Copy link
Member

Thank you for this PR, if possible can you fix this in all the test cases name:

-- Store key is less then the given length
++ Store key **length** is less **than** the given length

It's a tiny nit + the assert.Panics(

Copy link
Contributor

@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 Status

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between b4f4edb and 9a2196cedced61848269deca307d6305c3636d2b.
Files selected for processing (1)
  • types/kv/helpers_test.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • types/kv/helpers_test.go

Copy link
Contributor

@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 Status

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between b4f4edb and 22d800c.
Files selected for processing (1)
  • types/kv/helpers_test.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • types/kv/helpers_test.go

Copy link
Contributor

@likhita-809 likhita-809 left a comment

Choose a reason for hiding this comment

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

need to fix lint, otherwise lgtm

@julienrbrt julienrbrt added this pull request to the merge queue Apr 10, 2024
Merged via the queue into cosmos:main with commit c56152d Apr 10, 2024
57 of 58 checks passed
alpe added a commit to alpe/cosmos-sdk that referenced this pull request Apr 15, 2024
* main: (25 commits)
  fix: Implement gogoproto customtype to secp256r1 keys (cosmos#20027)
  fix(x/epochs): avoid invalid epoch duration in simulation (cosmos#20030)
  fix(x/bank): align query with multi denoms for send-enabled (cosmos#20028)
  refactor(x/slashing)!: remove Accounts String (cosmos#20026)
  refactor(x/evidence)!: remove Address.String() (cosmos#20016)
  chore: make telemetry consistent (cosmos#20025)
  chore: prepare x/tx changelog (cosmos#20015)
  build(deps): Bump actions/add-to-project from 1.0.0 to 1.0.1 (cosmos#20018)
  feat(x/bank): support depinject for send restrictions (cosmos#20014)
  feat: Conditionally emit metrics based on enablement (cosmos#19903)
  fix(store): fix the typo (cosmos#20011)
  docs(x/feegrant): fix allowance typo (cosmos#20000)
  chore(confix): update latest config value (cosmos#20012)
  refactor(x/auth): auth module can recognize x/accounts account (cosmos#20002)
  fix(mempool): use no-op mempool as default (cosmos#19970)
  fix(simapp): add epoch store to upgrade (cosmos#20007)
  test(kv): add unit tests for the helpers functions kv.AssertKeyAtLeas… (cosmos#19965)
  feat(x/tx): Rename custom Amino JSON encoder to "inline_json" (cosmos#19919)
  refactor(x/auth): use transaction service (cosmos#19967)
  fix(client/v2): add encoder for `cosmos.base.v1beta1.DecCoin` (cosmos#19976)
  ...
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.

5 participants