feat(server): add wait flag to create and stop commands

Author: kangasta

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 ### Added
 - Add `zone list` command that lists available zones.
+- Add `--wait` flag to `server create` and `server stop` commands to wait until server is in `started` and `stopped` state, respectively.
 
 ### Fixed
 - Do not display usage if execution fails because of missing credentials

internal/commands/server/create.go

@@ -30,6 +30,7 @@ func CreateCommand() commands.Command {
 			"create",
 			"Create a server",
 			"upctl server create --title myapp --zone fi-hel1 --hostname myapp --password-delivery email",
+			"upctl server create --wait --title myapp --zone fi-hel1 --hostname myapp --password-delivery email",
 			"upctl server create --title \"My Server\" --zone fi-hel1 --hostname myapp --password-delivery email",
 			"upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --plan 2xCPU-4GB",
 			"upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --plan custom --cores 2 --memory 4096",
@@ -243,6 +244,7 @@ type createCommand struct {
 	metadata       config.OptionalBoolean
 	remoteAccess   config.OptionalBoolean
 	createPassword config.OptionalBoolean
+	wait           config.OptionalBoolean
 }
 
 // InitCommand implements Command.InitCommand
@@ -275,6 +277,7 @@ func (s *createCommand) InitCommand() {
 	fs.StringVar(&s.params.UserData, "user-data", def.UserData, "Defines URL for a server setup script, or the script body itself.")
 	fs.StringVar(&s.params.username, "username", def.username, "Admin account username.")
 	fs.StringVar(&s.params.VideoModel, "video-model", def.VideoModel, "Video interface model of the server. Available: vga, cirrus")
+	config.AddToggleFlag(fs, &s.wait, "wait", false, "Wait for server to be in started state before returning.")
 	fs.StringVar(&s.params.Zone, "zone", def.Zone, "Zone where to create the server.")
 	// fs.BoolVar(&s.params.firewall, "firewall", def.firewall, "Enables the firewall. You can manage firewall rules with the firewall command.")
 	// fs.BoolVar(&s.params.metadata, "metadata", def.metadata, "Enable metadata service.")
@@ -369,6 +372,13 @@ func (s *createCommand) ExecuteWithoutArguments(exec commands.Executor) (output.
 	logline.SetMessage(fmt.Sprintf("%s: request sent", msg))
 	logline.MarkDone()
 
+	if s.wait.Value() {
+		logline := exec.NewLogEntry(msg)
+		if err := waitForServerState(res.UUID, upcloud.ServerStateStarted, serverSvc, logline); err != nil {
+			return nil, err
+		}
+	}
+
 	return output.MarshaledWithHumanDetails{Value: res, Details: []output.DetailRow{
 		{Title: "UUID", Value: res.UUID, Colour: ui.DefaultUUUIDColours},
 		{Title: "IP Addresses", Value: res, Format: formatIPAddresses},

internal/commands/server/server.go

@@ -1,10 +1,13 @@
 package server
 
 import (
+	"fmt"
 	"time"
 
 	"github.com/UpCloudLtd/upcloud-cli/internal/commands"
+	"github.com/UpCloudLtd/upcloud-cli/internal/ui"
 	"github.com/UpCloudLtd/upcloud-go-api/v4/upcloud/request"
+	"github.com/UpCloudLtd/upcloud-go-api/v4/upcloud/service"
 )
 
 const (
@@ -28,20 +31,23 @@ type serverCommand struct {
 	*commands.BaseCommand
 }
 
-// TODO: re-add when wait flag is refactored
-/*func serverStateWaiter(uuid, state, msg string, service service.Server, logline *ui.LogEntry) func() error {
-	return func() error {
-		for {
-			time.Sleep(100 * time.Millisecond)
-			details, err := service.GetServerDetails(&request.GetServerDetailsRequest{UUID: uuid})
-			if err != nil {
-				return err
-			}
-			if details.State == state {
-				return nil
-			}
-			logline.SetMessage(fmt.Sprintf("%s: waiting to start (%v)", msg, details.State))
-		}
+func waitForServerState(uuid, state string, service service.Server, logline *ui.LogEntry) error {
+	msg := fmt.Sprintf("Waiting for server %s to be in %s state", uuid, state)
+	logline.SetMessage(fmt.Sprintf("%s: polling", msg))
+	logline.StartedNow()
+
+	if _, err := service.WaitForServerState(&request.WaitForServerStateRequest{
+		UUID:         uuid,
+		DesiredState: state,
+		Timeout:      5 * time.Minute,
+	}); err != nil {
+		logline.SetMessage(ui.LiveLogEntryErrorColours.Sprintf("%s: failed (%v)", msg, err.Error()))
+		logline.SetDetails(err.Error(), "error: ")
+		return err
 	}
+
+	logline.SetMessage(fmt.Sprintf("%s: done", msg))
+	logline.MarkDone()
+
+	return nil
 }
-*/

internal/commands/server/start.go

@@ -53,7 +53,7 @@ func (s *startCommand) Execute(exec commands.Executor, uuid string) (output.Outp
 		return nil, err
 	}
 
-	logline.SetMessage(fmt.Sprintf("%s: request sent", msg))
+	logline.SetMessage(fmt.Sprintf("%s: done", msg))
 	logline.MarkDone()
 
 	return output.OnlyMarshaled{Value: res}, nil

internal/commands/server/stop.go

@@ -5,10 +5,12 @@ import (
 
 	"github.com/UpCloudLtd/upcloud-cli/internal/commands"
 	"github.com/UpCloudLtd/upcloud-cli/internal/completion"
+	"github.com/UpCloudLtd/upcloud-cli/internal/config"
 	"github.com/UpCloudLtd/upcloud-cli/internal/output"
 	"github.com/UpCloudLtd/upcloud-cli/internal/resolver"
 	"github.com/UpCloudLtd/upcloud-cli/internal/ui"
 
+	"github.com/UpCloudLtd/upcloud-go-api/v4/upcloud"
 	"github.com/UpCloudLtd/upcloud-go-api/v4/upcloud/request"
 	"github.com/spf13/pflag"
 )
@@ -22,13 +24,15 @@ func StopCommand() commands.Command {
 			"upctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8",
 			"upctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0",
 			"upctl server stop my_server",
+			"upctl server stop --wait my_server",
 		),
 	}
 }
 
 type stopCommand struct {
 	*commands.BaseCommand
 	StopType string
+	wait     config.OptionalBoolean
 	resolver.CachingServer
 	completion.Server
 }
@@ -38,6 +42,7 @@ func (s *stopCommand) InitCommand() {
 	//XXX: findout what to do with risky params (timeout actions)
 	flags := &pflag.FlagSet{}
 	flags.StringVar(&s.StopType, "type", defaultStopType, "The type of stop operation. Available: soft, hard")
+	config.AddToggleFlag(flags, &s.wait, "wait", false, "Wait for server to be in stopped state before returning.")
 	s.AddFlags(flags)
 }
 
@@ -63,5 +68,12 @@ func (s *stopCommand) Execute(exec commands.Executor, uuid string) (output.Outpu
 	logline.SetMessage(fmt.Sprintf("%s: request sent", msg))
 	logline.MarkDone()
 
+	if s.wait.Value() {
+		logline := exec.NewLogEntry(msg)
+		if err := waitForServerState(uuid, upcloud.ServerStateStopped, svc, logline); err != nil {
+			return nil, err
+		}
+	}
+
 	return output.OnlyMarshaled{Value: res}, nil
 }