Merge pull request #32 from stuartleeks/sl/exec-redesign

Redesign exec command

Author: stuartleeks

Makefile

@@ -5,7 +5,7 @@ help: ## show this help
 		| column -t -s '|'
 
 
-build: ## Build devcontainer cli
+build: fmt ## Build devcontainer cli
 	go build ./cmd/devcontainer
 
 lint: build ## Build and lint
@@ -31,4 +31,8 @@ endif
 
 
 test:
-	go test -v ./...
+	go test -v ./...
+
+
+fmt:
+	find . -name '*.go' | grep -v vendor | xargs gofmt -s -w

README.md

@@ -51,13 +51,25 @@ For example:
 
 ```bash
 # Run an interactive bash shell in the vscode-remote-test-dockerfile devcontainer
-devcontainer exec vscode-remote-test-dockerfile bash
+devcontainer exec --name vscode-remote-test-dockerfile bash
 
 # Run a command with args in the vscode-remote-test-dockercompose_devcontainer/mongo devcontainer
-devcontainer exec vscode-remote-test-dockercompose_devcontainer/mongo ls -a /workspaces/vscode-remote-test-dockerfile
+devcontainer exec --name vscode-remote-test-dockercompose_devcontainer/mongo ls -a /workspaces/vscode-remote-test-dockerfile
+
+# Run `bash` in the dev container for the project at `~/ source/my-proj`
+devcontainer exec --path ~/source/my-proj bash
+
+# If none of --name/--path/--prompt are specified then `--path .` is assumed (i.e. use the dev container for the current directory)
+devcontainer exec bash
+
+# If command/args not set, `bash` is assumed
+devcontainer exec --name vscode-remote-test-dockerfile
+
+# Combining these to launch bash in the dev container for the project in the current directory:
+devcontainer exec
 ```
 
-You can pass `?` as the devcontainer name and the CLI will prompt you to pick a devcontainer to run the `exec` command against, e.g.:
+You can use `--prompt` instead of `--name` or `--path` and the CLI will prompt you to pick a devcontainer to run the `exec` command against, e.g.:
 
 ```bash
 $ ./devcontainer exec ? bash
@@ -74,10 +86,12 @@ You can use this with Windows Terminal profiles:
     "guid": "{4b304185-99d2-493c-940c-ae74e0f14bba}",
     "hidden": false,
     "name": "devcontainer exec",
-    "commandline": "wsl bash -c \"path/to/devcontainer exec ? bash\"",
+    "commandline": "wsl bash -c \"path/to/devcontainer exec --prompt bash\"",
 },
 ```
 
+By default, `devcontainer exec` will set the working directory to be the mount path for the dev container. This can be overridden using `--work-dir`.
+
 ### Working with devcontainer templates
 
 To work with devcontainer templates `devcontainer` needs to know where you have the templates stored.

cmd/devcontainer/devcontainer.go

