- Notifications
You must be signed in to change notification settings - Fork928
fix: show --help message for CLI errors, add tests for delete#1403
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
8 commits Select commitHold shift + click to select a range
758dceb feat(cli): add test for delete
jsjoeio6ff347e fix(cli): use ExecuteC() to match Cobra
jsjoeio16c19c7 feat(cli): add WithoutParameters test for delete
jsjoeiodae45ab fixup! feat(cli): add WithoutParameters test for delete
jsjoeio32cbc85 refactor(cli): show --help error message on main
jsjoeioa7bd7bd fixup! refactor(cli): show --help error message on main
jsjoeioc28e93a refactor(cli): handle err with FormatCobraError
jsjoeio8ac2198 refactor(cli): add root_test.go, move delete test
jsjoeioFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
38 changes: 38 additions & 0 deletionscli/delete_test.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| package cli_test | ||
| import ( | ||
| "testing" | ||
| "github.com/stretchr/testify/require" | ||
| "github.com/coder/coder/cli/clitest" | ||
| "github.com/coder/coder/coderd/coderdtest" | ||
| "github.com/coder/coder/pty/ptytest" | ||
| ) | ||
| func TestDelete(t *testing.T) { | ||
| t.Run("WithParameter", func(t *testing.T) { | ||
| t.Parallel() | ||
| client := coderdtest.New(t, nil) | ||
| user := coderdtest.CreateFirstUser(t, client) | ||
| coderdtest.NewProvisionerDaemon(t, client) | ||
| version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil) | ||
| coderdtest.AwaitTemplateVersionJob(t, client, version.ID) | ||
| template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID) | ||
| workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID) | ||
| coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID) | ||
| cmd, root := clitest.New(t, "delete", workspace.Name) | ||
| clitest.SetupConfig(t, client, root) | ||
| doneChan := make(chan struct{}) | ||
| pty := ptytest.New(t) | ||
| cmd.SetIn(pty.Input()) | ||
| cmd.SetOut(pty.Output()) | ||
| go func() { | ||
| defer close(doneChan) | ||
| err := cmd.Execute() | ||
| require.NoError(t, err) | ||
| }() | ||
| pty.ExpectMatch("Cleaning Up") | ||
| <-doneChan | ||
| }) | ||
| } |
7 changes: 7 additions & 0 deletionscli/root.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| package cli | ||
| import ( | ||
| "fmt" | ||
| "net/url" | ||
| "os" | ||
| "time" | ||
| @@ -259,3 +260,9 @@ func versionTemplate() string { | ||
| template += "\r\n" | ||
| return template | ||
| } | ||
| // FormatCobraError colorizes and adds "--help" docs to cobra commands. | ||
| func FormatCobraError(err error, cmd *cobra.Command) string { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Extracted into function to make it easier to test | ||
| helpErrMsg := fmt.Sprintf("Run '%s %s --help' for usage.", cmd.Root().Name(), cmd.Name()) | ||
| return cliui.Styles.Error.Render(err.Error() + "\n" + helpErrMsg) | ||
| } | ||
22 changes: 22 additions & 0 deletionscli/root_test.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| package cli_test | ||
| import ( | ||
| "testing" | ||
| "github.com/stretchr/testify/require" | ||
| "github.com/coder/coder/cli" | ||
| "github.com/coder/coder/cli/clitest" | ||
| ) | ||
| func TestRoot(t *testing.T) { | ||
| t.Run("FormatCobraError", func(t *testing.T) { | ||
| t.Parallel() | ||
| cmd, _ := clitest.New(t, "delete") | ||
| cmd, err := cmd.ExecuteC() | ||
| errStr := cli.FormatCobraError(err, cmd) | ||
| require.Contains(t, errStr, "Run 'coder delete --help' for usage.") | ||
| }) | ||
| } |
5 changes: 3 additions & 2 deletionscmd/coder/main.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -14,12 +14,13 @@ import ( | ||
| func main() { | ||
| dadjoke() | ||
| cmd,err := cli.Root().ExecuteC() | ||
| if err != nil { | ||
| if errors.Is(err, cliui.Canceled) { | ||
| os.Exit(1) | ||
| } | ||
| cobraErr := cli.FormatCobraError(err, cmd) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Note: this behavior mimics what | ||
| _, _ = fmt.Fprintln(os.Stderr, cobraErr) | ||
| os.Exit(1) | ||
| } | ||
| } | ||
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.