Add open command

cmoog · cmoog · commit 721fe629fea7 · 2020-11-02T11:54:45.000-06:00
diff --git a/docs/coder.md b/docs/coder.md
@@ -16,6 +16,7 @@ coder provides a CLI for working with an existing Coder Enterprise installation
 * [coder envs](coder_envs.md)	 - Interact with Coder environments
 * [coder login](coder_login.md)	 - Authenticate this client for future operations
 * [coder logout](coder_logout.md)	 - Remove local authentication credentials if any exist
+* [coder open](coder_open.md)	 - launch your IDE and connect to a Coder environment
 * [coder secrets](coder_secrets.md)	 - Interact with Coder Secrets
 * [coder sh](coder_sh.md)	 - Open a shell and execute commands in a Coder environment
 * [coder sync](coder_sync.md)	 - Establish a one way directory sync to a Coder environment
diff --git a/docs/coder_open.md b/docs/coder_open.md
@@ -0,0 +1,31 @@
+## coder open
+
+launch your IDE and connect to a Coder environment
+
+```
+coder open [environment_name]:[remote_workspace_path] [flags]
+```
+
+### Examples
+
+```
+coder open backend-dev:/home/coder
+coder open backend-dev:/home/coder/backend-project
+```
+
+### Options
+
+```
+  -h, --help   help for open
+```
+
+### Options inherited from parent commands
+
+```
+  -v, --verbose   show verbose output
+```
+
+### SEE ALSO
+
+* [coder](coder.md)	 - coder provides a CLI for working with an existing Coder Enterprise installation
+
diff --git a/internal/cmd/cmd.go b/internal/cmd/cmd.go
@@ -24,6 +24,7 @@ func Make() *cobra.Command {
 		loginCmd(),
 		logoutCmd(),
 		shCmd(),
+		openCmd(),
 		usersCmd(),
 		configSSHCmd(),
 		secretsCmd(),
diff --git a/internal/cmd/open.go b/internal/cmd/open.go
@@ -0,0 +1,111 @@
+package cmd
+
+import (
+	"context"
+	"fmt"
+	"os/exec"
+	"os/user"
+	"path/filepath"
+	"strings"
+
+	"cdr.dev/coder-cli/coder-sdk"
+	"cdr.dev/coder-cli/pkg/clog"
+	"github.com/spf13/cobra"
+)
+
+func openCmd() *cobra.Command {
+	return &cobra.Command{
+		Use:               "open [environment_name]:[remote_workspace_path]",
+		Args:              cobra.ExactArgs(1),
+		Short:             "launch your IDE and connect to a Coder environment",
+		ValidArgsFunction: getEnvsForCompletion(coder.Me),
+		Example: `coder open backend-dev:/home/coder
+coder open backend-dev:/home/coder/backend-project`,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			ctx := cmd.Context()
+			client, err := newClient(ctx)
+			if err != nil {
+				return err
+			}
+			parts := strings.Split(args[0], ":")
+			if len(parts) < 2 {
+				return cmd.Usage()
+			}
+
+			envName, workspacePath := parts[0], parts[1]
+			env, err := findEnv(ctx, client, envName, coder.Me)
+			if err != nil {
+				return err
+			}
+			warnIfAliasMissing(env.Name)
+
+			if _, err := exec.LookPath("code"); err != nil {
+				return clog.Error(
+					`"code" command line tool not found`, clog.BlankLine,
+					clog.Tipf(`read about "code" here: https://code.visualstudio.com/docs/editor/command-line`),
+				)
+			}
+
+			// TODO(@cmoog) maybe check if it's not installed first, although it does seem to check internally
+			if err = installRemoteSSH(ctx); err != nil {
+				return clog.Error(
+					"failed to install VSCode Remote SSH extension", clog.BlankLine,
+					clog.Causef(err.Error()),
+				)
+			}
+
+			if err = openVSCodeRemote(ctx, env.Name, workspacePath); err != nil {
+				return err
+			}
+
+			return nil
+		},
+	}
+}
+
+func warnIfAliasMissing(envName string) {
+	usr, err := user.Current()
+	if err != nil {
+		return
+	}
+
+	// TODO(@cmoog) might be a better way of finding the path of the SSH config / whether an alias is valid or not
+	config, err := readStr(filepath.Join(usr.HomeDir, ".ssh", "config"))
+	if err != nil {
+		clog.LogWarn(
+			"failed to check that SSH target exists", clog.BlankLine,
+			clog.Causef(err.Error()),
+			clog.Tipf(`run "coder config-ssh" to add SSH targets for each environment`),
+		)
+		return
+	}
+
+	if !strings.Contains(config, fmt.Sprintf("coder.%s", envName)) {
+		clog.LogWarn(
+			"SSH alias not found for environment", clog.BlankLine,
+			clog.Tipf(`run "coder config-ssh" to add SSH targets for each environment`),
+		)
+		return
+	}
+}
+
+func installRemoteSSH(ctx context.Context) error {
+	cmd := exec.CommandContext(ctx,
+		"code", "--install-extension", "ms-vscode-remote.remote-ssh",
+	)
+	if _, err := cmd.CombinedOutput(); err != nil {
+		return err
+	}
+	return nil
+}
+
+func openVSCodeRemote(ctx context.Context, envName, dirPath string) error {
+	cmd := exec.CommandContext(ctx,
+		"code", "--remote", "ssh-remote+coder."+envName, dirPath,
+	)
+	_, err := cmd.CombinedOutput()
+	if err != nil {
+		return err
+	}
+	return nil
+}
diff --git a/pkg/clog/doc.go b/pkg/clog/doc.go
@@ -2,6 +2,6 @@
 //
 // clog encourages returning error types rather than
 // logging them and failing with os.Exit as they happen.
-// Error, Fatal, and Warn allow downstream functions to return errors with rich formatting information
+// Error and Fatal allow downstream functions to return errors with rich formatting information
 // while preserving the original, single-line error chain.
 package clog
