Merge pull request #22 from stuartleeks/sl/exec-working-dir

Set working folder for exec command to workspace mount folder

Author: stuartleeks

cmd/devcontainer/devcontainer.go

@@ -74,7 +74,7 @@ func createExecCommand() *cobra.Command {
 			}
 
 			devcontainerName := args[0]
-			devcontainers, err := devcontainers.ListDevcontainers()
+			devcontainerList, err := devcontainers.ListDevcontainers()
 			if err != nil {
 				return err
 			}
@@ -83,17 +83,17 @@ func createExecCommand() *cobra.Command {
 			if devcontainerName == "?" {
 				// prompt user
 				fmt.Println("Specify the devcontainer to use:")
-				for index, devcontainer := range devcontainers {
+				for index, devcontainer := range devcontainerList {
 					fmt.Printf("%4d: %s (%s)\n", index, devcontainer.DevcontainerName, devcontainer.ContainerName)
 				}
 				selection := -1
 				_, _ = fmt.Scanf("%d", &selection)
-				if selection < 0 || selection >= len(devcontainers) {
+				if selection < 0 || selection >= len(devcontainerList) {
 					return fmt.Errorf("Invalid option")
 				}
-				containerID = devcontainers[selection].ContainerID
+				containerID = devcontainerList[selection].ContainerID
 			} else {
-				for _, devcontainer := range devcontainers {
+				for _, devcontainer := range devcontainerList {
 					if devcontainer.ContainerName == devcontainerName || devcontainer.DevcontainerName == devcontainerName {
 						containerID = devcontainer.ContainerID
 						break
@@ -104,7 +104,17 @@ func createExecCommand() *cobra.Command {
 				}
 			}
 
-			dockerArgs := []string{"exec", "-it", containerID}
+			localPath, err := devcontainers.GetLocalFolderFromDevContainer(containerID)
+			if err != nil {
+				return err
+			}
+
+			mountPath, err := devcontainers.GetWorkspaceMountPath(localPath)
+			if err != nil {
+				return err
+			}
+
+			dockerArgs := []string{"exec", "-it", "--workdir", mountPath, containerID}
 			dockerArgs = append(dockerArgs, args[1:]...)
 
 			dockerCmd := exec.Command("docker", dockerArgs...)

internal/pkg/devcontainers/dockerutils.go

@@ -22,14 +22,16 @@ type DevcontainerInfo struct {
 }
 
 const (
-	ListPartID                     int = 0
-	ListPartLocalFolder            int = 1
-	ListPartComposeProject         int = 2
-	ListPartComposeService         int = 3
-	ListPartComposeContainerNumber int = 4
-	ListPartContainerName          int = 5
+	listPartID                     int = 0
+	listPartLocalFolder            int = 1
+	listPartComposeProject         int = 2
+	listPartComposeService         int = 3
+	listPartComposeContainerNumber int = 4
+	listPartContainerName          int = 5
 )
 
+var _ = listPartComposeContainerNumber
+
 // ListDevcontainers returns a list of devcontainers
 func ListDevcontainers() ([]DevcontainerInfo, error) {
 	cmd := exec.Command("docker", "ps", "--format", "{{.ID}}|{{.Label \"vsch.local.folder\"}}|{{.Label \"com.docker.compose.project\"}}|{{.Label \"com.docker.compose.service\"}}|{{.Label \"com.docker.compose.container-number\"}}|{{.Names}}")
@@ -48,22 +50,36 @@ func ListDevcontainers() ([]DevcontainerInfo, error) {
 	for scanner.Scan() {
 		line := scanner.Text()
 		parts := strings.Split(line, "|")
-		name := parts[ListPartLocalFolder]
+		name := parts[listPartLocalFolder]
 		if name == "" {
 			// No local folder => use dockercompose parts
-			name = fmt.Sprintf("%s/%s", parts[ListPartComposeProject], parts[ListPartComposeService])
+			name = fmt.Sprintf("%s/%s", parts[listPartComposeProject], parts[listPartComposeService])
 		} else {
 			// get the last path segment for the name
 			if index := strings.LastIndexAny(name, "/\\"); index >= 0 {
 				name = name[index+1:]
 			}
 		}
 		devcontainer := DevcontainerInfo{
-			ContainerID:      parts[ListPartID],
-			ContainerName:    parts[ListPartContainerName],
+			ContainerID:      parts[listPartID],
+			ContainerName:    parts[listPartContainerName],
 			DevcontainerName: name,
 		}
 		devcontainers = append(devcontainers, devcontainer)
 	}
 	return devcontainers, nil
 }
+
+// GetLocalFolderFromDevContainer looks up the local (host) folder name from the container labels
+func GetLocalFolderFromDevContainer(containerIDOrName string) (string, error) {
+	//docker inspect cool_goldberg --format '{{ index .Config.Labels "vsch.local.folder" }}'
+
+	cmd := exec.Command("docker", "inspect", containerIDOrName, "--format", "{{ index .Config.Labels \"vsch.local.folder\" }}")
+
+	output, err := cmd.Output()
+	if err != nil {
+		return "", fmt.Errorf("Failed to read docker stdout: %v", err)
+	}
+
+	return strings.TrimSpace(string(output)), nil
+}

internal/pkg/devcontainers/remoteuri.go

@@ -6,6 +6,7 @@ import (
 	"io/ioutil"
 	"path/filepath"
 	"regexp"
+	"strings"
 
 	"github.com/stuartleeks/devcontainer-cli/internal/pkg/wsl"
 )
@@ -28,7 +29,7 @@ func GetDevContainerURI(folderPath string) (string, error) {
 	}
 
 	launchPathHex := convertToHexString(launchPath)
-	workspaceMountPath, err := getWorkspaceMountPath(absPath)
+	workspaceMountPath, err := GetWorkspaceMountPath(absPath)
 	if err != nil {
 		return "", err
 	}
@@ -41,14 +42,21 @@ func convertToHexString(input string) string {
 	return hex.EncodeToString([]byte(input))
 }
 
-// TODO: add tests (and implementation) to handle JSON parsing with comments
-// Current implementation doesn't handle
-//  - block comments
-//  - the value split on a new line from the property name
-
-func getWorkspaceMountPath(folderPath string) (string, error) {
+// GetWorkspaceMountPath returns the devcontainer mount path for the devcontainer in the specified folder
+func GetWorkspaceMountPath(folderPath string) (string, error) {
 	// TODO - consider how to support repository-containers (https://github.com/microsoft/vscode-remote-release/issues/3218)
 
+	// If we're called from WSL we want a WSL Path but will also handle a Windows Path
+	if wsl.IsWsl() {
+		if strings.HasPrefix(folderPath, "\\\\wsl$\\") {
+			convertedPath, err := wsl.ConvertWindowsPathToWslPath(folderPath)
+			if err != nil {
+				return "", err
+			}
+			folderPath = convertedPath
+		}
+	}
+
 	devcontainerDefinitionPath := filepath.Join(folderPath, ".devcontainer/devcontainer.json")
 	buf, err := ioutil.ReadFile(devcontainerDefinitionPath)
 	if err != nil {
@@ -68,6 +76,11 @@ func getWorkspaceMountPath(folderPath string) (string, error) {
 	return fmt.Sprintf("/workspaces/%s", folderName), nil
 }
 
+// TODO: add tests (and implementation) to handle JSON parsing with comments
+// Current implementation doesn't handle
+//  - block comments
+//  - the value split on a new line from the property name
+
 func getWorkspaceMountPathFromDevcontainerDefinition(definition []byte) (string, error) {
 	r, err := regexp.Compile("(?m)^\\s*\"workspaceFolder\"\\s*:\\s*\"(.*)\"")
 	if err != nil {

internal/pkg/wsl/wsl.go

@@ -19,7 +19,18 @@ func ConvertWslPathToWindowsPath(path string) (string, error) {
 
 	buf, err := cmd.Output()
 	if err != nil {
-		return "", fmt.Errorf("Error running wslpath: %s", err)
+		return "", fmt.Errorf("Error running wslpath (for %q): %s", path, err)
+	}
+	return strings.TrimSpace(string(buf)), nil
+}
+
+// ConvertWslPathToWindowsPath converts a WSL path to the corresponding \\wsl$\... path for access from Windows
+func ConvertWindowsPathToWslPath(path string) (string, error) {
+	cmd := exec.Command("wslpath", "-u", path)
+
+	buf, err := cmd.Output()
+	if err != nil {
+		return "", fmt.Errorf("Error running wslpath (for %q): %s", path, err)
 	}
 	return strings.TrimSpace(string(buf)), nil
 }