Merge pull request #1834 from pratikjagrut/add.flgs.to.sync.cmd

feat: add new flags to sync command

Author: FabianKramm

cmd/sync.go

@@ -10,7 +10,6 @@ import (
 	"github.com/loft-sh/devspace/pkg/devspace/plugin"
 	"github.com/loft-sh/devspace/pkg/devspace/upgrade"
 	"github.com/loft-sh/devspace/pkg/util/message"
-	"github.com/loft-sh/devspace/pkg/util/ptr"
 	"k8s.io/apimachinery/pkg/labels"
 
 	"github.com/loft-sh/devspace/cmd/flags"
@@ -29,9 +28,12 @@ type SyncCmd struct {
 	*flags.GlobalFlags
 
 	LabelSelector string
+	ImageSelector string
 	Container     string
 	Pod           string
 	Pick          bool
+	Wait          bool
+	Polling       bool
 
 	Exclude       []string
 	ContainerPath string
@@ -82,6 +84,7 @@ devspace sync --container-path=/my-path
 	syncCmd.Flags().StringVarP(&cmd.Container, "container", "c", "", "Container name within pod where to sync to")
 	syncCmd.Flags().StringVar(&cmd.Pod, "pod", "", "Pod to sync to")
 	syncCmd.Flags().StringVarP(&cmd.LabelSelector, "label-selector", "l", "", "Comma separated key=value selector list (e.g. release=test)")
+	syncCmd.Flags().StringVar(&cmd.ImageSelector, "image-selector", "", "The image to search a pod for (e.g. nginx, nginx:latest, ${runtime.images.app}, nginx:${runtime.images.app.tag})")
 	syncCmd.Flags().BoolVar(&cmd.Pick, "pick", true, "Select a pod")
 
 	syncCmd.Flags().StringSliceVarP(&cmd.Exclude, "exclude", "e", []string{}, "Exclude directory from sync")
@@ -97,6 +100,9 @@ devspace sync --container-path=/my-path
 	syncCmd.Flags().BoolVar(&cmd.UploadOnly, "upload-only", false, "If set DevSpace will only upload files")
 	syncCmd.Flags().BoolVar(&cmd.DownloadOnly, "download-only", false, "If set DevSpace will only download files")
 
+	syncCmd.Flags().BoolVar(&cmd.Wait, "wait", true, "Wait for the pod(s) to start if they are not running")
+	syncCmd.Flags().BoolVar(&cmd.Polling, "polling", false, "If polling should be used to detect file changes in the container")
+
 	return syncCmd
 }
 
@@ -176,7 +182,16 @@ func (cmd *SyncCmd) Run(f factory.Factory) error {
 
 	// Build params
 	options := targetselector.NewOptionsFromFlags(cmd.Container, cmd.LabelSelector, cmd.Namespace, cmd.Pod, cmd.Pick)
-	options.Wait = ptr.Bool(false)
+	// get image selector if specified
+	imageSelector, err := getImageSelector(client, configLoader, configOptions, "", cmd.ImageSelector, logger)
+	if err != nil {
+		return err
+	}
+
+	// set image selector
+	options.ImageSelector = imageSelector
+	options.Wait = &cmd.Wait
+
 	if cmd.DownloadOnly && cmd.UploadOnly {
 		return errors.New("--upload-only cannot be used together with --download-only")
 	}
@@ -266,7 +281,7 @@ func (cmd *SyncCmd) applyFlagsToSyncConfig(syncConfig *latest.SyncConfig) error
 	if cmd.Container != "" {
 		syncConfig.ContainerName = ""
 	}
-	if cmd.LabelSelector != "" || cmd.Pod != "" {
+	if cmd.LabelSelector != "" || cmd.Pod != "" || cmd.ImageSelector != "" {
 		syncConfig.LabelSelector = nil
 		syncConfig.ImageSelector = ""
 	}
@@ -288,5 +303,9 @@ func (cmd *SyncCmd) applyFlagsToSyncConfig(syncConfig *latest.SyncConfig) error
 		syncConfig.InitialSync = latest.InitialSyncStrategy(cmd.InitialSync)
 	}
 
+	if cmd.Polling {
+		syncConfig.Polling = cmd.Polling
+	}
+
 	return nil
 }

docs/pages/commands/devspace_sync.md

@@ -44,8 +44,11 @@ devspace sync --container-path=/my-path
       --no-watch                   Synchronizes local and remote and then stops
       --pick                       Select a pod (default true)
       --pod string                 Pod to sync to
+      --polling bool               If polling should be used to detect file changes in the container
       --upload-only                If set DevSpace will only upload files
       --verbose                    Shows every file that is synced
+      --wait                       Wait for the pod(s) to start if they are not running
+
 ```
 
 
@@ -69,4 +72,3 @@ devspace sync --container-path=/my-path
       --var strings                  Variables to override during execution (e.g. --var=MYVAR=MYVALUE)
       --vars-secret string           The secret to restore/save the variables from/to, if --restore-vars or --save-vars is enabled (default "devspace-vars")
 ```
-

e2e/tests/sync/sync.go

@@ -37,8 +37,65 @@ var _ = DevSpaceDescribe("sync", func() {
 	})
 
 	ginkgo.It("devspace sync should work with and without config", func() {
-		// TODO:
-		// test devspace sync command with devspace.yaml and without devspace.yaml
+		tempDir, err := framework.CopyToTempDir("tests/sync/testdata/no-config")
+		framework.ExpectNoError(err)
+		defer framework.CleanupTempDir(initialDir, tempDir)
+
+		ns, err := kubeClient.CreateNamespace("sync")
+		framework.ExpectNoError(err)
+		defer func() {
+			err := kubeClient.DeleteNamespace(ns)
+			framework.ExpectNoError(err)
+		}()
+
+		// deploy app to sync
+		deployCmd := &cmd.DeployCmd{
+			GlobalFlags: &flags.GlobalFlags{
+				NoWarn:     true,
+				Namespace:  ns,
+				ConfigPath: "sync.yaml",
+			},
+		}
+		err = deployCmd.Run(f)
+		framework.ExpectNoError(err)
+
+		// interrupt chan for the sync command
+		interrupt, stop := framework.InterruptChan()
+		defer stop()
+
+		// sync with watch
+		syncCmd := &cmd.SyncCmd{
+			GlobalFlags: &flags.GlobalFlags{
+				NoWarn:    true,
+				Namespace: ns,
+			},
+			ImageSelector: "node:13.14-alpine",
+			ContainerPath: "/app",
+			UploadOnly:    true,
+			Polling:       true,
+			Wait:          true,
+			Interrupt:     interrupt,
+		}
+
+		// start the command
+		waitGroup := sync.WaitGroup{}
+		waitGroup.Add(1)
+		go func() {
+			defer ginkgo.GinkgoRecover()
+			defer waitGroup.Done()
+
+			err := syncCmd.Run(f)
+			framework.ExpectNoError(err)
+		}()
+
+		// wait until files were synced
+		framework.ExpectRemoteFileContents("node:13.14-alpine", ns, "/app/file1.txt", "Hello World\n")
+
+		// stop sync
+		stop()
+
+		// wait for the command to finish
+		waitGroup.Wait()
 	})
 
 	ginkgo.It("should execute a command after sync", func() {

e2e/tests/sync/testdata/no-config/file1.txt

@@ -0,0 +1 @@
+Hello World

e2e/tests/sync/testdata/no-config/sync.yaml

@@ -0,0 +1,13 @@
+version: v1beta11
+vars:
+  - name: IMAGE
+    value: node:13.14-alpine
+deployments:
+  - name: test
+    helm:
+      componentChart: true
+      values:
+        containers:
+          - image: ${IMAGE}
+            command: ["sleep"]
+            args: ["999999999999"]

pkg/devspace/services/synccontroller/controller.go

@@ -4,18 +4,19 @@ import (
 	"bytes"
 	"context"
 	"fmt"
-	runtimevar "github.com/loft-sh/devspace/pkg/devspace/config/loader/variable/runtime"
-	"github.com/loft-sh/devspace/pkg/devspace/imageselector"
-	"github.com/loft-sh/devspace/pkg/devspace/kubectl/selector"
 	"io"
-	kerrors "k8s.io/apimachinery/pkg/api/errors"
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"os"
 	"path/filepath"
 	"runtime"
 	"strconv"
 	"time"
 
+	runtimevar "github.com/loft-sh/devspace/pkg/devspace/config/loader/variable/runtime"
+	"github.com/loft-sh/devspace/pkg/devspace/imageselector"
+	"github.com/loft-sh/devspace/pkg/devspace/kubectl/selector"
+	kerrors "k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
 	"github.com/loft-sh/devspace/pkg/devspace/config"
 	"github.com/loft-sh/devspace/pkg/devspace/config/versions/latest"
 	"github.com/loft-sh/devspace/pkg/devspace/dependency/types"
@@ -279,7 +280,10 @@ func (c *controller) startSync(options *Options, onInitUploadDone chan struct{},
 		}
 	}
 
-	options.TargetOptions.ImageSelector = []imageselector.ImageSelector{}
+	if len(options.TargetOptions.ImageSelector) == 0 {
+		options.TargetOptions.ImageSelector = []imageselector.ImageSelector{}
+	}
+
 	if syncConfig.ImageSelector != "" {
 		imageSelector, err := runtimevar.NewRuntimeResolver(true).FillRuntimeVariablesAsImageSelector(syncConfig.ImageSelector, c.config, c.dependencies)
 		if err != nil {