@@ -5,6 +5,7 @@ import (
 	"os"
 	"os/exec"
 	"path"
+	"path/filepath"
 	"sort"
 	"strings"
 	"text/tabwriter"
@@ -65,30 +66,57 @@ func createListCommand() *cobra.Command {
 	return cmdList
 }
 
+func countBooleans(values ...bool) int {
+	count := 0
+	for _, v := range values {
+		if v {
+			count++
+		}
+	}
+	return count
+}
+
 func createExecCommand() *cobra.Command {
+	var argDevcontainerName string
+	var argDevcontainerPath string
+	var argPromptForDevcontainer bool
+	var argWorkDir string
+
 	cmd := &cobra.Command{
-		Use:   "exec DEVCONTAINER_NAME COMMAND [args...] (args will default to /bin/bash if none provided)",
+		Use:   "exec [--name <name>| --path <path> | --prompt ] [--work-dir <work-dir>] [<command> [<args...>]] (command will default to /bin/bash if none provided)",
 		Short: "Execute a command in a devcontainer",
-		Long:  "Execute a command in a devcontainer, similar to `docker exec`. Pass `?` as DEVCONTAINER_NAME to be prompted.",
+		Long:  "Execute a command in a devcontainer, similar to `docker exec`",
 		RunE: func(cmd *cobra.Command, args []string) error {
 
-			if len(args) < 1 {
-				return cmd.Usage()
+			// Default to executing /bin/bash
+			if len(args) == 0 {
+				args = []string{"/bin/bash"}
 			}
 
-			// Default to executing /bin/bash
-			if (len(args) == 1) {
-				args = append(args, "/bin/bash")
+			sourceCount := countBooleans(
+				argDevcontainerName != "",
+				argDevcontainerPath != "",
+				argPromptForDevcontainer,
+			)
+			if sourceCount > 0 {
+				fmt.Println("Can specify at most one of --name/--path/--prompt")
+				return cmd.Usage()
 			}
 
-			devcontainerName := args[0]
+			containerID := ""
 			devcontainerList, err := devcontainers.ListDevcontainers()
 			if err != nil {
 				return err
 			}
-
-			containerID := ""
-			if devcontainerName == "?" {
+			if argDevcontainerName != "" {
+				devcontainerName := argDevcontainerName
+				for _, devcontainer := range devcontainerList {
+					if devcontainer.ContainerName == devcontainerName || devcontainer.DevcontainerName == devcontainerName {
+						containerID = devcontainer.ContainerID
+						break
+					}
+				}
+			} else if argPromptForDevcontainer {
 				// prompt user
 				fmt.Println("Specify the devcontainer to use:")
 				for index, devcontainer := range devcontainerList {
@@ -101,25 +129,47 @@ func createExecCommand() *cobra.Command {
 				}
 				containerID = devcontainerList[selection].ContainerID
 			} else {
+				devcontainerPath := argDevcontainerPath
+				if devcontainerPath == "" {
+					devcontainerPath = "."
+				}
+				absPath, err := filepath.Abs(devcontainerPath)
+				if err != nil {
+					return fmt.Errorf("Error handling path %q: %s", devcontainerPath, err)
+				}
+
+				windowsPath := absPath
+				if wsl.IsWsl() {
+					var err error
+					windowsPath, err = wsl.ConvertWslPathToWindowsPath(windowsPath)
+					if err != nil {
+						return err
+					}
+				}
 				for _, devcontainer := range devcontainerList {
-					if devcontainer.ContainerName == devcontainerName || devcontainer.DevcontainerName == devcontainerName {
+					if devcontainer.LocalFolderPath == windowsPath {
 						containerID = devcontainer.ContainerID
 						break
 					}
 				}
-				if containerID == "" {
-					return cmd.Usage()
-				}
+			}
+
+			if containerID == "" {
+				fmt.Println("Failed to find dev container")
+				return cmd.Usage()
 			}
 
 			localPath, err := devcontainers.GetLocalFolderFromDevContainer(containerID)
 			if err != nil {
 				return err
 			}
 
-			mountPath, err := devcontainers.GetWorkspaceMountPath(localPath)
-			if err != nil {
-				return err
+			mountPath := argWorkDir
+			if mountPath == "" {
+				mountPath, err = devcontainers.GetWorkspaceMountPath(localPath)
+				if err != nil {
+					return err
+				}
 			}
 
 			wslPath := localPath
@@ -130,8 +180,8 @@ func createExecCommand() *cobra.Command {
 				}
 			}
 
-			devcontainerJsonPath := path.Join(wslPath, ".devcontainer/devcontainer.json")
-			userName, err := devcontainers.GetDevContainerUserName(devcontainerJsonPath)
+			devcontainerJSONPath := path.Join(wslPath, ".devcontainer/devcontainer.json")
+			userName, err := devcontainers.GetDevContainerUserName(devcontainerJSONPath)
 			if err != nil {
 				return err
 			}
@@ -141,24 +191,23 @@ func createExecCommand() *cobra.Command {
 				dockerArgs = append(dockerArgs, "--user", userName)
 			}
 			dockerArgs = append(dockerArgs, containerID)
-			dockerArgs = append(dockerArgs, args[1:]...)
+			dockerArgs = append(dockerArgs, args...)
 
 			dockerCmd := exec.Command("docker", dockerArgs...)
 			dockerCmd.Stdin = os.Stdin
 			dockerCmd.Stdout = os.Stdout
 
 			err = dockerCmd.Start()
 			if err != nil {
-				return fmt.Errorf("Exec: start error: %s\n", err)
+				return fmt.Errorf("Exec: start error: %s", err)
 			}
 			err = dockerCmd.Wait()
 			if err != nil {
-				return fmt.Errorf("Exec: wait error: %s\n", err)
+				return fmt.Errorf("Exec: wait error: %s", err)
 			}
 			return nil
 		},
 		Args:                  cobra.ArbitraryArgs,
-		DisableFlagParsing:    true,
 		DisableFlagsInUseLine: true,
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 			// only completing the first arg  (devcontainer name)
@@ -177,5 +226,9 @@ func createExecCommand() *cobra.Command {
 			return names, cobra.ShellCompDirectiveNoFileComp
 		},
 	}
+	cmd.Flags().StringVarP(&argDevcontainerName, "name", "n", "", "name of dev container to exec into")
+	cmd.Flags().StringVarP(&argDevcontainerPath, "path", "", "", "path containing the dev container to exec into")
+	cmd.Flags().BoolVarP(&argPromptForDevcontainer, "prompt", "", false, "prompt for the dev container to exec into")
+	cmd.Flags().StringVarP(&argWorkDir, "work-dir", "", "", "working directory to use in the dev container")
 	return cmd
 }

internal/pkg/config/config.go

@@ -68,6 +68,6 @@ func SaveConfig() error {
 	if err := os.MkdirAll(configPath, 0755); err != nil {
 		return err
 	}
-	configFilePath:=filepath.Join(configPath, "devcontainer-cli.json")
+	configFilePath := filepath.Join(configPath, "devcontainer-cli.json")
 	return viper.WriteConfigAs(configFilePath)
 }

internal/pkg/devcontainers/dockerutils.go

@@ -19,6 +19,7 @@ type DevcontainerInfo struct {
 	ContainerID      string
 	ContainerName    string
 	DevcontainerName string
+	LocalFolderPath  string
 }
 
 const (
@@ -63,6 +64,7 @@ func ListDevcontainers() ([]DevcontainerInfo, error) {
 		devcontainer := DevcontainerInfo{
 			ContainerID:      parts[listPartID],
 			ContainerName:    parts[listPartContainerName],
+			LocalFolderPath:  parts[listPartLocalFolder],
 			DevcontainerName: name,
 		}
 		devcontainers = append(devcontainers, devcontainer)