Skip to content

[CLI-1454] Modify potentially misleading flag suggestions #1482

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

Merged
Steven Gagniere (sgagniere) merged 3 commits into from
Oct 26, 2022
Merged

[CLI-1454] Modify potentially misleading flag suggestions #1482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9ec27eb
Modify api-key store error to remove references to the cluster flag
sgagniere Oct 26, 2022
26cbe33
remove --resource from a suggestion string
sgagniere Oct 26, 2022
637dfd1
Merge branch 'main' of github.com:confluentinc/cli into cli-1454
sgagniere Oct 26, 2022
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
3 changes: 2 additions & 1 deletion internal/cmd/api-key/command_store.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,8 @@ func (c *command) store(cmd *cobra.Command, args []string) error {
} else {
cluster, err = c.Context.GetKafkaClusterForCommand()
if err != nil {
return err
// Replace the error msg since it suggests flags which are unavailable with this command
return errors.NewErrorWithSuggestions(errors.NoKafkaSelectedErrorMsg, errors.APIKeyNotValidForClusterSuggestions)
}
}

Expand Down
2 changes: 1 addition & 1 deletion internal/pkg/errors/error_message.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ const (
KafkaNotReadyErrorMsg = `Kafka cluster "%s" not ready`
KafkaNotReadySuggestions = "It may take up to 5 minutes for a recently created Kafka cluster to be ready."
NoKafkaSelectedErrorMsg = "no Kafka cluster selected"
NoKafkaSelectedSuggestions = "You must pass `--cluster` or `--resource` with the command or set an active Kafka cluster in your context with `confluent kafka cluster use`."
NoKafkaSelectedSuggestions = "You must pass `--cluster` with the command or set an active Kafka cluster in your context with `confluent kafka cluster use`."
NoKafkaForDescribeSuggestions = "You must provide the cluster ID argument or set an active Kafka cluster in your context with `ccloud kafka cluster use`."
NoAPISecretStoredErrorMsg = `no API secret for API key "%s" of resource "%s" stored in local CLI state`
NoAPISecretStoredSuggestions = "Store the API secret with `confluent api-key store %s --resource %s`."
Expand Down
2 changes: 1 addition & 1 deletion test/fixtures/output/kafka/client-config/no-cluster.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Error: no Kafka cluster selected

Suggestions:
You must pass `--cluster` or `--resource` with the command or set an active Kafka cluster in your context with `confluent kafka cluster use`.
You must pass `--cluster` with the command or set an active Kafka cluster in your context with `confluent kafka cluster use`.
2 changes: 1 addition & 1 deletion test/fixtures/output/login/err-no-kafka.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Error: no Kafka cluster selected

Suggestions:
You must pass `--cluster` or `--resource` with the command or set an active Kafka cluster in your context with `confluent kafka cluster use`.
You must pass `--cluster` with the command or set an active Kafka cluster in your context with `confluent kafka cluster use`.