feat(registry): add configurable timeout for tag deletion (scaleway#5098)

Author: Mia-Cross

cmd/scw/testdata/test-all-usage-registry-tag-delete-usage.golden

@@ -7,6 +7,7 @@ USAGE:
 
 ARGS:
   tag-id            UUID of the tag
+  [timeout]         Maximum time to handle the request
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 DEPRECATED ARGS:

core/testing.go

@@ -679,6 +679,14 @@ func ExecBeforeCmdArgs(args []string) BeforeFunc {
 	}
 }
 
+// ExecBeforeCmdWithResult executes the given command and returns its result.
+func ExecBeforeCmdWithResult(ctx *BeforeFuncCtx, cmd string) any {
+	args := cmdToArgs(ctx.Meta, cmd)
+	ctx.Logger.Debugf("ExecBeforeCmd: args=%s\n", args)
+
+	return ctx.ExecuteCmd(args)
+}
+
 // ExecAfterCmd executes the given before command.
 func ExecAfterCmd(cmd string) AfterFunc {
 	return func(ctx *AfterFuncCtx) error {

docs/commands/registry.md

@@ -332,6 +332,7 @@ scw registry tag delete <tag-id ...> [arg=value ...]
 | Name |   | Description |
 |------|---|-------------|
 | tag-id | Required | UUID of the tag |
+| timeout |  | Maximum time to handle the request |
 | ~~force~~ | Deprecated | If two tags share the same digest the deletion will fail unless this parameter is set to true (deprecated) |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 

internal/namespaces/registry/v1/custom.go

@@ -27,6 +27,7 @@ func GetCommands() *core.Commands {
 		registryInstallDockerHelperCommand(),
 	))
 
+	cmds.MustFind("registry", "tag", "delete").Override(tagDeleteBuilder)
 	cmds.MustFind("registry", "tag", "get").Override(tagGetBuilder)
 	cmds.MustFind("registry", "tag", "list").Override(tagListBuilder)
 

internal/namespaces/registry/v1/custom_tag.go

@@ -3,12 +3,15 @@ package registry
 import (
 	"context"
 	"fmt"
+	"reflect"
+	"time"
 
 	"github.com/fatih/color"
 	"github.com/scaleway/scaleway-cli/v2/core"
 	"github.com/scaleway/scaleway-cli/v2/core/human"
 	"github.com/scaleway/scaleway-sdk-go/api/registry/v1"
 	"github.com/scaleway/scaleway-sdk-go/logger"
+	"github.com/scaleway/scaleway-sdk-go/scw"
 )
 
 //
@@ -25,7 +28,7 @@ var (
 	}
 )
 
