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

CLI-18: customize error messages for test command #115

Merged
merged 4 commits into from
Feb 27, 2021
Merged

CLI-18: customize error messages for test command #115

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
719698d
customize error messages for test command
morganelle Feb 26, 2021
939a533
fix error verb
morganelle Feb 26, 2021
3e3dd49
replace error format with new error when appropriate
morganelle Feb 26, 2021
1053757
updated test command errors for getOrCreateCLITesterClient
morganelle Feb 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions internal/cli/test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,14 @@ Launch a browser to try out your universal login box for the given client.
if clientID == "" {
client, err := getOrCreateCLITesterClient(cli.api.Client)
if err != nil {
return err
return fmt.Errorf("Unable to test the login box; please check your internet connection and verify you haven't reached your apps limit")
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
return fmt.Errorf("Unable to test the login box; please check your internet connection and verify you haven't reached your apps limit")
return errors.New("Unable to test the login box; please check your internet connection and verify you haven't reached your apps limit")

Given you're not passing %s style args, can just errors.New it.

Copy link

Choose a reason for hiding this comment

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

can we identify if the error is "reach app limit" vs internet issue? I would want to see the underlying error message, unless we know the two type of things that can happen are internet issue or app limit...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good call. Updated to Unable to create an app for testing the login box: {error} and Unable to create an app to test getting a token: {error}.

}
clientID = client.GetClientID()
}

client, err := cli.api.Client.Read(clientID)
if err != nil {
return err
return fmt.Errorf("Unable to find client %s; if you specified a client, please verify it exists, otherwise re-run the command", clientID)
}

if proceed := runLoginFlowPreflightChecks(cli, client); !proceed {
Expand All @@ -70,7 +70,7 @@ Launch a browser to try out your universal login box for the given client.
cliLoginTestingScopes,
)
if err != nil {
return err
return fmt.Errorf("An unexpected error occurred while logging in to client %s: %w", clientID, err)
}

if err := ansi.Spinner("Fetching user metadata", func() error {
Expand All @@ -79,7 +79,7 @@ Launch a browser to try out your universal login box for the given client.
userInfo, err = authutil.FetchUserInfo(tenant.Domain, tokenResponse.AccessToken)
return err
}); err != nil {
return err
return fmt.Errorf("An unexpected error occurred: %w", err)
}

fmt.Fprint(cli.renderer.MessageWriter, "\n")
Expand Down Expand Up @@ -118,14 +118,14 @@ Fetch an access token for the given client and API.
if clientID == "" {
client, err := getOrCreateCLITesterClient(cli.api.Client)
if err != nil {
return err
return fmt.Errorf("Unable to fetch a token; please check your internet connection and verify you haven't reached your apps limit")
}
clientID = client.GetClientID()
}

client, err := cli.api.Client.Read(clientID)
if err != nil {
return err
return fmt.Errorf("Unable to find client %s; if you specified a client, please verify it exists, otherwise re-run the command", clientID)
}

appType := client.GetAppType()
Expand All @@ -140,7 +140,7 @@ Fetch an access token for the given client and API.
if appType == "non_interactive" {
tokenResponse, err := runClientCredentialsFlow(cli, client, clientID, audience, tenant)
if err != nil {
return err
return fmt.Errorf("An unexpected error occurred while logging in to machine-to-machine client %s: %w", clientID, err)
}

fmt.Fprint(cli.renderer.MessageWriter, "\n")
Expand All @@ -162,7 +162,7 @@ Fetch an access token for the given client and API.
scopes,
)
if err != nil {
return err
return fmt.Errorf("An unexpected error occurred when logging in to client %s: %w", clientID, err)
}

fmt.Fprint(cli.renderer.MessageWriter, "\n")
Expand Down