diff --git a/docs/stackit_load-balancer.md b/docs/stackit_load-balancer.md index bd709799c..c9727e1b6 100644 --- a/docs/stackit_load-balancer.md +++ b/docs/stackit_load-balancer.md @@ -29,8 +29,10 @@ stackit load-balancer [flags] ### SEE ALSO * [stackit](./stackit.md) - Manage STACKIT resources using the command line +* [stackit load-balancer create](./stackit_load-balancer_create.md) - Creates a Load Balancer * [stackit load-balancer describe](./stackit_load-balancer_describe.md) - Shows details of a Load Balancer * [stackit load-balancer generate-payload](./stackit_load-balancer_generate-payload.md) - Generates a payload to create/update a Load Balancer * [stackit load-balancer list](./stackit_load-balancer_list.md) - Lists all Load Balancers * [stackit load-balancer quota](./stackit_load-balancer_quota.md) - Shows the configured Load Balancer quota +* [stackit load-balancer update](./stackit_load-balancer_update.md) - Updates a Load Balancer diff --git a/docs/stackit_load-balancer_create.md b/docs/stackit_load-balancer_create.md new file mode 100644 index 000000000..b685dd6e7 --- /dev/null +++ b/docs/stackit_load-balancer_create.md @@ -0,0 +1,50 @@ +## stackit load-balancer create + +Creates a Load Balancer + +### Synopsis + +Creates a Load Balancer. +The payload can be provided as a JSON string or a file path prefixed with "@". +See https://docs.api.stackit.cloud/documentation/load-balancer/version/v1#tag/Load-Balancer/operation/APIService_CreateLoadBalancer for information regarding the payload structure. + +``` +stackit load-balancer create [flags] +``` + +### Examples + +``` + Create a load balancer using an API payload sourced from the file "./payload.json" + $ stackit load-balancer create --payload @./payload.json + + Create a load balancer using an API payload provided as a JSON string + $ stackit load-balancer create --payload "{...}" + + Generate a payload with default values, and adapt it with custom values for the different configuration options + $ stackit load-balancer generate-payload > ./payload.json + + $ stackit load-balancer create --payload @./payload.json +``` + +### Options + +``` + -h, --help Help for "stackit load-balancer create" + --payload string Request payload (JSON). Can be a string or a file path, if prefixed with "@" (example: @./payload.json). +``` + +### 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"] + -p, --project-id string Project ID + --verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info") +``` + +### SEE ALSO + +* [stackit load-balancer](./stackit_load-balancer.md) - Provides functionality for Load Balancer + diff --git a/docs/stackit_load-balancer_generate-payload.md b/docs/stackit_load-balancer_generate-payload.md index eedcdd5ba..f01579eca 100644 --- a/docs/stackit_load-balancer_generate-payload.md +++ b/docs/stackit_load-balancer_generate-payload.md @@ -20,16 +20,16 @@ stackit load-balancer generate-payload [flags] $ stackit load-balancer create --payload @./payload.json Generate a payload with values of an existing load balancer, and adapt it with custom values for the different configuration options - $ stackit load-balancer generate-payload --instance-name my-lb > ./payload.json + $ stackit load-balancer generate-payload --lb-name xxx > ./payload.json - $ stackit load-balancer update my-lb --payload @./payload.json + $ stackit load-balancer update xxx --payload @./payload.json ``` ### Options ``` - -h, --help Help for "stackit load-balancer generate-payload" - -n, --instance-name string If set, generates the payload with the current values of the given load balancer. If unset, generates the payload with empty values + -h, --help Help for "stackit load-balancer generate-payload" + -n, --lb-name string If set, generates the payload with the current values of the given load balancer. If unset, generates the payload with empty values ``` ### Options inherited from parent commands diff --git a/docs/stackit_load-balancer_update.md b/docs/stackit_load-balancer_update.md new file mode 100644 index 000000000..b5fa0f334 --- /dev/null +++ b/docs/stackit_load-balancer_update.md @@ -0,0 +1,50 @@ +## stackit load-balancer update + +Updates a Load Balancer + +### Synopsis + +Updates a load balancer. +The payload can be provided as a JSON string or a file path prefixed with "@". +See https://docs.api.stackit.cloud/documentation/load-balancer/version/v1#tag/Load-Balancer/operation/APIService_UpdateLoadBalancer for information regarding the payload structure. + +``` +stackit load-balancer update LOAD_BALANCER_NAME [flags] +``` + +### Examples + +``` + Update a load balancer with name "xxx", using an API payload sourced from the file "./payload.json" + $ stackit load-balancer update xxx --payload @./payload.json + + Update a load balancer with name "xxx", using an API payload provided as a JSON string + $ stackit load-balancer update xxx --payload "{...}" + + Generate a payload with the current values of an existing load balancer xxx, and adapt it with custom values for the different configuration options + $ stackit load-balancer generate-payload --instance-name xxx > ./payload.json + + $ stackit load-balancer update xxx --payload @./payload.json +``` + +### Options + +``` + -h, --help Help for "stackit load-balancer update" + --payload string Request payload (JSON). Can be a string or a file path, if prefixed with "@". Example: @./payload.json +``` + +### 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"] + -p, --project-id string Project ID + --verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info") +``` + +### SEE ALSO + +* [stackit load-balancer](./stackit_load-balancer.md) - Provides functionality for Load Balancer + diff --git a/internal/cmd/load-balancer/create/create.go b/internal/cmd/load-balancer/create/create.go new file mode 100644 index 000000000..324948fff --- /dev/null +++ b/internal/cmd/load-balancer/create/create.go @@ -0,0 +1,164 @@ +package create + +import ( + "context" + "encoding/json" + "fmt" + + "github.com/google/uuid" + + "github.com/stackitcloud/stackit-cli/internal/pkg/projectname" + "github.com/stackitcloud/stackit-sdk-go/services/loadbalancer" + + "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/load-balancer/client" + "github.com/stackitcloud/stackit-cli/internal/pkg/spinner" + + "github.com/spf13/cobra" + "github.com/stackitcloud/stackit-sdk-go/services/loadbalancer/wait" +) + +const ( + payloadFlag = "payload" +) + +type inputModel struct { + *globalflags.GlobalFlagModel + Payload *loadbalancer.CreateLoadBalancerPayload +} + +var ( + xRequestId = uuid.NewString() +) + +func NewCmd(p *print.Printer) *cobra.Command { + cmd := &cobra.Command{ + Use: "create", + Short: "Creates a Load Balancer", + Long: fmt.Sprintf("%s\n%s\n%s", + "Creates a Load Balancer.", + "The payload can be provided as a JSON string or a file path prefixed with \"@\".", + "See https://docs.api.stackit.cloud/documentation/load-balancer/version/v1#tag/Load-Balancer/operation/APIService_CreateLoadBalancer for information regarding the payload structure.", + ), + Args: args.NoArgs, + Example: examples.Build( + examples.NewExample( + `Create a load balancer using an API payload sourced from the file "./payload.json"`, + "$ stackit load-balancer create --payload @./payload.json"), + examples.NewExample( + `Create a load balancer using an API payload provided as a JSON string`, + `$ stackit load-balancer create --payload "{...}"`), + examples.NewExample( + `Generate a payload with default values, and adapt it with custom values for the different configuration options`, + `$ stackit load-balancer generate-payload > ./payload.json`, + ``, + `$ stackit load-balancer create --payload @./payload.json`), + ), + RunE: func(cmd *cobra.Command, args []string) error { + ctx := context.Background() + model, err := parseInput(p, cmd) + if err != nil { + return err + } + + // Configure API client + apiClient, err := client.ConfigureClient(p) + if err != nil { + return err + } + + projectLabel, err := projectname.GetProjectName(ctx, p, cmd) + if err != nil { + p.Debug(print.ErrorLevel, "get project name: %v", err) + projectLabel = model.ProjectId + } + + if !model.AssumeYes { + prompt := fmt.Sprintf("Are you sure you want to create a load balancer for project %q?", projectLabel) + 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("create load balancer: %w", err) + } + + // Wait for async operation, if async mode not enabled + if !model.Async { + s := spinner.New(p) + s.Start("Creating load balancer") + _, err = wait.CreateLoadBalancerWaitHandler(ctx, apiClient, model.ProjectId, *model.Payload.Name).WaitWithContext(ctx) + if err != nil { + return fmt.Errorf("wait for load balancer creation: %w", err) + } + s.Stop() + } + + operationState := "Created" + if model.Async { + operationState = "Triggered creation of" + } + p.Outputf("%s load balancer with name %q \n", operationState, *model.Payload.Name) + 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).`) + + err := flags.MarkFlagsRequired(cmd, payloadFlag) + cobra.CheckErr(err) +} + +func parseInput(p *print.Printer, cmd *cobra.Command) (*inputModel, error) { + globalFlags := globalflags.Parse(p, cmd) + if globalFlags.ProjectId == "" { + return nil, &errors.ProjectIdError{} + } + + payloadValue := flags.FlagToStringPointer(p, cmd, payloadFlag) + var payload *loadbalancer.CreateLoadBalancerPayload + if payloadValue != nil { + payload = &loadbalancer.CreateLoadBalancerPayload{} + err := json.Unmarshal([]byte(*payloadValue), payload) + if err != nil { + return nil, fmt.Errorf("encode payload: %w", err) + } + } + + model := inputModel{ + GlobalFlagModel: globalFlags, + Payload: payload, + } + + if p.IsVerbosityDebug() { + modelStr, err := print.BuildDebugStrFromInputModel(model) + if err != nil { + p.Debug(print.ErrorLevel, "convert model to string for debugging: %v", err) + } else { + p.Debug(print.DebugLevel, "parsed input values: %s", modelStr) + } + } + + return &model, nil +} + +func buildRequest(ctx context.Context, model *inputModel, apiClient *loadbalancer.APIClient) loadbalancer.ApiCreateLoadBalancerRequest { + req := apiClient.CreateLoadBalancer(ctx, model.ProjectId) + req = req.CreateLoadBalancerPayload(*model.Payload) + req = req.XRequestID(xRequestId) + return req +} diff --git a/internal/cmd/load-balancer/create/create_test.go b/internal/cmd/load-balancer/create/create_test.go new file mode 100644 index 000000000..09dae8cc1 --- /dev/null +++ b/internal/cmd/load-balancer/create/create_test.go @@ -0,0 +1,354 @@ +package create + +import ( + "context" + "testing" + + "github.com/stackitcloud/stackit-sdk-go/services/loadbalancer" + + "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" +) + +var projectIdFlag = globalflags.ProjectIdFlag + +type testCtxKey struct{} + +var testCtx = context.WithValue(context.Background(), testCtxKey{}, "foo") +var testClient = &loadbalancer.APIClient{} +var testProjectId = uuid.NewString() +var testRequestId = xRequestId + +var testPayload = &loadbalancer.CreateLoadBalancerPayload{ + ExternalAddress: utils.Ptr(""), + + Listeners: &[]loadbalancer.Listener{ + { + DisplayName: utils.Ptr(""), + Port: utils.Ptr(int64(0)), + Protocol: utils.Ptr(""), + ServerNameIndicators: &[]loadbalancer.ServerNameIndicator{ + { + Name: utils.Ptr(""), + }, + }, + TargetPool: utils.Ptr(""), + Tcp: &loadbalancer.OptionsTCP{ + IdleTimeout: utils.Ptr(""), + }, + Udp: &loadbalancer.OptionsUDP{ + IdleTimeout: utils.Ptr(""), + }, + }, + }, + Name: utils.Ptr(""), + Networks: &[]loadbalancer.Network{ + { + NetworkId: utils.Ptr(""), + Role: utils.Ptr(""), + }, + }, + Options: &loadbalancer.LoadBalancerOptions{ + AccessControl: &loadbalancer.LoadbalancerOptionAccessControl{ + AllowedSourceRanges: &[]string{ + "", + }, + }, + EphemeralAddress: utils.Ptr(false), + Observability: &loadbalancer.LoadbalancerOptionObservability{ + Logs: &loadbalancer.LoadbalancerOptionLogs{ + CredentialsRef: utils.Ptr(""), + PushUrl: utils.Ptr(""), + }, + Metrics: &loadbalancer.LoadbalancerOptionMetrics{ + CredentialsRef: utils.Ptr(""), + PushUrl: utils.Ptr(""), + }, + }, + PrivateNetworkOnly: utils.Ptr(false), + }, + TargetPools: &[]loadbalancer.TargetPool{ + { + ActiveHealthCheck: &loadbalancer.ActiveHealthCheck{ + HealthyThreshold: utils.Ptr(int64(0)), + Interval: utils.Ptr(""), + IntervalJitter: utils.Ptr(""), + Timeout: utils.Ptr(""), + UnhealthyThreshold: utils.Ptr(int64(0)), + }, + Name: utils.Ptr(""), + SessionPersistence: &loadbalancer.SessionPersistence{ + UseSourceIpAddress: utils.Ptr(false), + }, + TargetPort: utils.Ptr(int64(0)), + Targets: &[]loadbalancer.Target{ + { + DisplayName: utils.Ptr(""), + Ip: utils.Ptr(""), + }, + }, + }, + }, +} + +func fixtureFlagValues(mods ...func(flagValues map[string]string)) map[string]string { + flagValues := map[string]string{ + projectIdFlag: testProjectId, + payloadFlag: `{ + "externalAddress": "", + "listeners": [ + { + "displayName": "", + "port": 0, + "protocol": "", + "serverNameIndicators": [ + { + "name": "" + } + ], + "targetPool": "", + "tcp": { + "idleTimeout": "" + }, + "udp": { + "idleTimeout": "" + } + } + ], + "name": "", + "networks": [ + { + "networkId": "", + "role": "" + } + ], + "options": { + "accessControl": { + "allowedSourceRanges": [ + "" + ] + }, + "ephemeralAddress": false, + "observability": { + "logs": { + "credentialsRef": "", + "pushUrl": "" + }, + "metrics": { + "credentialsRef": "", + "pushUrl": "" + } + }, + "privateNetworkOnly": false + }, + "targetPools": [ + { + "activeHealthCheck": { + "healthyThreshold": 0, + "interval": "", + "intervalJitter": "", + "timeout": "", + "unhealthyThreshold": 0 + }, + "name": "", + "sessionPersistence": { + "useSourceIpAddress": false + }, + "targetPort": 0, + "targets": [ + { + "displayName": "", + "ip": "" + } + ] + } + ] +}`, + } + 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, + }, + Payload: testPayload, + } + for _, mod := range mods { + mod(model) + } + return model +} + +func fixtureRequest(mods ...func(request *loadbalancer.ApiCreateLoadBalancerRequest)) loadbalancer.ApiCreateLoadBalancerRequest { + request := testClient.CreateLoadBalancer(testCtx, testProjectId) + request = request.CreateLoadBalancerPayload(*testPayload) + request = request.XRequestID(testRequestId) + 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: "no flag values", + flagValues: map[string]string{}, + isValid: false, + }, + { + description: "project id missing", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, projectIdFlag) + }), + isValid: false, + }, + { + description: "project id invalid 1", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[projectIdFlag] = "" + }), + isValid: false, + }, + { + description: "project id invalid 2", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[projectIdFlag] = "invalid-uuid" + }), + isValid: false, + }, + { + description: "payload is missing", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, payloadFlag) + }), + isValid: false, + }, + { + description: "payload is empty", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[payloadFlag] = "" + }), + 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) { + p := print.NewPrinter() + cmd := NewCmd(p) + 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.ValidateRequiredFlags() + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("error validating flags: %v", err) + } + + err = cmd.ValidateFlagGroups() + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("error validating flags: %v", err) + } + + model, err := parseInput(p, 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, + cmpopts.EquateComparable(testCtx), + ) + if diff != "" { + t.Fatalf("Data does not match: %s", diff) + } + }) + } +} + +func TestBuildRequest(t *testing.T) { + tests := []struct { + description string + model *inputModel + expectedRequest loadbalancer.ApiCreateLoadBalancerRequest + 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/internal/cmd/load-balancer/generate-payload/generate_payload.go b/internal/cmd/load-balancer/generate-payload/generate_payload.go index 9d1ebb9fd..6275ba819 100644 --- a/internal/cmd/load-balancer/generate-payload/generate_payload.go +++ b/internal/cmd/load-balancer/generate-payload/generate_payload.go @@ -19,18 +19,17 @@ import ( ) const ( - instanceNameFlag = "instance-name" + loadBalancerNameFlag = "lb-name" ) type inputModel struct { *globalflags.GlobalFlagModel - InstanceName *string + LoadBalancerName *string } var ( defaultPayloadListener = &loadbalancer.Listener{ DisplayName: utils.Ptr(""), - Name: utils.Ptr(""), Port: utils.Ptr(int64(0)), Protocol: utils.Ptr(""), ServerNameIndicators: &[]loadbalancer.ServerNameIndicator{ @@ -101,7 +100,6 @@ var ( }, PrivateNetworkOnly: utils.Ptr(false), }, - PrivateAddress: utils.Ptr(""), TargetPools: &[]loadbalancer.TargetPool{ *defaultPayloadTargetPool, }, @@ -125,9 +123,9 @@ func NewCmd(p *print.Printer) *cobra.Command { `$ stackit load-balancer create --payload @./payload.json`), examples.NewExample( `Generate a payload with values of an existing load balancer, and adapt it with custom values for the different configuration options`, - `$ stackit load-balancer generate-payload --instance-name my-lb > ./payload.json`, + `$ stackit load-balancer generate-payload --lb-name xxx > ./payload.json`, ``, - `$ stackit load-balancer update my-lb --payload @./payload.json`), + `$ stackit load-balancer update xxx --payload @./payload.json`), ), RunE: func(cmd *cobra.Command, args []string) error { ctx := context.Background() @@ -142,7 +140,7 @@ func NewCmd(p *print.Printer) *cobra.Command { return err } - if model.InstanceName == nil { + if model.LoadBalancerName == nil { createPayload := DefaultCreateLoadBalancerPayload return outputCreateResult(p, &createPayload) } @@ -152,13 +150,15 @@ func NewCmd(p *print.Printer) *cobra.Command { if err != nil { return fmt.Errorf("read load balancer: %w", err) } + + listeners := modifyListener(resp) + updatePayload := &loadbalancer.UpdateLoadBalancerPayload{ ExternalAddress: resp.ExternalAddress, - Listeners: resp.Listeners, + Listeners: listeners, Name: resp.Name, Networks: resp.Networks, Options: resp.Options, - PrivateAddress: resp.PrivateAddress, TargetPools: resp.TargetPools, Version: resp.Version, } @@ -170,26 +170,37 @@ func NewCmd(p *print.Printer) *cobra.Command { } func configureFlags(cmd *cobra.Command) { - cmd.Flags().StringP(instanceNameFlag, "n", "", "If set, generates the payload with the current values of the given load balancer. If unset, generates the payload with empty values") + cmd.Flags().StringP(loadBalancerNameFlag, "n", "", "If set, generates the payload with the current values of the given load balancer. If unset, generates the payload with empty values") } func parseInput(p *print.Printer, cmd *cobra.Command) (*inputModel, error) { globalFlags := globalflags.Parse(p, cmd) - instanceName := flags.FlagToStringPointer(p, cmd, instanceNameFlag) - // If instanceName is provided, projectId is needed as well - if instanceName != nil && globalFlags.ProjectId == "" { + loadBalancerName := flags.FlagToStringPointer(p, cmd, loadBalancerNameFlag) + // If load balancer name is provided, projectId is needed as well + if loadBalancerName != nil && globalFlags.ProjectId == "" { return nil, &errors.ProjectIdError{} } - return &inputModel{ - GlobalFlagModel: globalFlags, - InstanceName: instanceName, - }, nil + model := inputModel{ + GlobalFlagModel: globalFlags, + LoadBalancerName: loadBalancerName, + } + + if p.IsVerbosityDebug() { + modelStr, err := print.BuildDebugStrFromInputModel(model) + if err != nil { + p.Debug(print.ErrorLevel, "convert model to string for debugging: %v", err) + } else { + p.Debug(print.DebugLevel, "parsed input values: %s", modelStr) + } + } + + return &model, nil } func buildRequest(ctx context.Context, model *inputModel, apiClient *loadbalancer.APIClient) loadbalancer.ApiGetLoadBalancerRequest { - req := apiClient.GetLoadBalancer(ctx, model.ProjectId, *model.InstanceName) + req := apiClient.GetLoadBalancer(ctx, model.ProjectId, *model.LoadBalancerName) return req } @@ -212,3 +223,13 @@ func outputUpdateResult(p *print.Printer, payload *loadbalancer.UpdateLoadBalanc return nil } + +func modifyListener(resp *loadbalancer.LoadBalancer) *[]loadbalancer.Listener { + listeners := *resp.Listeners + + for i := range listeners { + listeners[i].Name = nil + } + + return &listeners +} diff --git a/internal/cmd/load-balancer/generate-payload/generate_payload_test.go b/internal/cmd/load-balancer/generate-payload/generate_payload_test.go index 8f7b8459b..a1661d545 100644 --- a/internal/cmd/load-balancer/generate-payload/generate_payload_test.go +++ b/internal/cmd/load-balancer/generate-payload/generate_payload_test.go @@ -5,6 +5,7 @@ import ( "testing" "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" @@ -24,8 +25,8 @@ var testProjectId = uuid.NewString() func fixtureFlagValues(mods ...func(flagValues map[string]string)) map[string]string { flagValues := map[string]string{ - projectIdFlag: testProjectId, - instanceNameFlag: "example-name", + projectIdFlag: testProjectId, + loadBalancerNameFlag: "example-name", } for _, mod := range mods { mod(flagValues) @@ -39,7 +40,7 @@ func fixtureInputModel(mods ...func(model *inputModel)) *inputModel { ProjectId: testProjectId, Verbosity: globalflags.VerbosityDefault, }, - InstanceName: utils.Ptr("example-name"), + LoadBalancerName: utils.Ptr("example-name"), } for _, mod := range mods { mod(model) @@ -79,11 +80,11 @@ func TestParseInput(t *testing.T) { { description: "name missing", flagValues: fixtureFlagValues(func(flagValues map[string]string) { - delete(flagValues, instanceNameFlag) + delete(flagValues, loadBalancerNameFlag) }), isValid: true, expectedModel: fixtureInputModel(func(model *inputModel) { - model.InstanceName = nil + model.LoadBalancerName = nil }), }, { @@ -111,7 +112,8 @@ func TestParseInput(t *testing.T) { for _, tt := range tests { t.Run(tt.description, func(t *testing.T) { - cmd := NewCmd(nil) + p := print.NewPrinter() + cmd := NewCmd(p) err := globalflags.Configure(cmd.Flags()) if err != nil { t.Fatalf("configure global flags: %v", err) @@ -143,7 +145,7 @@ func TestParseInput(t *testing.T) { t.Fatalf("error validating flags: %v", err) } - model, err := parseInput(nil, cmd) + model, err := parseInput(p, cmd) if err != nil { if !tt.isValid { return @@ -190,3 +192,104 @@ func TestBuildRequest(t *testing.T) { }) } } + +func TestModifyListeners(t *testing.T) { + tests := []struct { + description string + response *loadbalancer.LoadBalancer + expected *[]loadbalancer.Listener + }{ + { + description: "base", + response: &loadbalancer.LoadBalancer{ + Listeners: &[]loadbalancer.Listener{ + { + DisplayName: utils.Ptr(""), + Port: utils.Ptr(int64(0)), + Protocol: utils.Ptr(""), + Name: utils.Ptr(""), + ServerNameIndicators: &[]loadbalancer.ServerNameIndicator{ + { + Name: utils.Ptr(""), + }, + }, + TargetPool: utils.Ptr(""), + Tcp: &loadbalancer.OptionsTCP{ + IdleTimeout: utils.Ptr(""), + }, + Udp: &loadbalancer.OptionsUDP{ + IdleTimeout: utils.Ptr(""), + }, + }, + { + DisplayName: utils.Ptr(""), + Port: utils.Ptr(int64(0)), + Protocol: utils.Ptr(""), + Name: utils.Ptr(""), + ServerNameIndicators: &[]loadbalancer.ServerNameIndicator{ + { + Name: utils.Ptr(""), + }, + }, + TargetPool: utils.Ptr(""), + Tcp: &loadbalancer.OptionsTCP{ + IdleTimeout: utils.Ptr(""), + }, + Udp: &loadbalancer.OptionsUDP{ + IdleTimeout: utils.Ptr(""), + }, + }, + }, + }, + expected: &[]loadbalancer.Listener{ + { + DisplayName: utils.Ptr(""), + Port: utils.Ptr(int64(0)), + Protocol: utils.Ptr(""), + Name: nil, + ServerNameIndicators: &[]loadbalancer.ServerNameIndicator{ + { + Name: utils.Ptr(""), + }, + }, + TargetPool: utils.Ptr(""), + Tcp: &loadbalancer.OptionsTCP{ + IdleTimeout: utils.Ptr(""), + }, + Udp: &loadbalancer.OptionsUDP{ + IdleTimeout: utils.Ptr(""), + }, + }, + { + DisplayName: utils.Ptr(""), + Port: utils.Ptr(int64(0)), + Protocol: utils.Ptr(""), + Name: nil, + ServerNameIndicators: &[]loadbalancer.ServerNameIndicator{ + { + Name: utils.Ptr(""), + }, + }, + TargetPool: utils.Ptr(""), + Tcp: &loadbalancer.OptionsTCP{ + IdleTimeout: utils.Ptr(""), + }, + Udp: &loadbalancer.OptionsUDP{ + IdleTimeout: utils.Ptr(""), + }, + }, + }, + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + output := modifyListener(tt.response) + + diff := cmp.Diff(output, tt.expected) + if diff != "" { + t.Errorf("expected output to be %+v, got %+v", tt.expected, output) + } + }) + } +} diff --git a/internal/cmd/load-balancer/load_balancer.go b/internal/cmd/load-balancer/load_balancer.go index 5d2165537..ed7f2f809 100644 --- a/internal/cmd/load-balancer/load_balancer.go +++ b/internal/cmd/load-balancer/load_balancer.go @@ -1,11 +1,13 @@ package loadbalancer import ( + "github.com/stackitcloud/stackit-cli/internal/cmd/load-balancer/create" "github.com/stackitcloud/stackit-cli/internal/cmd/load-balancer/delete" "github.com/stackitcloud/stackit-cli/internal/cmd/load-balancer/describe" generatepayload "github.com/stackitcloud/stackit-cli/internal/cmd/load-balancer/generate-payload" "github.com/stackitcloud/stackit-cli/internal/cmd/load-balancer/list" "github.com/stackitcloud/stackit-cli/internal/cmd/load-balancer/quota" + "github.com/stackitcloud/stackit-cli/internal/cmd/load-balancer/update" "github.com/stackitcloud/stackit-cli/internal/pkg/args" "github.com/stackitcloud/stackit-cli/internal/pkg/print" @@ -33,4 +35,6 @@ func addSubcommands(cmd *cobra.Command, p *print.Printer) { cmd.AddCommand(list.NewCmd(p)) cmd.AddCommand(quota.NewCmd(p)) cmd.AddCommand(generatepayload.NewCmd(p)) + cmd.AddCommand(create.NewCmd(p)) + cmd.AddCommand(update.NewCmd(p)) } diff --git a/internal/cmd/load-balancer/update/update.go b/internal/cmd/load-balancer/update/update.go new file mode 100644 index 000000000..d1fa791c9 --- /dev/null +++ b/internal/cmd/load-balancer/update/update.go @@ -0,0 +1,136 @@ +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/load-balancer/client" + + "github.com/spf13/cobra" + "github.com/stackitcloud/stackit-sdk-go/services/loadbalancer" +) + +const ( + loadBalancerNameArg = "LOAD_BALANCER_NAME" + payloadFlag = "payload" +) + +type inputModel struct { + *globalflags.GlobalFlagModel + LoadBalancerName string + Payload loadbalancer.UpdateLoadBalancerPayload +} + +func NewCmd(p *print.Printer) *cobra.Command { + cmd := &cobra.Command{ + Use: fmt.Sprintf("update %s", loadBalancerNameArg), + Short: "Updates a Load Balancer", + Long: fmt.Sprintf("%s\n%s\n%s", + "Updates a load balancer.", + "The payload can be provided as a JSON string or a file path prefixed with \"@\".", + "See https://docs.api.stackit.cloud/documentation/load-balancer/version/v1#tag/Load-Balancer/operation/APIService_UpdateLoadBalancer for information regarding the payload structure.", + ), + Args: args.SingleArg(loadBalancerNameArg, nil), + Example: examples.Build( + examples.NewExample( + `Update a load balancer with name "xxx", using an API payload sourced from the file "./payload.json"`, + "$ stackit load-balancer update xxx --payload @./payload.json"), + examples.NewExample( + `Update a load balancer with name "xxx", using an API payload provided as a JSON string`, + `$ stackit load-balancer update xxx --payload "{...}"`), + examples.NewExample( + `Generate a payload with the current values of an existing load balancer xxx, and adapt it with custom values for the different configuration options`, + `$ stackit load-balancer generate-payload --instance-name xxx > ./payload.json`, + ``, + `$ stackit load-balancer update xxx --payload @./payload.json`), + ), + RunE: func(cmd *cobra.Command, args []string) error { + ctx := context.Background() + model, err := parseInput(p, 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 load balancer %q?", model.LoadBalancerName) + 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 load balancer: %w", err) + } + + // The API has no status to wait on, so async mode is default + p.Info("Updated load balancer with name %q\n", model.LoadBalancerName) + 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`) + + err := flags.MarkFlagsRequired(cmd, payloadFlag) + cobra.CheckErr(err) +} + +func parseInput(p *print.Printer, cmd *cobra.Command, inputArgs []string) (*inputModel, error) { + loadBalancerName := inputArgs[0] + + globalFlags := globalflags.Parse(p, cmd) + if globalFlags.ProjectId == "" { + return nil, &errors.ProjectIdError{} + } + + payloadString := flags.FlagToStringValue(p, cmd, payloadFlag) + var payload loadbalancer.UpdateLoadBalancerPayload + err := json.Unmarshal([]byte(payloadString), &payload) + if err != nil { + return nil, fmt.Errorf("encode payload: %w", err) + } + + model := inputModel{ + GlobalFlagModel: globalFlags, + LoadBalancerName: loadBalancerName, + Payload: payload, + } + + if p.IsVerbosityDebug() { + modelStr, err := print.BuildDebugStrFromInputModel(model) + if err != nil { + p.Debug(print.ErrorLevel, "convert model to string for debugging: %v", err) + } else { + p.Debug(print.DebugLevel, "parsed input values: %s", modelStr) + } + } + + return &model, nil +} + +func buildRequest(ctx context.Context, model *inputModel, apiClient *loadbalancer.APIClient) loadbalancer.ApiUpdateLoadBalancerRequest { + req := apiClient.UpdateLoadBalancer(ctx, model.ProjectId, model.LoadBalancerName) + + req = req.UpdateLoadBalancerPayload(model.Payload) + return req +} diff --git a/internal/cmd/load-balancer/update/update_test.go b/internal/cmd/load-balancer/update/update_test.go new file mode 100644 index 000000000..ea03f5932 --- /dev/null +++ b/internal/cmd/load-balancer/update/update_test.go @@ -0,0 +1,377 @@ +package update + +import ( + "context" + "testing" + + "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" + "github.com/stackitcloud/stackit-sdk-go/services/loadbalancer" +) + +var projectIdFlag = globalflags.ProjectIdFlag + +type testCtxKey struct{} + +var testCtx = context.WithValue(context.Background(), testCtxKey{}, "foo") +var testClient = &loadbalancer.APIClient{} +var testProjectId = uuid.NewString() +var testLoadBalancerName = "loadBalancer" + +var testPayload = loadbalancer.UpdateLoadBalancerPayload{ + ExternalAddress: utils.Ptr(""), + + Listeners: &[]loadbalancer.Listener{ + { + DisplayName: utils.Ptr(""), + Port: utils.Ptr(int64(0)), + Protocol: utils.Ptr(""), + ServerNameIndicators: &[]loadbalancer.ServerNameIndicator{ + { + Name: utils.Ptr(""), + }, + }, + TargetPool: utils.Ptr(""), + Tcp: &loadbalancer.OptionsTCP{ + IdleTimeout: utils.Ptr(""), + }, + Udp: &loadbalancer.OptionsUDP{ + IdleTimeout: utils.Ptr(""), + }, + }, + }, + Name: utils.Ptr(""), + Networks: &[]loadbalancer.Network{ + { + NetworkId: utils.Ptr(""), + Role: utils.Ptr(""), + }, + }, + Options: &loadbalancer.LoadBalancerOptions{ + AccessControl: &loadbalancer.LoadbalancerOptionAccessControl{ + AllowedSourceRanges: &[]string{ + "", + }, + }, + EphemeralAddress: utils.Ptr(false), + Observability: &loadbalancer.LoadbalancerOptionObservability{ + Logs: &loadbalancer.LoadbalancerOptionLogs{ + CredentialsRef: utils.Ptr(""), + PushUrl: utils.Ptr(""), + }, + Metrics: &loadbalancer.LoadbalancerOptionMetrics{ + CredentialsRef: utils.Ptr(""), + PushUrl: utils.Ptr(""), + }, + }, + PrivateNetworkOnly: utils.Ptr(false), + }, + TargetPools: &[]loadbalancer.TargetPool{ + { + ActiveHealthCheck: &loadbalancer.ActiveHealthCheck{ + HealthyThreshold: utils.Ptr(int64(0)), + Interval: utils.Ptr(""), + IntervalJitter: utils.Ptr(""), + Timeout: utils.Ptr(""), + UnhealthyThreshold: utils.Ptr(int64(0)), + }, + Name: utils.Ptr(""), + SessionPersistence: &loadbalancer.SessionPersistence{ + UseSourceIpAddress: utils.Ptr(false), + }, + TargetPort: utils.Ptr(int64(0)), + Targets: &[]loadbalancer.Target{ + { + DisplayName: utils.Ptr(""), + Ip: utils.Ptr(""), + }, + }, + }, + }, + Version: utils.Ptr(""), +} + +func fixtureArgValues(mods ...func(argValues []string)) []string { + argValues := []string{ + testLoadBalancerName, + } + 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: ` +{ + "externalAddress": "", + "listeners": [ + { + "displayName": "", + "port": 0, + "protocol": "", + "serverNameIndicators": [ + { + "name": "" + } + ], + "targetPool": "", + "tcp": { + "idleTimeout": "" + }, + "udp": { + "idleTimeout": "" + } + } + ], + "name": "", + "networks": [ + { + "networkId": "", + "role": "" + } + ], + "options": { + "accessControl": { + "allowedSourceRanges": [ + "" + ] + }, + "ephemeralAddress": false, + "observability": { + "logs": { + "credentialsRef": "", + "pushUrl": "" + }, + "metrics": { + "credentialsRef": "", + "pushUrl": "" + } + }, + "privateNetworkOnly": false + }, + "targetPools": [ + { + "activeHealthCheck": { + "healthyThreshold": 0, + "interval": "", + "intervalJitter": "", + "timeout": "", + "unhealthyThreshold": 0 + }, + "name": "", + "sessionPersistence": { + "useSourceIpAddress": false + }, + "targetPort": 0, + "targets": [ + { + "displayName": "", + "ip": "" + } + ] + } + ], + "version": "" +} +`, + } + 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, + }, + LoadBalancerName: testLoadBalancerName, + Payload: testPayload, + } + for _, mod := range mods { + mod(model) + } + return model +} + +func fixtureRequest(mods ...func(request *loadbalancer.ApiUpdateLoadBalancerRequest)) loadbalancer.ApiUpdateLoadBalancerRequest { + request := testClient.UpdateLoadBalancer(testCtx, testProjectId, testLoadBalancerName) + request = request.UpdateLoadBalancerPayload(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, + }, + { + description: "payload missing", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, payloadFlag) + }), + isValid: false, + }, + { + description: "payload is empty", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[payloadFlag] = "" + }), + isValid: false, + }, + } + + for _, tt := range tests { + t.Run(tt.description, func(t *testing.T) { + p := print.NewPrinter() + cmd := NewCmd(p) + 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(p, 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 loadbalancer.ApiUpdateLoadBalancerRequest + 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) + } + }) + } +}