disable printing usage info for management-cluster and cluster commands if they fail even for correct command #2253

chandrareddyp · 2022-04-28T03:50:16Z

What this PR does / why we need it

tanzu commands - tanzu cluster and tanzu management-cluster commands and their sub-commands, print usage information if the command fails irrespective of the reason, even though the input command is correct. The command might fail because of some internal or external errors, but commands still print command usage information that is misleading the end-user, it is not a great user experience.

As part of this fix, the usage information will be disabled (silentUsage enabled), in case the command fails, it does not print usage information just prints error details. This is applicable for tanzu cluster and tanzu management-cluster commands and their sub-commands.

Which issue(s) this PR fixes

Fixes #1907

Describe testing done for PR

Unit test cases are written to test the silentUsage for management-cluster and cluster commands and their sub-commands.
Manual testing has been done for management-cluster and cluster commands and their sub-commands, to make sure usage information does not print if the command fails because of some internal or external errors.

Release note

`tanzu cluster` and `tanzu management-cluster` commands and their sub-commands, do not print usage information in case the command fails for any reason, it just prints error information.  To get usage information for  `tanzu cluster` or `tanzu management-cluster` commands and their sub-commands, need to call the command or sub-commands with the flag `--help` or `-h`.

PR Checklist

Squash the commits into one or a small number of logical commits
Use good commit messages
Ensure PR contains terms all contributors can understand and links all contributors can access

Additional information

Special notes for your reviewer

github-actions · 2022-04-28T04:02:02Z

Cluster Generation A/B Results:
https://storage.googleapis.com/tkg-clustergen/2253/20220428040200/clustergen.diff.txt
Author/reviewers:
Please review to verify that the effects on the generated cluster configurations are exactly what the PR intended, and give a thumbs-up if so.

github-actions · 2022-04-28T04:03:54Z

Cluster Generation A/B Results:
https://storage.googleapis.com/tkg-clustergen/2253/20220428040352/clustergen.diff.txt
Author/reviewers:
Please review to verify that the effects on the generated cluster configurations are exactly what the PR intended, and give a thumbs-up if so.

github-actions · 2022-04-28T04:05:51Z

Cluster Generation A/B Results:
https://storage.googleapis.com/tkg-clustergen/2253/20220428040549/clustergen.diff.txt
Author/reviewers:
Please review to verify that the effects on the generated cluster configurations are exactly what the PR intended, and give a thumbs-up if so.

github-actions · 2022-04-28T04:16:09Z

Cluster Generation A/B Results:
https://storage.googleapis.com/tkg-clustergen/2253/20220428041607/clustergen.diff.txt
Author/reviewers:
Please review to verify that the effects on the generated cluster configurations are exactly what the PR intended, and give a thumbs-up if so.

github-actions · 2022-04-28T04:17:40Z

Cluster Generation A/B Results:
https://storage.googleapis.com/tkg-clustergen/2253/20220428041737/clustergen.diff.txt
Author/reviewers:
Please review to verify that the effects on the generated cluster configurations are exactly what the PR intended, and give a thumbs-up if so.

vuil · 2022-04-29T18:40:30Z

cmd/cli/plugin/cluster/test/cluster_silentmode.go

