Improve testing for help command for plugins#856
Merged
Conversation
There was a change in Cobra 1.9.0 which caused our unit tests to fail and showed that calling "rootCmd.SetArgs(spec.args)" is the proper approach when setting arguments to a cobra command in tests. Also, because of the way we handle the help command for plugins in "getHelpArguments()", we must also continue to set "os.Args"; however, the way the tests were written before would not cause a failure if the call to "os.Args" was removed. This commit updates the tests for both cases. Signed-off-by: Marc Khouzam <marc.khouzam@broadcom.com>
prkalle
approved these changes
Feb 26, 2025
Contributor
prkalle
left a comment
prkalle
left a comment
There was a problem hiding this comment.
LGTM. Thanks for the changes!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it
There was a change in Cobra 1.9.0 which caused our unit tests to fail and showed that calling
rootCmd.SetArgs(spec.args)is the proper approach when setting arguments to a cobra command in tests, even ifos.Argsis also used.Also, because of the way we handle the help command for plugins in
getHelpArguments(), we must also continue to setos.Args; however, the way the tests were written before this PR would not cause a failure if the call toos.Argswas removed.This commit updates the tests to better handle both cases.
Note that because of impacts to other programs, the particular change in Cobra was reverted in release v1.9.1.
Which issue(s) this PR fixes
Fixes # N/A
Describe testing done for PR
Only impacts tests, so CI.
Release note
Additional information
Special notes for your reviewer