add tests

Signed-off-by: Patrik Cyvoct <pcyvoct@scaleway.com>

cmd/scw/testdata/test-all-usage-registry-namespace-login-usage.stderr.golden → cmd/scw/testdata/test-all-usage-registry-login-usage.stderr.golden

@@ -1,11 +1,10 @@
-This command will run the correct command in order to log you in on the namespace with the chosen program.
+This command will run the correct command in order to log you in on the registry with the chosen program.
 You will need to have the chosen binary installed on your system and in your PATH.
 
 USAGE:
-  scw registry namespace login <namespace> [arg=value ...]
+  scw registry login [arg=value ...]
 
 ARGS:
-  namespace          Namespace name or ID to log in to
   [program=docker]   Program used to log in to the namespace (docker | podman)
   [region]           Region to target. If none is passed will use default region from the config
 

cmd/scw/testdata/test-all-usage-registry-namespace-logout-usage.stderr.golden → cmd/scw/testdata/test-all-usage-registry-logout-usage.stderr.golden

@@ -1,11 +1,10 @@
-This command will run the correct command in order to log you out of the namespace with the chosen program.
+This command will run the correct command in order to log you out of the registry with the chosen program.
 You will need to have the chosen binary installed on your system and in your PATH.
 
 USAGE:
-  scw registry namespace logout <namespace> [arg=value ...]
+  scw registry logout [arg=value ...]
 
 ARGS:
-  namespace          Namespace name or ID to log out of
   [program=docker]   Program used to log in to the namespace (docker | podman)
   [region]           Region to target. If none is passed will use default region from the config
 

cmd/scw/testdata/test-all-usage-registry-namespace-usage.stderr.golden

@@ -17,8 +17,6 @@ AVAILABLE COMMANDS:
   create      Create a new namespace
   update      Update an existing namespace
   delete      Delete an existing namespace
-  login       Login to a namespace
-  logout      Logout of a namespace
 
 FLAGS:
   -h, --help   help for namespace

cmd/scw/testdata/test-all-usage-registry-usage.stderr.golden

@@ -7,6 +7,8 @@ AVAILABLE COMMANDS:
   namespace   A namespace is for images what a folder is for files
   image       An image represents a container image
   tag         A tag represents a container tag of an image
+  login       Login to a registry
+  logout      Logout of a registry
 
 FLAGS:
   -h, --help   help for registry

internal/core/bootstrap.go

@@ -40,6 +40,10 @@ type BootstrapConfig struct {
 	// OverrideEnv overrides environment variables returned by core.ExtractEnv function.
 	// This is useful for tests as it allows overriding env without relying on global state.
 	OverrideEnv map[string]string
+
+	// OverrideExecCommmand contains programs that will be overriden during the test.
+	// This is useful when commands include external commands
+	OverrideExecCommand map[string]ExecCmd
 }
 
 // Bootstrap is the main entry point. It is directly called from main.
