-
Notifications
You must be signed in to change notification settings - Fork 152
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(block): add volume wait command (#4434)
- Loading branch information
Showing
5 changed files
with
138 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
25 changes: 25 additions & 0 deletions
25
cmd/scw/testdata/test-all-usage-block-volume-wait-usage.golden
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 | ||
| 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ | ||
| Wait for volume to reach a stable state. This is similar to using --wait flag on other action commands, but without requiring a new action on the volume. | ||
|
|
||
| USAGE: | ||
| scw block volume wait <volume-id ...> [arg=value ...] | ||
|
|
||
| EXAMPLES: | ||
| Wait for a volume to be available | ||
| scw block volume wait 11111111-1111-1111-1111-111111111111 terminal-status=available | ||
|
|
||
| ARGS: | ||
| [timeout=5m0s] Timeout of the wait | ||
| volume-id ID of the volume affected by the action. | ||
| [terminal-status] Expected terminal status, will wait until this status is reached. (unknown_status | creating | available | in_use | deleting | deleted | resizing | error | snapshotting | locked | updating) | ||
| [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3) | ||
|
|
||
| FLAGS: | ||
| -h, --help help for wait | ||
|
|
||
| GLOBAL FLAGS: | ||
| -c, --config string The path to the config file | ||
| -D, --debug Enable debug mode | ||
| -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") | ||
| -p, --profile string The config profile to use |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| package block | ||
|
|
||
| import ( | ||
| "context" | ||
| "reflect" | ||
| "time" | ||
|
|
||
| "github.com/scaleway/scaleway-cli/v2/core" | ||
| block "github.com/scaleway/scaleway-sdk-go/api/block/v1alpha1" | ||
| "github.com/scaleway/scaleway-sdk-go/api/instance/v1" | ||
| "github.com/scaleway/scaleway-sdk-go/scw" | ||
| ) | ||
|
|
||
| const ( | ||
| volumeActionTimeout = 5 * time.Minute | ||
| ) | ||
|
|
||
| type volumeWaitRequest struct { | ||
| Zone scw.Zone | ||
| VolumeID string | ||
| Timeout time.Duration | ||
|
|
||
| TerminalStatus *block.VolumeStatus | ||
| } | ||
|
|
||
| func volumeWaitCommand() *core.Command { | ||
| terminalStatus := block.VolumeStatus("").Values() | ||
| terminalStatusStrings := make([]string, len(terminalStatus)) | ||
| for k, v := range terminalStatus { | ||
| terminalStatusStrings[k] = v.String() | ||
| } | ||
|
|
||
| return &core.Command{ | ||
| Short: `Wait for volume to reach a stable state`, | ||
| Long: `Wait for volume to reach a stable state. This is similar to using --wait flag on other action commands, but without requiring a new action on the volume.`, | ||
| Namespace: "block", | ||
| Resource: "volume", | ||
| Verb: "wait", | ||
| Groups: []string{"workflow"}, | ||
| ArgsType: reflect.TypeOf(volumeWaitRequest{}), | ||
| Run: func(ctx context.Context, argsI interface{}) (i interface{}, err error) { | ||
| args := argsI.(*volumeWaitRequest) | ||
|
|
||
| return block.NewAPI(core.ExtractClient(ctx)).WaitForVolume(&block.WaitForVolumeRequest{ | ||
| Zone: args.Zone, | ||
| VolumeID: args.VolumeID, | ||
| Timeout: scw.TimeDurationPtr(args.Timeout), | ||
| RetryInterval: core.DefaultRetryInterval, | ||
|
|
||
| TerminalStatus: args.TerminalStatus, | ||
| }) | ||
| }, | ||
| ArgSpecs: core.ArgSpecs{ | ||
| core.WaitTimeoutArgSpec(volumeActionTimeout), | ||
| { | ||
| Name: "volume-id", | ||
| Short: `ID of the volume affected by the action.`, | ||
| Required: true, | ||
| Positional: true, | ||
| }, | ||
| { | ||
| Name: "terminal-status", | ||
| Short: `Expected terminal status, will wait until this status is reached.`, | ||
| EnumValues: terminalStatusStrings, | ||
| }, | ||
| core.ZoneArgSpec((*instance.API)(nil).Zones()...), | ||
| }, | ||
| Examples: []*core.Example{ | ||
| { | ||
| Short: "Wait for a volume to be available", | ||
| ArgsJSON: `{"volume_id": "11111111-1111-1111-1111-111111111111", "terminal_status": "available"}`, | ||
| }, | ||
| }, | ||
| } | ||
| } |