diff --git a/docs/stackit_observability.md b/docs/stackit_observability.md index e8f0912de..97d104747 100644 --- a/docs/stackit_observability.md +++ b/docs/stackit_observability.md @@ -30,6 +30,7 @@ stackit observability [flags] ### SEE ALSO * [stackit](./stackit.md) - Manage STACKIT resources using the command line +* [stackit observability acl](./stackit_observability_acl.md) - Provides functionality for ACLs of Observability instances * [stackit observability credentials](./stackit_observability_credentials.md) - Provides functionality for Observability credentials * [stackit observability grafana](./stackit_observability_grafana.md) - Provides functionality for the Grafana configuration of Observability instances * [stackit observability instance](./stackit_observability_instance.md) - Provides functionality for Observability instances diff --git a/docs/stackit_observability_acl.md b/docs/stackit_observability_acl.md new file mode 100644 index 000000000..9b0ed9eb5 --- /dev/null +++ b/docs/stackit_observability_acl.md @@ -0,0 +1,35 @@ +## stackit observability acl + +Provides functionality for ACLs of Observability instances + +### Synopsis + +Provides functionality for access control lists (ACLs) of Observability instances. + +``` +stackit observability acl [flags] +``` + +### Options + +``` + -h, --help Help for "stackit observability acl" +``` + +### 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, none, yaml]) + -p, --project-id string Project ID + --region string Target region for region-specific requests + --verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info") +``` + +### SEE ALSO + +* [stackit observability](./stackit_observability.md) - Provides functionality for Observability +* [stackit observability acl list](./stackit_observability_acl_list.md) - Lists all ACLs of an Observability instance +* [stackit observability acl update](./stackit_observability_acl_update.md) - Updates the ACLs of an Observability instance + diff --git a/docs/stackit_observability_acl_list.md b/docs/stackit_observability_acl_list.md new file mode 100644 index 000000000..45f8ab60e --- /dev/null +++ b/docs/stackit_observability_acl_list.md @@ -0,0 +1,48 @@ +## stackit observability acl list + +Lists all ACLs of an Observability instance + +### Synopsis + +Lists all IP networks in CIDR notation which are allowed to access an Observability instance. + +``` +stackit observability acl list [flags] +``` + +### Examples + +``` + List all ACLs of Observability instance "xxx" + $ stackit observability acl list --instance-id xxx + + List all ACLs of Observability instance "xxx" in JSON format + $ stackit observability acl list --instance-id xxx --output-format json + + List up to 10 ACLs of Observability instance "xxx" + $ stackit observability acl list --instance-id xxx --limit 10 +``` + +### Options + +``` + -h, --help Help for "stackit observability acl 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, none, yaml]) + -p, --project-id string Project ID + --region string Target region for region-specific requests + --verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info") +``` + +### SEE ALSO + +* [stackit observability acl](./stackit_observability_acl.md) - Provides functionality for ACLs of Observability instances + diff --git a/docs/stackit_observability_acl_update.md b/docs/stackit_observability_acl_update.md new file mode 100644 index 000000000..f8a213ce2 --- /dev/null +++ b/docs/stackit_observability_acl_update.md @@ -0,0 +1,45 @@ +## stackit observability acl update + +Updates the ACLs of an Observability instance + +### Synopsis + +Updates the ACLs of an Observability instance. + +``` +stackit observability acl update [flags] +``` + +### Examples + +``` + Set the ACLs of Observability instance "xxx" to the IP networks "1.2.3.0/24" and "5.6.7.8/32" + $ stackit observability acl update --instance-id xxx --acl 1.2.3.0/24,5.6.7.8/32 + + Remove all ACLs of Observability instance "xxx" + $ stackit observability acl update --instance-id xxx --acl "" +``` + +### Options + +``` + --acl strings List of IP networks in CIDR notation which are allowed to access the instance. Replaces all existing ACLs, an empty value removes all ACLs (default []) + -h, --help Help for "stackit observability acl update" + --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, none, yaml]) + -p, --project-id string Project ID + --region string Target region for region-specific requests + --verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info") +``` + +### SEE ALSO + +* [stackit observability acl](./stackit_observability_acl.md) - Provides functionality for ACLs of Observability instances + diff --git a/internal/cmd/observability/acl/acl.go b/internal/cmd/observability/acl/acl.go new file mode 100644 index 000000000..376ba0f54 --- /dev/null +++ b/internal/cmd/observability/acl/acl.go @@ -0,0 +1,28 @@ +package acl + +import ( + "github.com/stackitcloud/stackit-cli/internal/cmd/observability/acl/list" + "github.com/stackitcloud/stackit-cli/internal/cmd/observability/acl/update" + "github.com/stackitcloud/stackit-cli/internal/pkg/args" + "github.com/stackitcloud/stackit-cli/internal/pkg/types" + "github.com/stackitcloud/stackit-cli/internal/pkg/utils" + + "github.com/spf13/cobra" +) + +func NewCmd(params *types.CmdParams) *cobra.Command { + cmd := &cobra.Command{ + Use: "acl", + Short: "Provides functionality for ACLs of Observability instances", + Long: "Provides functionality for access control lists (ACLs) of Observability instances.", + Args: args.NoArgs, + Run: utils.CmdHelp, + } + addSubcommands(cmd, params) + return cmd +} + +func addSubcommands(cmd *cobra.Command, params *types.CmdParams) { + cmd.AddCommand(list.NewCmd(params)) + cmd.AddCommand(update.NewCmd(params)) +} diff --git a/internal/cmd/observability/acl/list/list.go b/internal/cmd/observability/acl/list/list.go new file mode 100644 index 000000000..8e4d72b12 --- /dev/null +++ b/internal/cmd/observability/acl/list/list.go @@ -0,0 +1,148 @@ +package list + +import ( + "context" + "fmt" + + "github.com/stackitcloud/stackit-cli/internal/pkg/types" + + "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/observability/client" + "github.com/stackitcloud/stackit-cli/internal/pkg/tables" + + observabilityUtils "github.com/stackitcloud/stackit-cli/internal/pkg/services/observability/utils" + + "github.com/spf13/cobra" + observability "github.com/stackitcloud/stackit-sdk-go/services/observability/v1api" +) + +const ( + limitFlag = "limit" + instanceIdFlag = "instance-id" +) + +type inputModel struct { + *globalflags.GlobalFlagModel + Limit *int64 + InstanceId string +} + +func NewCmd(params *types.CmdParams) *cobra.Command { + cmd := &cobra.Command{ + Use: "list", + Short: "Lists all ACLs of an Observability instance", + Long: "Lists all IP networks in CIDR notation which are allowed to access an Observability instance.", + Args: args.NoArgs, + Example: examples.Build( + examples.NewExample( + `List all ACLs of Observability instance "xxx"`, + "$ stackit observability acl list --instance-id xxx"), + examples.NewExample( + `List all ACLs of Observability instance "xxx" in JSON format`, + "$ stackit observability acl list --instance-id xxx --output-format json"), + examples.NewExample( + `List up to 10 ACLs of Observability instance "xxx"`, + "$ stackit observability acl list --instance-id xxx --limit 10"), + ), + RunE: func(cmd *cobra.Command, args []string) error { + ctx := context.Background() + model, err := parseInput(params.Printer, cmd, args) + if err != nil { + return err + } + + // Configure API client + apiClient, err := client.ConfigureClient(params.Printer, params.CliVersion) + if err != nil { + return err + } + + // Call API + req := buildRequest(ctx, model, apiClient.DefaultAPI) + resp, err := req.Execute() + if err != nil { + return fmt.Errorf("get Observability instance ACLs: %w", err) + } + + acls := resp.GetAcl() + + instanceLabel, err := observabilityUtils.GetInstanceName(ctx, apiClient.DefaultAPI, model.InstanceId, model.ProjectId) + if err != nil || instanceLabel == "" { + params.Printer.Debug(print.ErrorLevel, "get instance name: %v", err) + instanceLabel = model.InstanceId + } + + // Truncate output + if model.Limit != nil && len(acls) > int(*model.Limit) { + acls = acls[:*model.Limit] + } + + return outputResult(params.Printer, model.OutputFormat, instanceLabel, acls) + }, + } + + 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(p *print.Printer, cmd *cobra.Command, _ []string) (*inputModel, error) { + globalFlags := globalflags.Parse(p, cmd) + if globalFlags.ProjectId == "" { + return nil, &errors.ProjectIdError{} + } + + limit := flags.FlagToInt64Pointer(p, cmd, limitFlag) + if limit != nil && *limit < 1 { + return nil, &errors.FlagValidationError{ + Flag: limitFlag, + Details: "must be greater than 0", + } + } + + model := inputModel{ + GlobalFlagModel: globalFlags, + Limit: limit, + InstanceId: flags.FlagToStringValue(p, cmd, instanceIdFlag), + } + + p.DebugInputModel(model) + return &model, nil +} + +func buildRequest(ctx context.Context, model *inputModel, apiClient observability.DefaultAPI) observability.ApiListACLRequest { + req := apiClient.ListACL(ctx, model.InstanceId, model.ProjectId) + return req +} + +func outputResult(p *print.Printer, outputFormat, instanceLabel string, acls []string) error { + return p.OutputResult(outputFormat, acls, func() error { + if len(acls) == 0 { + p.Outputf("No ACLs found for instance %q\n", instanceLabel) + return nil + } + table := tables.NewTable() + table.SetHeader("CIDR") + for _, acl := range acls { + table.AddRow(acl) + } + err := table.Display(p) + if err != nil { + return fmt.Errorf("render table: %w", err) + } + + return nil + }) +} diff --git a/internal/cmd/observability/acl/list/list_test.go b/internal/cmd/observability/acl/list/list_test.go new file mode 100644 index 000000000..50688658c --- /dev/null +++ b/internal/cmd/observability/acl/list/list_test.go @@ -0,0 +1,233 @@ +package list + +import ( + "context" + "testing" + + "github.com/stackitcloud/stackit-cli/internal/pkg/testparams" + "github.com/stackitcloud/stackit-cli/internal/pkg/testutils" + + "github.com/stackitcloud/stackit-cli/internal/pkg/globalflags" + "github.com/stackitcloud/stackit-cli/internal/pkg/print" + "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" + observability "github.com/stackitcloud/stackit-sdk-go/services/observability/v1api" +) + +var projectIdFlag = globalflags.ProjectIdFlag + +type testCtxKey struct{} + +var testCtx = context.WithValue(context.Background(), testCtxKey{}, "foo") +var testClient = &observability.APIClient{DefaultAPI: &observability.DefaultAPIService{}} +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 *observability.ApiListACLRequest)) observability.ApiListACLRequest { + request := testClient.DefaultAPI.ListACL(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: "no limit", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, limitFlag) + }), + isValid: true, + expectedModel: fixtureInputModel(func(model *inputModel) { + model.Limit = nil + }), + }, + { + 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) { + testutils.TestParseInput(t, NewCmd, parseInput, tt.expectedModel, tt.argValues, tt.flagValues, tt.isValid) + }) + } +} + +func TestBuildRequest(t *testing.T) { + tests := []struct { + description string + model *inputModel + expectedRequest observability.ApiListACLRequest + }{ + { + description: "base", + model: fixtureInputModel(), + expectedRequest: fixtureRequest(), + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + request := buildRequest(testCtx, tt.model, testClient.DefaultAPI) + + diff := cmp.Diff(request, tt.expectedRequest, + cmp.AllowUnexported(tt.expectedRequest, observability.DefaultAPIService{}), + cmpopts.EquateComparable(testCtx), + ) + if diff != "" { + t.Fatalf("Data does not match: %s", diff) + } + }) + } +} + +func TestOutputResult(t *testing.T) { + type args struct { + outputFormat string + instanceLabel string + acls []string + } + tests := []struct { + name string + args args + wantErr bool + }{ + { + name: "empty", + args: args{}, + wantErr: false, + }, + { + name: "empty acls slice", + args: args{ + acls: []string{}, + }, + wantErr: false, + }, + { + name: "multiple acls", + args: args{ + acls: []string{"1.2.3.0/24", "5.6.7.8/32"}, + }, + wantErr: false, + }, + { + name: "multiple acls json output", + args: args{ + outputFormat: print.JSONOutputFormat, + acls: []string{"1.2.3.0/24", "5.6.7.8/32"}, + }, + wantErr: false, + }, + } + params := testparams.NewTestParams() + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if err := outputResult(params.Printer, tt.args.outputFormat, tt.args.instanceLabel, tt.args.acls); (err != nil) != tt.wantErr { + t.Errorf("outputResult() error = %v, wantErr %v", err, tt.wantErr) + } + }) + } +} diff --git a/internal/cmd/observability/acl/update/update.go b/internal/cmd/observability/acl/update/update.go new file mode 100644 index 000000000..232510219 --- /dev/null +++ b/internal/cmd/observability/acl/update/update.go @@ -0,0 +1,123 @@ +package update + +import ( + "context" + "fmt" + + "github.com/stackitcloud/stackit-cli/internal/pkg/types" + + "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/observability/client" + observabilityUtils "github.com/stackitcloud/stackit-cli/internal/pkg/services/observability/utils" + + "github.com/spf13/cobra" + observability "github.com/stackitcloud/stackit-sdk-go/services/observability/v1api" +) + +const ( + instanceIdFlag = "instance-id" + aclFlag = "acl" +) + +type inputModel struct { + *globalflags.GlobalFlagModel + InstanceId string + Acls []string +} + +func NewCmd(params *types.CmdParams) *cobra.Command { + cmd := &cobra.Command{ + Use: "update", + Short: "Updates the ACLs of an Observability instance", + Long: "Updates the ACLs of an Observability instance.", + Args: args.NoArgs, + Example: examples.Build( + examples.NewExample( + `Set the ACLs of Observability instance "xxx" to the IP networks "1.2.3.0/24" and "5.6.7.8/32"`, + "$ stackit observability acl update --instance-id xxx --acl 1.2.3.0/24,5.6.7.8/32"), + examples.NewExample( + `Remove all ACLs of Observability instance "xxx"`, + `$ stackit observability acl update --instance-id xxx --acl ""`), + ), + RunE: func(cmd *cobra.Command, args []string) error { + ctx := context.Background() + model, err := parseInput(params.Printer, cmd, args) + if err != nil { + return err + } + + // Configure API client + apiClient, err := client.ConfigureClient(params.Printer, params.CliVersion) + if err != nil { + return err + } + + instanceLabel, err := observabilityUtils.GetInstanceName(ctx, apiClient.DefaultAPI, model.InstanceId, model.ProjectId) + if err != nil || instanceLabel == "" { + params.Printer.Debug(print.ErrorLevel, "get instance name: %v", err) + instanceLabel = model.InstanceId + } + + prompt := fmt.Sprintf("Are you sure you want to replace the ACLs of Observability instance %q?", instanceLabel) + err = params.Printer.PromptForConfirmation(prompt) + if err != nil { + return err + } + + // Call API + req := buildRequest(ctx, model, apiClient.DefaultAPI) + _, err = req.Execute() + if err != nil { + return fmt.Errorf("update Observability instance ACLs: %w", err) + } + + params.Printer.Info("Updated ACLs of Observability instance %q\n", instanceLabel) + return nil + }, + } + configureFlags(cmd) + return cmd +} + +func configureFlags(cmd *cobra.Command) { + cmd.Flags().Var(flags.UUIDFlag(), instanceIdFlag, "Instance ID") + cmd.Flags().Var(flags.CIDRSliceFlag(), aclFlag, "List of IP networks in CIDR notation which are allowed to access the instance. Replaces all existing ACLs, an empty value removes all ACLs") + + err := flags.MarkFlagsRequired(cmd, instanceIdFlag, aclFlag) + cobra.CheckErr(err) +} + +func parseInput(p *print.Printer, cmd *cobra.Command, _ []string) (*inputModel, error) { + globalFlags := globalflags.Parse(p, cmd) + if globalFlags.ProjectId == "" { + return nil, &errors.ProjectIdError{} + } + + acls := flags.FlagToStringSliceValue(p, cmd, aclFlag) + if acls == nil { + // An empty --acl value is explicitly allowed to remove all ACLs + acls = []string{} + } + + model := inputModel{ + GlobalFlagModel: globalFlags, + InstanceId: flags.FlagToStringValue(p, cmd, instanceIdFlag), + Acls: acls, + } + + p.DebugInputModel(model) + return &model, nil +} + +func buildRequest(ctx context.Context, model *inputModel, apiClient observability.DefaultAPI) observability.ApiUpdateACLRequest { + req := apiClient.UpdateACL(ctx, model.InstanceId, model.ProjectId) + req = req.UpdateACLPayload(observability.UpdateACLPayload{ + Acl: model.Acls, + }) + return req +} diff --git a/internal/cmd/observability/acl/update/update_test.go b/internal/cmd/observability/acl/update/update_test.go new file mode 100644 index 000000000..7ed1aaeb6 --- /dev/null +++ b/internal/cmd/observability/acl/update/update_test.go @@ -0,0 +1,229 @@ +package update + +import ( + "context" + "testing" + + "github.com/stackitcloud/stackit-cli/internal/pkg/globalflags" + "github.com/stackitcloud/stackit-cli/internal/pkg/testutils" + + "github.com/google/go-cmp/cmp" + "github.com/google/go-cmp/cmp/cmpopts" + "github.com/google/uuid" + observability "github.com/stackitcloud/stackit-sdk-go/services/observability/v1api" +) + +var projectIdFlag = globalflags.ProjectIdFlag + +type testCtxKey struct{} + +var testCtx = context.WithValue(context.Background(), testCtxKey{}, "foo") +var testClient = &observability.APIClient{DefaultAPI: &observability.DefaultAPIService{}} +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, + aclFlag: "198.51.100.14/24", + } + 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, + Acls: []string{"198.51.100.14/24"}, + } + for _, mod := range mods { + mod(model) + } + return model +} + +func fixtureRequest(mods ...func(request *observability.ApiUpdateACLRequest)) observability.ApiUpdateACLRequest { + request := testClient.DefaultAPI.UpdateACL(testCtx, testInstanceId, testProjectId) + request = request.UpdateACLPayload(observability.UpdateACLPayload{ + Acl: []string{"198.51.100.14/24"}, + }) + for _, mod := range mods { + mod(&request) + } + return request +} + +func TestParseInput(t *testing.T) { + tests := []struct { + description string + argValues []string + flagValues map[string]string + aclValues []string + isValid bool + expectedModel *inputModel + }{ + { + description: "base", + flagValues: fixtureFlagValues(), + isValid: true, + expectedModel: fixtureInputModel(), + }, + { + description: "multiple acls", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[aclFlag] = "198.51.100.14/24,1.2.3.4/32" + }), + isValid: true, + expectedModel: fixtureInputModel(func(model *inputModel) { + model.Acls = []string{"198.51.100.14/24", "1.2.3.4/32"} + }), + }, + { + description: "repeated acl flags", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, aclFlag) + }), + aclValues: []string{"198.51.100.14/24", "1.2.3.4/32"}, + isValid: true, + expectedModel: fixtureInputModel(func(model *inputModel) { + model.Acls = []string{"198.51.100.14/24", "1.2.3.4/32"} + }), + }, + { + description: "empty acl removes all acls", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[aclFlag] = "" + }), + isValid: true, + expectedModel: fixtureInputModel(func(model *inputModel) { + model.Acls = []string{} + }), + }, + { + description: "acl missing", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, aclFlag) + }), + isValid: false, + }, + { + description: "acl invalid", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[aclFlag] = "invalid-cidr" + }), + isValid: false, + }, + { + 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, + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + testutils.TestParseInputWithAdditionalFlags(t, NewCmd, parseInput, tt.expectedModel, tt.argValues, tt.flagValues, map[string][]string{ + aclFlag: tt.aclValues, + }, tt.isValid) + }) + } +} + +func TestBuildRequest(t *testing.T) { + tests := []struct { + description string + model *inputModel + expectedRequest observability.ApiUpdateACLRequest + }{ + { + description: "base", + model: fixtureInputModel(), + expectedRequest: fixtureRequest(), + }, + { + description: "multiple acls", + model: fixtureInputModel(func(model *inputModel) { + model.Acls = []string{"198.51.100.14/24", "1.2.3.4/32"} + }), + expectedRequest: fixtureRequest(func(request *observability.ApiUpdateACLRequest) { + *request = request.UpdateACLPayload(observability.UpdateACLPayload{ + Acl: []string{"198.51.100.14/24", "1.2.3.4/32"}, + }) + }), + }, + { + description: "empty acls", + model: fixtureInputModel(func(model *inputModel) { + model.Acls = []string{} + }), + expectedRequest: fixtureRequest(func(request *observability.ApiUpdateACLRequest) { + *request = request.UpdateACLPayload(observability.UpdateACLPayload{ + Acl: []string{}, + }) + }), + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + request := buildRequest(testCtx, tt.model, testClient.DefaultAPI) + + diff := cmp.Diff(request, tt.expectedRequest, + cmp.AllowUnexported(tt.expectedRequest, observability.DefaultAPIService{}), + cmpopts.EquateComparable(testCtx), + ) + if diff != "" { + t.Fatalf("Data does not match: %s", diff) + } + }) + } +} diff --git a/internal/cmd/observability/observability.go b/internal/cmd/observability/observability.go index 66345691a..1e6ac887f 100644 --- a/internal/cmd/observability/observability.go +++ b/internal/cmd/observability/observability.go @@ -1,6 +1,7 @@ package observability import ( + "github.com/stackitcloud/stackit-cli/internal/cmd/observability/acl" "github.com/stackitcloud/stackit-cli/internal/cmd/observability/credentials" "github.com/stackitcloud/stackit-cli/internal/cmd/observability/grafana" "github.com/stackitcloud/stackit-cli/internal/cmd/observability/instance" @@ -31,4 +32,5 @@ func addSubcommands(cmd *cobra.Command, params *types.CmdParams) { cmd.AddCommand(credentials.NewCmd(params)) cmd.AddCommand(scrapeconfig.NewCmd(params)) cmd.AddCommand(plans.NewCmd(params)) + cmd.AddCommand(acl.NewCmd(params)) }