Rename flytesnacks flag to sourcesPath (#116)

Signed-off-by: Haytham Abuelfutuh <[email protected]>
flyteorg · Jun 24, 2021 · 59860c4 · 59860c4
1 parent 0229fb9
commit 59860c4
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 25 deletions.
diff --git a/flytectl/Makefile b/flytectl/Makefile
@@ -9,8 +9,6 @@ PACKAGE ?=github.com/flyteorg/flytestdlib
 
 LD_FLAGS="-s -w -X $(PACKAGE)/version.Version=$(GIT_VERSION) -X $(PACKAGE)/version.Build=$(GIT_HASH) -X $(PACKAGE)/version.BuildTime=$(TIMESTAMP)"
 
-
-
 define PIP_COMPILE
 pip-compile $(1) --upgrade --verbose
 endef

diff --git a/flytectl/cmd/config/subcommand/sandbox/config_flags.go b/flytectl/cmd/config/subcommand/sandbox/config_flags.go
diff --git a/flytectl/cmd/config/subcommand/sandbox/config_flags_test.go b/flytectl/cmd/config/subcommand/sandbox/config_flags_test.go
diff --git a/flytectl/cmd/config/subcommand/sandbox/sandbox_config.go b/flytectl/cmd/config/subcommand/sandbox/sandbox_config.go
@@ -5,7 +5,7 @@ var (
 	DefaultConfig = &Config{}
 )
 
-// Config
+// Config represents the config parameters exposed for the `sandbox` command.
 type Config struct {
-	SnacksRepo string `json:"flytesnacks" pflag:", Path of your flytesnacks repository"`
+	SourcesPath string `json:"sourcesPath" pflag:",Path to your source code path where flyte workflows and tasks are."`
 }
diff --git a/flytectl/cmd/sandbox/start.go b/flytectl/cmd/sandbox/start.go
@@ -26,7 +26,7 @@ Start will run the flyte sandbox cluster inside a docker container and setup the
 Mount your flytesnacks repository code inside sandbox 
 ::
 
- bin/flytectl sandbox start --flytesnacks=$HOME/flyteorg/flytesnacks 
+ bin/flytectl sandbox start --sourcesPath=$HOME/flyteorg/flytesnacks 
 Usage
 	`
 )
@@ -65,10 +65,10 @@ func startSandbox(ctx context.Context, cli docker.Docker, reader io.Reader) (*bu
 		return nil, err
 	}
 
-	if len(sandboxConfig.DefaultConfig.SnacksRepo) > 0 {
+	if len(sandboxConfig.DefaultConfig.SourcesPath) > 0 {
 		docker.Volumes = append(docker.Volumes, mount.Mount{
 			Type:   mount.TypeBind,
-			Source: sandboxConfig.DefaultConfig.SnacksRepo,
+			Source: sandboxConfig.DefaultConfig.SourcesPath,
 			Target: docker.FlyteSnackDir,
 		})
 	}

diff --git a/flytectl/cmd/sandbox/start_test.go b/flytectl/cmd/sandbox/start_test.go
@@ -61,10 +61,10 @@ func TestStartSandboxFunc(t *testing.T) {
 		errCh := make(chan error)
 		bodyStatus := make(chan container.ContainerWaitOKBody)
 		mockDocker := &mocks.Docker{}
-		sandboxConfig.DefaultConfig.SnacksRepo = f.UserHomeDir()
+		sandboxConfig.DefaultConfig.SourcesPath = f.UserHomeDir()
 		volumes := append(docker.Volumes, mount.Mount{
 			Type:   mount.TypeBind,
-			Source: sandboxConfig.DefaultConfig.SnacksRepo,
+			Source: sandboxConfig.DefaultConfig.SourcesPath,
 			Target: docker.FlyteSnackDir,
 		})
 		mockDocker.OnContainerCreate(ctx, &container.Config{
@@ -97,10 +97,10 @@ func TestStartSandboxFunc(t *testing.T) {
 		errCh := make(chan error)
 		bodyStatus := make(chan container.ContainerWaitOKBody)
 		mockDocker := &mocks.Docker{}
-		sandboxConfig.DefaultConfig.SnacksRepo = f.UserHomeDir()
+		sandboxConfig.DefaultConfig.SourcesPath = f.UserHomeDir()
 		volumes := append(docker.Volumes, mount.Mount{
 			Type:   mount.TypeBind,
-			Source: sandboxConfig.DefaultConfig.SnacksRepo,
+			Source: sandboxConfig.DefaultConfig.SourcesPath,
 			Target: docker.FlyteSnackDir,
 		})
 		mockDocker.OnContainerCreate(ctx, &container.Config{
@@ -133,10 +133,10 @@ func TestStartSandboxFunc(t *testing.T) {
 		errCh := make(chan error)
 		bodyStatus := make(chan container.ContainerWaitOKBody)
 		mockDocker := &mocks.Docker{}
-		sandboxConfig.DefaultConfig.SnacksRepo = f.UserHomeDir()
+		sandboxConfig.DefaultConfig.SourcesPath = f.UserHomeDir()
 		volumes := append(docker.Volumes, mount.Mount{
 			Type:   mount.TypeBind,
-			Source: sandboxConfig.DefaultConfig.SnacksRepo,
+			Source: sandboxConfig.DefaultConfig.SourcesPath,
 			Target: docker.FlyteSnackDir,
 		})
 		mockDocker.OnContainerCreate(ctx, &container.Config{
@@ -177,10 +177,10 @@ func TestStartSandboxFunc(t *testing.T) {
 		errCh := make(chan error)
 		bodyStatus := make(chan container.ContainerWaitOKBody)
 		mockDocker := &mocks.Docker{}
-		sandboxConfig.DefaultConfig.SnacksRepo = f.UserHomeDir()
+		sandboxConfig.DefaultConfig.SourcesPath = f.UserHomeDir()
 		volumes := append(docker.Volumes, mount.Mount{
 			Type:   mount.TypeBind,
-			Source: sandboxConfig.DefaultConfig.SnacksRepo,
+			Source: sandboxConfig.DefaultConfig.SourcesPath,
 			Target: docker.FlyteSnackDir,
 		})
 		mockDocker.OnContainerCreate(ctx, &container.Config{
@@ -213,10 +213,10 @@ func TestStartSandboxFunc(t *testing.T) {
 		errCh := make(chan error)
 		bodyStatus := make(chan container.ContainerWaitOKBody)
 		mockDocker := &mocks.Docker{}
-		sandboxConfig.DefaultConfig.SnacksRepo = f.UserHomeDir()
+		sandboxConfig.DefaultConfig.SourcesPath = f.UserHomeDir()
 		volumes := append(docker.Volumes, mount.Mount{
 			Type:   mount.TypeBind,
-			Source: sandboxConfig.DefaultConfig.SnacksRepo,
+			Source: sandboxConfig.DefaultConfig.SourcesPath,
 			Target: docker.FlyteSnackDir,
 		})
 		mockDocker.OnContainerCreate(ctx, &container.Config{
@@ -249,10 +249,10 @@ func TestStartSandboxFunc(t *testing.T) {
 		errCh := make(chan error)
 		bodyStatus := make(chan container.ContainerWaitOKBody)
 		mockDocker := &mocks.Docker{}
-		sandboxConfig.DefaultConfig.SnacksRepo = f.UserHomeDir()
+		sandboxConfig.DefaultConfig.SourcesPath = f.UserHomeDir()
 		volumes := append(docker.Volumes, mount.Mount{
 			Type:   mount.TypeBind,
-			Source: sandboxConfig.DefaultConfig.SnacksRepo,
+			Source: sandboxConfig.DefaultConfig.SourcesPath,
 			Target: docker.FlyteSnackDir,
 		})
 		mockDocker.OnContainerCreate(ctx, &container.Config{
@@ -312,7 +312,7 @@ func TestStartSandboxFunc(t *testing.T) {
 		}).Return(reader, nil)
 		mockDocker.OnContainerWaitMatch(ctx, mock.Anything, container.WaitConditionNotRunning).Return(bodyStatus, errCh)
 		docker.Client = mockDocker
-		sandboxConfig.DefaultConfig.SnacksRepo = ""
+		sandboxConfig.DefaultConfig.SourcesPath = ""
 		err := startSandboxCluster(ctx, []string{}, cmdCtx)
 		assert.Nil(t, err)
 	})
@@ -348,7 +348,7 @@ func TestStartSandboxFunc(t *testing.T) {
 		}).Return(reader, nil)
 		mockDocker.OnContainerWaitMatch(ctx, mock.Anything, container.WaitConditionNotRunning).Return(bodyStatus, errCh)
 		docker.Client = mockDocker
-		sandboxConfig.DefaultConfig.SnacksRepo = ""
+		sandboxConfig.DefaultConfig.SourcesPath = ""
 		err := startSandboxCluster(ctx, []string{}, cmdCtx)
 		assert.NotNil(t, err)
 	})

diff --git a/flytectl/docs/source/gen/flytectl_sandbox_start.rst b/flytectl/docs/source/gen/flytectl_sandbox_start.rst
@@ -18,7 +18,7 @@ Start will run the flyte sandbox cluster inside a docker container and setup the
 Mount your flytesnacks repository code inside sandbox 
 ::
 
- bin/flytectl sandbox start --flytesnacks=$HOME/flyteorg/flytesnacks 
+ bin/flytectl sandbox start --sourcesPath=$HOME/flyteorg/flytesnacks
 Usage
 
 
@@ -31,7 +31,7 @@ Options
 
 ::
 
-      --flytesnacks string    Path of your flytesnacks repository
+      --sourcesPath string   Path to your source code path where flyte workflows and tasks are.
   -h, --help                 help for start
 
 Options inherited from parent commands
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,8 +9,6 @@ PACKAGE ?=github.com/flyteorg/flytestdlib @@
     LD_FLAGS="-s -w -X $(PACKAGE)/version.Version=$(GIT_VERSION) -X $(PACKAGE)/version.Build=$(GIT_HASH) -X $(PACKAGE)/version.BuildTime=$(TIMESTAMP)"
     define PIP_COMPILE
     pip-compile $(1) --upgrade --verbose
     endef
@@ Expand Down @@