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.

Sign up for GitHub

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

Jump to bottom

Added unit tests for go/cmd/rulesctl/ package #15028

Merged
merged 4 commits into from
Mar 5, 2024
Merged

Added unit tests for go/cmd/rulesctl/ package #15028

merged 4 commits into from
Mar 5, 2024

Conversation

VaibhavMalik4187
Copy link
Contributor

@VaibhavMalik4187 VaibhavMalik4187 commented Jan 24, 2024 •
edited
Loading

Description

This PR adds new tests for the go/cmd/rulesctl package

This commit increases the code coverage of the cmd/rulesctl/common package to 71% and that of cmd/rulesctl/cmd package to >90%

Related Issue(s)

Partially Fixes: #14931

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Jan 24, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Jan 24, 2024
@github-actions github-actions bot added this to the v19.0.0 milestone Jan 24, 2024
@VaibhavMalik4187 VaibhavMalik4187 marked this pull request as draft January 24, 2024 12:51
@codecov Codecov
Copy link

codecov bot commented Jan 25, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.61%. Comparing base (9d861f8) to head (f9560ac).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #15028      +/-   ##
==========================================
+ Coverage   65.49%   65.61%   +0.11%     
==========================================
  Files        1562     1562              
  Lines      193940   193940              
==========================================
+ Hits       127016   127246     +230     
+ Misses      66924    66694     -230

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@VaibhavMalik4187 VaibhavMalik4187 marked this pull request as ready for review January 25, 2024 18:47
@VaibhavMalik4187
Copy link
Contributor Author

@systay, @frouioui, could you please review this PR whenever you have some spare time? Thanks :)

@frouioui frouioui added Type: Testing Component: General Changes throughout the code base and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Jan 25, 2024
GuptaManan100
GuptaManan100 approved these changes Jan 28, 2024
View reviewed changes
Copy link
Member

@GuptaManan100 GuptaManan100 left a comment

Choose a reason for hiding this comment

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

Excellent work!

ajm188
ajm188 requested changes Jan 29, 2024
View reviewed changes
Copy link
Contributor

@ajm188 ajm188 left a comment

Choose a reason for hiding this comment

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

cobra provides some builtin utils for some of the work you're doing here; we should use those instead

go/cmd/rulesctl/cmd/add_test.go Show resolved Hide resolved
go/cmd/rulesctl/cmd/list_test.go Show resolved Hide resolved
go/cmd/rulesctl/cmd/main_test.go Outdated Show resolved Hide resolved
go/cmd/rulesctl/cmd/remove_test.go Show resolved Hide resolved
@GuptaManan100
Copy link
Member

@VaibhavMalik4187 Could you address the changes requested in the PR.

@VaibhavMalik4187
Copy link
Contributor Author

@VaibhavMalik4187 Could you address the changes requested in the PR.

On it.

@frouioui frouioui modified the milestones: v19.0.0, v20.0.0 Feb 6, 2024
@VaibhavMalik4187
Added unit tests for go/cmd/rulesctl/ package
9623a8f 
This commit increases the code coverage of the `cmd/rulesctl/common`
package to 71% and that of `cmd/rulesctl/cmd` package to >90%

Partially Fixes: vitessio#14931

Signed-off-by: VaibhavMalik4187 <[email protected]>
@GuptaManan100 GuptaManan100 requested a review from ajm188 February 7, 2024 14:38
ajm188
ajm188 reviewed Feb 13, 2024
View reviewed changes
go/cmd/rulesctl/cmd/add_test.go Outdated Show resolved Hide resolved
go/cmd/rulesctl/cmd/add_test.go Show resolved Hide resolved
go/cmd/rulesctl/cmd/list_test.go Outdated Show resolved Hide resolved
go/cmd/rulesctl/cmd/list_test.go Show resolved Hide resolved
go/cmd/rulesctl/cmd/remove_test.go Show resolved Hide resolved
go/cmd/rulesctl/cmd/add_test.go Outdated Show resolved Hide resolved
go/cmd/rulesctl/common/common_test.go Outdated Show resolved Hide resolved
go/cmd/rulesctl/common/common_test.go Outdated Show resolved Hide resolved
go/cmd/rulesctl/common/common_test.go Show resolved Hide resolved
go/cmd/rulesctl/cmd/remove_test.go Show resolved Hide resolved
@GuptaManan100 GuptaManan100 merged commit 9cd8ffc into vitessio:main Mar 5, 2024
102 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GuptaManan100 GuptaManan100 GuptaManan100 approved these changes

@harshit-gangal harshit-gangal harshit-gangal approved these changes

@ajm188 ajm188 ajm188 approved these changes

@deepthi deepthi Awaiting requested review from deepthi deepthi is a code owner

Assignees
No one assigned
Labels
Component: General Changes throughout the code base Type: Testing
Projects
None yet
Milestone
v20.0.0
Development

Successfully merging this pull request may close these issues.

Improve Unit Test Coverage
5 participants
@VaibhavMalik4187 @GuptaManan100 @ajm188 @harshit-gangal @frouioui