From 906ec29d67e86896c2fcfdf962e1856b113de594 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diogo=20Ferr=C3=A3o?= Date: Mon, 22 Apr 2024 13:29:25 +0200 Subject: [PATCH 01/12] delete command implementation and testing --- docs/stackit_argus_scrape-configs_delete.md | 40 +++ .../cmd/argus/scrape-configs/delete/delete.go | 120 +++++++++ .../scrape-configs/delete/delete_test.go | 233 ++++++++++++++++++ 3 files changed, 393 insertions(+) create mode 100644 docs/stackit_argus_scrape-configs_delete.md create mode 100644 internal/cmd/argus/scrape-configs/delete/delete.go create mode 100644 internal/cmd/argus/scrape-configs/delete/delete_test.go diff --git a/docs/stackit_argus_scrape-configs_delete.md b/docs/stackit_argus_scrape-configs_delete.md new file mode 100644 index 000000000..5886abbde --- /dev/null +++ b/docs/stackit_argus_scrape-configs_delete.md @@ -0,0 +1,40 @@ +## stackit argus scrape-configs delete + +Deletes an Argus Scrape Config + +### Synopsis + +Deletes an Argus Scrape Config. + +``` +stackit argus scrape-configs delete JOB_NAME [flags] +``` + +### Examples + +``` + Delete an Argus Scrape config with name "my-config" from Argus instance "xxx" + $ stackit argus scrape-configs delete my-config --instance-id xxx +``` + +### Options + +``` + -h, --help Help for "stackit argus scrape-configs delete" + --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 scrape-configs](./stackit_argus_scrape-configs.md) - Provides functionality for scrape configs in Argus. + diff --git a/internal/cmd/argus/scrape-configs/delete/delete.go b/internal/cmd/argus/scrape-configs/delete/delete.go new file mode 100644 index 000000000..605790280 --- /dev/null +++ b/internal/cmd/argus/scrape-configs/delete/delete.go @@ -0,0 +1,120 @@ +package delete + +import ( + "context" + "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/spinner" + + "github.com/spf13/cobra" + "github.com/stackitcloud/stackit-sdk-go/services/argus" + "github.com/stackitcloud/stackit-sdk-go/services/argus/wait" +) + +const ( + jobNameArg = "JOB_NAME" + + instanceIdFlag = "instance-id" +) + +type inputModel struct { + *globalflags.GlobalFlagModel + JobName string + InstanceId string +} + +func NewCmd(p *print.Printer) *cobra.Command { + cmd := &cobra.Command{ + Use: fmt.Sprintf("delete %s", jobNameArg), + Short: "Deletes an Argus Scrape Config", + Long: "Deletes an Argus Scrape Config.", + Args: args.SingleArg(jobNameArg, nil), + Example: examples.Build( + examples.NewExample( + `Delete an Argus Scrape config with name "my-config" from Argus instance "xxx"`, + "$ stackit argus scrape-configs delete my-config --instance-id xxx"), + ), + RunE: func(cmd *cobra.Command, args []string) error { + ctx := context.Background() + model, err := parseInput(cmd, args) + if err != nil { + return err + } + + // Configure API client + apiClient, err := client.ConfigureClient(p) + if err != nil { + return err + } + + if !model.AssumeYes { + prompt := fmt.Sprintf("Are you sure you want to delete Scrape Config %q? (This cannot be undone)", model.JobName) + err = p.PromptForConfirmation(prompt) + if err != nil { + return err + } + } + + // Call API + req := buildRequest(ctx, model, apiClient) + _, err = req.Execute() + if err != nil { + return fmt.Errorf("delete Scrape Config: %w", err) + } + + // Wait for async operation, if async mode not enabled + if !model.Async { + s := spinner.New(p) + s.Start("Deleting scrape config") + _, err = wait.DeleteScrapeConfigWaitHandler(ctx, apiClient, model.InstanceId, model.JobName, model.ProjectId).WaitWithContext(ctx) + if err != nil { + return fmt.Errorf("wait for Scrape Config deletion: %w", err) + } + s.Stop() + } + + operationState := "Deleted" + if model.Async { + operationState = "Triggered deletion of" + } + p.Info("%s Scrape Config %q\n", operationState, model.JobName) + return nil + }, + } + configureFlags(cmd) + return cmd +} + +func configureFlags(cmd *cobra.Command) { + cmd.Flags().Var(flags.UUIDFlag(), instanceIdFlag, "Instance ID") + + err := flags.MarkFlagsRequired(cmd, instanceIdFlag) + cobra.CheckErr(err) +} + +func parseInput(cmd *cobra.Command, inputArgs []string) (*inputModel, error) { + clusterName := inputArgs[0] + + globalFlags := globalflags.Parse(cmd) + if globalFlags.ProjectId == "" { + return nil, &errors.ProjectIdError{} + } + + return &inputModel{ + GlobalFlagModel: globalFlags, + JobName: clusterName, + InstanceId: flags.FlagToStringValue(cmd, instanceIdFlag), + }, nil +} + +func buildRequest(ctx context.Context, model *inputModel, apiClient *argus.APIClient) argus.ApiDeleteScrapeConfigRequest { + req := apiClient.DeleteScrapeConfig(ctx, model.InstanceId, model.JobName, model.ProjectId) + return req +} diff --git a/internal/cmd/argus/scrape-configs/delete/delete_test.go b/internal/cmd/argus/scrape-configs/delete/delete_test.go new file mode 100644 index 000000000..f6f7ae5b6 --- /dev/null +++ b/internal/cmd/argus/scrape-configs/delete/delete_test.go @@ -0,0 +1,233 @@ +package delete + +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() +var testJobName = "my-config" + +func fixtureArgValues(mods ...func(argValues []string)) []string { + argValues := []string{ + testJobName, + } + for _, mod := range mods { + mod(argValues) + } + return argValues +} + +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, + }, + JobName: testJobName, + InstanceId: testInstanceId, + } + for _, mod := range mods { + mod(model) + } + return model +} + +func fixtureRequest(mods ...func(request *argus.ApiDeleteScrapeConfigRequest)) argus.ApiDeleteScrapeConfigRequest { + request := testClient.DeleteScrapeConfig(testCtx, testInstanceId, testJobName, 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", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(), + isValid: true, + expectedModel: fixtureInputModel(), + }, + { + description: "no values", + argValues: []string{}, + flagValues: map[string]string{}, + isValid: false, + }, + { + description: "no arg values", + argValues: []string{}, + flagValues: fixtureFlagValues(), + isValid: false, + }, + { + description: "no flag values", + argValues: fixtureArgValues(), + flagValues: map[string]string{}, + isValid: false, + }, + { + description: "project id missing", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, projectIdFlag) + }), + isValid: false, + }, + { + description: "project id invalid 1", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[projectIdFlag] = "" + }), + isValid: false, + }, + { + description: "project id invalid 2", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[projectIdFlag] = "invalid-uuid" + }), + isValid: false, + }, + { + description: "instance id missing", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, instanceIdFlag) + }), + isValid: false, + }, + { + description: "instance id invalid 1", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[instanceIdFlag] = "" + }), + isValid: false, + }, + { + description: "instance id invalid 2", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[instanceIdFlag] = "invalid-uuid" + }), + 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, tt.argValues) + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("error parsing flags: %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 TestBuildRequest(t *testing.T) { + tests := []struct { + description string + model *inputModel + isValid bool + expectedRequest argus.ApiDeleteScrapeConfigRequest + }{ + { + description: "base", + model: fixtureInputModel(), + isValid: true, + expectedRequest: fixtureRequest(), + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + request := buildRequest(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) + } + }) + } +} From e4c645768a2f5d0194768b2814ab4a8e953a53f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diogo=20Ferr=C3=A3o?= Date: Mon, 22 Apr 2024 16:16:26 +0200 Subject: [PATCH 02/12] initial implementation --- .../cmd/argus/scrape-configs/update/update.go | 131 ++++++++++ .../scrape-configs/update/update_test.go | 247 ++++++++++++++++++ update.json | 20 ++ 3 files changed, 398 insertions(+) create mode 100644 internal/cmd/argus/scrape-configs/update/update.go create mode 100644 internal/cmd/argus/scrape-configs/update/update_test.go create mode 100644 update.json diff --git a/internal/cmd/argus/scrape-configs/update/update.go b/internal/cmd/argus/scrape-configs/update/update.go new file mode 100644 index 000000000..00a128671 --- /dev/null +++ b/internal/cmd/argus/scrape-configs/update/update.go @@ -0,0 +1,131 @@ +package update + +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/spf13/cobra" + "github.com/stackitcloud/stackit-sdk-go/services/argus" +) + +const ( + jobNameArg = "JOB_NAME" + + instanceIdFlag = "instance-id" + payloadFlag = "payload" +) + +type inputModel struct { + *globalflags.GlobalFlagModel + JobName string + InstanceId string + Payload argus.UpdateScrapeConfigPayload +} + +func NewCmd(p *print.Printer) *cobra.Command { + cmd := &cobra.Command{ + Use: fmt.Sprintf("update %s", jobNameArg), + Short: "Updates a Scrape Config of an Argus instance", + Long: fmt.Sprintf("%s\n%s\n%s", + "Updates a Scrape Config of an Argus instance.", + "The payload can be provided as a JSON string or a file path prefixed with \"@\".", + "See https://docs.api.stackit.cloud/documentation/argus/version/v1#tag/scrape-config/operation/v1_projects_instances_scrapeconfigs_partial_update for information regarding the payload structure.", + ), + Args: args.SingleArg(jobNameArg, nil), + Example: examples.Build( + examples.NewExample( + `Update a Scrape Config from Argus instance "xxx", using an API payload sourced from the file "./payload.json"`, + "$ stackit argus scrape-configs update my-config --payload @./payload.json --instance-id xxx"), + examples.NewExample( + `Update an Scrape Config from Argus instance "xxx", using an API payload provided as a JSON string`, + `$ stackit argus scrape-configs update my-config --payload "{...}" --instance-id xxx`), + examples.NewExample( + `Generate a payload with the current values of a Scrape Config, and adapt it with custom values for the different configuration options`, + `$ stackit argus scrape-config generate-payload --job-name my-config > ./payload.json`, + ``, + `$ stackit argus scrape-configs update my-config --payload @./payload.json`), + ), + RunE: func(cmd *cobra.Command, args []string) error { + ctx := context.Background() + model, err := parseInput(cmd, args) + if err != nil { + return err + } + + // Configure API client + apiClient, err := client.ConfigureClient(p) + if err != nil { + return err + } + + if !model.AssumeYes { + prompt := fmt.Sprintf("Are you sure you want to update scrape config %q?", model.JobName) + err = p.PromptForConfirmation(prompt) + if err != nil { + return err + } + } + + // Call API + req := buildRequest(ctx, model, apiClient) + _, err = req.Execute() + if err != nil { + return fmt.Errorf("update scrape config: %w", err) + } + + // The API has no status to wait on, so async mode is default + operationState := "Triggered update of" + p.Info("%s Argus Scrape Config %q\n", operationState, model.JobName) + return nil + }, + } + configureFlags(cmd) + return cmd +} + +func configureFlags(cmd *cobra.Command) { + cmd.Flags().Var(flags.ReadFromFileFlag(), payloadFlag, `Request payload (JSON). Can be a string or a file path, if prefixed with "@". Example: @./payload.json`) + cmd.Flags().Var(flags.UUIDFlag(), instanceIdFlag, "Instance ID") + + err := flags.MarkFlagsRequired(cmd, instanceIdFlag, payloadFlag) + cobra.CheckErr(err) +} + +func parseInput(cmd *cobra.Command, inputArgs []string) (*inputModel, error) { + clusterName := inputArgs[0] + + globalFlags := globalflags.Parse(cmd) + if globalFlags.ProjectId == "" { + return nil, &errors.ProjectIdError{} + } + + payloadString := flags.FlagToStringValue(cmd, payloadFlag) + var payload argus.UpdateScrapeConfigPayload + err := json.Unmarshal([]byte(payloadString), &payload) + if err != nil { + return nil, fmt.Errorf("encode payload: %w", err) + } + + return &inputModel{ + GlobalFlagModel: globalFlags, + JobName: clusterName, + Payload: payload, + InstanceId: flags.FlagToStringValue(cmd, instanceIdFlag), + }, nil +} + +func buildRequest(ctx context.Context, model *inputModel, apiClient *argus.APIClient) argus.ApiUpdateScrapeConfigRequest { + req := apiClient.UpdateScrapeConfig(ctx, model.InstanceId, model.JobName, model.ProjectId) + + req = req.UpdateScrapeConfigPayload(model.Payload) + return req +} diff --git a/internal/cmd/argus/scrape-configs/update/update_test.go b/internal/cmd/argus/scrape-configs/update/update_test.go new file mode 100644 index 000000000..5402e5659 --- /dev/null +++ b/internal/cmd/argus/scrape-configs/update/update_test.go @@ -0,0 +1,247 @@ +package update + +import ( + "context" + "testing" + + "github.com/stackitcloud/stackit-cli/internal/pkg/globalflags" + "github.com/stackitcloud/stackit-cli/internal/pkg/utils" + + "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" + "github.com/stackitcloud/stackit-sdk-go/services/ske" +) + +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() +var testJobName = "my-config" + +var testPayload = argus.UpdateScrapeConfigPayload{ + BasicAuth: &argus.CreateScrapeConfigPayloadBasicAuth{ + Username: utils.Ptr("username"), + Password: utils.Ptr("password"), + }, + BearerToken: utils.Ptr("bearerToken"), + HonorLabels: utils.Ptr(true), + HonorTimeStamps: utils.Ptr(true), + MetricsPath: utils.Ptr("/metrics"), + MetricsRelabelConfigs: &[]argus.CreateScrapeConfigPayloadMetricsRelabelConfigsInner{ + { + Action: utils.Ptr("replace"), + Modulus: utils.Ptr(1.0), + Regex: utils.Ptr("regex"), + Replacement: utils.Ptr("replacement"), + Separator: utils.Ptr("separator"), + SourceLabels: &[]string{"sourceLabel"}, + TargetLabel: utils.Ptr("targetLabel"), + }, + }, + Params: &map[string]interface{}{ + "key": []interface{}{string("value1"), string("value2")}, + "key2": []interface{}{}, + }, +} + +func fixtureArgValues(mods ...func(argValues []string)) []string { + argValues := []string{ + testJobName, + } + for _, mod := range mods { + mod(argValues) + } + return argValues +} + +func fixtureFlagValues(mods ...func(flagValues map[string]string)) map[string]string { + flagValues := map[string]string{ + projectIdFlag: testProjectId, + payloadFlag: `{ + + }`, + } + 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, + }, + ClusterName: testJobName, + Payload: testPayload, + } + for _, mod := range mods { + mod(model) + } + return model +} + +func fixtureRequest(mods ...func(request *argus.ApiUpdateScrapeConfigRequest)) argus.ApiUpdateScrapeConfigRequest { + request := testClient.ScrapeConfig(testCtx, testProjectId, fixtureInputModel().ClusterName) + request = request.CreateOrUpdateClusterPayload(testPayload) + 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", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(), + isValid: true, + expectedModel: fixtureInputModel(), + }, + { + description: "no values", + argValues: []string{}, + flagValues: map[string]string{}, + isValid: false, + }, + { + description: "no arg values", + argValues: []string{}, + flagValues: fixtureFlagValues(), + isValid: false, + }, + { + description: "no flag values", + argValues: fixtureArgValues(), + flagValues: map[string]string{}, + isValid: false, + }, + { + description: "project id missing", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, projectIdFlag) + }), + isValid: false, + }, + { + description: "project id invalid 1", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[projectIdFlag] = "" + }), + isValid: false, + }, + { + description: "project id invalid 2", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[projectIdFlag] = "invalid-uuid" + }), + isValid: false, + }, + { + description: "invalid json", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[payloadFlag] = "not json" + }), + isValid: false, + expectedModel: fixtureInputModel(), + }, + } + + 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, tt.argValues) + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("error parsing flags: %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 TestBuildRequest(t *testing.T) { + tests := []struct { + description string + model *inputModel + expectedRequest ske.ApiCreateOrUpdateClusterRequest + isValid bool + }{ + { + description: "base", + model: fixtureInputModel(), + expectedRequest: fixtureRequest(), + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + request := buildRequest(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/update.json b/update.json new file mode 100644 index 000000000..dd3f17b4c --- /dev/null +++ b/update.json @@ -0,0 +1,20 @@ +{ + "honorLabels": false, + "honorTimeStamps": false, + "metricsPath": "/metrics123", + "params": {}, + "sampleLimit": 5000, + "scheme": "https", + "scrapeInterval": "5m", + "scrapeTimeout": "2m", + "staticConfigs": [ + { + "labels": { + "job": "prometheus" + }, + "targets": [ + "localhost:9090" + ] + } + ] +} From 6190512ad7c7e3a54501683ec696e2610c74dce9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diogo=20Ferr=C3=A3o?= Date: Mon, 22 Apr 2024 17:42:15 +0200 Subject: [PATCH 03/12] finish implementation --- .../cmd/argus/scrape-configs/delete/delete.go | 120 --------- .../scrape-configs/delete/delete_test.go | 233 ----------------- .../cmd/argus/scrape-configs/update/update.go | 131 ---------- .../scrape-configs/update/update_test.go | 247 ------------------ 4 files changed, 731 deletions(-) delete mode 100644 internal/cmd/argus/scrape-configs/delete/delete.go delete mode 100644 internal/cmd/argus/scrape-configs/delete/delete_test.go delete mode 100644 internal/cmd/argus/scrape-configs/update/update.go delete mode 100644 internal/cmd/argus/scrape-configs/update/update_test.go diff --git a/internal/cmd/argus/scrape-configs/delete/delete.go b/internal/cmd/argus/scrape-configs/delete/delete.go deleted file mode 100644 index 605790280..000000000 --- a/internal/cmd/argus/scrape-configs/delete/delete.go +++ /dev/null @@ -1,120 +0,0 @@ -package delete - -import ( - "context" - "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/spinner" - - "github.com/spf13/cobra" - "github.com/stackitcloud/stackit-sdk-go/services/argus" - "github.com/stackitcloud/stackit-sdk-go/services/argus/wait" -) - -const ( - jobNameArg = "JOB_NAME" - - instanceIdFlag = "instance-id" -) - -type inputModel struct { - *globalflags.GlobalFlagModel - JobName string - InstanceId string -} - -func NewCmd(p *print.Printer) *cobra.Command { - cmd := &cobra.Command{ - Use: fmt.Sprintf("delete %s", jobNameArg), - Short: "Deletes an Argus Scrape Config", - Long: "Deletes an Argus Scrape Config.", - Args: args.SingleArg(jobNameArg, nil), - Example: examples.Build( - examples.NewExample( - `Delete an Argus Scrape config with name "my-config" from Argus instance "xxx"`, - "$ stackit argus scrape-configs delete my-config --instance-id xxx"), - ), - RunE: func(cmd *cobra.Command, args []string) error { - ctx := context.Background() - model, err := parseInput(cmd, args) - if err != nil { - return err - } - - // Configure API client - apiClient, err := client.ConfigureClient(p) - if err != nil { - return err - } - - if !model.AssumeYes { - prompt := fmt.Sprintf("Are you sure you want to delete Scrape Config %q? (This cannot be undone)", model.JobName) - err = p.PromptForConfirmation(prompt) - if err != nil { - return err - } - } - - // Call API - req := buildRequest(ctx, model, apiClient) - _, err = req.Execute() - if err != nil { - return fmt.Errorf("delete Scrape Config: %w", err) - } - - // Wait for async operation, if async mode not enabled - if !model.Async { - s := spinner.New(p) - s.Start("Deleting scrape config") - _, err = wait.DeleteScrapeConfigWaitHandler(ctx, apiClient, model.InstanceId, model.JobName, model.ProjectId).WaitWithContext(ctx) - if err != nil { - return fmt.Errorf("wait for Scrape Config deletion: %w", err) - } - s.Stop() - } - - operationState := "Deleted" - if model.Async { - operationState = "Triggered deletion of" - } - p.Info("%s Scrape Config %q\n", operationState, model.JobName) - return nil - }, - } - configureFlags(cmd) - return cmd -} - -func configureFlags(cmd *cobra.Command) { - cmd.Flags().Var(flags.UUIDFlag(), instanceIdFlag, "Instance ID") - - err := flags.MarkFlagsRequired(cmd, instanceIdFlag) - cobra.CheckErr(err) -} - -func parseInput(cmd *cobra.Command, inputArgs []string) (*inputModel, error) { - clusterName := inputArgs[0] - - globalFlags := globalflags.Parse(cmd) - if globalFlags.ProjectId == "" { - return nil, &errors.ProjectIdError{} - } - - return &inputModel{ - GlobalFlagModel: globalFlags, - JobName: clusterName, - InstanceId: flags.FlagToStringValue(cmd, instanceIdFlag), - }, nil -} - -func buildRequest(ctx context.Context, model *inputModel, apiClient *argus.APIClient) argus.ApiDeleteScrapeConfigRequest { - req := apiClient.DeleteScrapeConfig(ctx, model.InstanceId, model.JobName, model.ProjectId) - return req -} diff --git a/internal/cmd/argus/scrape-configs/delete/delete_test.go b/internal/cmd/argus/scrape-configs/delete/delete_test.go deleted file mode 100644 index f6f7ae5b6..000000000 --- a/internal/cmd/argus/scrape-configs/delete/delete_test.go +++ /dev/null @@ -1,233 +0,0 @@ -package delete - -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() -var testJobName = "my-config" - -func fixtureArgValues(mods ...func(argValues []string)) []string { - argValues := []string{ - testJobName, - } - for _, mod := range mods { - mod(argValues) - } - return argValues -} - -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, - }, - JobName: testJobName, - InstanceId: testInstanceId, - } - for _, mod := range mods { - mod(model) - } - return model -} - -func fixtureRequest(mods ...func(request *argus.ApiDeleteScrapeConfigRequest)) argus.ApiDeleteScrapeConfigRequest { - request := testClient.DeleteScrapeConfig(testCtx, testInstanceId, testJobName, 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", - argValues: fixtureArgValues(), - flagValues: fixtureFlagValues(), - isValid: true, - expectedModel: fixtureInputModel(), - }, - { - description: "no values", - argValues: []string{}, - flagValues: map[string]string{}, - isValid: false, - }, - { - description: "no arg values", - argValues: []string{}, - flagValues: fixtureFlagValues(), - isValid: false, - }, - { - description: "no flag values", - argValues: fixtureArgValues(), - flagValues: map[string]string{}, - isValid: false, - }, - { - description: "project id missing", - argValues: fixtureArgValues(), - flagValues: fixtureFlagValues(func(flagValues map[string]string) { - delete(flagValues, projectIdFlag) - }), - isValid: false, - }, - { - description: "project id invalid 1", - argValues: fixtureArgValues(), - flagValues: fixtureFlagValues(func(flagValues map[string]string) { - flagValues[projectIdFlag] = "" - }), - isValid: false, - }, - { - description: "project id invalid 2", - argValues: fixtureArgValues(), - flagValues: fixtureFlagValues(func(flagValues map[string]string) { - flagValues[projectIdFlag] = "invalid-uuid" - }), - isValid: false, - }, - { - description: "instance id missing", - argValues: fixtureArgValues(), - flagValues: fixtureFlagValues(func(flagValues map[string]string) { - delete(flagValues, instanceIdFlag) - }), - isValid: false, - }, - { - description: "instance id invalid 1", - argValues: fixtureArgValues(), - flagValues: fixtureFlagValues(func(flagValues map[string]string) { - flagValues[instanceIdFlag] = "" - }), - isValid: false, - }, - { - description: "instance id invalid 2", - argValues: fixtureArgValues(), - flagValues: fixtureFlagValues(func(flagValues map[string]string) { - flagValues[instanceIdFlag] = "invalid-uuid" - }), - 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, tt.argValues) - if err != nil { - if !tt.isValid { - return - } - t.Fatalf("error parsing flags: %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 TestBuildRequest(t *testing.T) { - tests := []struct { - description string - model *inputModel - isValid bool - expectedRequest argus.ApiDeleteScrapeConfigRequest - }{ - { - description: "base", - model: fixtureInputModel(), - isValid: true, - expectedRequest: fixtureRequest(), - }, - } - - for _, tt := range tests { - t.Run(tt.description, func(t *testing.T) { - request := buildRequest(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/scrape-configs/update/update.go b/internal/cmd/argus/scrape-configs/update/update.go deleted file mode 100644 index 00a128671..000000000 --- a/internal/cmd/argus/scrape-configs/update/update.go +++ /dev/null @@ -1,131 +0,0 @@ -package update - -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/spf13/cobra" - "github.com/stackitcloud/stackit-sdk-go/services/argus" -) - -const ( - jobNameArg = "JOB_NAME" - - instanceIdFlag = "instance-id" - payloadFlag = "payload" -) - -type inputModel struct { - *globalflags.GlobalFlagModel - JobName string - InstanceId string - Payload argus.UpdateScrapeConfigPayload -} - -func NewCmd(p *print.Printer) *cobra.Command { - cmd := &cobra.Command{ - Use: fmt.Sprintf("update %s", jobNameArg), - Short: "Updates a Scrape Config of an Argus instance", - Long: fmt.Sprintf("%s\n%s\n%s", - "Updates a Scrape Config of an Argus instance.", - "The payload can be provided as a JSON string or a file path prefixed with \"@\".", - "See https://docs.api.stackit.cloud/documentation/argus/version/v1#tag/scrape-config/operation/v1_projects_instances_scrapeconfigs_partial_update for information regarding the payload structure.", - ), - Args: args.SingleArg(jobNameArg, nil), - Example: examples.Build( - examples.NewExample( - `Update a Scrape Config from Argus instance "xxx", using an API payload sourced from the file "./payload.json"`, - "$ stackit argus scrape-configs update my-config --payload @./payload.json --instance-id xxx"), - examples.NewExample( - `Update an Scrape Config from Argus instance "xxx", using an API payload provided as a JSON string`, - `$ stackit argus scrape-configs update my-config --payload "{...}" --instance-id xxx`), - examples.NewExample( - `Generate a payload with the current values of a Scrape Config, and adapt it with custom values for the different configuration options`, - `$ stackit argus scrape-config generate-payload --job-name my-config > ./payload.json`, - ``, - `$ stackit argus scrape-configs update my-config --payload @./payload.json`), - ), - RunE: func(cmd *cobra.Command, args []string) error { - ctx := context.Background() - model, err := parseInput(cmd, args) - if err != nil { - return err - } - - // Configure API client - apiClient, err := client.ConfigureClient(p) - if err != nil { - return err - } - - if !model.AssumeYes { - prompt := fmt.Sprintf("Are you sure you want to update scrape config %q?", model.JobName) - err = p.PromptForConfirmation(prompt) - if err != nil { - return err - } - } - - // Call API - req := buildRequest(ctx, model, apiClient) - _, err = req.Execute() - if err != nil { - return fmt.Errorf("update scrape config: %w", err) - } - - // The API has no status to wait on, so async mode is default - operationState := "Triggered update of" - p.Info("%s Argus Scrape Config %q\n", operationState, model.JobName) - return nil - }, - } - configureFlags(cmd) - return cmd -} - -func configureFlags(cmd *cobra.Command) { - cmd.Flags().Var(flags.ReadFromFileFlag(), payloadFlag, `Request payload (JSON). Can be a string or a file path, if prefixed with "@". Example: @./payload.json`) - cmd.Flags().Var(flags.UUIDFlag(), instanceIdFlag, "Instance ID") - - err := flags.MarkFlagsRequired(cmd, instanceIdFlag, payloadFlag) - cobra.CheckErr(err) -} - -func parseInput(cmd *cobra.Command, inputArgs []string) (*inputModel, error) { - clusterName := inputArgs[0] - - globalFlags := globalflags.Parse(cmd) - if globalFlags.ProjectId == "" { - return nil, &errors.ProjectIdError{} - } - - payloadString := flags.FlagToStringValue(cmd, payloadFlag) - var payload argus.UpdateScrapeConfigPayload - err := json.Unmarshal([]byte(payloadString), &payload) - if err != nil { - return nil, fmt.Errorf("encode payload: %w", err) - } - - return &inputModel{ - GlobalFlagModel: globalFlags, - JobName: clusterName, - Payload: payload, - InstanceId: flags.FlagToStringValue(cmd, instanceIdFlag), - }, nil -} - -func buildRequest(ctx context.Context, model *inputModel, apiClient *argus.APIClient) argus.ApiUpdateScrapeConfigRequest { - req := apiClient.UpdateScrapeConfig(ctx, model.InstanceId, model.JobName, model.ProjectId) - - req = req.UpdateScrapeConfigPayload(model.Payload) - return req -} diff --git a/internal/cmd/argus/scrape-configs/update/update_test.go b/internal/cmd/argus/scrape-configs/update/update_test.go deleted file mode 100644 index 5402e5659..000000000 --- a/internal/cmd/argus/scrape-configs/update/update_test.go +++ /dev/null @@ -1,247 +0,0 @@ -package update - -import ( - "context" - "testing" - - "github.com/stackitcloud/stackit-cli/internal/pkg/globalflags" - "github.com/stackitcloud/stackit-cli/internal/pkg/utils" - - "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" - "github.com/stackitcloud/stackit-sdk-go/services/ske" -) - -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() -var testJobName = "my-config" - -var testPayload = argus.UpdateScrapeConfigPayload{ - BasicAuth: &argus.CreateScrapeConfigPayloadBasicAuth{ - Username: utils.Ptr("username"), - Password: utils.Ptr("password"), - }, - BearerToken: utils.Ptr("bearerToken"), - HonorLabels: utils.Ptr(true), - HonorTimeStamps: utils.Ptr(true), - MetricsPath: utils.Ptr("/metrics"), - MetricsRelabelConfigs: &[]argus.CreateScrapeConfigPayloadMetricsRelabelConfigsInner{ - { - Action: utils.Ptr("replace"), - Modulus: utils.Ptr(1.0), - Regex: utils.Ptr("regex"), - Replacement: utils.Ptr("replacement"), - Separator: utils.Ptr("separator"), - SourceLabels: &[]string{"sourceLabel"}, - TargetLabel: utils.Ptr("targetLabel"), - }, - }, - Params: &map[string]interface{}{ - "key": []interface{}{string("value1"), string("value2")}, - "key2": []interface{}{}, - }, -} - -func fixtureArgValues(mods ...func(argValues []string)) []string { - argValues := []string{ - testJobName, - } - for _, mod := range mods { - mod(argValues) - } - return argValues -} - -func fixtureFlagValues(mods ...func(flagValues map[string]string)) map[string]string { - flagValues := map[string]string{ - projectIdFlag: testProjectId, - payloadFlag: `{ - - }`, - } - 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, - }, - ClusterName: testJobName, - Payload: testPayload, - } - for _, mod := range mods { - mod(model) - } - return model -} - -func fixtureRequest(mods ...func(request *argus.ApiUpdateScrapeConfigRequest)) argus.ApiUpdateScrapeConfigRequest { - request := testClient.ScrapeConfig(testCtx, testProjectId, fixtureInputModel().ClusterName) - request = request.CreateOrUpdateClusterPayload(testPayload) - 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", - argValues: fixtureArgValues(), - flagValues: fixtureFlagValues(), - isValid: true, - expectedModel: fixtureInputModel(), - }, - { - description: "no values", - argValues: []string{}, - flagValues: map[string]string{}, - isValid: false, - }, - { - description: "no arg values", - argValues: []string{}, - flagValues: fixtureFlagValues(), - isValid: false, - }, - { - description: "no flag values", - argValues: fixtureArgValues(), - flagValues: map[string]string{}, - isValid: false, - }, - { - description: "project id missing", - argValues: fixtureArgValues(), - flagValues: fixtureFlagValues(func(flagValues map[string]string) { - delete(flagValues, projectIdFlag) - }), - isValid: false, - }, - { - description: "project id invalid 1", - argValues: fixtureArgValues(), - flagValues: fixtureFlagValues(func(flagValues map[string]string) { - flagValues[projectIdFlag] = "" - }), - isValid: false, - }, - { - description: "project id invalid 2", - argValues: fixtureArgValues(), - flagValues: fixtureFlagValues(func(flagValues map[string]string) { - flagValues[projectIdFlag] = "invalid-uuid" - }), - isValid: false, - }, - { - description: "invalid json", - flagValues: fixtureFlagValues(func(flagValues map[string]string) { - flagValues[payloadFlag] = "not json" - }), - isValid: false, - expectedModel: fixtureInputModel(), - }, - } - - 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, tt.argValues) - if err != nil { - if !tt.isValid { - return - } - t.Fatalf("error parsing flags: %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 TestBuildRequest(t *testing.T) { - tests := []struct { - description string - model *inputModel - expectedRequest ske.ApiCreateOrUpdateClusterRequest - isValid bool - }{ - { - description: "base", - model: fixtureInputModel(), - expectedRequest: fixtureRequest(), - }, - } - - for _, tt := range tests { - t.Run(tt.description, func(t *testing.T) { - request := buildRequest(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) - } - }) - } -} From 14c4631e00b4e3adac8a3c333d132cd5f3b479cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diogo=20Ferr=C3=A3o?= Date: Mon, 22 Apr 2024 17:54:33 +0200 Subject: [PATCH 04/12] remove json files --- update.json | 20 -------------------- 1 file changed, 20 deletions(-) delete mode 100644 update.json diff --git a/update.json b/update.json deleted file mode 100644 index dd3f17b4c..000000000 --- a/update.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "honorLabels": false, - "honorTimeStamps": false, - "metricsPath": "/metrics123", - "params": {}, - "sampleLimit": 5000, - "scheme": "https", - "scrapeInterval": "5m", - "scrapeTimeout": "2m", - "staticConfigs": [ - { - "labels": { - "job": "prometheus" - }, - "targets": [ - "localhost:9090" - ] - } - ] -} From 5c3412582849f19f854379ca862b37087ff27891 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diogo=20Ferr=C3=A3o?= Date: Mon, 22 Apr 2024 23:12:12 +0200 Subject: [PATCH 05/12] list command implementation and testing --- docs/stackit_argus_scrape-config.md | 1 + docs/stackit_argus_scrape-config_list.md | 47 ++++ internal/cmd/argus/scrape-config/list/list.go | 162 ++++++++++++++ .../cmd/argus/scrape-config/list/list_test.go | 210 ++++++++++++++++++ .../cmd/argus/scrape-config/scrape_config.go | 2 + 5 files changed, 422 insertions(+) create mode 100644 docs/stackit_argus_scrape-config_list.md create mode 100644 internal/cmd/argus/scrape-config/list/list.go create mode 100644 internal/cmd/argus/scrape-config/list/list_test.go diff --git a/docs/stackit_argus_scrape-config.md b/docs/stackit_argus_scrape-config.md index d888ab89d..b44dc1f44 100644 --- a/docs/stackit_argus_scrape-config.md +++ b/docs/stackit_argus_scrape-config.md @@ -32,5 +32,6 @@ stackit argus scrape-config [flags] * [stackit argus scrape-config create](./stackit_argus_scrape-config_create.md) - Creates a scrape configuration for an Argus instance * [stackit argus scrape-config delete](./stackit_argus_scrape-config_delete.md) - Deletes a scrape configuration from an Argus instance * [stackit argus scrape-config generate-payload](./stackit_argus_scrape-config_generate-payload.md) - Generates a payload to create/update scrape configurations for an Argus instance +* [stackit argus scrape-config list](./stackit_argus_scrape-config_list.md) - Lists all scrape configurations of an Argus instance * [stackit argus scrape-config update](./stackit_argus_scrape-config_update.md) - Updates a scrape configuration of an Argus instance diff --git a/docs/stackit_argus_scrape-config_list.md b/docs/stackit_argus_scrape-config_list.md new file mode 100644 index 000000000..10a7fd368 --- /dev/null +++ b/docs/stackit_argus_scrape-config_list.md @@ -0,0 +1,47 @@ +## stackit argus scrape-config list + +Lists all scrape configurations of an Argus instance + +### Synopsis + +Lists all scrape configurations of an Argus instance. + +``` +stackit argus scrape-config list [flags] +``` + +### Examples + +``` + List all scrape configurations of Argus instance "xxx" + $ stackit argus scrape-config list --instance-id xxx + + List all scrape configurations of Argus instance "xxx" in JSON format + $ stackit argus scrape-config list --instance-id xxx --output-format json + + List up to 10 scrape configurations of Argus instance "xxx" + $ stackit argus scrape-config list --instance-id xxx --limit 10 +``` + +### Options + +``` + -h, --help Help for "stackit argus scrape-config list" + --instance-id string Instance ID + --limit int Maximum number of entries to list +``` + +### 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 scrape-config](./stackit_argus_scrape-config.md) - Provides functionality for scrape configurations in Argus + diff --git a/internal/cmd/argus/scrape-config/list/list.go b/internal/cmd/argus/scrape-config/list/list.go new file mode 100644 index 000000000..385a20597 --- /dev/null +++ b/internal/cmd/argus/scrape-config/list/list.go @@ -0,0 +1,162 @@ +package list + +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" + + argusUtils "github.com/stackitcloud/stackit-cli/internal/pkg/services/argus/utils" + + "github.com/spf13/cobra" + "github.com/stackitcloud/stackit-sdk-go/services/argus" +) + +const ( + limitFlag = "limit" + instanceIdFlag = "instance-id" +) + +type inputModel struct { + *globalflags.GlobalFlagModel + Limit *int64 + InstanceId string +} + +func NewCmd(p *print.Printer) *cobra.Command { + cmd := &cobra.Command{ + Use: "list", + Short: "Lists all scrape configurations of an Argus instance", + Long: "Lists all scrape configurations of an Argus instance.", + Args: args.NoArgs, + Example: examples.Build( + examples.NewExample( + `List all scrape configurations of Argus instance "xxx"`, + "$ stackit argus scrape-config list --instance-id xxx"), + examples.NewExample( + `List all scrape configurations of Argus instance "xxx" in JSON format`, + "$ stackit argus scrape-config list --instance-id xxx --output-format json"), + examples.NewExample( + `List up to 10 scrape configurations of Argus instance "xxx"`, + "$ stackit argus scrape-config list --instance-id xxx --limit 10"), + ), + 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 + req := buildRequest(ctx, model, apiClient) + resp, err := req.Execute() + if err != nil { + return fmt.Errorf("get scrape configurations: %w", err) + } + configs := *resp.Data + if len(configs) == 0 { + instanceLabel, err := argusUtils.GetInstanceName(ctx, apiClient, model.InstanceId, model.ProjectId) + if err != nil { + instanceLabel = model.InstanceId + } + p.Info("No scrape configurations found for instance %q\n", instanceLabel) + return nil + } + + // Truncate output + if model.Limit != nil && len(configs) > int(*model.Limit) { + configs = configs[:*model.Limit] + } + + return outputResult(p, model.OutputFormat, configs) + }, + } + + configureFlags(cmd) + return cmd +} + +func configureFlags(cmd *cobra.Command) { + cmd.Flags().Int64(limitFlag, 0, "Maximum number of entries to list") + cmd.Flags().Var(flags.UUIDFlag(), instanceIdFlag, "Instance ID") + + 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{} + } + + limit := flags.FlagToInt64Pointer(cmd, limitFlag) + if limit != nil && *limit < 1 { + return nil, &errors.FlagValidationError{ + Flag: limitFlag, + Details: "must be greater than 0", + } + } + + return &inputModel{ + GlobalFlagModel: globalFlags, + Limit: flags.FlagToInt64Pointer(cmd, limitFlag), + InstanceId: flags.FlagToStringValue(cmd, instanceIdFlag), + }, nil +} + +func buildRequest(ctx context.Context, model *inputModel, apiClient *argus.APIClient) argus.ApiListScrapeConfigsRequest { + req := apiClient.ListScrapeConfigs(ctx, model.InstanceId, model.ProjectId) + return req +} + +func outputResult(p *print.Printer, outputFormat string, configs []argus.Job) error { + switch outputFormat { + case globalflags.JSONOutputFormat: + details, err := json.MarshalIndent(configs, "", " ") + if err != nil { + return fmt.Errorf("marshal scrape configurations list: %w", err) + } + p.Outputln(string(details)) + + return nil + default: + table := tables.NewTable() + table.SetHeader("NAME", "TARGETS", "SCRAPE INTERVAL") + for i := range configs { + c := configs[i] + + targets := 0 + if c.StaticConfigs != nil { + for _, sc := range *c.StaticConfigs { + if sc.Targets == nil { + continue + } + targets += len(*sc.Targets) + } + } + + table.AddRow(*c.JobName, targets, *c.ScrapeInterval) + } + err := table.Display(p) + if err != nil { + return fmt.Errorf("render table: %w", err) + } + + return nil + } +} diff --git a/internal/cmd/argus/scrape-config/list/list_test.go b/internal/cmd/argus/scrape-config/list/list_test.go new file mode 100644 index 000000000..9a5952a32 --- /dev/null +++ b/internal/cmd/argus/scrape-config/list/list_test.go @@ -0,0 +1,210 @@ +package list + +import ( + "context" + "testing" + + "github.com/stackitcloud/stackit-cli/internal/pkg/globalflags" + "github.com/stackitcloud/stackit-cli/internal/pkg/utils" + + "github.com/google/go-cmp/cmp" + "github.com/google/go-cmp/cmp/cmpopts" + "github.com/google/uuid" + "github.com/spf13/cobra" + "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, + limitFlag: "10", + 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, + }, + Limit: utils.Ptr(int64(10)), + InstanceId: testInstanceId, + } + for _, mod := range mods { + mod(model) + } + return model +} + +func fixtureRequest(mods ...func(request *argus.ApiListScrapeConfigsRequest)) argus.ApiListScrapeConfigsRequest { + request := testClient.ListScrapeConfigs(testCtx, testInstanceId, testProjectId) + for _, mod := range mods { + mod(&request) + } + return request +} + +func TestParseInput(t *testing.T) { + tests := []struct { + description string + flagValues map[string]string + isValid bool + expectedModel *inputModel + }{ + { + description: "base", + flagValues: fixtureFlagValues(), + isValid: true, + expectedModel: fixtureInputModel(), + }, + { + description: "no 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: "limit invalid", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[limitFlag] = "invalid" + }), + isValid: false, + }, + { + description: "limit invalid 2", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[limitFlag] = "0" + }), + isValid: false, + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + cmd := &cobra.Command{} + err := globalflags.Configure(cmd.Flags()) + if err != nil { + t.Fatalf("configure global flags: %v", err) + } + + configureFlags(cmd) + + 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.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 flags: %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 TestBuildRequest(t *testing.T) { + tests := []struct { + description string + model *inputModel + expectedRequest argus.ApiListScrapeConfigsRequest + }{ + { + description: "base", + model: fixtureInputModel(), + expectedRequest: fixtureRequest(), + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + request := buildRequest(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/scrape-config/scrape_config.go b/internal/cmd/argus/scrape-config/scrape_config.go index aab92fa9e..740388691 100644 --- a/internal/cmd/argus/scrape-config/scrape_config.go +++ b/internal/cmd/argus/scrape-config/scrape_config.go @@ -4,6 +4,7 @@ import ( "github.com/stackitcloud/stackit-cli/internal/cmd/argus/scrape-config/create" "github.com/stackitcloud/stackit-cli/internal/cmd/argus/scrape-config/delete" generatepayload "github.com/stackitcloud/stackit-cli/internal/cmd/argus/scrape-config/generate-payload" + "github.com/stackitcloud/stackit-cli/internal/cmd/argus/scrape-config/list" "github.com/stackitcloud/stackit-cli/internal/cmd/argus/scrape-config/update" "github.com/stackitcloud/stackit-cli/internal/pkg/args" "github.com/stackitcloud/stackit-cli/internal/pkg/print" @@ -29,4 +30,5 @@ func addSubcommands(cmd *cobra.Command, p *print.Printer) { cmd.AddCommand(create.NewCmd(p)) cmd.AddCommand(delete.NewCmd(p)) cmd.AddCommand(update.NewCmd(p)) + cmd.AddCommand(list.NewCmd(p)) } From 7700f74be50359d71a891e061e023d1dcd27531f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diogo=20Ferr=C3=A3o?= Date: Mon, 22 Apr 2024 23:42:24 +0200 Subject: [PATCH 06/12] describe command implementation and testing --- docs/stackit_argus_scrape-config.md | 1 + docs/stackit_argus_scrape-config_describe.md | 43 ++++ .../argus/scrape-config/describe/describe.go | 148 +++++++++++ .../scrape-config/describe/describe_test.go | 233 ++++++++++++++++++ .../cmd/argus/scrape-config/scrape_config.go | 2 + 5 files changed, 427 insertions(+) create mode 100644 docs/stackit_argus_scrape-config_describe.md create mode 100644 internal/cmd/argus/scrape-config/describe/describe.go create mode 100644 internal/cmd/argus/scrape-config/describe/describe_test.go diff --git a/docs/stackit_argus_scrape-config.md b/docs/stackit_argus_scrape-config.md index b44dc1f44..a04d07494 100644 --- a/docs/stackit_argus_scrape-config.md +++ b/docs/stackit_argus_scrape-config.md @@ -31,6 +31,7 @@ stackit argus scrape-config [flags] * [stackit argus](./stackit_argus.md) - Provides functionality for Argus * [stackit argus scrape-config create](./stackit_argus_scrape-config_create.md) - Creates a scrape configuration for an Argus instance * [stackit argus scrape-config delete](./stackit_argus_scrape-config_delete.md) - Deletes a scrape configuration from an Argus instance +* [stackit argus scrape-config describe](./stackit_argus_scrape-config_describe.md) - Shows details of a scrape configuration from an Argus instance * [stackit argus scrape-config generate-payload](./stackit_argus_scrape-config_generate-payload.md) - Generates a payload to create/update scrape configurations for an Argus instance * [stackit argus scrape-config list](./stackit_argus_scrape-config_list.md) - Lists all scrape configurations of an Argus instance * [stackit argus scrape-config update](./stackit_argus_scrape-config_update.md) - Updates a scrape configuration of an Argus instance diff --git a/docs/stackit_argus_scrape-config_describe.md b/docs/stackit_argus_scrape-config_describe.md new file mode 100644 index 000000000..567b14e85 --- /dev/null +++ b/docs/stackit_argus_scrape-config_describe.md @@ -0,0 +1,43 @@ +## stackit argus scrape-config describe + +Shows details of a scrape configuration from an Argus instance + +### Synopsis + +Shows details of a scrape configuration from an Argus instance. + +``` +stackit argus scrape-config describe JOB_NAME [flags] +``` + +### Examples + +``` + Get details of a scrape configuration with name "my-config" from Argus instance "xxx" + $ stackit argus scrape-config describe my-config --instance-id xxx + + Get details of a scrape configuration with name "my-config" from Argus instance "xxx" in a table format + $ stackit argus scrape-config describe my-config --output-format pretty +``` + +### Options + +``` + -h, --help Help for "stackit argus scrape-config describe" + --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 scrape-config](./stackit_argus_scrape-config.md) - Provides functionality for scrape configurations in Argus + diff --git a/internal/cmd/argus/scrape-config/describe/describe.go b/internal/cmd/argus/scrape-config/describe/describe.go new file mode 100644 index 000000000..b06270dda --- /dev/null +++ b/internal/cmd/argus/scrape-config/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/stackitcloud/stackit-sdk-go/services/argus" + + "github.com/spf13/cobra" +) + +const ( + jobNameArg = "JOB_NAME" + + instanceIdFlag = "instance-id" +) + +type inputModel struct { + *globalflags.GlobalFlagModel + JobName string + InstanceId string +} + +func NewCmd(p *print.Printer) *cobra.Command { + cmd := &cobra.Command{ + Use: fmt.Sprintf("describe %s", jobNameArg), + Short: "Shows details of a scrape configuration from an Argus instance", + Long: "Shows details of a scrape configuration from an Argus instance.", + Args: args.SingleArg(jobNameArg, nil), + Example: examples.Build( + examples.NewExample( + `Get details of a scrape configuration with name "my-config" from Argus instance "xxx"`, + "$ stackit argus scrape-config describe my-config --instance-id xxx"), + examples.NewExample( + `Get details of a scrape configuration with name "my-config" from Argus instance "xxx" in a table format`, + "$ stackit argus scrape-config describe my-config --output-format pretty"), + ), + RunE: func(cmd *cobra.Command, args []string) error { + ctx := context.Background() + model, err := parseInput(cmd, args) + if err != nil { + return err + } + // Configure API client + apiClient, err := client.ConfigureClient(p) + if err != nil { + return err + } + + // Call API + req := buildRequest(ctx, model, apiClient) + resp, err := req.Execute() + if err != nil { + return fmt.Errorf("read scrape configuration: %w", err) + } + + return outputResult(p, model.OutputFormat, resp.Data) + }, + } + configureFlags(cmd) + return cmd +} + +func configureFlags(cmd *cobra.Command) { + cmd.Flags().Var(flags.UUIDFlag(), instanceIdFlag, "Instance ID") + + err := flags.MarkFlagsRequired(cmd, instanceIdFlag) + cobra.CheckErr(err) +} + +func parseInput(cmd *cobra.Command, inputArgs []string) (*inputModel, error) { + jobName := inputArgs[0] + + globalFlags := globalflags.Parse(cmd) + if globalFlags.ProjectId == "" { + return nil, &errors.ProjectIdError{} + } + + return &inputModel{ + GlobalFlagModel: globalFlags, + JobName: jobName, + InstanceId: flags.FlagToStringValue(cmd, instanceIdFlag), + }, nil +} + +func buildRequest(ctx context.Context, model *inputModel, apiClient *argus.APIClient) argus.ApiGetScrapeConfigRequest { + req := apiClient.GetScrapeConfig(ctx, model.InstanceId, model.JobName, model.ProjectId) + return req +} + +func outputResult(p *print.Printer, outputFormat string, config *argus.Job) error { + switch outputFormat { + case globalflags.PrettyOutputFormat: + + saml2 := (*config.Params)["saml2"] + saml2Enabled := "Enabled" + if len(saml2) > 0 && saml2[0] == "disabled" { + saml2Enabled = "Disabled" + } + + table := tables.NewTable() + table.AddRow("NAME", *config.JobName) + table.AddSeparator() + table.AddRow("METRICS PATH", *config.MetricsPath) + table.AddSeparator() + table.AddRow("SCHEME", *config.Scheme) + table.AddSeparator() + table.AddRow("SCRAPE INTERVAL", *config.ScrapeInterval) + table.AddSeparator() + table.AddRow("SCRAPE TIMEOUT", *config.ScrapeTimeout) + table.AddSeparator() + table.AddRow("SAML2", saml2Enabled) + table.AddSeparator() + if config.BasicAuth == nil { + table.AddRow("AUTHENTICATION", "None") + } else { + table.AddRow("AUTHENTICATION", "Basic Auth") + table.AddSeparator() + table.AddRow("USERNAME", *config.BasicAuth.Username) + table.AddSeparator() + table.AddRow("PASSWORD", *config.BasicAuth.Password) + } + + err := table.Display(p) + if err != nil { + return fmt.Errorf("render table: %w", err) + } + + return nil + default: + details, err := json.MarshalIndent(config, "", " ") + if err != nil { + return fmt.Errorf("marshal scrape configuration: %w", err) + } + p.Outputln(string(details)) + + return nil + } +} diff --git a/internal/cmd/argus/scrape-config/describe/describe_test.go b/internal/cmd/argus/scrape-config/describe/describe_test.go new file mode 100644 index 000000000..ab2217f3e --- /dev/null +++ b/internal/cmd/argus/scrape-config/describe/describe_test.go @@ -0,0 +1,233 @@ +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() +var testJobName = "my-config" + +func fixtureArgValues(mods ...func(argValues []string)) []string { + argValues := []string{ + testJobName, + } + for _, mod := range mods { + mod(argValues) + } + return argValues +} + +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, + }, + JobName: testJobName, + InstanceId: testInstanceId, + } + for _, mod := range mods { + mod(model) + } + return model +} + +func fixtureRequest(mods ...func(request *argus.ApiGetScrapeConfigRequest)) argus.ApiGetScrapeConfigRequest { + request := testClient.GetScrapeConfig(testCtx, testInstanceId, testJobName, 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", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(), + isValid: true, + expectedModel: fixtureInputModel(), + }, + { + description: "no values", + argValues: []string{}, + flagValues: map[string]string{}, + isValid: false, + }, + { + description: "no arg values", + argValues: []string{}, + flagValues: fixtureFlagValues(), + isValid: false, + }, + { + description: "no flag values", + argValues: fixtureArgValues(), + flagValues: map[string]string{}, + isValid: false, + }, + { + description: "project id missing", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, projectIdFlag) + }), + isValid: false, + }, + { + description: "project id invalid 1", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[projectIdFlag] = "" + }), + isValid: false, + }, + { + description: "project id invalid 2", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[projectIdFlag] = "invalid-uuid" + }), + isValid: false, + }, + { + description: "instance id missing", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, instanceIdFlag) + }), + isValid: false, + }, + { + description: "instance id invalid 1", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[instanceIdFlag] = "" + }), + isValid: false, + }, + { + description: "instance id invalid 2", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[instanceIdFlag] = "invalid-uuid" + }), + 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, tt.argValues) + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("error parsing flags: %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 TestBuildRequest(t *testing.T) { + tests := []struct { + description string + model *inputModel + isValid bool + expectedRequest argus.ApiGetScrapeConfigRequest + }{ + { + description: "base", + model: fixtureInputModel(), + isValid: true, + expectedRequest: fixtureRequest(), + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + request := buildRequest(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/scrape-config/scrape_config.go b/internal/cmd/argus/scrape-config/scrape_config.go index 740388691..781569aa9 100644 --- a/internal/cmd/argus/scrape-config/scrape_config.go +++ b/internal/cmd/argus/scrape-config/scrape_config.go @@ -3,6 +3,7 @@ package scrapeconfig import ( "github.com/stackitcloud/stackit-cli/internal/cmd/argus/scrape-config/create" "github.com/stackitcloud/stackit-cli/internal/cmd/argus/scrape-config/delete" + "github.com/stackitcloud/stackit-cli/internal/cmd/argus/scrape-config/describe" generatepayload "github.com/stackitcloud/stackit-cli/internal/cmd/argus/scrape-config/generate-payload" "github.com/stackitcloud/stackit-cli/internal/cmd/argus/scrape-config/list" "github.com/stackitcloud/stackit-cli/internal/cmd/argus/scrape-config/update" @@ -31,4 +32,5 @@ func addSubcommands(cmd *cobra.Command, p *print.Printer) { cmd.AddCommand(delete.NewCmd(p)) cmd.AddCommand(update.NewCmd(p)) cmd.AddCommand(list.NewCmd(p)) + cmd.AddCommand(describe.NewCmd(p)) } From e197945f85211e909f7baa4b8b6f6392b9a3ed46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diogo=20Ferr=C3=A3o?= Date: Tue, 23 Apr 2024 09:49:42 +0200 Subject: [PATCH 07/12] verify pointer before dereference --- internal/cmd/argus/scrape-config/describe/describe.go | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/internal/cmd/argus/scrape-config/describe/describe.go b/internal/cmd/argus/scrape-config/describe/describe.go index b06270dda..4f7170603 100644 --- a/internal/cmd/argus/scrape-config/describe/describe.go +++ b/internal/cmd/argus/scrape-config/describe/describe.go @@ -101,10 +101,13 @@ func outputResult(p *print.Printer, outputFormat string, config *argus.Job) erro switch outputFormat { case globalflags.PrettyOutputFormat: - saml2 := (*config.Params)["saml2"] saml2Enabled := "Enabled" - if len(saml2) > 0 && saml2[0] == "disabled" { - saml2Enabled = "Disabled" + + if config.Params != nil { + saml2 := (*config.Params)["saml2"] + if len(saml2) > 0 && saml2[0] == "disabled" { + saml2Enabled = "Disabled" + } } table := tables.NewTable() From 661fcc91b3423c7b5ece47b81c46a50fb9684c23 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diogo=20Ferr=C3=A3o?= Date: Tue, 23 Apr 2024 09:57:17 +0200 Subject: [PATCH 08/12] add config name to confirmation prompt in create cmd --- internal/cmd/argus/scrape-config/create/create.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/cmd/argus/scrape-config/create/create.go b/internal/cmd/argus/scrape-config/create/create.go index 4eeda25d9..329d59e1a 100644 --- a/internal/cmd/argus/scrape-config/create/create.go +++ b/internal/cmd/argus/scrape-config/create/create.go @@ -77,7 +77,7 @@ func NewCmd(p *print.Printer) *cobra.Command { } if !model.AssumeYes { - prompt := fmt.Sprintf("Are you sure you want to create a scrape configuration on Argus instance %q?", instanceLabel) + prompt := fmt.Sprintf("Are you sure you want to create scrape configuration %q on Argus instance %q?", *model.Payload.JobName, instanceLabel) err = p.PromptForConfirmation(prompt) if err != nil { return err From ee523f0621e9b918d48e1c85db88f88918474934 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diogo=20Ferr=C3=A3o?= Date: Tue, 23 Apr 2024 11:27:44 +0200 Subject: [PATCH 09/12] generate docs --- docs/stackit_argus_scrape-configs_delete.md | 40 --------------------- 1 file changed, 40 deletions(-) delete mode 100644 docs/stackit_argus_scrape-configs_delete.md diff --git a/docs/stackit_argus_scrape-configs_delete.md b/docs/stackit_argus_scrape-configs_delete.md deleted file mode 100644 index 5886abbde..000000000 --- a/docs/stackit_argus_scrape-configs_delete.md +++ /dev/null @@ -1,40 +0,0 @@ -## stackit argus scrape-configs delete - -Deletes an Argus Scrape Config - -### Synopsis - -Deletes an Argus Scrape Config. - -``` -stackit argus scrape-configs delete JOB_NAME [flags] -``` - -### Examples - -``` - Delete an Argus Scrape config with name "my-config" from Argus instance "xxx" - $ stackit argus scrape-configs delete my-config --instance-id xxx -``` - -### Options - -``` - -h, --help Help for "stackit argus scrape-configs delete" - --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 scrape-configs](./stackit_argus_scrape-configs.md) - Provides functionality for scrape configs in Argus. - From 34f67dd726c659eb98186f0968bc14c9b6eab63c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diogo=20Ferr=C3=A3o?= Date: Tue, 23 Apr 2024 12:17:27 +0200 Subject: [PATCH 10/12] improve describe output --- .../argus/scrape-config/describe/describe.go | 32 ++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/internal/cmd/argus/scrape-config/describe/describe.go b/internal/cmd/argus/scrape-config/describe/describe.go index 4f7170603..6c0c8ad96 100644 --- a/internal/cmd/argus/scrape-config/describe/describe.go +++ b/internal/cmd/argus/scrape-config/describe/describe.go @@ -102,7 +102,6 @@ func outputResult(p *print.Printer, outputFormat string, config *argus.Job) erro case globalflags.PrettyOutputFormat: saml2Enabled := "Enabled" - if config.Params != nil { saml2 := (*config.Params)["saml2"] if len(saml2) > 0 && saml2[0] == "disabled" { @@ -110,6 +109,32 @@ func outputResult(p *print.Printer, outputFormat string, config *argus.Job) erro } } + targets := []string{} + for _, target := range *config.StaticConfigs { + targetFmt := "" + if target.Labels != nil { + // make map prettier + for k, v := range *target.Labels { + if targetFmt != "" { + targetFmt += " " + } else { + targetFmt += "labels: [" + } + targetFmt += fmt.Sprintf("%s:%s", k, v) + } + if targetFmt != "" { + targetFmt += "]" + } + } + if target.Targets != nil { + if targetFmt != "" { + targetFmt += "; " + } + targetFmt += fmt.Sprintf("urls: %v", *target.Targets) + } + targets = append(targets, targetFmt) + } + table := tables.NewTable() table.AddRow("NAME", *config.JobName) table.AddSeparator() @@ -132,6 +157,11 @@ func outputResult(p *print.Printer, outputFormat string, config *argus.Job) erro table.AddSeparator() table.AddRow("PASSWORD", *config.BasicAuth.Password) } + table.AddSeparator() + for i, target := range targets { + table.AddRow(fmt.Sprintf("TARGET %d", i+1), target) + table.AddSeparator() + } err := table.Display(p) if err != nil { From f4ee43739f2a8646384494e1e33012a4f852ad70 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diogo=20Ferr=C3=A3o?= Date: Tue, 23 Apr 2024 13:55:01 +0200 Subject: [PATCH 11/12] improve describe output --- .../argus/scrape-config/describe/describe.go | 25 ++++++++----------- 1 file changed, 10 insertions(+), 15 deletions(-) diff --git a/internal/cmd/argus/scrape-config/describe/describe.go b/internal/cmd/argus/scrape-config/describe/describe.go index 6c0c8ad96..7fa0dfa0b 100644 --- a/internal/cmd/argus/scrape-config/describe/describe.go +++ b/internal/cmd/argus/scrape-config/describe/describe.go @@ -4,6 +4,7 @@ import ( "context" "encoding/json" "fmt" + "strings" "github.com/stackitcloud/stackit-cli/internal/pkg/args" "github.com/stackitcloud/stackit-cli/internal/pkg/errors" @@ -109,30 +110,24 @@ func outputResult(p *print.Printer, outputFormat string, config *argus.Job) erro } } - targets := []string{} + var targets []string for _, target := range *config.StaticConfigs { - targetFmt := "" + targetLabels := []string{} + targetLabelStr := "N/A" if target.Labels != nil { // make map prettier for k, v := range *target.Labels { - if targetFmt != "" { - targetFmt += " " - } else { - targetFmt += "labels: [" - } - targetFmt += fmt.Sprintf("%s:%s", k, v) + targetLabels = append(targetLabels, fmt.Sprintf("%s:%s", k, v)) } - if targetFmt != "" { - targetFmt += "]" + if targetLabels != nil { + targetLabelStr = strings.Join(targetLabels, ",") } } + targetUrlsStr := "N/A" if target.Targets != nil { - if targetFmt != "" { - targetFmt += "; " - } - targetFmt += fmt.Sprintf("urls: %v", *target.Targets) + targetUrlsStr = strings.Join(*target.Targets, ",") } - targets = append(targets, targetFmt) + targets = append(targets, fmt.Sprintf("labels: %s\nurls: %s", targetLabelStr, targetUrlsStr)) } table := tables.NewTable() From 965dd612352bc33975ee5d69f9ee14ad88d5be47 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diogo=20Ferr=C3=A3o?= Date: Tue, 23 Apr 2024 14:46:52 +0200 Subject: [PATCH 12/12] address PR comments --- internal/cmd/argus/scrape-config/describe/describe.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/cmd/argus/scrape-config/describe/describe.go b/internal/cmd/argus/scrape-config/describe/describe.go index 7fa0dfa0b..9d9af74cf 100644 --- a/internal/cmd/argus/scrape-config/describe/describe.go +++ b/internal/cmd/argus/scrape-config/describe/describe.go @@ -154,7 +154,7 @@ func outputResult(p *print.Printer, outputFormat string, config *argus.Job) erro } table.AddSeparator() for i, target := range targets { - table.AddRow(fmt.Sprintf("TARGET %d", i+1), target) + table.AddRow(fmt.Sprintf("TARGET #%d", i+1), target) table.AddSeparator() }