-type customTag struct {
+type CustomTag struct {
 	registry.Tag
 	FullName string
 }
@@ -59,7 +62,7 @@ func tagGetBuilder(c *core.Command) *core.Command {
 			return getTagResp, nil
 		}
 
-		res := customTag{
+		res := CustomTag{
 			Tag:      *tag,
 			FullName: fmt.Sprintf("%s/%s:%s", namespace.Endpoint, image.Name, tag.Name),
 		}
@@ -112,9 +115,9 @@ func tagListBuilder(c *core.Command) *core.Command {
 			return listTagResp, err
 		}
 
-		var customRes []customTag
+		var customRes []CustomTag
 		for _, tag := range listTagResp.([]*registry.Tag) {
-			customRes = append(customRes, customTag{
+			customRes = append(customRes, CustomTag{
 				Tag: *tag,
 				FullName: fmt.Sprintf("%s/%s:%s",
 					namespace.Endpoint,
@@ -129,3 +132,40 @@ func tagListBuilder(c *core.Command) *core.Command {
 
 	return c
 }
+
+type customTagDeleteArgs struct {
+	registry.DeleteTagRequest
+	Timeout *string
+}
+
+func tagDeleteBuilder(c *core.Command) *core.Command {
+	c.ArgsType = reflect.TypeOf(customTagDeleteArgs{})
+	c.ArgSpecs.AddBefore("force", &core.ArgSpec{
+		Name:       "timeout",
+		Short:      "Maximum time to handle the request",
+		Required:   false,
+		Positional: false,
+	})
+
+	c.Run = func(ctx context.Context, argsI any) (any, error) {
+		client := core.ExtractClient(ctx)
+		api := registry.NewAPI(client)
+		args := argsI.(*customTagDeleteArgs)
+
+		if args.Timeout == nil {
+			return api.DeleteTag(&args.DeleteTagRequest, scw.WithContext(ctx))
+		}
+
+		timeout, err := time.ParseDuration(*args.Timeout)
+		if err != nil {
+			return nil, err
+		}
+
+		ctxWithTimeout, cancel := context.WithTimeout(ctx, timeout)
+		defer cancel()
+
+		return api.DeleteTag(&args.DeleteTagRequest, scw.WithContext(ctxWithTimeout))
+	}
+
+	return c
+}

internal/namespaces/registry/v1/custom_tag_test.go

@@ -0,0 +1,95 @@
+package registry_test
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/scaleway/scaleway-cli/v2/core"
+	"github.com/scaleway/scaleway-cli/v2/internal/namespaces/registry/v1"
+	"github.com/scaleway/scaleway-cli/v2/internal/testhelpers"
+)
+
+func Test_RegistryTagDelete(t *testing.T) {
+	registryNamespaceMetaKey := "RegistryNamespace"
+	helloWorldImage := "hello-world:latest"
+	helloWorldImageMetaKey := "HelloWorldImage"
+	tagIDMetaKey := "TagID"
+
+	t.Run("simple", core.Test(&core.TestConfig{
+		Commands: registry.GetCommands(),
+		BeforeFunc: core.BeforeFuncCombine(
+			core.ExecStoreBeforeCmd(
+				registryNamespaceMetaKey,
+				fmt.Sprintf("scw registry namespace create name=%s is-public=false",
+					core.GetRandomName("test-rg-tag-delete"),
+				),
+			),
+			core.BeforeFuncWhenUpdatingCassette(
+				core.BeforeFuncCombine(
+					core.ExecBeforeCmd("scw registry login"),
+					testhelpers.PushRegistryImage(helloWorldImage, registryNamespaceMetaKey),
+				),
+			),
+			testhelpers.StoreImageIdentifierInMeta(
+				registryNamespaceMetaKey,
+				helloWorldImage,
+				helloWorldImageMetaKey,
+			),
+			testhelpers.StoreTagIDInMeta(registryNamespaceMetaKey, helloWorldImage, tagIDMetaKey),
+		),
+		Cmd: fmt.Sprintf("scw registry tag delete {{ .%s }}", tagIDMetaKey),
+		Check: core.TestCheckCombine(
+			core.TestCheckGolden(),
+			core.TestCheckExitCode(0),
+		),
+		AfterFunc: func(ctx *core.AfterFuncCtx) error {
+			return core.ExecAfterCmd(
+				fmt.Sprintf(
+					"scw registry namespace delete {{ .%s.ID }}",
+					registryNamespaceMetaKey,
+				),
+			)(
+				ctx,
+			)
+		},
+	}))
+
+	t.Run("timeout-ok", core.Test(&core.TestConfig{
+		Commands: registry.GetCommands(),
+		BeforeFunc: core.BeforeFuncCombine(
+			core.ExecStoreBeforeCmd(
+				registryNamespaceMetaKey,
+				fmt.Sprintf("scw registry namespace create name=%s is-public=false",
+					core.GetRandomName("test-rg-tag-delete"),
+				),
+			),
+			core.BeforeFuncWhenUpdatingCassette(
+				core.BeforeFuncCombine(
+					core.ExecBeforeCmd("scw registry login"),
+					testhelpers.PushRegistryImage(helloWorldImage, registryNamespaceMetaKey),
+				),
+			),
+			testhelpers.StoreImageIdentifierInMeta(
+				registryNamespaceMetaKey,
+				helloWorldImage,
+				helloWorldImageMetaKey,
+			),
+			testhelpers.StoreTagIDInMeta(registryNamespaceMetaKey, helloWorldImage, tagIDMetaKey),
+		),
+		Cmd: fmt.Sprintf("scw registry tag delete {{ .%s }} timeout=1s", tagIDMetaKey),
+		Check: core.TestCheckCombine(
+			core.TestCheckGolden(),
+			core.TestCheckExitCode(0),
+		),
+		AfterFunc: func(ctx *core.AfterFuncCtx) error {
+			return core.ExecAfterCmd(
+				fmt.Sprintf(
+					"scw registry namespace delete {{ .%s.ID }}",
+					registryNamespaceMetaKey,
+				),
+			)(
+				ctx,
+			)
+		},
+	}))
+}