- Notifications
You must be signed in to change notification settings - Fork928
feat: Refactor CLI config-ssh to Include configurations#1848
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,13 @@ | ||
| package cli | ||
| import ( | ||
| "bufio" | ||
| "fmt" | ||
| "io/fs" | ||
| "os" | ||
| "path/filepath" | ||
| "runtime" | ||
| "strings" | ||
| "github.com/cli/safeexec" | ||
| "github.com/spf13/cobra" | ||
| @@ -18,15 +19,19 @@ import ( | ||
| "github.com/coder/coder/codersdk" | ||
| ) | ||
| const ( | ||
| // Include path is relative to `~/.ssh` and each workspace will | ||
| // have a separate file (e.g. `~/.ssh/coder.d/host-my-workspace`). | ||
| // By prefixing hosts as `host-` we give ourselves the flexibility | ||
| // to manage other files in this folder as well, e.g. keys, vscode | ||
| // specific config (i.e. for only listing coder files in vscode), | ||
| // etc. | ||
| sshEnabledLine = "Include coder.d/host-*" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Is there a reason to prefer multiple configurations over a single, larger one? e.g. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I did have some thoughts in mind, one was to store a hash in the config file so we can detect user modifications and prompt to overwrite. Another is for the user to be able to include specific hosts into their config (example):
In Code you could then set | ||
| // TODO(mafredri): Does this hold on Windows? | ||
| sshCoderConfigd = "~/.ssh/coder.d" | ||
| // TODO(mafredri): Write a README to the folder? | ||
| // sshCoderConfigdReadme = `Information, tricks, removal, etc.` | ||
Comment on lines -24 to +33 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. What kind of migration path will this have for users? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Unfortunately, yes. The idea was originally that we'd get this changed early enough for that not to be a problem. But if it is, we can add a cleanup function (I'd have left it in but it wasn't implemented yet 😄.) | ||
| ) | ||
| func configSSH() *cobra.Command { | ||
| var ( | ||
| @@ -52,18 +57,11 @@ func configSSH() *cobra.Command { | ||
| if err != nil { | ||
| return err | ||
| } | ||
| dirname, _ := os.UserHomeDir() | ||
| if strings.HasPrefix(sshConfigFile, "~/") { | ||
| sshConfigFile = filepath.Join(dirname, sshConfigFile[2:]) | ||
| } | ||
| confd := filepath.Join(dirname, sshCoderConfigd[2:]) | ||
| workspaces, err := client.WorkspacesByOwner(cmd.Context(), organization.ID, codersdk.Me) | ||
| if err != nil { | ||
| @@ -78,10 +76,74 @@ func configSSH() *cobra.Command { | ||
| return err | ||
| } | ||
| enabled := false | ||
| err = func() error { | ||
| exists := true | ||
| configRaw, err := os.Open(sshConfigFile) | ||
| if err != nil && !xerrors.Is(err, fs.ErrNotExist) { | ||
| return err | ||
| } else if xerrors.Is(err, fs.ErrNotExist) { | ||
| exists = false | ||
| } | ||
| defer configRaw.Close() | ||
| if exists { | ||
| s := bufio.NewScanner(configRaw) | ||
| for s.Scan() { | ||
| if strings.HasPrefix(s.Text(), sshEnabledLine) { | ||
| enabled = true | ||
| break | ||
| } | ||
| } | ||
| if s.Err() != nil { | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| }() | ||
Comment on lines +80 to +103 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. 🤔 make it its own func, perhaps? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Will do 👍🏻! (Lots of cleanup left to do here.) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if !enabled { | ||
| _, err = cliui.Prompt(cmd, cliui.PromptOptions{ | ||
| Text: fmt.Sprintf("The following line will be added to %s:\n\n %s\n\n And configuration files will be stored in ~/.ssh/coder.d\n\n Continue?", sshConfigFile, sshEnabledLine), | ||
| IsConfirm: true, | ||
| }) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| _, _ = fmt.Fprintf(cmd.OutOrStdout(), "\n") | ||
| // Create directory first in case of error since we do not check for existence. | ||
| err = os.Mkdir(confd, 0o700) | ||
| if err != nil && !xerrors.Is(err, fs.ErrExist) { | ||
| return err | ||
| } | ||
| f, err := os.OpenFile(sshConfigFile, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0o644) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| // TODO(mafredri): Only add newline if necessary. | ||
| _, err = f.WriteString("\n" + sshEnabledLine) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| err = f.Close() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| _, _ = fmt.Fprintf(cmd.OutOrStdout(), "* Added Include directive to %s\n", sshConfigFile) | ||
| _, _ = fmt.Fprintf(cmd.OutOrStdout(), "* Created configuration directory %s\n", confd) | ||
| } | ||
| root := createConfig(cmd) | ||
| var errGroup errgroup.Group | ||
| // TODO(mafredri): Delete configurations that no longer exist. | ||
| for _, workspace := range workspaces { | ||
| workspace := workspace | ||
| errGroup.Go(func() error { | ||
| @@ -94,7 +156,6 @@ func configSSH() *cobra.Command { | ||
| continue | ||
| } | ||
| for _, agent := range resource.Agents { | ||
| hostname := workspace.Name | ||
| if len(resource.Agents) > 1 { | ||
| hostname += "." + agent.Name | ||
| @@ -119,8 +180,13 @@ func configSSH() *cobra.Command { | ||
| if !skipProxyCommand { | ||
| configOptions = append(configOptions, fmt.Sprintf("\tProxyCommand %q --global-config %q ssh --stdio %s", binaryFile, root, hostname)) | ||
| } | ||
| dest := filepath.Join(confd, fmt.Sprintf("host-%s", hostname)) | ||
| // TODO(mafredri): Avoid re-write if files match. | ||
| err := os.WriteFile(dest, []byte(strings.Join(configOptions, "\n")), 0o600) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
| } | ||
| return nil | ||
| @@ -130,18 +196,10 @@ func configSSH() *cobra.Command { | ||
| if err != nil { | ||
| return err | ||
| } | ||
| _, _ = fmt.Fprintf(cmd.OutOrStdout(), "* Created workspace configurations in %s\n\n", confd) | ||
| _, _ = fmt.Fprintln(cmd.OutOrStdout(), "You should now be able to ssh into your workspace.") | ||
| _, _ = fmt.Fprintf(cmd.OutOrStdout(), "For example, try running:\n\n\t$ ssh coder.%s\n\n", workspaces[0].Name) | ||
| return nil | ||
| }, | ||
| } | ||