Merge pull request #2728 from 89luca89/fix/run_watch_globs

fix: run_watch glob pattern handling

Author: FabianKramm

docs/pages/_partials/command_run_watch.mdx

@@ -12,7 +12,16 @@ run_watch --path [MY_PATH] -- [my_command]
 
 ### `--path`, `-p`
 
-The paths to watch. Can be patterns in the form of `./**/my-file.txt`.
+The paths to watch. Can be patterns in the form of `"./**/my-file.txt"`.
+
+Please note that globgs need to be quoted in order to avoid them being expanded
+by your shell, for example:
+
+
+```
+run_watch --path "**/*.go" -- devspace dev
+```
+
 
 ```
 ```

e2e/tests/pipelines/pipelines.go

@@ -301,6 +301,34 @@ var _ = DevSpaceDescribe("pipelines", func() {
 			framework.ExpectNoError(err)
 		}
 	})
+	ginkgo.It("should fail to watch files with unquoted globbing", func(ctx context.Context) {
+		tempDir, err := framework.CopyToTempDir("tests/pipelines/testdata/run_watch")
+		framework.ExpectNoError(err)
+		ginkgo.DeferCleanup(framework.CleanupTempDir, initialDir, tempDir)
+
+		ns, err := kubeClient.CreateNamespace("pipelines")
+		framework.ExpectNoError(err)
+		ginkgo.DeferCleanup(framework.ExpectDeleteNamespace, kubeClient, ns)
+
+		cancelCtx, cancel := context.WithCancel(ctx)
+		ginkgo.DeferCleanup(cancel)
+
+		output := &bytes.Buffer{}
+		multiWriter := io.MultiWriter(output, os.Stdout)
+		log := logpkg.NewStreamLogger(multiWriter, multiWriter, logrus.DebugLevel)
+
+		devCmd := &cmd.RunPipelineCmd{
+			GlobalFlags: &flags.GlobalFlags{
+				NoWarn:    true,
+				Namespace: ns,
+			},
+			Pipeline: "unquoted-glob",
+			Ctx:      cancelCtx,
+			Log:      log,
+		}
+		err = devCmd.RunDefault(f)
+		framework.ExpectError(err)
+	})
 
 	ginkgo.It("should use --set and --set-string values from run_pipelines command", func() {
 		tempDir, err := framework.CopyToTempDir("tests/pipelines/testdata/run_pipelines")

e2e/tests/pipelines/testdata/run_watch/devspace.yaml

@@ -32,5 +32,9 @@ pipelines:
       --path './foo*/**/*' \
       --exclude './foo2/*' \
       -- date
-      
-  
+
+  unquoted-glob: |-
+    # Still triggers run_watch for foo2/bar2.txt changes
+    run_watch \
+      --path **/* \
+      -- date

pkg/devspace/pipeline/engine/basichandler/commands/run_watch.go

@@ -30,6 +30,15 @@ type RunWatchOptions struct {
 }
 
 func RunWatch(ctx context.Context, args []string, handler types2.ExecHandler, log log.Logger) error {
+	command := []string{}
+
+	// Separately handle the `--` catchall flag
+	// in order to have clean arguments for the parsing below
+	commandINdex := indexOf("--", args)
+	if commandINdex > 0 {
+		command = args[commandINdex+1:]
+	}
+
 	options := &RunWatchOptions{}
 	args, err := flags.ParseArgs(options, args)
 	if err != nil {
@@ -41,10 +50,15 @@ func RunWatch(ctx context.Context, args []string, handler types2.ExecHandler, lo
 	if len(args) == 0 {
 		return fmt.Errorf("usage: run_watch --path MY_PATH -- my_command")
 	}
+	if len(args) > len(command) {
+		// if we have more args left thant the one after "--" then we have some invalid flags inside
+		return fmt.Errorf("invalid flags: %v, usage: run_watch --path MY_PATH --path 'MY/**/GLOB*/PATH' -- my_command", command)
+	}
 
 	w := &watcher{
 		options: *options,
 	}
+
 	return w.Watch(ctx, func(ctx context.Context) error {
 		return handler.ExecHandler(ctx, args)
 	}, log)
@@ -232,3 +246,12 @@ func (w *watcher) startCommand(ctx context.Context, action func(ctx context.Cont
 	})
 	return t
 }
+
+func indexOf(element string, data []string) int {
+	for k, v := range data {
+		if element == v {
+			return k
+		}
+	}
+	return -1
+}