@@ -57,23 +61,29 @@ func Bootstrap(config *BootstrapConfig) (exitCode int, result interface{}, err e
 	// Meta store globally available variables like SDK client.
 	// Meta is injected in a context object that will be passed to all commands.
 	meta := &meta{
-		BinaryName:  config.Args[0],
-		BuildInfo:   config.BuildInfo,
-		stdout:      config.Stdout,
-		stderr:      config.Stderr,
-		Client:      config.Client,
-		Commands:    config.Commands,
-		Printer:     globalPrinter,
-		OverrideEnv: config.OverrideEnv,
-		result:      nil, // result is later injected by cobra_utils.go/cobraRun()
-		command:     nil, // command is later injected by cobra_utils.go/cobraRun()
+		BinaryName:          config.Args[0],
+		BuildInfo:           config.BuildInfo,
+		stdout:              config.Stdout,
+		stderr:              config.Stderr,
+		Client:              config.Client,
+		Commands:            config.Commands,
+		Printer:             globalPrinter,
+		OverrideEnv:         config.OverrideEnv,
+		OverrideExecCommand: config.OverrideExecCommand,
+		result:              nil, // result is later injected by cobra_utils.go/cobraRun()
+		command:             nil, // command is later injected by cobra_utils.go/cobraRun()
 	}
 
 	// We make sure OverrideEnv is never nil in meta.
 	if meta.OverrideEnv == nil {
 		meta.OverrideEnv = map[string]string{}
 	}
 
+	// We make sure OverrideExecCommand is never nil in meta.
+	if meta.OverrideExecCommand == nil {
+		meta.OverrideExecCommand = map[string]ExecCmd{}
+	}
+
 	// Send Matomo telemetry when exiting the bootstrap
 	start := time.Now()
 	defer func() {

internal/core/context.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"io"
 	"os"
+	"os/exec"
 
 	"github.com/scaleway/scaleway-cli/internal/printer"
 	"github.com/scaleway/scaleway-sdk-go/scw"
@@ -17,11 +18,12 @@ type meta struct {
 	DebugModeFlag   bool
 	PrinterTypeFlag printer.Type
 
-	BuildInfo   *BuildInfo
-	Client      *scw.Client
-	Printer     printer.Printer
-	Commands    *Commands
-	OverrideEnv map[string]string
+	BuildInfo           *BuildInfo
+	Client              *scw.Client
+	Printer             printer.Printer
+	Commands            *Commands
+	OverrideEnv         map[string]string
+	OverrideExecCommand map[string]ExecCmd
 
 	command *Command
 	stdout  io.Writer
@@ -99,3 +101,20 @@ func ExtractUserHomeDir(ctx context.Context) string {
 func ExtractBinaryName(ctx context.Context) string {
 	return extractMeta(ctx).BinaryName
 }
+
+func ExtractAndExecCommand(ctx context.Context, function string, args ...string) Cmd {
+	meta := extractMeta(ctx)
+	var cmd Cmd
+	if f, exist := meta.OverrideExecCommand[function]; exist {
+		cmd = f(function, os.Stdin, meta.stdout, meta.stderr, args...)
+	} else {
+		realCmd := exec.Command(function, args...)
+		realCmd.Stdout = meta.stdout
+		realCmd.Stderr = meta.stderr
+		cmd = &RealCmd{
+			realCmd,
+		}
+	}
+
+	return cmd
+}

internal/core/exec.go

@@ -0,0 +1,21 @@
+package core
+
+import (
+	"io"
+	"os/exec"
+)
+
+type ExecCmd func(name string, stdin io.Reader, stdout io.Writer, stderr io.Writer, args ...string) Cmd
+
+type Cmd interface {
+	Run() error
+	SetStdin(io.Reader)
+}
+
+type RealCmd struct {
+	*exec.Cmd
+}
+
+func (rc *RealCmd) SetStdin(r io.Reader) {
+	rc.Stdin = r
+}

internal/core/testing.go

@@ -57,6 +57,9 @@ type CheckFuncCtx struct {
 
 	// OverrideEnv passed in the TestConfig
 	OverrideEnv map[string]string
+
+	// OverrideExecCommand passed in the TestConfig
+	OverrideExecCommand map[string]ExecCmd
 }
 
 // TestCheck is a function that perform assertion on a CheckFuncCtx
@@ -67,20 +70,22 @@ type BeforeFunc func(ctx *BeforeFuncCtx) error
 type AfterFunc func(ctx *AfterFuncCtx) error
 
 type BeforeFuncCtx struct {
-	T           *testing.T
-	Client      *scw.Client
-	ExecuteCmd  func(args []string) interface{}
-	Meta        map[string]interface{}
-	OverrideEnv map[string]string
+	T                   *testing.T
+	Client              *scw.Client
+	ExecuteCmd          func(args []string) interface{}
+	Meta                map[string]interface{}
+	OverrideEnv         map[string]string
+	OverrideExecCommand map[string]ExecCmd
 }
 
 type AfterFuncCtx struct {
-	T           *testing.T
-	Client      *scw.Client
-	ExecuteCmd  func(args []string) interface{}
-	Meta        map[string]interface{}
-	CmdResult   interface{}
-	OverrideEnv map[string]string
+	T                   *testing.T
+	Client              *scw.Client
+	ExecuteCmd          func(args []string) interface{}
+	Meta                map[string]interface{}
+	CmdResult           interface{}
+	OverrideEnv         map[string]string
+	OverrideExecCommand map[string]ExecCmd
 }
 
 // TestConfig contain configuration that can be used with the Test function
@@ -130,6 +135,9 @@ type TestConfig struct {
 
 	// Custom client to use for test, if none are provided will create one automatically
 	Client *scw.Client
+
+	// OverrideExecCommand contains programs that will be overriden during the test.
+	OverrideExecCommand map[string]ExecCmd
 }
 
 // getTestFilePath returns a valid filename path based on the go test name and suffix. (Take care of non fs friendly char)
@@ -158,6 +166,7 @@ func createTestClient(t *testing.T, testConfig *TestConfig) (client *scw.Client,
 		scw.WithEnv(),
 		scw.WithUserAgent("cli-e2e-test"),
 		scw.WithDefaultOrganizationID("11111111-1111-1111-1111-111111111111"),
+		scw.WithAuth("SCWXXXXXXXXXXXXXXXXX", "11111111-1111-1111-1111-111111111111"),
 	}
 
 	// If client is NOT an E2E client we init http recorder and load configuration.
@@ -222,9 +231,14 @@ func Test(config *TestConfig) func(t *testing.T) {
 
 		meta := map[string]interface{}{}
 
-		overideEnv := config.OverrideEnv
-		if overideEnv == nil {
-			overideEnv = map[string]string{}
+		overrideEnv := config.OverrideEnv
+		if overrideEnv == nil {
+			overrideEnv = map[string]string{}
+		}
+
+		overrideExecCommand := config.OverrideExecCommand
+		if overrideExecCommand == nil {
+			overrideExecCommand = map[string]ExecCmd{}
 		}
 
 		if config.TmpHomeDir {
@@ -234,22 +248,23 @@ func Test(config *TestConfig) func(t *testing.T) {
 				err = os.RemoveAll(dir)
 				assert.NoError(t, err)
 			}()
-			overideEnv["HOME"] = dir
+			overrideEnv["HOME"] = dir
 		}
 
 		executeCmd := func(args []string) interface{} {
 			stdoutBuffer := &bytes.Buffer{}
 			stderrBuffer := &bytes.Buffer{}
 			logger.Debugf("command: %s", args)
 			_, result, err := Bootstrap(&BootstrapConfig{
-				Args:             args,
-				Commands:         config.Commands,
-				BuildInfo:        &config.BuildInfo,
-				Stdout:           stdoutBuffer,
-				Stderr:           stderrBuffer,
-				Client:           client,
-				DisableTelemetry: true,
-				OverrideEnv:      overideEnv,
+				Args:                args,
+				Commands:            config.Commands,
+				BuildInfo:           &config.BuildInfo,
+				Stdout:              stdoutBuffer,
+				Stderr:              stderrBuffer,
+				Client:              client,
+				DisableTelemetry:    true,
+				OverrideEnv:         overrideEnv,
+				OverrideExecCommand: overrideExecCommand,
 			})
 			require.NoError(t, err, "stdout: %s\nstderr: %s", stdoutBuffer.String(), stderrBuffer.String())
 
@@ -259,11 +274,12 @@ func Test(config *TestConfig) func(t *testing.T) {
 		// Run config.BeforeFunc
 		if config.BeforeFunc != nil {
 			require.NoError(t, config.BeforeFunc(&BeforeFuncCtx{
-				T:           t,
-				Client:      client,
-				ExecuteCmd:  executeCmd,
-				Meta:        meta,
-				OverrideEnv: overideEnv,
+				T:                   t,
+				Client:              client,
+				ExecuteCmd:          executeCmd,
+				Meta:                meta,
+				OverrideEnv:         overrideEnv,
+				OverrideExecCommand: overrideExecCommand,
 			}))
 		}
 
@@ -280,38 +296,41 @@ func Test(config *TestConfig) func(t *testing.T) {
 			stderr := &bytes.Buffer{}
 			logger.Debugf("command: %s", args)
 			exitCode, result, err = Bootstrap(&BootstrapConfig{
-				Args:             args,
-				Commands:         config.Commands,
-				BuildInfo:        &config.BuildInfo,
-				Stdout:           stdout,
-				Stderr:           stderr,
-				Client:           client,
-				DisableTelemetry: true,
-				OverrideEnv:      overideEnv,
+				Args:                args,
+				Commands:            config.Commands,
+				BuildInfo:           &config.BuildInfo,
+				Stdout:              stdout,
+				Stderr:              stderr,
+				Client:              client,
+				DisableTelemetry:    true,
+				OverrideEnv:         overrideEnv,
+				OverrideExecCommand: overrideExecCommand,
 			})
 
 			meta["CmdResult"] = result
 			config.Check(t, &CheckFuncCtx{
-				ExitCode:    exitCode,
-				Stdout:      stdout.Bytes(),
-				Stderr:      stderr.Bytes(),
-				Meta:        meta,
-				Result:      result,
-				Err:         err,
-				Client:      client,
-				OverrideEnv: overideEnv,
+				ExitCode:            exitCode,
+				Stdout:              stdout.Bytes(),
+				Stderr:              stderr.Bytes(),
+				Meta:                meta,
+				Result:              result,
+				Err:                 err,
+				Client:              client,
+				OverrideEnv:         overrideEnv,
+				OverrideExecCommand: overrideExecCommand,
 			})
 		}
 
 		// Run config.AfterFunc
 		if config.AfterFunc != nil {
 			require.NoError(t, config.AfterFunc(&AfterFuncCtx{
-				T:           t,
-				Client:      client,
-				ExecuteCmd:  executeCmd,
-				Meta:        meta,
-				CmdResult:   result,
-				OverrideEnv: overideEnv,
+				T:                   t,
+				Client:              client,
+				ExecuteCmd:          executeCmd,
+				Meta:                meta,
+				CmdResult:           result,
+				OverrideEnv:         overrideEnv,
+				OverrideExecCommand: overrideExecCommand,
 			}))
 		}
 	}