diff --git a/docs/stackit.md b/docs/stackit.md index eaa87cd07..7dacfde65 100644 --- a/docs/stackit.md +++ b/docs/stackit.md @@ -26,35 +26,22 @@ stackit [flags] ### SEE ALSO -* [stackit argus](./stackit_argus.md) - Provides functionality for Argus * [stackit argus](./stackit_argus.md) - Provides functionality for Argus * [stackit auth](./stackit_auth.md) - Provides authentication functionality * [stackit config](./stackit_config.md) - Provides functionality for CLI configuration options * [stackit curl](./stackit_curl.md) - Executes an authenticated HTTP request to an endpoint * [stackit dns](./stackit_dns.md) - Provides functionality for DNS * [stackit logme](./stackit_logme.md) - Provides functionality for LogMe -* [stackit logme](./stackit_logme.md) - Provides functionality for LogMe * [stackit mariadb](./stackit_mariadb.md) - Provides functionality for MariaDB -* [stackit mariadb](./stackit_mariadb.md) - Provides functionality for MariaDB -* [stackit mongodbflex](./stackit_mongodbflex.md) - Provides functionality for MongoDB Flex * [stackit mongodbflex](./stackit_mongodbflex.md) - Provides functionality for MongoDB Flex * [stackit object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage -* [stackit object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage -* [stackit opensearch](./stackit_opensearch.md) - Provides functionality for OpenSearch * [stackit opensearch](./stackit_opensearch.md) - Provides functionality for OpenSearch * [stackit organization](./stackit_organization.md) - Provides functionality regarding organizations -* [stackit organization](./stackit_organization.md) - Provides functionality regarding organizations -* [stackit postgresflex](./stackit_postgresflex.md) - Provides functionality for PostgreSQL Flex * [stackit postgresflex](./stackit_postgresflex.md) - Provides functionality for PostgreSQL Flex * [stackit project](./stackit_project.md) - Provides functionality regarding projects * [stackit rabbitmq](./stackit_rabbitmq.md) - Provides functionality for RabbitMQ -* [stackit rabbitmq](./stackit_rabbitmq.md) - Provides functionality for RabbitMQ -* [stackit redis](./stackit_redis.md) - Provides functionality for Redis * [stackit redis](./stackit_redis.md) - Provides functionality for Redis * [stackit secrets-manager](./stackit_secrets-manager.md) - Provides functionality for Secrets Manager -* [stackit secrets-manager](./stackit_secrets-manager.md) - Provides functionality for Secrets Manager -* [stackit service-account](./stackit_service-account.md) - Provides functionality for service accounts * [stackit service-account](./stackit_service-account.md) - Provides functionality for service accounts * [stackit ske](./stackit_ske.md) - Provides functionality for SKE -* [stackit ske](./stackit_ske.md) - Provides functionality for SKE diff --git a/docs/stackit_argus.md b/docs/stackit_argus.md index 659b1dc36..99585f43a 100644 --- a/docs/stackit_argus.md +++ b/docs/stackit_argus.md @@ -29,6 +29,7 @@ stackit argus [flags] ### SEE ALSO * [stackit](./stackit.md) - Manage STACKIT resources using the command line +* [stackit argus grafana](./stackit_argus_grafana.md) - Provides functionality for the Grafana configuration of Argus instances * [stackit argus instance](./stackit_argus_instance.md) - Provides functionality for Argus instances * [stackit argus plans](./stackit_argus_plans.md) - Lists all Argus service plans diff --git a/docs/stackit_argus_grafana.md b/docs/stackit_argus_grafana.md new file mode 100644 index 000000000..9d6714075 --- /dev/null +++ b/docs/stackit_argus_grafana.md @@ -0,0 +1,33 @@ +## stackit argus grafana + +Provides functionality for the Grafana configuration of Argus instances + +### Synopsis + +Provides functionality for the Grafana configuration of Argus instances. + +``` +stackit argus grafana [flags] +``` + +### Options + +``` + -h, --help Help for "stackit argus grafana" +``` + +### Options inherited from parent commands + +``` + -y, --assume-yes If set, skips all confirmation prompts + --async If set, runs the command asynchronously + -o, --output-format string Output format, one of ["json" "pretty"] + -p, --project-id string Project ID + --verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info") +``` + +### SEE ALSO + +* [stackit argus](./stackit_argus.md) - Provides functionality for Argus +* [stackit argus grafana describe](./stackit_argus_grafana_describe.md) - Shows details of the Grafana configuration of an Argus instance + diff --git a/docs/stackit_argus_grafana_describe.md b/docs/stackit_argus_grafana_describe.md new file mode 100644 index 000000000..086d30a42 --- /dev/null +++ b/docs/stackit_argus_grafana_describe.md @@ -0,0 +1,49 @@ +## stackit argus grafana describe + +Shows details of the Grafana configuration of an Argus instance + +### Synopsis + +Shows details of the Grafana configuration of an Argus instance. +The Grafana dashboard URL and initial credentials (admin user and password) will be shown in the "pretty" output format. These credentials are only valid for first login. Please change the password after first login. After changing, the initial password is no longer valid. +The initial password is shown by default, if you want to hide it use the "--hide-password" flag. + +``` +stackit argus grafana describe [flags] +``` + +### Examples + +``` + Get details of the Grafana configuration of an Argus instance with ID "xxx" + $ stackit argus credentials describe --instance-id xxx + + Get details of the Grafana configuration of an Argus instance with ID "xxx" in a table format + $ stackit argus credentials describe --instance-id xxx --output-format pretty + + Get details of the Grafana configuration of an Argus instance with ID "xxx" and hide the initial admin password + $ stackit argus credentials describe --instance-id xxx --output-format pretty --hide-password +``` + +### Options + +``` + -h, --help Help for "stackit argus grafana describe" + --hide-password Show the initial admin password in the "pretty" output format + --instance-id string Instance ID +``` + +### Options inherited from parent commands + +``` + -y, --assume-yes If set, skips all confirmation prompts + --async If set, runs the command asynchronously + -o, --output-format string Output format, one of ["json" "pretty"] + -p, --project-id string Project ID + --verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info") +``` + +### SEE ALSO + +* [stackit argus grafana](./stackit_argus_grafana.md) - Provides functionality for the Grafana configuration of Argus instances + diff --git a/internal/cmd/argus/argus.go b/internal/cmd/argus/argus.go index 38dc77321..4454a1c02 100644 --- a/internal/cmd/argus/argus.go +++ b/internal/cmd/argus/argus.go @@ -1,6 +1,7 @@ package argus import ( + "github.com/stackitcloud/stackit-cli/internal/cmd/argus/grafana" "github.com/stackitcloud/stackit-cli/internal/cmd/argus/instance" "github.com/stackitcloud/stackit-cli/internal/cmd/argus/plans" "github.com/stackitcloud/stackit-cli/internal/pkg/args" @@ -23,6 +24,7 @@ func NewCmd(p *print.Printer) *cobra.Command { } func addSubcommands(cmd *cobra.Command, p *print.Printer) { - cmd.AddCommand(plans.NewCmd(p)) + cmd.AddCommand(grafana.NewCmd(p)) cmd.AddCommand(instance.NewCmd(p)) + cmd.AddCommand(plans.NewCmd(p)) } diff --git a/internal/cmd/argus/grafana/describe/describe.go b/internal/cmd/argus/grafana/describe/describe.go new file mode 100644 index 000000000..a950591c0 --- /dev/null +++ b/internal/cmd/argus/grafana/describe/describe.go @@ -0,0 +1,148 @@ +package describe + +import ( + "context" + "encoding/json" + "fmt" + + "github.com/stackitcloud/stackit-cli/internal/pkg/args" + "github.com/stackitcloud/stackit-cli/internal/pkg/errors" + "github.com/stackitcloud/stackit-cli/internal/pkg/examples" + "github.com/stackitcloud/stackit-cli/internal/pkg/flags" + "github.com/stackitcloud/stackit-cli/internal/pkg/globalflags" + "github.com/stackitcloud/stackit-cli/internal/pkg/print" + "github.com/stackitcloud/stackit-cli/internal/pkg/services/argus/client" + "github.com/stackitcloud/stackit-cli/internal/pkg/tables" + + "github.com/spf13/cobra" + "github.com/stackitcloud/stackit-sdk-go/services/argus" +) + +const ( + instanceIdFlag = "instance-id" + hidePasswordFlag = "hide-password" +) + +type inputModel struct { + *globalflags.GlobalFlagModel + InstanceId string + HidePassword bool +} + +func NewCmd(p *print.Printer) *cobra.Command { + cmd := &cobra.Command{ + Use: "describe", + Short: "Shows details of the Grafana configuration of an Argus instance", + Long: fmt.Sprintf("%s\n%s\n%s", + "Shows details of the Grafana configuration of an Argus instance.", + `The Grafana dashboard URL and initial credentials (admin user and password) will be shown in the "pretty" output format. These credentials are only valid for first login. Please change the password after first login. After changing, the initial password is no longer valid.`, + `The initial password is shown by default, if you want to hide it use the "--hide-password" flag.`, + ), + Args: args.NoArgs, + Example: examples.Build( + examples.NewExample( + `Get details of the Grafana configuration of an Argus instance with ID "xxx"`, + "$ stackit argus credentials describe --instance-id xxx"), + examples.NewExample( + `Get details of the Grafana configuration of an Argus instance with ID "xxx" in a table format`, + "$ stackit argus credentials describe --instance-id xxx --output-format pretty"), + examples.NewExample( + `Get details of the Grafana configuration of an Argus instance with ID "xxx" and hide the initial admin password`, + "$ stackit argus credentials describe --instance-id xxx --output-format pretty --hide-password"), + ), + RunE: func(cmd *cobra.Command, args []string) error { + ctx := context.Background() + model, err := parseInput(cmd) + if err != nil { + return err + } + // Configure API client + apiClient, err := client.ConfigureClient(p) + if err != nil { + return err + } + + // Call API + grafanaConfigsReq := buildGetGrafanaConfigRequest(ctx, model, apiClient) + grafanaConfigsResp, err := grafanaConfigsReq.Execute() + if err != nil { + return fmt.Errorf("get Grafana configs: %w", err) + } + instanceReq := buildGetInstanceRequest(ctx, model, apiClient) + instanceResp, err := instanceReq.Execute() + if err != nil { + return fmt.Errorf("get instance: %w", err) + } + + return outputResult(p, model, grafanaConfigsResp, instanceResp) + }, + } + configureFlags(cmd) + return cmd +} + +func configureFlags(cmd *cobra.Command) { + cmd.Flags().Var(flags.UUIDFlag(), instanceIdFlag, "Instance ID") + cmd.Flags().Bool(hidePasswordFlag, false, `Show the initial admin password in the "pretty" output format`) + + err := flags.MarkFlagsRequired(cmd, instanceIdFlag) + cobra.CheckErr(err) +} + +func parseInput(cmd *cobra.Command) (*inputModel, error) { + globalFlags := globalflags.Parse(cmd) + if globalFlags.ProjectId == "" { + return nil, &errors.ProjectIdError{} + } + + return &inputModel{ + GlobalFlagModel: globalFlags, + InstanceId: flags.FlagToStringValue(cmd, instanceIdFlag), + HidePassword: flags.FlagToBoolValue(cmd, hidePasswordFlag), + }, nil +} + +func buildGetGrafanaConfigRequest(ctx context.Context, model *inputModel, apiClient *argus.APIClient) argus.ApiGetGrafanaConfigsRequest { + req := apiClient.GetGrafanaConfigs(ctx, model.InstanceId, model.ProjectId) + return req +} + +func buildGetInstanceRequest(ctx context.Context, model *inputModel, apiClient *argus.APIClient) argus.ApiGetInstanceRequest { + req := apiClient.GetInstance(ctx, model.InstanceId, model.ProjectId) + return req +} + +func outputResult(p *print.Printer, inputModel *inputModel, grafanaConfigs *argus.GrafanaConfigs, instance *argus.GetInstanceResponse) error { + switch inputModel.OutputFormat { + case globalflags.PrettyOutputFormat: + initialAdminPassword := *instance.Instance.GrafanaAdminPassword + if inputModel.HidePassword { + initialAdminPassword = "" + } + + table := tables.NewTable() + table.AddRow("GRAFANA DASHBOARD", *instance.Instance.GrafanaUrl) + table.AddSeparator() + table.AddRow("PUBLIC READ ACCESS", *grafanaConfigs.PublicReadAccess) + table.AddSeparator() + table.AddRow("SINGLE SIGN-ON", *grafanaConfigs.UseStackitSso) + table.AddSeparator() + table.AddRow("INITIAL ADMIN USER (DEFAULT)", *instance.Instance.GrafanaAdminUser) + table.AddSeparator() + table.AddRow("INITIAL ADMIN PASSWORD (DEFAULT)", initialAdminPassword) + err := table.Display(p) + if err != nil { + return fmt.Errorf("render table: %w", err) + } + + return nil + default: + details, err := json.MarshalIndent(grafanaConfigs, "", " ") + if err != nil { + return fmt.Errorf("marshal Grafana configs: %w", err) + } + p.Outputln(string(details)) + + return nil + } +} diff --git a/internal/cmd/argus/grafana/describe/describe_test.go b/internal/cmd/argus/grafana/describe/describe_test.go new file mode 100644 index 000000000..b380f5257 --- /dev/null +++ b/internal/cmd/argus/grafana/describe/describe_test.go @@ -0,0 +1,263 @@ +package describe + +import ( + "context" + "testing" + + "github.com/stackitcloud/stackit-cli/internal/pkg/globalflags" + + "github.com/google/go-cmp/cmp" + "github.com/google/go-cmp/cmp/cmpopts" + "github.com/google/uuid" + "github.com/stackitcloud/stackit-sdk-go/services/argus" +) + +var projectIdFlag = globalflags.ProjectIdFlag + +type testCtxKey struct{} + +var testCtx = context.WithValue(context.Background(), testCtxKey{}, "foo") +var testClient = &argus.APIClient{} +var testProjectId = uuid.NewString() +var testInstanceId = uuid.NewString() + +func fixtureFlagValues(mods ...func(flagValues map[string]string)) map[string]string { + flagValues := map[string]string{ + projectIdFlag: testProjectId, + instanceIdFlag: testInstanceId, + } + for _, mod := range mods { + mod(flagValues) + } + return flagValues +} + +func fixtureInputModel(mods ...func(model *inputModel)) *inputModel { + model := &inputModel{ + GlobalFlagModel: &globalflags.GlobalFlagModel{ + ProjectId: testProjectId, + Verbosity: globalflags.VerbosityDefault, + }, + InstanceId: testInstanceId, + } + for _, mod := range mods { + mod(model) + } + return model +} + +func fixtureGetGrafanaConfigsRequest(mods ...func(request *argus.ApiGetGrafanaConfigsRequest)) argus.ApiGetGrafanaConfigsRequest { + request := testClient.GetGrafanaConfigs(testCtx, testInstanceId, testProjectId) + for _, mod := range mods { + mod(&request) + } + return request +} + +func fixtureGetInstanceRequest(mods ...func(request *argus.ApiGetInstanceRequest)) argus.ApiGetInstanceRequest { + request := testClient.GetInstance(testCtx, testInstanceId, testProjectId) + for _, mod := range mods { + mod(&request) + } + return request +} + +func TestParseInput(t *testing.T) { + tests := []struct { + description string + argValues []string + flagValues map[string]string + isValid bool + expectedModel *inputModel + }{ + { + description: "base", + flagValues: fixtureFlagValues(), + isValid: true, + expectedModel: fixtureInputModel(), + }, + { + description: "hide password", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[hidePasswordFlag] = "true" + }), + isValid: true, + expectedModel: fixtureInputModel(func(model *inputModel) { + model.HidePassword = true + }), + }, + { + description: "no values", + argValues: []string{}, + flagValues: map[string]string{}, + isValid: false, + }, + { + description: "no flag values", + flagValues: map[string]string{}, + isValid: false, + }, + { + description: "project id missing", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, projectIdFlag) + }), + isValid: false, + }, + { + description: "project id invalid 1", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[projectIdFlag] = "" + }), + isValid: false, + }, + { + description: "project id invalid 2", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[projectIdFlag] = "invalid-uuid" + }), + isValid: false, + }, + { + description: "instance id missing", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, instanceIdFlag) + }), + isValid: false, + }, + { + description: "instance id invalid 1", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[instanceIdFlag] = "" + }), + isValid: false, + }, + { + description: "instance id invalid 2", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[instanceIdFlag] = "invalid-uuid" + }), + isValid: false, + }, + { + description: "credentials id invalid 1", + argValues: []string{""}, + flagValues: fixtureFlagValues(), + isValid: false, + }, + { + description: "credentials id invalid 2", + argValues: []string{"invalid-uuid"}, + flagValues: fixtureFlagValues(), + isValid: false, + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + cmd := NewCmd(nil) + err := globalflags.Configure(cmd.Flags()) + if err != nil { + t.Fatalf("configure global flags: %v", err) + } + + for flag, value := range tt.flagValues { + err := cmd.Flags().Set(flag, value) + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("setting flag --%s=%s: %v", flag, value, err) + } + } + + err = cmd.ValidateArgs(tt.argValues) + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("error validating args: %v", err) + } + + err = cmd.ValidateRequiredFlags() + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("error validating flags: %v", err) + } + + model, err := parseInput(cmd) + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("error parsing input: %v", err) + } + + if !tt.isValid { + t.Fatalf("did not fail on invalid input") + } + diff := cmp.Diff(model, tt.expectedModel) + if diff != "" { + t.Fatalf("Data does not match: %s", diff) + } + }) + } +} + +func TestBuildGetGrafanaConfigsRequest(t *testing.T) { + tests := []struct { + description string + model *inputModel + expectedRequest argus.ApiGetGrafanaConfigsRequest + }{ + { + description: "base", + model: fixtureInputModel(), + expectedRequest: fixtureGetGrafanaConfigsRequest(), + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + request := buildGetGrafanaConfigRequest(testCtx, tt.model, testClient) + + diff := cmp.Diff(request, tt.expectedRequest, + cmp.AllowUnexported(tt.expectedRequest), + cmpopts.EquateComparable(testCtx), + ) + if diff != "" { + t.Fatalf("Data does not match: %s", diff) + } + }) + } +} + +func TestBuildGetInstanceRequest(t *testing.T) { + tests := []struct { + description string + model *inputModel + expectedRequest argus.ApiGetInstanceRequest + }{ + { + description: "base", + model: fixtureInputModel(), + expectedRequest: fixtureGetInstanceRequest(), + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + request := buildGetInstanceRequest(testCtx, tt.model, testClient) + + diff := cmp.Diff(request, tt.expectedRequest, + cmp.AllowUnexported(tt.expectedRequest), + cmpopts.EquateComparable(testCtx), + ) + if diff != "" { + t.Fatalf("Data does not match: %s", diff) + } + }) + } +} diff --git a/internal/cmd/argus/grafana/grafana.go b/internal/cmd/argus/grafana/grafana.go new file mode 100644 index 000000000..e1a77a9ce --- /dev/null +++ b/internal/cmd/argus/grafana/grafana.go @@ -0,0 +1,26 @@ +package grafana + +import ( + "github.com/stackitcloud/stackit-cli/internal/cmd/argus/grafana/describe" + "github.com/stackitcloud/stackit-cli/internal/pkg/args" + "github.com/stackitcloud/stackit-cli/internal/pkg/print" + "github.com/stackitcloud/stackit-cli/internal/pkg/utils" + + "github.com/spf13/cobra" +) + +func NewCmd(p *print.Printer) *cobra.Command { + cmd := &cobra.Command{ + Use: "grafana", + Short: "Provides functionality for the Grafana configuration of Argus instances", + Long: "Provides functionality for the Grafana configuration of Argus instances.", + Args: args.NoArgs, + Run: utils.CmdHelp, + } + addSubcommands(cmd, p) + return cmd +} + +func addSubcommands(cmd *cobra.Command, p *print.Printer) { + cmd.AddCommand(describe.NewCmd(p)) +}