feat(instance): add snapshot update (#3079)

Author: Codelax

cmd/scw/testdata/test-all-usage-instance-snapshot-update-usage.golden

@@ -0,0 +1,22 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Update a snapshot
+
+USAGE:
+  scw instance snapshot update <snapshot-id ...> [arg=value ...]
+
+ARGS:
+  snapshot-id       UUID of the snapshot.
+  [name]            Name of the snapshot.
+  [tags.{index}]    Tags of the snapshot.
+  [zone=fr-par-1]   Zone to target. If none is passed will use default zone from the config
+
+FLAGS:
+  -h, --help   help for update
+  -w, --wait   wait until the snapshot is ready
+
+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

cmd/scw/testdata/test-all-usage-instance-snapshot-usage.golden

@@ -25,6 +25,7 @@ AVAILABLE COMMANDS:
   export      Export a snapshot
   get         Get a snapshot
   list        List snapshots
+  update      Update a snapshot
 
 WORKFLOW COMMANDS:
   wait        Wait for snapshot to reach a stable state

docs/commands/instance.md

@@ -76,6 +76,7 @@ Instance API.
   - [Export a snapshot](#export-a-snapshot)
   - [Get a snapshot](#get-a-snapshot)
   - [List snapshots](#list-snapshots)
+  - [Update a snapshot](#update-a-snapshot)
   - [Wait for snapshot to reach a stable state](#wait-for-snapshot-to-reach-a-stable-state)
 - [User data management commands](#user-data-management-commands)
   - [Delete user data](#delete-user-data)
@@ -2527,6 +2528,28 @@ scw instance snapshot list zone=fr-par-1
 
 
 
+### Update a snapshot
+
+
+
+**Usage:**
+
+```
+scw instance snapshot update <snapshot-id ...> [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| snapshot-id | Required | UUID of the snapshot. |
+| name |  | Name of the snapshot. |
+| tags.{index} |  | Tags of the snapshot. |
+| zone | Default: `fr-par-1` | Zone to target. If none is passed will use default zone from the config |
+
+
+
 ### Wait for snapshot to reach a stable state
 
 Wait for snapshot to reach a stable state. This is similar to using --wait flag on other action commands, but without requiring a new action on the snapshot.

internal/namespaces/instance/v1/custom.go

@@ -109,6 +109,7 @@ func GetCommands() *core.Commands {
 	cmds.MustFind("instance", "snapshot", "list").Override(snapshotListBuilder)
 	cmds.Merge(core.NewCommands(
 		snapshotWaitCommand(),
+		snapshotUpdateCommand(),
 	))
 
 	//

internal/namespaces/instance/v1/custom_snapshot.go

@@ -142,3 +142,44 @@ func snapshotWaitCommand() *core.Command {
 		},
 	}
 }
+
+func snapshotUpdateCommand() *core.Command {
+	return &core.Command{
+		Short:     `Update a snapshot`,
+		Namespace: "instance",
+		Resource:  "snapshot",
+		Verb:      "update",
+		ArgsType:  reflect.TypeOf(instance.UpdateSnapshotRequest{}),
+		ArgSpecs: core.ArgSpecs{
+			{
+				Name:       "snapshot-id",
+				Short:      "UUID of the snapshot.",
+				Required:   true,
+				Positional: true,
+			},
+			{
+				Name:  "name",
+				Short: "Name of the snapshot.",
+			},
+			{
+				Name:  "tags.{index}",
+				Short: "Tags of the snapshot.",
+			},
+			core.ZoneArgSpec(),
+		},
+		WaitFunc: func(ctx context.Context, argsI, respI interface{}) (interface{}, error) {
+			snapshot := respI.(*instance.UpdateSnapshotResponse).Snapshot
+			api := instance.NewAPI(core.ExtractClient(ctx))
+			return api.WaitForSnapshot(&instance.WaitForSnapshotRequest{
+				SnapshotID:    snapshot.ID,
+				Zone:          snapshot.Zone,
+				Timeout:       scw.TimeDurationPtr(snapshotActionTimeout),
+				RetryInterval: core.DefaultRetryInterval,
+			})
+		},
+		Run: func(ctx context.Context, argsI interface{}) (i interface{}, err error) {
+			api := instance.NewAPI(core.ExtractClient(ctx))
+			return api.UpdateSnapshot(argsI.(*instance.UpdateSnapshotRequest))
+		},
+	}
+}

internal/namespaces/instance/v1/custom_snapshot_test.go

@@ -0,0 +1,60 @@
+package instance
+
+import (
+	"testing"
+
+	"github.com/alecthomas/assert"
+	"github.com/scaleway/scaleway-cli/v2/internal/core"
+	"github.com/scaleway/scaleway-sdk-go/api/instance/v1"
+)
+
+func Test_UpdateSnapshot(t *testing.T) {
+	t.Run("Simple", func(t *testing.T) {
+		t.Run("Change tags", core.Test(&core.TestConfig{
+			Commands: GetCommands(),
+			BeforeFunc: core.BeforeFuncCombine(
+				createVolume("Volume", 10, instance.VolumeVolumeTypeBSSD),
+				core.ExecStoreBeforeCmd("CreateSnapshot", "scw instance snapshot create volume-id={{ .Volume.ID }} name=cli-test-snapshot-update-tags tags.0=foo tags.1=bar"),
+			),
+			Cmd: "scw instance snapshot update -w {{ .CreateSnapshot.Snapshot.ID }} tags.0=bar tags.1=foo",
+			Check: core.TestCheckCombine(
+				core.TestCheckGolden(),
+				core.TestCheckExitCode(0),
+				func(t *testing.T, ctx *core.CheckFuncCtx) {
+					snapshot := ctx.Result.(*instance.Snapshot)
+					assert.Equal(t, snapshot.Name, "cli-test-snapshot-update-tags")
+					assert.Len(t, snapshot.Tags, 2)
+					assert.Equal(t, snapshot.Tags[0], "bar")
+					assert.Equal(t, snapshot.Tags[1], "foo")
+				},
+			),
+			AfterFunc: core.AfterFuncCombine(
+				deleteSnapshot("CreateSnapshot"),
+				deleteVolume("Volume"),
+			),
+		}))
+		t.Run("Change name", core.Test(&core.TestConfig{
+			Commands: GetCommands(),
+			BeforeFunc: core.BeforeFuncCombine(
+				createVolume("Volume", 10, instance.VolumeVolumeTypeBSSD),
+				core.ExecStoreBeforeCmd("CreateSnapshot", "scw instance snapshot create volume-id={{ .Volume.ID }} name=cli-test-snapshot-update-name tags.0=foo tags.1=bar"),
+			),
+			Cmd: "scw instance snapshot update -w {{ .CreateSnapshot.Snapshot.ID }} name=cli-test-snapshot-update-name-updated",
+			Check: core.TestCheckCombine(
+				core.TestCheckGolden(),
+				core.TestCheckExitCode(0),
+				func(t *testing.T, ctx *core.CheckFuncCtx) {
+					snapshot := ctx.Result.(*instance.Snapshot)
+					assert.Equal(t, snapshot.Name, "cli-test-snapshot-update-name-updated")
+					assert.Len(t, snapshot.Tags, 2)
+					assert.Equal(t, snapshot.Tags[0], "foo")
+					assert.Equal(t, snapshot.Tags[1], "bar")
+				},
+			),
+			AfterFunc: core.AfterFuncCombine(
+				deleteSnapshot("CreateSnapshot"),
+				deleteVolume("Volume"),
+			),
+		}))
+	})
+}

internal/namespaces/instance/v1/helpers_test.go

@@ -62,7 +62,7 @@ func createVolume(metaKey string, sizeInGb int, volumeType instance.VolumeVolume
 }
 
 // deleteVolume deletes a volume previously registered in the context Meta at metaKey.
-func deleteVolume(metaKey string) core.AfterFunc {
+func deleteVolume(metaKey string) core.AfterFunc { //nolint: unparam
 	return core.ExecAfterCmd("scw instance volume delete {{ ." + metaKey + ".ID }}")
 }