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

Add required tests for internal/flag #15220

Merged
merged 5 commits into from
Mar 5, 2024
Merged

Add required tests for internal/flag #15220

merged 5 commits into from
Mar 5, 2024

Conversation

beingnoble03
Copy link
Member

Description

This PR adds required tests for go/internal/flag.

Related Issue(s)

Fixes part of #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

Deployment Notes

@beingnoble03
Initialize the flag test
7b2b823 
Signed-off-by: Noble Mittal <noblemittal@outlook.com>
@beingnoble03
Add required tests for internal/flag
a8f82c2 
Signed-off-by: Noble Mittal <noblemittal@outlook.com>
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Feb 13, 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 Feb 13, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Feb 13, 2024
ajm188
ajm188 reviewed Feb 13, 2024
View reviewed changes
go/internal/flag/flag_test.go
Comment on lines +29 to +33
oldCommandLine := goflag.CommandLine
defer func() {
goflag.CommandLine = oldCommandLine
}()

Copy link
Contributor

Choose a reason for hiding this comment

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

why do we need to mutate the global flagset to do these tests? from my reading we should be able to do our assertions with testFlagSet directly

Copy link
Member Author

Choose a reason for hiding this comment

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

The function PreventGlogVFlagFromClobberingVersionFlagShorthand uses f := goflag.Lookup("v"), so we need to register v flag in goflag.CommandLine for this.

go/internal/flag/flag_test.go
}

func TestParse(t *testing.T) {
oldCommandLine := goflag.CommandLine
Copy link
Contributor

Choose a reason for hiding this comment

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

same comment here

Copy link
Member Author

@beingnoble03 beingnoble03 Feb 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

The function Parse has fs.AddGoFlagSet(goflag.CommandLine), to test this we first register a testFlag in goflag.CommandLine, then to check if this was called, we use testFlagSet.Lookup. Please let me know if I am missing something here.

go/internal/flag/flag_test.go
assert.True(t, isProvided)
}

func TestFilterTestFlags(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.

i'm not sure we need this, as we exercise this function in a bunch of end-to-end tests implicitly (cc @rohit-nayak-ps)

Copy link
Contributor

Choose a reason for hiding this comment

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

I think the aim here is to increase unit test coverage, so it is fine to add these, especially since we don't yet have the tooling to incorporate the test coverage from e2e tests into our Code Coverage CI workflow.

go/internal/flag/flag_test.go
assert.Equal(t, expectedTestFlags, testFlags)
}

func TestParseFlagsForTest(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.

same about not needing this test

go/internal/flag/flag_test.go Outdated
}

func TestIsZeroValue(t *testing.T) {
oldCommandLine := goflag.CommandLine
Copy link
Contributor

Choose a reason for hiding this comment

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

again, we don't need to mutate global state for this test

Copy link
Member Author

Choose a reason for hiding this comment

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

Alternatively, created new FlagSet

go/internal/flag/usage_test.go Outdated Show resolved Hide resolved
@beingnoble03
Make use of BoolVar instead of creating own type
1f24603 
Signed-off-by: Noble Mittal <noblemittal@outlook.com>
@codecov Codecov
Copy link

codecov bot commented Feb 17, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.48%. Comparing base (14473b9) to head (e37ec38).
Report is 76 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #15220      +/-   ##
==========================================
- Coverage   67.34%   65.48%   -1.87%     
==========================================
  Files        1560     1562       +2     
  Lines      192571   193911    +1340     
==========================================
- Hits       129695   126982    -2713     
- Misses      62876    66929    +4053

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

ajm188
ajm188 reviewed Feb 17, 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.

looking good! just a few minor things

go/internal/flag/flag_test.go Outdated Show resolved Hide resolved
go/internal/flag/flag_test.go Outdated Show resolved Hide resolved
@beingnoble03
Add error message for assert.True and assert.False
60ba1ad 
Signed-off-by: Noble Mittal <noblemittal@outlook.com>
@beingnoble03
Copy link
Member Author

@ajm188 can you please review?

ajm188
ajm188 reviewed Feb 27, 2024
View reviewed changes
go/internal/flag/flag_test.go Show resolved Hide resolved
go/internal/flag/flag_test.go Outdated Show resolved Hide resolved
@beingnoble03
Simplify error messages for failing tests
e37ec38 
Signed-off-by: Noble Mittal <noblemittal@outlook.com>
@GuptaManan100 GuptaManan100 added Type: Testing Component: CLI 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
@GuptaManan100 GuptaManan100 merged commit 9d861f8 into vitessio:main Mar 5, 2024
107 of 108 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

@ajm188 ajm188 ajm188 approved these changes

@rohit-nayak-ps rohit-nayak-ps Awaiting requested review from rohit-nayak-ps rohit-nayak-ps is a code owner

Assignees
No one assigned
Labels
Component: CLI Type: Testing
Projects
None yet
Milestone
v20.0.0
Development

Successfully merging this pull request may close these issues.
4 participants
@beingnoble03 @ajm188 @GuptaManan100 @rohit-nayak-ps