diff --git a/docs/stackit_beta_server.md b/docs/stackit_beta_server.md index 1a2b67b25..2c96d2c32 100644 --- a/docs/stackit_beta_server.md +++ b/docs/stackit_beta_server.md @@ -31,4 +31,9 @@ stackit beta server [flags] * [stackit beta](./stackit_beta.md) - Contains beta STACKIT CLI commands * [stackit beta server backup](./stackit_beta_server_backup.md) - Provides functionality for Server Backup * [stackit beta server command](./stackit_beta_server_command.md) - Provides functionality for Server Command +* [stackit beta server create](./stackit_beta_server_create.md) - Creates a server +* [stackit beta server delete](./stackit_beta_server_delete.md) - Deletes a server +* [stackit beta server describe](./stackit_beta_server_describe.md) - Shows details of a server +* [stackit beta server list](./stackit_beta_server_list.md) - Lists all servers of a project +* [stackit beta server update](./stackit_beta_server_update.md) - Updates a server diff --git a/docs/stackit_beta_server_create.md b/docs/stackit_beta_server_create.md new file mode 100644 index 000000000..6d8194715 --- /dev/null +++ b/docs/stackit_beta_server_create.md @@ -0,0 +1,81 @@ +## stackit beta server create + +Creates a server + +### Synopsis + +Creates a server. + +``` +stackit beta server create [flags] +``` + +### Examples + +``` + Create a server from an image with id xxx + $ stackit beta server create --machine-type t1.1 --name server1 --image-id xxx + + Create a server with labels from an image with id xxx + $ stackit beta server create --machine-type t1.1 --name server1 --image-id xxx --labels key=value,foo=bar + + Create a server with a boot volume + $ stackit beta server create --machine-type t1.1 --name server1 --boot-volume-source-id xxx --boot-volume-source-type image --boot-volume-size 64 + + Create a server with a boot volume from an existing volume + $ stackit beta server create --machine-type t1.1 --name server1 --boot-volume-source-id xxx --boot-volume-source-type volume + + Create a server with a keypair + $ stackit beta server create --machine-type t1.1 --name server1 --image-id xxx --keypair-name example + + Create a server with a network + $ stackit beta server create --machine-type t1.1 --name server1 --image-id xxx --network-id yyy + + Create a server with a network interface + $ stackit beta server create --machine-type t1.1 --name server1 --boot-volume-source-id xxx --boot-volume-source-type image --boot-volume-size 64 --network-interface-ids yyy + + Create a server with an attached volume + $ stackit beta server create --machine-type t1.1 --name server1 --boot-volume-source-id xxx --boot-volume-source-type image --boot-volume-size 64 --volumes yyy + + Create a server with user data (cloud-init) + $ stackit beta server create --machine-type t1.1 --name server1 --boot-volume-source-id xxx --boot-volume-source-type image --boot-volume-size 64 --user-data @path/to/file.yaml") +``` + +### Options + +``` + --affinity-group string The affinity group the server is assigned to + --availability-zone string The availability zone of the server + --boot-volume-delete-on-termination Delete the volume during the termination of the server. Defaults to false + --boot-volume-performance-class string Boot volume performance class + --boot-volume-size int The size of the boot volume in GB. Must be provided when 'boot-volume-source-type' is 'image' + --boot-volume-source-id string ID of the source object of boot volume. It can be either an image or volume ID + --boot-volume-source-type string Type of the source object of boot volume. It can be either 'image' or 'volume' + -h, --help Help for "stackit beta server create" + --image-id string The image ID to be used for an ephemeral disk on the server. Either 'image-id' or 'boot-volume-...' flags are required + --keypair-name string The name of the SSH keypair used during the server creation + --labels stringToString Labels are key-value string pairs which can be attached to a server. E.g. '--labels key1=value1,key2=value2,...' (default []) + --machine-type string Name of the type of the machine for the server. Possible values are documented in https://docs.stackit.cloud/stackit/en/virtual-machine-flavors-75137231.html + -n, --name string Server name + --network-id string ID of the network for the initial networking setup for the server creation + --network-interface-ids strings List of network interface IDs for the initial networking setup for the server creation + --security-groups strings The initial security groups for the server creation + --service-account-emails strings List of the service account mails + --user-data string User data that is passed via cloud-init to the server + --volumes strings The list of volumes attached to the server +``` + +### 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 + --verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info") +``` + +### SEE ALSO + +* [stackit beta server](./stackit_beta_server.md) - Provides functionality for Server + diff --git a/docs/stackit_beta_server_delete.md b/docs/stackit_beta_server_delete.md new file mode 100644 index 000000000..ffe1f941c --- /dev/null +++ b/docs/stackit_beta_server_delete.md @@ -0,0 +1,41 @@ +## stackit beta server delete + +Deletes a server + +### Synopsis + +Deletes a server. +If the server is still in use, the deletion will fail + + +``` +stackit beta server delete [flags] +``` + +### Examples + +``` + Delete server with ID "xxx" + $ stackit beta server delete xxx +``` + +### Options + +``` + -h, --help Help for "stackit beta server delete" +``` + +### 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 + --verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info") +``` + +### SEE ALSO + +* [stackit beta server](./stackit_beta_server.md) - Provides functionality for Server + diff --git a/docs/stackit_beta_server_describe.md b/docs/stackit_beta_server_describe.md new file mode 100644 index 000000000..1dab42995 --- /dev/null +++ b/docs/stackit_beta_server_describe.md @@ -0,0 +1,46 @@ +## stackit beta server describe + +Shows details of a server + +### Synopsis + +Shows details of a server. + +``` +stackit beta server describe [flags] +``` + +### Examples + +``` + Show details of a server with ID "xxx" + $ stackit beta server describe xxx + + Show detailed information of a server with ID "xxx" + $ stackit beta server describe xxx --details + + Show details of a server with ID "xxx" in JSON format + $ stackit beta server describe xxx --output-format json +``` + +### Options + +``` + --details Show detailed information about server + -h, --help Help for "stackit beta server describe" +``` + +### 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 + --verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info") +``` + +### SEE ALSO + +* [stackit beta server](./stackit_beta_server.md) - Provides functionality for Server + diff --git a/docs/stackit_beta_server_list.md b/docs/stackit_beta_server_list.md new file mode 100644 index 000000000..4641bea02 --- /dev/null +++ b/docs/stackit_beta_server_list.md @@ -0,0 +1,50 @@ +## stackit beta server list + +Lists all servers of a project + +### Synopsis + +Lists all servers of a project. + +``` +stackit beta server list [flags] +``` + +### Examples + +``` + Lists all servers + $ stackit beta server list + + Lists all servers which contains the label xxx + $ stackit beta server list --label-selector xxx + + Lists all servers in JSON format + $ stackit beta server list --output-format json + + Lists up to 10 servers + $ stackit beta server list --limit 10 +``` + +### Options + +``` + -h, --help Help for "stackit beta server list" + --label-selector string Filter by label + --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 + --verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info") +``` + +### SEE ALSO + +* [stackit beta server](./stackit_beta_server.md) - Provides functionality for Server + diff --git a/docs/stackit_beta_server_update.md b/docs/stackit_beta_server_update.md new file mode 100644 index 000000000..633b75fbd --- /dev/null +++ b/docs/stackit_beta_server_update.md @@ -0,0 +1,44 @@ +## stackit beta server update + +Updates a server + +### Synopsis + +Updates a server. + +``` +stackit beta server update [flags] +``` + +### Examples + +``` + Update server with ID "xxx" with new name "server-1-new" + $ stackit beta server update xxx --name server-1-new + + Update server with ID "xxx" with new name "server-1-new" and label(s) + $ stackit beta server update xxx --name server-1-new --labels key=value,foo=bar +``` + +### Options + +``` + -h, --help Help for "stackit beta server update" + --labels stringToString Labels are key-value string pairs which can be attached to a server. E.g. '--labels key1=value1,key2=value2,...' (default []) + -n, --name string Server name +``` + +### 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 + --verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info") +``` + +### SEE ALSO + +* [stackit beta server](./stackit_beta_server.md) - Provides functionality for Server + diff --git a/internal/cmd/beta/server/create/create.go b/internal/cmd/beta/server/create/create.go new file mode 100644 index 000000000..106956633 --- /dev/null +++ b/internal/cmd/beta/server/create/create.go @@ -0,0 +1,359 @@ +package create + +import ( + "context" + "encoding/json" + "fmt" + + "github.com/goccy/go-yaml" + "github.com/stackitcloud/stackit-cli/internal/pkg/args" + cliErr "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/projectname" + "github.com/stackitcloud/stackit-cli/internal/pkg/services/iaas/client" + "github.com/stackitcloud/stackit-cli/internal/pkg/spinner" + "github.com/stackitcloud/stackit-cli/internal/pkg/utils" + "github.com/stackitcloud/stackit-sdk-go/services/iaas" + "github.com/stackitcloud/stackit-sdk-go/services/iaas/wait" + + "github.com/spf13/cobra" +) + +const ( + nameFlag = "name" + machineTypeFlag = "machine-type" + affinityGroupFlag = "affinity-group" + availabilityZoneFlag = "availability-zone" + bootVolumeSourceIdFlag = "boot-volume-source-id" + bootVolumeSourceTypeFlag = "boot-volume-source-type" + bootVolumeSizeFlag = "boot-volume-size" + bootVolumePerformanceClassFlag = "boot-volume-performance-class" + bootVolumeDeleteOnTerminationFlag = "boot-volume-delete-on-termination" + imageIdFlag = "image-id" + keypairNameFlag = "keypair-name" + labelFlag = "labels" + networkIdFlag = "network-id" + networkInterfaceIdsFlag = "network-interface-ids" + securityGroupsFlag = "security-groups" + serviceAccountEmailsFlag = "service-account-emails" + userDataFlag = "user-data" + volumesFlag = "volumes" +) + +type inputModel struct { + *globalflags.GlobalFlagModel + Name *string + MachineType *string + AffinityGroup *string + AvailabilityZone *string + BootVolumeSourceId *string + BootVolumeSourceType *string + BootVolumeSize *int64 + BootVolumePerformanceClass *string + BootVolumeDeleteOnTermination *bool + ImageId *string + KeypairName *string + Labels *map[string]string + NetworkId *string + NetworkInterfaceIds *[]string + SecurityGroups *[]string + ServiceAccountMails *[]string + UserData *string + Volumes *[]string +} + +func NewCmd(p *print.Printer) *cobra.Command { + cmd := &cobra.Command{ + Use: "create", + Short: "Creates a server", + Long: "Creates a server.", + Args: args.NoArgs, + Example: examples.Build( + examples.NewExample( + `Create a server from an image with id xxx`, + `$ stackit beta server create --machine-type t1.1 --name server1 --image-id xxx`, + ), + examples.NewExample( + `Create a server with labels from an image with id xxx`, + `$ stackit beta server create --machine-type t1.1 --name server1 --image-id xxx --labels key=value,foo=bar`, + ), + examples.NewExample( + `Create a server with a boot volume`, + `$ stackit beta server create --machine-type t1.1 --name server1 --boot-volume-source-id xxx --boot-volume-source-type image --boot-volume-size 64`, + ), + examples.NewExample( + `Create a server with a boot volume from an existing volume`, + `$ stackit beta server create --machine-type t1.1 --name server1 --boot-volume-source-id xxx --boot-volume-source-type volume`, + ), + examples.NewExample( + `Create a server with a keypair`, + `$ stackit beta server create --machine-type t1.1 --name server1 --image-id xxx --keypair-name example`, + ), + examples.NewExample( + `Create a server with a network`, + `$ stackit beta server create --machine-type t1.1 --name server1 --image-id xxx --network-id yyy`, + ), + examples.NewExample( + `Create a server with a network interface`, + `$ stackit beta server create --machine-type t1.1 --name server1 --boot-volume-source-id xxx --boot-volume-source-type image --boot-volume-size 64 --network-interface-ids yyy`, + ), + examples.NewExample( + `Create a server with an attached volume`, + `$ stackit beta server create --machine-type t1.1 --name server1 --boot-volume-source-id xxx --boot-volume-source-type image --boot-volume-size 64 --volumes yyy`, + ), + examples.NewExample( + `Create a server with user data (cloud-init)`, + `$ stackit beta server create --machine-type t1.1 --name server1 --boot-volume-source-id xxx --boot-volume-source-type image --boot-volume-size 64 --user-data @path/to/file.yaml")`, + ), + ), + RunE: func(cmd *cobra.Command, _ []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 server for project %q?", projectLabel) + err = p.PromptForConfirmation(prompt) + if err != nil { + return err + } + } + + // Call API + req := buildRequest(ctx, model, apiClient) + resp, err := req.Execute() + if err != nil { + return fmt.Errorf("create server : %w", err) + } + serverId := *resp.Id + + // Wait for async operation, if async mode not enabled + if !model.Async { + s := spinner.New(p) + s.Start("Creating server") + _, err = wait.CreateServerWaitHandler(ctx, apiClient, model.ProjectId, serverId).WaitWithContext(ctx) + if err != nil { + return fmt.Errorf("wait for server creation: %w", err) + } + s.Stop() + } + + return outputResult(p, model, projectLabel, resp) + }, + } + configureFlags(cmd) + return cmd +} + +func configureFlags(cmd *cobra.Command) { + cmd.Flags().StringP(nameFlag, "n", "", "Server name") + cmd.Flags().String(machineTypeFlag, "", "Name of the type of the machine for the server. Possible values are documented in https://docs.stackit.cloud/stackit/en/virtual-machine-flavors-75137231.html") + cmd.Flags().String(affinityGroupFlag, "", "The affinity group the server is assigned to") + cmd.Flags().String(availabilityZoneFlag, "", "The availability zone of the server") + cmd.Flags().String(bootVolumeSourceIdFlag, "", "ID of the source object of boot volume. It can be either an image or volume ID") + cmd.Flags().String(bootVolumeSourceTypeFlag, "", "Type of the source object of boot volume. It can be either 'image' or 'volume'") + cmd.Flags().Int64(bootVolumeSizeFlag, 0, "The size of the boot volume in GB. Must be provided when 'boot-volume-source-type' is 'image'") + cmd.Flags().String(bootVolumePerformanceClassFlag, "", "Boot volume performance class") + cmd.Flags().Bool(bootVolumeDeleteOnTerminationFlag, false, "Delete the volume during the termination of the server. Defaults to false") + cmd.Flags().String(imageIdFlag, "", "The image ID to be used for an ephemeral disk on the server. Either 'image-id' or 'boot-volume-...' flags are required") + cmd.Flags().String(keypairNameFlag, "", "The name of the SSH keypair used during the server creation") + cmd.Flags().StringToString(labelFlag, nil, "Labels are key-value string pairs which can be attached to a server. E.g. '--labels key1=value1,key2=value2,...'") + cmd.Flags().String(networkIdFlag, "", "ID of the network for the initial networking setup for the server creation") + cmd.Flags().StringSlice(networkInterfaceIdsFlag, []string{}, "List of network interface IDs for the initial networking setup for the server creation") + cmd.Flags().StringSlice(securityGroupsFlag, []string{}, "The initial security groups for the server creation") + cmd.Flags().StringSlice(serviceAccountEmailsFlag, []string{}, "List of the service account mails") + cmd.Flags().Var(flags.ReadFromFileFlag(), userDataFlag, "User data that is passed via cloud-init to the server") + cmd.Flags().StringSlice(volumesFlag, []string{}, "The list of volumes attached to the server") + + err := flags.MarkFlagsRequired(cmd, nameFlag, machineTypeFlag) + cmd.MarkFlagsMutuallyExclusive(imageIdFlag, bootVolumeSourceIdFlag) + cmd.MarkFlagsMutuallyExclusive(imageIdFlag, bootVolumeSourceTypeFlag) + cmd.MarkFlagsMutuallyExclusive(networkIdFlag, networkInterfaceIdsFlag) + cobra.CheckErr(err) +} + +func parseInput(p *print.Printer, cmd *cobra.Command) (*inputModel, error) { + globalFlags := globalflags.Parse(p, cmd) + if globalFlags.ProjectId == "" { + return nil, &cliErr.ProjectIdError{} + } + + bootVolumeSourceId := flags.FlagToStringPointer(p, cmd, bootVolumeSourceIdFlag) + bootVolumeSourceType := flags.FlagToStringPointer(p, cmd, bootVolumeSourceTypeFlag) + bootVolumeSize := flags.FlagToInt64Pointer(p, cmd, bootVolumeSizeFlag) + imageId := flags.FlagToStringPointer(p, cmd, imageIdFlag) + + if imageId == nil && bootVolumeSourceId == nil && bootVolumeSourceType == nil { + return nil, &cliErr.ServerCreateMissingFlagsError{ + Cmd: cmd, + } + } + + if imageId == nil { + err := flags.MarkFlagsRequired(cmd, bootVolumeSourceIdFlag, bootVolumeSourceTypeFlag) + cobra.CheckErr(err) + } + + if bootVolumeSourceId != nil && bootVolumeSourceType == nil { + err := cmd.MarkFlagRequired(bootVolumeSourceTypeFlag) + cobra.CheckErr(err) + + return nil, &cliErr.ServerCreateMissingVolumeTypeError{ + Cmd: cmd, + } + } + + if bootVolumeSourceType != nil { + if bootVolumeSourceId == nil { + err := cmd.MarkFlagRequired(bootVolumeSourceIdFlag) + cobra.CheckErr(err) + + return nil, &cliErr.ServerCreateMissingVolumeIdError{ + Cmd: cmd, + } + } + + if *bootVolumeSourceType == "image" && bootVolumeSize == nil { + err := cmd.MarkFlagRequired(bootVolumeSizeFlag) + cobra.CheckErr(err) + return nil, &cliErr.ServerCreateError{ + Cmd: cmd, + } + } + } + + if bootVolumeSourceId == nil && bootVolumeSourceType == nil { + err := cmd.MarkFlagRequired(imageIdFlag) + cobra.CheckErr(err) + } + + model := inputModel{ + GlobalFlagModel: globalFlags, + Name: flags.FlagToStringPointer(p, cmd, nameFlag), + MachineType: flags.FlagToStringPointer(p, cmd, machineTypeFlag), + AffinityGroup: flags.FlagToStringPointer(p, cmd, affinityGroupFlag), + AvailabilityZone: flags.FlagToStringPointer(p, cmd, availabilityZoneFlag), + BootVolumeSourceId: flags.FlagToStringPointer(p, cmd, bootVolumeSourceIdFlag), + BootVolumeSourceType: flags.FlagToStringPointer(p, cmd, bootVolumeSourceTypeFlag), + BootVolumeSize: flags.FlagToInt64Pointer(p, cmd, bootVolumeSizeFlag), + BootVolumePerformanceClass: flags.FlagToStringPointer(p, cmd, bootVolumePerformanceClassFlag), + BootVolumeDeleteOnTermination: flags.FlagToBoolPointer(p, cmd, bootVolumeDeleteOnTerminationFlag), + ImageId: flags.FlagToStringPointer(p, cmd, imageIdFlag), + KeypairName: flags.FlagToStringPointer(p, cmd, keypairNameFlag), + Labels: flags.FlagToStringToStringPointer(p, cmd, labelFlag), + NetworkId: flags.FlagToStringPointer(p, cmd, networkIdFlag), + NetworkInterfaceIds: flags.FlagToStringSlicePointer(p, cmd, networkInterfaceIdsFlag), + SecurityGroups: flags.FlagToStringSlicePointer(p, cmd, securityGroupsFlag), + ServiceAccountMails: flags.FlagToStringSlicePointer(p, cmd, serviceAccountEmailsFlag), + UserData: flags.FlagToStringPointer(p, cmd, userDataFlag), + Volumes: flags.FlagToStringSlicePointer(p, cmd, volumesFlag), + } + + 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 *iaas.APIClient) iaas.ApiCreateServerRequest { + req := apiClient.CreateServer(ctx, model.ProjectId) + var labelsMap *map[string]interface{} + if model.Labels != nil && len(*model.Labels) > 0 { + // convert map[string]string to map[string]interface{} + labelsMap = utils.Ptr(map[string]interface{}{}) + for k, v := range *model.Labels { + (*labelsMap)[k] = v + } + } + + payload := iaas.CreateServerPayload{ + Name: model.Name, + MachineType: model.MachineType, + AffinityGroup: model.AffinityGroup, + AvailabilityZone: model.AvailabilityZone, + + ImageId: model.ImageId, + KeypairName: model.KeypairName, + SecurityGroups: model.SecurityGroups, + ServiceAccountMails: model.ServiceAccountMails, + UserData: model.UserData, + Volumes: model.Volumes, + Labels: labelsMap, + } + + if model.BootVolumePerformanceClass != nil || model.BootVolumeSize != nil || model.BootVolumeDeleteOnTermination != nil || model.BootVolumeSourceId != nil || model.BootVolumeSourceType != nil { + payload.BootVolume = &iaas.CreateServerPayloadBootVolume{ + PerformanceClass: model.BootVolumePerformanceClass, + Size: model.BootVolumeSize, + DeleteOnTermination: model.BootVolumeDeleteOnTermination, + Source: &iaas.BootVolumeSource{ + Id: model.BootVolumeSourceId, + Type: model.BootVolumeSourceType, + }, + } + } + + if model.NetworkInterfaceIds != nil || model.NetworkId != nil { + payload.Networking = &iaas.CreateServerPayloadNetworking{} + + if model.NetworkInterfaceIds != nil { + payload.Networking.CreateServerNetworkingWithNics = &iaas.CreateServerNetworkingWithNics{ + NicIds: model.NetworkInterfaceIds, + } + } + if model.NetworkId != nil { + payload.Networking.CreateServerNetworking = &iaas.CreateServerNetworking{ + NetworkId: model.NetworkId, + } + } + } + + return req.CreateServerPayload(payload) +} + +func outputResult(p *print.Printer, model *inputModel, projectLabel string, server *iaas.Server) error { + switch model.OutputFormat { + case print.JSONOutputFormat: + details, err := json.MarshalIndent(server, "", " ") + if err != nil { + return fmt.Errorf("marshal server: %w", err) + } + p.Outputln(string(details)) + + return nil + case print.YAMLOutputFormat: + details, err := yaml.MarshalWithOptions(server, yaml.IndentSequence(true)) + if err != nil { + return fmt.Errorf("marshal server: %w", err) + } + p.Outputln(string(details)) + + return nil + default: + p.Outputf("Created server for project %q.\nServer ID: %s\n", projectLabel, *server.Id) + return nil + } +} diff --git a/internal/cmd/beta/server/create/create_test.go b/internal/cmd/beta/server/create/create_test.go new file mode 100644 index 000000000..2ac1afcac --- /dev/null +++ b/internal/cmd/beta/server/create/create_test.go @@ -0,0 +1,410 @@ +package create + +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/iaas" +) + +var projectIdFlag = globalflags.ProjectIdFlag + +type testCtxKey struct{} + +var testCtx = context.WithValue(context.Background(), testCtxKey{}, "foo") +var testClient = &iaas.APIClient{} + +var testProjectId = uuid.NewString() +var testSourceId = uuid.NewString() +var testImageId = uuid.NewString() +var testNetworkId = uuid.NewString() +var testVolumeId = uuid.NewString() + +func fixtureFlagValues(mods ...func(flagValues map[string]string)) map[string]string { + flagValues := map[string]string{ + projectIdFlag: testProjectId, + availabilityZoneFlag: "eu01-1", + nameFlag: "test-server-name", + machineTypeFlag: "t1.1", + affinityGroupFlag: "test-affinity-group", + labelFlag: "key=value", + bootVolumePerformanceClassFlag: "test-perf-class", + bootVolumeSizeFlag: "5", + bootVolumeSourceIdFlag: testSourceId, + bootVolumeSourceTypeFlag: "test-source-type", + bootVolumeDeleteOnTerminationFlag: "false", + imageIdFlag: testImageId, + keypairNameFlag: "test-keypair-name", + networkIdFlag: testNetworkId, + securityGroupsFlag: "test-security-groups", + serviceAccountEmailsFlag: "test-service-account", + userDataFlag: "test-user-data", + volumesFlag: testVolumeId, + } + 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, + }, + AvailabilityZone: utils.Ptr("eu01-1"), + Name: utils.Ptr("test-server-name"), + MachineType: utils.Ptr("t1.1"), + AffinityGroup: utils.Ptr("test-affinity-group"), + BootVolumePerformanceClass: utils.Ptr("test-perf-class"), + BootVolumeSize: utils.Ptr(int64(5)), + BootVolumeSourceId: utils.Ptr(testSourceId), + BootVolumeSourceType: utils.Ptr("test-source-type"), + BootVolumeDeleteOnTermination: utils.Ptr(false), + ImageId: utils.Ptr(testImageId), + KeypairName: utils.Ptr("test-keypair-name"), + NetworkId: utils.Ptr(testNetworkId), + SecurityGroups: utils.Ptr([]string{"test-security-groups"}), + ServiceAccountMails: utils.Ptr([]string{"test-service-account"}), + UserData: utils.Ptr("test-user-data"), + Volumes: utils.Ptr([]string{testVolumeId}), + Labels: utils.Ptr(map[string]string{ + "key": "value", + }), + } + for _, mod := range mods { + mod(model) + } + return model +} + +func fixtureRequest(mods ...func(request *iaas.ApiCreateServerRequest)) iaas.ApiCreateServerRequest { + request := testClient.CreateServer(testCtx, testProjectId) + request = request.CreateServerPayload(fixturePayload()) + for _, mod := range mods { + mod(&request) + } + return request +} + +func fixtureRequiredRequest(mods ...func(request *iaas.ApiCreateServerRequest)) iaas.ApiCreateServerRequest { + request := testClient.CreateServer(testCtx, testProjectId) + request = request.CreateServerPayload(iaas.CreateServerPayload{ + MachineType: utils.Ptr("t1.1"), + Name: utils.Ptr("test-server-name"), + }) + for _, mod := range mods { + mod(&request) + } + return request +} + +func fixturePayload(mods ...func(payload *iaas.CreateServerPayload)) iaas.CreateServerPayload { + payload := iaas.CreateServerPayload{ + Labels: utils.Ptr(map[string]interface{}{ + "key": "value", + }), + MachineType: utils.Ptr("t1.1"), + Name: utils.Ptr("test-server-name"), + AvailabilityZone: utils.Ptr("eu01-1"), + AffinityGroup: utils.Ptr("test-affinity-group"), + ImageId: utils.Ptr(testImageId), + KeypairName: utils.Ptr("test-keypair-name"), + SecurityGroups: utils.Ptr([]string{"test-security-groups"}), + ServiceAccountMails: utils.Ptr([]string{"test-service-account"}), + UserData: utils.Ptr("test-user-data"), + Volumes: utils.Ptr([]string{testVolumeId}), + BootVolume: &iaas.CreateServerPayloadBootVolume{ + PerformanceClass: utils.Ptr("test-perf-class"), + Size: utils.Ptr(int64(5)), + DeleteOnTermination: utils.Ptr(false), + Source: &iaas.BootVolumeSource{ + Id: utils.Ptr(testSourceId), + Type: utils.Ptr("test-source-type"), + }, + }, + Networking: &iaas.CreateServerPayloadNetworking{ + CreateServerNetworking: &iaas.CreateServerNetworking{ + NetworkId: utils.Ptr(testNetworkId), + }, + }, + } + for _, mod := range mods { + mod(&payload) + } + return payload +} + +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: "required only", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, affinityGroupFlag) + delete(flagValues, availabilityZoneFlag) + delete(flagValues, labelFlag) + delete(flagValues, bootVolumeSourceIdFlag) + delete(flagValues, bootVolumeSourceTypeFlag) + delete(flagValues, bootVolumeSizeFlag) + delete(flagValues, bootVolumePerformanceClassFlag) + delete(flagValues, bootVolumeDeleteOnTerminationFlag) + delete(flagValues, keypairNameFlag) + delete(flagValues, networkIdFlag) + delete(flagValues, networkInterfaceIdsFlag) + delete(flagValues, securityGroupsFlag) + delete(flagValues, serviceAccountEmailsFlag) + delete(flagValues, userDataFlag) + delete(flagValues, volumesFlag) + }), + isValid: true, + expectedModel: fixtureInputModel(func(model *inputModel) { + model.AffinityGroup = nil + model.AvailabilityZone = nil + model.Labels = nil + model.BootVolumeSourceId = nil + model.BootVolumeSourceType = nil + model.BootVolumeSize = nil + model.BootVolumePerformanceClass = nil + model.BootVolumeDeleteOnTermination = nil + model.KeypairName = nil + model.NetworkId = nil + model.NetworkInterfaceIds = nil + model.SecurityGroups = nil + model.ServiceAccountMails = nil + model.UserData = nil + model.Volumes = nil + }), + }, + { + description: "machine type missing", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, machineTypeFlag) + }), + isValid: false, + }, + { + description: "name missing", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, nameFlag) + }), + 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: "use network id", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[networkIdFlag] = testNetworkId + flagValues[nameFlag] = "test-server-name" + flagValues[machineTypeFlag] = "t1.1" + }), + isValid: true, + expectedModel: fixtureInputModel(func(model *inputModel) { + model.NetworkId = utils.Ptr(testNetworkId) + model.Name = utils.Ptr("test-server-name") + model.MachineType = utils.Ptr("t1.1") + }), + }, + { + description: "use boot volume source id and type", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[bootVolumeSourceIdFlag] = testImageId + flagValues[bootVolumeSourceTypeFlag] = "image" + }), + isValid: true, + expectedModel: fixtureInputModel(func(model *inputModel) { + model.BootVolumeSourceId = utils.Ptr(testImageId) + model.BootVolumeSourceType = utils.Ptr("image") + }), + }, + { + description: "invalid without image-id, boot-volume-source-id and type", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, bootVolumeSourceIdFlag) + delete(flagValues, bootVolumeSourceTypeFlag) + delete(flagValues, imageIdFlag) + }), + isValid: false, + }, + { + description: "invalid with boot-volume-source-id and without type", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, bootVolumeSourceTypeFlag) + }), + isValid: false, + }, + { + description: "invalid with boot-volume-source-type is image and without size", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, bootVolumeSizeFlag) + flagValues[bootVolumeSourceIdFlag] = testImageId + flagValues[bootVolumeSourceTypeFlag] = "image" + }), + isValid: false, + }, + { + description: "valid with image-id", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, bootVolumeSourceIdFlag) + delete(flagValues, bootVolumeSourceTypeFlag) + delete(flagValues, bootVolumeSizeFlag) + }), + isValid: true, + expectedModel: fixtureInputModel(func(model *inputModel) { + model.BootVolumeSourceId = nil + model.BootVolumeSourceType = nil + model.BootVolumeSize = nil + }), + }, + { + description: "valid with boot-volume-source-id and type volume", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, imageIdFlag) + delete(flagValues, bootVolumeSizeFlag) + }), + isValid: true, + expectedModel: fixtureInputModel(func(model *inputModel) { + model.ImageId = nil + model.BootVolumeSize = nil + }), + }, + { + description: "valid with boot-volume-source-id, type volume and size", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + delete(flagValues, imageIdFlag) + }), + isValid: true, + expectedModel: fixtureInputModel(func(model *inputModel) { + model.ImageId = nil + }), + }, + } + + 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) + } + + 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) + if diff != "" { + t.Fatalf("Data does not match: %s", diff) + } + }) + } +} + +func TestBuildRequest(t *testing.T) { + tests := []struct { + description string + model *inputModel + expectedRequest iaas.ApiCreateServerRequest + }{ + { + description: "base", + model: fixtureInputModel(), + expectedRequest: fixtureRequest(), + }, + { + description: "only name and machine type in payload", + model: &inputModel{ + GlobalFlagModel: &globalflags.GlobalFlagModel{ + ProjectId: testProjectId, + Verbosity: globalflags.VerbosityDefault, + }, + MachineType: utils.Ptr("t1.1"), + Name: utils.Ptr("test-server-name"), + }, + expectedRequest: fixtureRequiredRequest(), + }, + } + + 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/beta/server/delete/delete.go b/internal/cmd/beta/server/delete/delete.go new file mode 100644 index 000000000..c82059193 --- /dev/null +++ b/internal/cmd/beta/server/delete/delete.go @@ -0,0 +1,129 @@ +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/globalflags" + "github.com/stackitcloud/stackit-cli/internal/pkg/print" + "github.com/stackitcloud/stackit-cli/internal/pkg/services/iaas/client" + iaasUtils "github.com/stackitcloud/stackit-cli/internal/pkg/services/iaas/utils" + "github.com/stackitcloud/stackit-cli/internal/pkg/spinner" + "github.com/stackitcloud/stackit-cli/internal/pkg/utils" + "github.com/stackitcloud/stackit-sdk-go/services/iaas" + "github.com/stackitcloud/stackit-sdk-go/services/iaas/wait" + + "github.com/spf13/cobra" +) + +const ( + serverIdArg = "SERVER_ID" +) + +type inputModel struct { + *globalflags.GlobalFlagModel + ServerId string +} + +func NewCmd(p *print.Printer) *cobra.Command { + cmd := &cobra.Command{ + Use: "delete", + Short: "Deletes a server", + Long: fmt.Sprintf("%s\n%s\n", + "Deletes a server.", + "If the server is still in use, the deletion will fail", + ), + Args: args.SingleArg(serverIdArg, utils.ValidateUUID), + Example: examples.Build( + examples.NewExample( + `Delete server with ID "xxx"`, + "$ stackit beta server delete xxx", + ), + ), + 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 + } + + serverLabel, err := iaasUtils.GetServerName(ctx, apiClient, model.ProjectId, model.ServerId) + if err != nil { + p.Debug(print.ErrorLevel, "get server name: %v", err) + serverLabel = model.ServerId + } + + if !model.AssumeYes { + prompt := fmt.Sprintf("Are you sure you want to delete server %q?", serverLabel) + 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 server: %w", err) + } + + // Wait for async operation, if async mode not enabled + if !model.Async { + s := spinner.New(p) + s.Start("Deleting server") + _, err = wait.DeleteServerWaitHandler(ctx, apiClient, model.ProjectId, model.ServerId).WaitWithContext(ctx) + if err != nil { + return fmt.Errorf("wait for server deletion: %w", err) + } + s.Stop() + } + + operationState := "Deleted" + if model.Async { + operationState = "Triggered deletion of" + } + p.Info("%s server %q\n", operationState, serverLabel) + return nil + }, + } + return cmd +} + +func parseInput(p *print.Printer, cmd *cobra.Command, inputArgs []string) (*inputModel, error) { + serverId := inputArgs[0] + + globalFlags := globalflags.Parse(p, cmd) + if globalFlags.ProjectId == "" { + return nil, &errors.ProjectIdError{} + } + + model := inputModel{ + GlobalFlagModel: globalFlags, + ServerId: serverId, + } + + 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 *iaas.APIClient) iaas.ApiDeleteServerRequest { + return apiClient.DeleteServer(ctx, model.ProjectId, model.ServerId) +} diff --git a/internal/cmd/beta/server/delete/delete_test.go b/internal/cmd/beta/server/delete/delete_test.go new file mode 100644 index 000000000..3b7c0ba31 --- /dev/null +++ b/internal/cmd/beta/server/delete/delete_test.go @@ -0,0 +1,218 @@ +package delete + +import ( + "context" + "testing" + + "github.com/stackitcloud/stackit-cli/internal/pkg/globalflags" + "github.com/stackitcloud/stackit-cli/internal/pkg/print" + + "github.com/google/go-cmp/cmp" + "github.com/google/go-cmp/cmp/cmpopts" + "github.com/google/uuid" + "github.com/stackitcloud/stackit-sdk-go/services/iaas" +) + +var projectIdFlag = globalflags.ProjectIdFlag + +type testCtxKey struct{} + +var testCtx = context.WithValue(context.Background(), testCtxKey{}, "foo") +var testClient = &iaas.APIClient{} +var testServerId = uuid.NewString() +var testProjectId = uuid.NewString() + +func fixtureArgValues(mods ...func(argValues []string)) []string { + argValues := []string{ + testServerId, + } + 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, + } + for _, mod := range mods { + mod(flagValues) + } + return flagValues +} + +func fixtureInputModel(mods ...func(model *inputModel)) *inputModel { + model := &inputModel{ + GlobalFlagModel: &globalflags.GlobalFlagModel{ + Verbosity: globalflags.VerbosityDefault, + ProjectId: testProjectId, + }, + ServerId: testServerId, + } + for _, mod := range mods { + mod(model) + } + return model +} + +func fixtureRequest(mods ...func(request *iaas.ApiDeleteServerRequest)) iaas.ApiDeleteServerRequest { + request := testClient.DeleteServer(testCtx, testProjectId, testServerId) + 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: "server id invalid 1", + argValues: []string{""}, + flagValues: fixtureFlagValues(), + isValid: false, + }, + { + description: "server id invalid 2", + argValues: []string{"invalid-uuid"}, + flagValues: fixtureFlagValues(), + 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 input: %v", err) + } + + if !tt.isValid { + t.Fatalf("did not fail on invalid input") + } + diff := cmp.Diff(model, tt.expectedModel) + if diff != "" { + t.Fatalf("Data does not match: %s", diff) + } + }) + } +} + +func TestBuildRequest(t *testing.T) { + tests := []struct { + description string + model *inputModel + expectedRequest iaas.ApiDeleteServerRequest + }{ + { + 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/beta/server/describe/describe.go b/internal/cmd/beta/server/describe/describe.go new file mode 100644 index 000000000..a9c105a93 --- /dev/null +++ b/internal/cmd/beta/server/describe/describe.go @@ -0,0 +1,218 @@ +package describe + +import ( + "context" + "encoding/json" + "fmt" + "strings" + + "github.com/goccy/go-yaml" + + "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/iaas/client" + "github.com/stackitcloud/stackit-cli/internal/pkg/tables" + "github.com/stackitcloud/stackit-cli/internal/pkg/utils" + "github.com/stackitcloud/stackit-sdk-go/services/iaas" + + "github.com/spf13/cobra" +) + +const ( + serverIdArg = "SERVER_ID" + detailsFlag = "details" +) + +type inputModel struct { + *globalflags.GlobalFlagModel + ServerId string + Details bool +} + +func NewCmd(p *print.Printer) *cobra.Command { + cmd := &cobra.Command{ + Use: "describe", + Short: "Shows details of a server", + Long: "Shows details of a server.", + Args: args.SingleArg(serverIdArg, utils.ValidateUUID), + Example: examples.Build( + examples.NewExample( + `Show details of a server with ID "xxx"`, + "$ stackit beta server describe xxx", + ), + examples.NewExample( + `Show detailed information of a server with ID "xxx"`, + "$ stackit beta server describe xxx --details", + ), + examples.NewExample( + `Show details of a server with ID "xxx" in JSON format`, + "$ stackit beta server describe xxx --output-format 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 + } + + // Call API + req := buildRequest(ctx, model, apiClient) + resp, err := req.Execute() + if err != nil { + return fmt.Errorf("read server: %w", err) + } + + return outputResult(p, model, resp) + }, + } + configureFlags(cmd) + return cmd +} + +func configureFlags(cmd *cobra.Command) { + cmd.Flags().Bool(detailsFlag, false, "Show detailed information about server") +} + +func parseInput(p *print.Printer, cmd *cobra.Command, inputArgs []string) (*inputModel, error) { + serverId := inputArgs[0] + + globalFlags := globalflags.Parse(p, cmd) + if globalFlags.ProjectId == "" { + return nil, &errors.ProjectIdError{} + } + + model := inputModel{ + GlobalFlagModel: globalFlags, + ServerId: serverId, + Details: flags.FlagToBoolValue(p, cmd, detailsFlag), + } + + 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 *iaas.APIClient) iaas.ApiGetServerRequest { + req := apiClient.GetServer(ctx, model.ProjectId, model.ServerId) + + if model.Details { + req = req.Details(true) + } + + return req +} + +func outputResult(p *print.Printer, model *inputModel, server *iaas.Server) error { + outputFormat := model.OutputFormat + + switch outputFormat { + case print.JSONOutputFormat: + details, err := json.MarshalIndent(server, "", " ") + if err != nil { + return fmt.Errorf("marshal server: %w", err) + } + p.Outputln(string(details)) + + return nil + case print.YAMLOutputFormat: + details, err := yaml.MarshalWithOptions(server, yaml.IndentSequence(true)) + if err != nil { + return fmt.Errorf("marshal server: %w", err) + } + p.Outputln(string(details)) + + return nil + default: + table := tables.NewTable() + table.AddRow("ID", *server.Id) + table.AddSeparator() + table.AddRow("NAME", *server.Name) + table.AddSeparator() + table.AddRow("STATE", *server.Status) + table.AddSeparator() + table.AddRow("AVAILABILITY ZONE", *server.AvailabilityZone) + table.AddSeparator() + table.AddRow("BOOT VOLUME", *server.BootVolume.Id) + table.AddSeparator() + table.AddRow("POWER STATUS", *server.PowerStatus) + table.AddSeparator() + + if server.AffinityGroup != nil { + table.AddRow("AFFINITY GROUP", *server.AffinityGroup) + table.AddSeparator() + } + + if server.ImageId != nil { + table.AddRow("IMAGE", *server.ImageId) + table.AddSeparator() + } + + if server.KeypairName != nil { + table.AddRow("KEYPAIR", *server.KeypairName) + table.AddSeparator() + } + + if server.MachineType != nil { + table.AddRow("MACHINE TYPE", *server.MachineType) + table.AddSeparator() + } + + if server.Labels != nil && len(*server.Labels) > 0 { + labels := []string{} + for key, value := range *server.Labels { + labels = append(labels, fmt.Sprintf("%s: %s", key, value)) + } + table.AddRow("LABELS", strings.Join(labels, "\n")) + table.AddSeparator() + } + + if server.Volumes != nil && len(*server.Volumes) > 0 { + volumes := []string{} + volumes = append(volumes, *server.Volumes...) + table.AddRow("VOLUMES", strings.Join(volumes, "\n")) + table.AddSeparator() + } + + if model.Details { + if server.ServiceAccountMails != nil && len(*server.ServiceAccountMails) > 0 { + emails := []string{} + emails = append(emails, *server.ServiceAccountMails...) + table.AddRow("SERVICE ACCOUNTS", strings.Join(emails, "\n")) + table.AddSeparator() + } + + if server.Nics != nil && len(*server.Nics) > 0 { + nics := []string{} + for _, nic := range *server.Nics { + nics = append(nics, *nic.NicId) + } + table.AddRow("NICS", strings.Join(nics, "\n")) + table.AddSeparator() + } + } + + err := table.Display(p) + if err != nil { + return fmt.Errorf("render table: %w", err) + } + return nil + } +} diff --git a/internal/cmd/beta/server/describe/describe_test.go b/internal/cmd/beta/server/describe/describe_test.go new file mode 100644 index 000000000..0c8c2ff13 --- /dev/null +++ b/internal/cmd/beta/server/describe/describe_test.go @@ -0,0 +1,232 @@ +package describe + +import ( + "context" + "testing" + + "github.com/stackitcloud/stackit-cli/internal/pkg/globalflags" + "github.com/stackitcloud/stackit-cli/internal/pkg/print" + + "github.com/google/go-cmp/cmp" + "github.com/google/go-cmp/cmp/cmpopts" + "github.com/google/uuid" + "github.com/stackitcloud/stackit-sdk-go/services/iaas" +) + +var projectIdFlag = globalflags.ProjectIdFlag + +type testCtxKey struct{} + +var testCtx = context.WithValue(context.Background(), testCtxKey{}, "foo") +var testClient = &iaas.APIClient{} +var testProjectId = uuid.NewString() +var testServerId = uuid.NewString() + +func fixtureArgValues(mods ...func(argValues []string)) []string { + argValues := []string{ + testServerId, + } + 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, + detailsFlag: "true", + } + 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, + }, + ServerId: testServerId, + Details: true, + } + for _, mod := range mods { + mod(model) + } + return model +} + +func fixtureRequest(mods ...func(request *iaas.ApiGetServerRequest)) iaas.ApiGetServerRequest { + request := testClient.GetServer(testCtx, testProjectId, testServerId) + request = request.Details(true) + 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: "server id invalid 1", + argValues: []string{""}, + flagValues: fixtureFlagValues(), + isValid: false, + }, + { + description: "server id invalid 2", + argValues: []string{"invalid-uuid"}, + flagValues: fixtureFlagValues(), + isValid: false, + }, + { + description: "details flag false", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[detailsFlag] = "false" + }), + isValid: true, + expectedModel: fixtureInputModel(func(model *inputModel) { + model.Details = 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 input: %v", err) + } + + if !tt.isValid { + t.Fatalf("did not fail on invalid input") + } + diff := cmp.Diff(model, tt.expectedModel) + if diff != "" { + t.Fatalf("Data does not match: %s", diff) + } + }) + } +} + +func TestBuildRequest(t *testing.T) { + tests := []struct { + description string + model *inputModel + expectedRequest iaas.ApiGetServerRequest + }{ + { + 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/beta/server/list/list.go b/internal/cmd/beta/server/list/list.go new file mode 100644 index 000000000..af2e59655 --- /dev/null +++ b/internal/cmd/beta/server/list/list.go @@ -0,0 +1,177 @@ +package list + +import ( + "context" + "encoding/json" + "fmt" + + "github.com/goccy/go-yaml" + "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/projectname" + "github.com/stackitcloud/stackit-cli/internal/pkg/services/iaas/client" + "github.com/stackitcloud/stackit-cli/internal/pkg/tables" + "github.com/stackitcloud/stackit-sdk-go/services/iaas" + + "github.com/spf13/cobra" +) + +const ( + limitFlag = "limit" + labelSelectorFlag = "label-selector" +) + +type inputModel struct { + *globalflags.GlobalFlagModel + Limit *int64 + LabelSelector *string +} + +func NewCmd(p *print.Printer) *cobra.Command { + cmd := &cobra.Command{ + Use: "list", + Short: "Lists all servers of a project", + Long: "Lists all servers of a project.", + Args: args.NoArgs, + Example: examples.Build( + examples.NewExample( + `Lists all servers`, + "$ stackit beta server list", + ), + examples.NewExample( + `Lists all servers which contains the label xxx`, + "$ stackit beta server list --label-selector xxx", + ), + examples.NewExample( + `Lists all servers in JSON format`, + "$ stackit beta server list --output-format json", + ), + examples.NewExample( + `Lists up to 10 servers`, + "$ stackit beta server list --limit 10", + ), + ), + RunE: func(cmd *cobra.Command, _ []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 + } + + // Call API + req := buildRequest(ctx, model, apiClient) + resp, err := req.Execute() + if err != nil { + return fmt.Errorf("list servers: %w", err) + } + + if resp.Items == nil || len(*resp.Items) == 0 { + projectLabel, err := projectname.GetProjectName(ctx, p, cmd) + if err != nil { + p.Debug(print.ErrorLevel, "get project name: %v", err) + projectLabel = model.ProjectId + } + p.Info("No servers found for project %q\n", projectLabel) + return nil + } + + // Truncate output + items := *resp.Items + if model.Limit != nil && len(items) > int(*model.Limit) { + items = items[:*model.Limit] + } + + return outputResult(p, model.OutputFormat, items) + }, + } + configureFlags(cmd) + return cmd +} + +func configureFlags(cmd *cobra.Command) { + cmd.Flags().Int64(limitFlag, 0, "Maximum number of entries to list") + cmd.Flags().String(labelSelectorFlag, "", "Filter by label") +} + +func parseInput(p *print.Printer, cmd *cobra.Command) (*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, + LabelSelector: flags.FlagToStringPointer(p, cmd, labelSelectorFlag), + } + + 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 *iaas.APIClient) iaas.ApiListServersRequest { + req := apiClient.ListServers(ctx, model.ProjectId) + if model.LabelSelector != nil { + req = req.LabelSelector(*model.LabelSelector) + } + + return req +} + +func outputResult(p *print.Printer, outputFormat string, servers []iaas.Server) error { + switch outputFormat { + case print.JSONOutputFormat: + details, err := json.MarshalIndent(servers, "", " ") + if err != nil { + return fmt.Errorf("marshal server: %w", err) + } + p.Outputln(string(details)) + + return nil + case print.YAMLOutputFormat: + details, err := yaml.MarshalWithOptions(servers, yaml.IndentSequence(true)) + if err != nil { + return fmt.Errorf("marshal server: %w", err) + } + p.Outputln(string(details)) + + return nil + default: + table := tables.NewTable() + table.SetHeader("ID", "Name", "Status", "Availability Zones") + + for i := range servers { + server := servers[i] + table.AddRow(*server.Id, *server.Name, *server.Status, *server.AvailabilityZone) + } + + p.Outputln(table.Render()) + return nil + } +} diff --git a/internal/cmd/beta/server/list/list_test.go b/internal/cmd/beta/server/list/list_test.go new file mode 100644 index 000000000..47ed2e4f1 --- /dev/null +++ b/internal/cmd/beta/server/list/list_test.go @@ -0,0 +1,204 @@ +package list + +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/iaas" +) + +var projectIdFlag = globalflags.ProjectIdFlag + +type testCtxKey struct{} + +var testCtx = context.WithValue(context.Background(), testCtxKey{}, "foo") +var testClient = &iaas.APIClient{} +var testProjectId = uuid.NewString() +var testLabelSelector = "label" + +func fixtureFlagValues(mods ...func(flagValues map[string]string)) map[string]string { + flagValues := map[string]string{ + projectIdFlag: testProjectId, + limitFlag: "10", + labelSelectorFlag: testLabelSelector, + } + for _, mod := range mods { + mod(flagValues) + } + return flagValues +} + +func fixtureInputModel(mods ...func(model *inputModel)) *inputModel { + model := &inputModel{ + GlobalFlagModel: &globalflags.GlobalFlagModel{ + Verbosity: globalflags.VerbosityDefault, + ProjectId: testProjectId, + }, + Limit: utils.Ptr(int64(10)), + LabelSelector: utils.Ptr(testLabelSelector), + } + for _, mod := range mods { + mod(model) + } + return model +} + +func fixtureRequest(mods ...func(request *iaas.ApiListServersRequest)) iaas.ApiListServersRequest { + request := testClient.ListServers(testCtx, testProjectId) + request = request.LabelSelector(testLabelSelector) + 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: "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, + }, + { + description: "label selector empty", + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[labelSelectorFlag] = "" + }), + isValid: true, + expectedModel: fixtureInputModel(func(model *inputModel) { + model.LabelSelector = utils.Ptr("") + }), + }, + } + + 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) + } + + model, err := parseInput(p, cmd) + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("error parsing input: %v", err) + } + + if !tt.isValid { + t.Fatalf("did not fail on invalid input") + } + diff := cmp.Diff(model, tt.expectedModel) + if diff != "" { + t.Fatalf("Data does not match: %s", diff) + } + }) + } +} + +func TestBuildRequest(t *testing.T) { + tests := []struct { + description string + model *inputModel + expectedRequest iaas.ApiListServersRequest + }{ + { + 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/beta/server/server.go b/internal/cmd/beta/server/server.go index 4a0d70559..d3debf967 100644 --- a/internal/cmd/beta/server/server.go +++ b/internal/cmd/beta/server/server.go @@ -3,6 +3,11 @@ package server import ( "github.com/stackitcloud/stackit-cli/internal/cmd/beta/server/backup" "github.com/stackitcloud/stackit-cli/internal/cmd/beta/server/command" + "github.com/stackitcloud/stackit-cli/internal/cmd/beta/server/create" + "github.com/stackitcloud/stackit-cli/internal/cmd/beta/server/delete" + "github.com/stackitcloud/stackit-cli/internal/cmd/beta/server/describe" + "github.com/stackitcloud/stackit-cli/internal/cmd/beta/server/list" + "github.com/stackitcloud/stackit-cli/internal/cmd/beta/server/update" "github.com/stackitcloud/stackit-cli/internal/pkg/args" "github.com/stackitcloud/stackit-cli/internal/pkg/print" "github.com/stackitcloud/stackit-cli/internal/pkg/utils" @@ -25,4 +30,9 @@ func NewCmd(p *print.Printer) *cobra.Command { func addSubcommands(cmd *cobra.Command, p *print.Printer) { cmd.AddCommand(backup.NewCmd(p)) cmd.AddCommand(command.NewCmd(p)) + cmd.AddCommand(create.NewCmd(p)) + cmd.AddCommand(delete.NewCmd(p)) + cmd.AddCommand(describe.NewCmd(p)) + cmd.AddCommand(list.NewCmd(p)) + cmd.AddCommand(update.NewCmd(p)) } diff --git a/internal/cmd/beta/server/update/update.go b/internal/cmd/beta/server/update/update.go new file mode 100644 index 000000000..127cb67ca --- /dev/null +++ b/internal/cmd/beta/server/update/update.go @@ -0,0 +1,168 @@ +package update + +import ( + "context" + "encoding/json" + "fmt" + + "github.com/goccy/go-yaml" + + "github.com/spf13/cobra" + "github.com/stackitcloud/stackit-cli/internal/pkg/args" + cliErr "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/iaas/client" + iaasUtils "github.com/stackitcloud/stackit-cli/internal/pkg/services/iaas/utils" + "github.com/stackitcloud/stackit-cli/internal/pkg/utils" + "github.com/stackitcloud/stackit-sdk-go/services/iaas" +) + +const ( + serverIdArg = "SERVER_ID" + + nameFlag = "name" + labelFlag = "labels" +) + +type inputModel struct { + *globalflags.GlobalFlagModel + ServerId string + Name *string + Labels *map[string]string +} + +func NewCmd(p *print.Printer) *cobra.Command { + cmd := &cobra.Command{ + Use: "update", + Short: "Updates a server", + Long: "Updates a server.", + Args: args.SingleArg(serverIdArg, utils.ValidateUUID), + Example: examples.Build( + examples.NewExample( + `Update server with ID "xxx" with new name "server-1-new"`, + `$ stackit beta server update xxx --name server-1-new`, + ), + examples.NewExample( + `Update server with ID "xxx" with new name "server-1-new" and label(s)`, + `$ stackit beta server update xxx --name server-1-new --labels key=value,foo=bar`, + ), + ), + 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 + } + + serverLabel, err := iaasUtils.GetServerName(ctx, apiClient, model.ProjectId, model.ServerId) + if err != nil { + p.Debug(print.ErrorLevel, "get server name: %v", err) + serverLabel = model.ServerId + } + + if !model.AssumeYes { + prompt := fmt.Sprintf("Are you sure you want to update server %q?", serverLabel) + err = p.PromptForConfirmation(prompt) + if err != nil { + return err + } + } + + // Call API + req := buildRequest(ctx, model, apiClient) + resp, err := req.Execute() + if err != nil { + return fmt.Errorf("update server: %w", err) + } + + return outputResult(p, model, serverLabel, resp) + }, + } + configureFlags(cmd) + return cmd +} + +func configureFlags(cmd *cobra.Command) { + cmd.Flags().StringP(nameFlag, "n", "", "Server name") + cmd.Flags().StringToString(labelFlag, nil, "Labels are key-value string pairs which can be attached to a server. E.g. '--labels key1=value1,key2=value2,...'") +} + +func parseInput(p *print.Printer, cmd *cobra.Command, inputArgs []string) (*inputModel, error) { + serverId := inputArgs[0] + + globalFlags := globalflags.Parse(p, cmd) + if globalFlags.ProjectId == "" { + return nil, &cliErr.ProjectIdError{} + } + + model := inputModel{ + GlobalFlagModel: globalFlags, + Name: flags.FlagToStringPointer(p, cmd, nameFlag), + ServerId: serverId, + Labels: flags.FlagToStringToStringPointer(p, cmd, labelFlag), + } + + 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 *iaas.APIClient) iaas.ApiUpdateServerRequest { + req := apiClient.UpdateServer(ctx, model.ProjectId, model.ServerId) + + var labelsMap *map[string]interface{} + if model.Labels != nil && len(*model.Labels) > 0 { + // convert map[string]string to map[string]interface{} + labelsMap = utils.Ptr(map[string]interface{}{}) + for k, v := range *model.Labels { + (*labelsMap)[k] = v + } + } + + payload := iaas.UpdateServerPayload{ + Name: model.Name, + Labels: labelsMap, + } + + return req.UpdateServerPayload(payload) +} + +func outputResult(p *print.Printer, model *inputModel, serverLabel string, server *iaas.Server) error { + switch model.OutputFormat { + case print.JSONOutputFormat: + details, err := json.MarshalIndent(server, "", " ") + if err != nil { + return fmt.Errorf("marshal server: %w", err) + } + p.Outputln(string(details)) + + return nil + case print.YAMLOutputFormat: + details, err := yaml.MarshalWithOptions(server, yaml.IndentSequence(true)) + if err != nil { + return fmt.Errorf("marshal server: %w", err) + } + p.Outputln(string(details)) + + return nil + default: + p.Outputf("Updated server %q.\n", serverLabel) + return nil + } +} diff --git a/internal/cmd/beta/server/update/update_test.go b/internal/cmd/beta/server/update/update_test.go new file mode 100644 index 000000000..f06cbd6a5 --- /dev/null +++ b/internal/cmd/beta/server/update/update_test.go @@ -0,0 +1,252 @@ +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/iaas" +) + +var projectIdFlag = globalflags.ProjectIdFlag + +type testCtxKey struct{} + +var testCtx = context.WithValue(context.Background(), testCtxKey{}, "foo") +var testClient = &iaas.APIClient{} + +var testProjectId = uuid.NewString() +var testServerId = uuid.NewString() + +func fixtureArgValues(mods ...func(argValues []string)) []string { + argValues := []string{ + testServerId, + } + for _, mod := range mods { + mod(argValues) + } + return argValues +} + +func fixtureFlagValues(mods ...func(flagValues map[string]string)) map[string]string { + flagValues := map[string]string{ + nameFlag: "example-server-name", + projectIdFlag: testProjectId, + labelFlag: "key=value", + } + 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, + }, + Name: utils.Ptr("example-server-name"), + ServerId: testServerId, + Labels: utils.Ptr(map[string]string{ + "key": "value", + }), + } + for _, mod := range mods { + mod(model) + } + return model +} + +func fixtureRequest(mods ...func(request *iaas.ApiUpdateServerRequest)) iaas.ApiUpdateServerRequest { + request := testClient.UpdateServer(testCtx, testProjectId, testServerId) + request = request.UpdateServerPayload(fixturePayload()) + for _, mod := range mods { + mod(&request) + } + return request +} + +func fixturePayload(mods ...func(payload *iaas.UpdateServerPayload)) iaas.UpdateServerPayload { + payload := iaas.UpdateServerPayload{ + Name: utils.Ptr("example-server-name"), + Labels: utils.Ptr(map[string]interface{}{ + "key": "value", + }), + } + for _, mod := range mods { + mod(&payload) + } + return payload +} + +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: "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: "server id invalid 1", + argValues: []string{}, + flagValues: fixtureFlagValues(), + isValid: false, + }, + { + description: "server id invalid 2", + argValues: []string{"invalid-uuid"}, + flagValues: fixtureFlagValues(), + isValid: false, + }, + { + description: "use name", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[nameFlag] = "example-server-name" + }), + isValid: true, + expectedModel: fixtureInputModel(func(model *inputModel) { + model.Name = utils.Ptr("example-server-name") + }), + }, + { + description: "use labels", + argValues: fixtureArgValues(), + flagValues: fixtureFlagValues(func(flagValues map[string]string) { + flagValues[labelFlag] = "key=value" + }), + isValid: true, + expectedModel: fixtureInputModel(func(model *inputModel) { + model.Labels = &map[string]string{ + "key": "value", + } + }), + }, + } + + 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.ValidateArgs(tt.argValues) + if err != nil { + if !tt.isValid { + return + } + t.Fatalf("error validating args: %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 iaas.ApiUpdateServerRequest + }{ + { + 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/pkg/errors/errors.go b/internal/pkg/errors/errors.go index 92af7ab83..0f37aa617 100644 --- a/internal/pkg/errors/errors.go +++ b/internal/pkg/errors/errors.go @@ -138,8 +138,48 @@ The profile name can only contain lowercase letters, numbers, and "-" and cannot To enable it, run: $ stackit %s enable` + + IAAS_SERVER_MISSING_VOLUME_SIZE = `The "boot-volume-size" flag must be provided when "boot-volume-source-type" is "image".` + + IAAS_SERVER_MISSING_VOLUME_ID = `The "boot-volume-source-id" flag must be provided together with "boot-volume-source-type" flag.` + + IAAS_SERVER_MISSING_VOLUME_TYPE = `The "boot-volume-source-type" flag must be provided together with "boot-volume-source-id" flag.` + + IAAS_SERVER_MISSING_IMAGE_OR_VOLUME_FLAGS = `Either "image-id" or "boot-volume-source-type" and "boot-volume-source-id" flags must be provided.` ) +type ServerCreateMissingVolumeIdError struct { + Cmd *cobra.Command +} + +func (e *ServerCreateMissingVolumeIdError) Error() string { + return IAAS_SERVER_MISSING_VOLUME_ID +} + +type ServerCreateMissingVolumeTypeError struct { + Cmd *cobra.Command +} + +func (e *ServerCreateMissingVolumeTypeError) Error() string { + return IAAS_SERVER_MISSING_VOLUME_TYPE +} + +type ServerCreateMissingFlagsError struct { + Cmd *cobra.Command +} + +func (e *ServerCreateMissingFlagsError) Error() string { + return IAAS_SERVER_MISSING_IMAGE_OR_VOLUME_FLAGS +} + +type ServerCreateError struct { + Cmd *cobra.Command +} + +func (e *ServerCreateError) Error() string { + return IAAS_SERVER_MISSING_VOLUME_SIZE +} + type ProjectIdError struct{} func (e *ProjectIdError) Error() string { diff --git a/internal/pkg/services/iaas/utils/utils.go b/internal/pkg/services/iaas/utils/utils.go index 9e7d79510..c522633d5 100644 --- a/internal/pkg/services/iaas/utils/utils.go +++ b/internal/pkg/services/iaas/utils/utils.go @@ -8,6 +8,7 @@ import ( ) type IaaSClient interface { + GetServerExecute(ctx context.Context, projectId, serverId string) (*iaas.Server, error) GetVolumeExecute(ctx context.Context, projectId, volumeId string) (*iaas.Volume, error) GetNetworkExecute(ctx context.Context, projectId, networkId string) (*iaas.Network, error) GetNetworkAreaExecute(ctx context.Context, organizationId, areaId string) (*iaas.NetworkArea, error) @@ -15,6 +16,14 @@ type IaaSClient interface { GetNetworkAreaRangeExecute(ctx context.Context, organizationId, areaId, networkRangeId string) (*iaas.NetworkRange, error) } +func GetServerName(ctx context.Context, apiClient IaaSClient, projectId, serverId string) (string, error) { + resp, err := apiClient.GetServerExecute(ctx, projectId, serverId) + if err != nil { + return "", fmt.Errorf("get server: %w", err) + } + return *resp.Name, nil +} + func GetVolumeName(ctx context.Context, apiClient IaaSClient, projectId, volumeId string) (string, error) { resp, err := apiClient.GetVolumeExecute(ctx, projectId, volumeId) if err != nil { diff --git a/internal/pkg/services/iaas/utils/utils_test.go b/internal/pkg/services/iaas/utils/utils_test.go index 9c0e41ac1..aeda9d6d3 100644 --- a/internal/pkg/services/iaas/utils/utils_test.go +++ b/internal/pkg/services/iaas/utils/utils_test.go @@ -11,6 +11,8 @@ import ( ) type IaaSClientMocked struct { + GetServerFails bool + GetServerResp *iaas.Server GetVolumeFails bool GetVolumeResp *iaas.Volume GetNetworkFails bool @@ -23,6 +25,13 @@ type IaaSClientMocked struct { GetNetworkAreaRangeResp *iaas.NetworkRange } +func (m *IaaSClientMocked) GetServerExecute(_ context.Context, _, _ string) (*iaas.Server, error) { + if m.GetServerFails { + return nil, fmt.Errorf("could not get server") + } + return m.GetServerResp, nil +} + func (m *IaaSClientMocked) GetVolumeExecute(_ context.Context, _, _ string) (*iaas.Volume, error) { if m.GetVolumeFails { return nil, fmt.Errorf("could not get volume") @@ -58,6 +67,52 @@ func (m *IaaSClientMocked) GetNetworkAreaRangeExecute(_ context.Context, _, _, _ return m.GetNetworkAreaRangeResp, nil } +func TestGetServerName(t *testing.T) { + type args struct { + getInstanceFails bool + getInstanceResp *iaas.Server + } + tests := []struct { + name string + args args + want string + wantErr bool + }{ + { + name: "base", + args: args{ + getInstanceResp: &iaas.Server{ + Name: utils.Ptr("test"), + }, + }, + want: "test", + }, + { + name: "get server fails", + args: args{ + getInstanceFails: true, + }, + wantErr: true, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + m := &IaaSClientMocked{ + GetServerFails: tt.args.getInstanceFails, + GetServerResp: tt.args.getInstanceResp, + } + got, err := GetServerName(context.Background(), m, "", "") + if (err != nil) != tt.wantErr { + t.Errorf("GetServerName() error = %v, wantErr %v", err, tt.wantErr) + return + } + if got != tt.want { + t.Errorf("GetServerName() = %v, want %v", got, tt.want) + } + }) + } +} + func TestGetVolumeName(t *testing.T) { type args struct { getInstanceFails bool