+}
+
+func initClusterSilentModeUsecases() {
+	createClusterNegTestSilentMode = clitest.NewTest("create cluster", "cluster create", FuncToExecAndValidateStdError)


nit: are we running each of these commands without args and relying on some being failure cases and some not to exercise the usage silencing behavior?
It may be a good idea group the test cases, and to provide some explanation what we are trying to testing here

All cases are failure cases only, yes it's to exercise the silentUsage. I have already grouped all silent use cases, I will update details in the comments.

vuil · 2022-04-29T18:43:09Z

changes look good, I just have a nit suggestion posted as a comment.
Besides that, please also:

provide a clearer description in the commit message on what is changed. e.g. good to summarize the output behavior under various circumstances
add a release note line in the PR description since this change has user-facing implications. Release automation actually picks it these relnotes lines
sign the commit (git commit --amend -s)
mentioned Fixes: #xxx in the commit message

github-actions · 2022-05-04T22:19:34Z

Cluster Generation A/B Results:
https://storage.googleapis.com/tkg-clustergen/2253/20220504221933/clustergen.diff.txt
Author/reviewers:
Please review to verify that the effects on the generated cluster configurations are exactly what the PR intended, and give a thumbs-up if so.

github-actions · 2022-05-04T22:30:04Z

Cluster Generation A/B Results:
https://storage.googleapis.com/tkg-clustergen/2253/20220504223002/clustergen.diff.txt
Author/reviewers:
Please review to verify that the effects on the generated cluster configurations are exactly what the PR intended, and give a thumbs-up if so.

github-actions · 2022-05-04T22:35:00Z

Cluster Generation A/B Results:
https://storage.googleapis.com/tkg-clustergen/2253/20220504223459/clustergen.diff.txt
Author/reviewers:
Please review to verify that the effects on the generated cluster configurations are exactly what the PR intended, and give a thumbs-up if so.

github-actions · 2022-05-04T22:35:20Z

Cluster Generation A/B Results:
https://storage.googleapis.com/tkg-clustergen/2253/20220504223519/clustergen.diff.txt
Author/reviewers:
Please review to verify that the effects on the generated cluster configurations are exactly what the PR intended, and give a thumbs-up if so.

github-actions · 2022-05-04T22:35:28Z

Cluster Generation A/B Results:
https://storage.googleapis.com/tkg-clustergen/2253/20220504223525/clustergen.diff.txt
Author/reviewers:
Please review to verify that the effects on the generated cluster configurations are exactly what the PR intended, and give a thumbs-up if so.

chandrareddyp · 2022-05-05T01:00:24Z

@vuil I have updated the commit message (with sign and issue id) and release note in PR description. Please review it. thanks.

github-actions · 2022-05-05T01:04:34Z

Cluster Generation A/B Results:
https://storage.googleapis.com/tkg-clustergen/2253/20220505010432/clustergen.diff.txt
Author/reviewers:
Please review to verify that the effects on the generated cluster configurations are exactly what the PR intended, and give a thumbs-up if so.

vuil · 2022-05-06T20:49:13Z

/test upgrade-vc7

will merge on this passing

alfredthenarwhal · 2022-05-07T05:19:12Z

@vuil: /test upgrade-vc7
Commit: 24adcd5

Tests failed! Build no: 1941

vuil · 2022-05-09T17:41:33Z

/test upgrade-vc7

vuil

lgtm, thanks!

vuil · 2022-05-12T19:15:05Z

/test upgrade-vc7

alfredthenarwhal · 2022-05-12T22:40:19Z

@vuil: /test upgrade-vc7
Commit: 24adcd5

Tests failed! Build no: 1977

github-actions · 2022-05-17T00:38:54Z

Cluster Generation A/B Results:
https://storage.googleapis.com/tkg-clustergen/2253/20220517003852/clustergen.diff.txt
Author/reviewers:
Please review to verify that the effects on the generated cluster configurations are exactly what the PR intended, and give a thumbs-up if so.

chandrareddyp · 2022-05-17T01:34:54Z

/test upgrade-vc7

alfredthenarwhal · 2022-05-17T01:34:57Z

@chandrareddyp: /test upgrade-vc7

Tests can be triggered only by the trusted reviewers (users mentioned in CODEOWNERS file).

…entUsage:true) for management-cluster and cluster commands, their sub-commands. This gives better user experience, before this fix usage info prints always if command fails, irrespective of the issue, which is not great end user experience. More details: `tanzu cluster` and `tanzu management-cluster` commands and its sub-commands, do not print usage information in case command fails for any reason, it just prints error information. To get usage details for both `tanzu cluster` and `tanzu management-cluster` commands and their sub-commands, need to call the command or sub-commands with the flag `--help` or `-h`. eg: `tanzu cluster --help` `tanzu management-cluster create --help`

github-actions · 2022-05-18T04:17:02Z

Cluster Generation A/B Results:
https://storage.googleapis.com/tkg-clustergen/2253/20220518041700/clustergen.diff.txt
Author/reviewers:
Please review to verify that the effects on the generated cluster configurations are exactly what the PR intended, and give a thumbs-up if so.

vuil · 2022-05-18T04:36:24Z

/test upgrade-vc7

alfredthenarwhal · 2022-05-18T07:43:11Z

@vuil: /test upgrade-vc7
Commit: 8902e74

Tests failed! Build no: 2013

chandrareddyp · 2022-05-19T00:09:33Z

We did rerun the BOLT test, its successful - https://gitlab.eng.vmware.com/TKG/bolt/bolt-release-yamls/-/merge_requests/2013

chandrareddyp requested review from a team as code owners April 28, 2022 03:50

vmwclabot added the cla-not-required label Apr 28, 2022

chandrareddyp force-pushed the topic/cpamuluri/silentusage branch from 30f0920 to e56b47a Compare April 28, 2022 03:52

chandrareddyp force-pushed the topic/cpamuluri/silentusage branch from fc8f225 to 26633b3 Compare April 28, 2022 04:04

