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 the cmd/mysqlctl package #15041

Closed
wants to merge 1 commit into from
Closed

Added unit tests for the cmd/mysqlctl package #15041

wants to merge 1 commit into from

Conversation

VaibhavMalik4187
Copy link
Contributor

Description

Related Issue(s)

Partially addresses: #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 25, 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 25, 2024
@VaibhavMalik4187 VaibhavMalik4187 marked this pull request as draft January 25, 2024 20:39
@github-actions github-actions bot added this to the v19.0.0 milestone Jan 25, 2024
@VaibhavMalik4187
Added unit tests for the cmd/mysqlctl package
847d252 
Partially addresses: vitessio#14931

Signed-off-by: VaibhavMalik4187 <[email protected]>
@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 47.49%. Comparing base (2162883) to head (847d252).
Report is 449 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #15041      +/-   ##
==========================================
- Coverage   47.50%   47.49%   -0.02%     
==========================================
  Files        1149     1158       +9     
  Lines      239324   239491     +167     
==========================================
+ Hits       113682   113735      +53     
- Misses     117053   117175     +122     
+ Partials     8589     8581       -8

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

ajm188
ajm188 reviewed Feb 5, 2024
View reviewed changes
go/cmd/mysqlctl/command/position_test.go
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := cmd.Args(&cobra.Command{}, tt.args)
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: technically speaking (here it is Fine by coincidence, but in case anyone copies this pattern), this should be cmd.Args(cmd, tt.args)

go/cmd/mysqlctl/command/start_test.go
"github.com/stretchr/testify/require"
)

func TestList(t *testing.T) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this called TestList when we are testing the Start command?

go/cmd/mysqlctl/command/start_test.go

func TestList(t *testing.T) {
require.NotNil(t, Start)
require.Equal(t, "start", Start.Name())
Copy link
Contributor

Choose a reason for hiding this comment

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

i don't think this assertion is particularly valuable

go/cmd/mysqlctl/command/start_test.go
func TestList(t *testing.T) {
require.NotNil(t, Start)
require.Equal(t, "start", Start.Name())
require.Equal(t, "Starts mysqld on an already 'init'-ed directory.", Start.Short)
Copy link
Contributor

Choose a reason for hiding this comment

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

nor this one

go/cmd/mysqlctl/command/start_test.go
require.Equal(t, "start", Start.Name())
require.Equal(t, "Starts mysqld on an already 'init'-ed directory.", Start.Short)

err := Start.RunE(&cobra.Command{}, []string{})
Copy link
Contributor

Choose a reason for hiding this comment

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

can we set up a more comprehensive test? this fails pretty early into the command's main method right?

go/cmd/mysqlctl/command/position_test.go
{
name: "parse error",
args: []string{"equal", "at_least", "append"},
expectedErr: "parse error: unknown GTIDSet flavor \"\"",
Copy link
Contributor

Choose a reason for hiding this comment

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

reading these test cases, it seems like we are really only testing that GTIDSet flavor parsing is correct, which is orthogonal to the actual mysqlctl command (i.e., that functionality should be tested elsewhere). we should remove these (and replace them with different tests if necessary/applicable)

@frouioui frouioui modified the milestones: v19.0.0, v20.0.0 Feb 6, 2024
@GuptaManan100 GuptaManan100 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 Mar 5, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 5, 2024

This PR is being marked as stale because it has been open for 30 days with no activity. To rectify, you may do any of the following:

  • Push additional commits to the associated branch.
  • Remove the stale label.
  • Add a comment indicating why it is not stale.

If no action is taken within 7 days, this PR will be closed.

@github-actions github-actions bot added Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. and removed Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. labels Apr 5, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 6, 2024

This PR is being marked as stale because it has been open for 30 days with no activity. To rectify, you may do any of the following:

  • Push additional commits to the associated branch.
  • Remove the stale label.
  • Add a comment indicating why it is not stale.

If no action is taken within 7 days, this PR will be closed.

@github-actions github-actions bot added Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. and removed Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. labels May 6, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 6, 2024

This PR is being marked as stale because it has been open for 30 days with no activity. To rectify, you may do any of the following:

  • Push additional commits to the associated branch.
  • Remove the stale label.
  • Add a comment indicating why it is not stale.

If no action is taken within 7 days, this PR will be closed.

@github-actions github-actions bot added Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. and removed Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. labels Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ajm188 ajm188 ajm188 left review comments

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

@mattlord mattlord Awaiting requested review from mattlord mattlord will be requested when the pull request is marked ready for review mattlord 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.
4 participants
@VaibhavMalik4187 @ajm188 @frouioui @GuptaManan100