vuil reviewed Apr 29, 2022

View reviewed changes

chandrareddyp force-pushed the topic/cpamuluri/silentusage branch 2 times, most recently from 27f19e7 to 7fd9e50 Compare May 4, 2022 22:18

chandrareddyp force-pushed the topic/cpamuluri/silentusage branch 3 times, most recently from 1e31092 to 31b0ab6 Compare May 4, 2022 22:24

chandrareddyp force-pushed the topic/cpamuluri/silentusage branch from 31b0ab6 to 24adcd5 Compare May 5, 2022 00:53

vuil added area/ux UX related area/cli labels May 6, 2022

vuil approved these changes May 9, 2022

View reviewed changes

chandrareddyp force-pushed the topic/cpamuluri/silentusage branch from 24adcd5 to e18e19c Compare May 17, 2022 00:28

chandrareddyp force-pushed the topic/cpamuluri/silentusage branch from e18e19c to 8902e74 Compare May 18, 2022 04:03

vuil added the ok-to-merge PRs should be labelled with this before merging label May 19, 2022

vuil merged commit 40532e4 into vmware-tanzu:main May 19, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

disable printing usage info for management-cluster and cluster commands if they fail even for correct command #2253

disable printing usage info for management-cluster and cluster commands if they fail even for correct command #2253

chandrareddyp commented Apr 28, 2022 •

edited by vuil

Loading

github-actions bot commented Apr 28, 2022

github-actions bot commented Apr 28, 2022

github-actions bot commented Apr 28, 2022

github-actions bot commented Apr 28, 2022

github-actions bot commented Apr 28, 2022

vuil Apr 29, 2022

chandrareddyp May 4, 2022 •

edited

Loading

vuil commented Apr 29, 2022 •

edited

Loading

github-actions bot commented May 4, 2022

github-actions bot commented May 4, 2022

github-actions bot commented May 4, 2022

github-actions bot commented May 4, 2022

github-actions bot commented May 4, 2022

chandrareddyp commented May 5, 2022

github-actions bot commented May 5, 2022

vuil commented May 6, 2022

alfredthenarwhal commented May 7, 2022

vuil commented May 9, 2022

vuil left a comment

vuil commented May 12, 2022

alfredthenarwhal commented May 12, 2022

github-actions bot commented May 17, 2022

chandrareddyp commented May 17, 2022

alfredthenarwhal commented May 17, 2022

github-actions bot commented May 18, 2022

vuil commented May 18, 2022

alfredthenarwhal commented May 18, 2022

chandrareddyp commented May 19, 2022 •

edited

Loading

disable printing usage info for management-cluster and cluster commands if they fail even for correct command #2253

disable printing usage info for management-cluster and cluster commands if they fail even for correct command #2253

Conversation

chandrareddyp commented Apr 28, 2022 • edited by vuil Loading

What this PR does / why we need it

Which issue(s) this PR fixes

Describe testing done for PR

Release note

PR Checklist

Additional information

Special notes for your reviewer

github-actions bot commented Apr 28, 2022

github-actions bot commented Apr 28, 2022

github-actions bot commented Apr 28, 2022

github-actions bot commented Apr 28, 2022

github-actions bot commented Apr 28, 2022

vuil Apr 29, 2022

Choose a reason for hiding this comment

chandrareddyp May 4, 2022 • edited Loading

Choose a reason for hiding this comment

vuil commented Apr 29, 2022 • edited Loading

github-actions bot commented May 4, 2022

github-actions bot commented May 4, 2022

github-actions bot commented May 4, 2022

github-actions bot commented May 4, 2022

github-actions bot commented May 4, 2022

chandrareddyp commented May 5, 2022

github-actions bot commented May 5, 2022

vuil commented May 6, 2022

alfredthenarwhal commented May 7, 2022

vuil commented May 9, 2022

vuil left a comment

Choose a reason for hiding this comment

vuil commented May 12, 2022

alfredthenarwhal commented May 12, 2022

github-actions bot commented May 17, 2022

chandrareddyp commented May 17, 2022

alfredthenarwhal commented May 17, 2022

github-actions bot commented May 18, 2022

vuil commented May 18, 2022

alfredthenarwhal commented May 18, 2022

chandrareddyp commented May 19, 2022 • edited Loading

chandrareddyp commented Apr 28, 2022 •

edited by vuil

Loading

chandrareddyp May 4, 2022 •

edited

Loading

vuil commented Apr 29, 2022 •

edited

Loading

chandrareddyp commented May 19, 2022 •

edited

Loading