Use env.ssh_available field in config-ssh

deansheather · deansheather · commit f14f8ea38004 · 2020-12-03T17:37:09.000Z
diff --git a/coder-sdk/env.go b/coder-sdk/env.go
@@ -32,6 +32,7 @@ type Environment struct {
 	LastOpenedAt     time.Time        `json:"last_opened_at"     table:"-"`
 	LastConnectionAt time.Time        `json:"last_connection_at" table:"-"`
 	AutoOffThreshold Duration         `json:"auto_off_threshold" table:"-"`
+	SSHAvailable     bool             `json:"ssh_available"      table:"-"`
 }
 
 // RebuildMessage defines the message shown when an Environment requires a rebuild for it can be accessed.
diff --git a/internal/cmd/configssh.go b/internal/cmd/configssh.go
@@ -93,10 +93,6 @@ func configSSH(configpath *string, remove *bool) func(cmd *cobra.Command, _ []st
 			return err
 		}
 
-		if !isSSHAvailable(ctx) {
-			return xerrors.New("SSH is disabled or not available for your Coder Enterprise deployment.")
-		}
-
 		user, err := client.Me(ctx)
 		if err != nil {
 			return xerrors.Errorf("fetch username: %w", err)
@@ -109,6 +105,16 @@ func configSSH(configpath *string, remove *bool) func(cmd *cobra.Command, _ []st
 		if len(envs) < 1 {
 			return xerrors.New("no environments found")
 		}
+
+		if !sshAvailable(envs) {
+			return xerrors.New("SSH is disabled or not available any environments in your Coder Enterprise deployment.")
+		}
+
+		err = canConnectSSH(ctx)
+		if err != nil {
+			return xerrors.Errorf("check if SSH is available: unable to connect to SSH endpoint: %w", err)
+		}
+
 		newConfig, err := makeNewConfigs(user.Username, envs, startToken, startMessage, endToken, privateKeyFilepath)
 		if err != nil {
 			return xerrors.Errorf("make new ssh configurations: %w", err)
@@ -145,6 +151,43 @@ func configSSH(configpath *string, remove *bool) func(cmd *cobra.Command, _ []st
 	}
 }
 
+// sshAvailable returns true if SSH is available for at least one environment.
+func sshAvailable(envs []coder.Environment) bool {
+	for _, env := range envs {
+		if env.SSHAvailable {
+			return true
+		}
+	}
+
+	return false
+}
+
+// canConnectSSH returns an error if we cannot dial the SSH port.
+func canConnectSSH(ctx context.Context) error {
+	ctx, cancel := context.WithTimeout(ctx, 3*time.Second)
+	defer cancel()
+
+	host, err := configuredHostname()
+	if err != nil {
+		return xerrors.Errorf("get configured manager hostname: %w", err)
+	}
+
+	var (
+		dialer   net.Dialer
+		hostPort = net.JoinHostPort(host, "22")
+	)
+	conn, err := dialer.DialContext(ctx, "tcp", hostPort)
+	if err != nil {
+		if err == context.DeadlineExceeded {
+			err = xerrors.New("timed out after 3 seconds")
+		}
+		return xerrors.Errorf("dial tcp://%v: %w", hostPort, err)
+	}
+	conn.Close()
+
+	return nil
+}
+
 func writeSSHKey(ctx context.Context, client *coder.Client, privateKeyPath string) error {
 	key, err := client.SSHKey(ctx)
 	if err != nil {
@@ -161,6 +204,10 @@ func makeNewConfigs(userName string, envs []coder.Environment, startToken, start
 
 	newConfig := fmt.Sprintf("\n%s\n%s\n\n", startToken, startMsg)
 	for _, env := range envs {
+		if !env.SSHAvailable {
+			continue
+		}
+
 		newConfig += makeSSHConfig(hostname, userName, env.Name, privateKeyFilepath)
 	}
 	newConfig += fmt.Sprintf("\n%s\n", endToken)
@@ -181,20 +228,6 @@ func makeSSHConfig(host, userName, envName, privateKeyFilepath string) string {
 `, envName, host, userName, envName, privateKeyFilepath)
 }
 
-func isSSHAvailable(ctx context.Context) bool {
-	ctx, cancel := context.WithTimeout(ctx, 3*time.Second)
-	defer cancel()
-
-	host, err := configuredHostname()
-	if err != nil {
-		return false
-	}
-
-	var dialer net.Dialer
-	_, err = dialer.DialContext(ctx, "tcp", net.JoinHostPort(host, "22"))
-	return err == nil
-}
-
 func configuredHostname() (string, error) {
 	u, err := config.URL.Read()
 	if err != nil {

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ type Environment struct {`
`32`	`32`	LastOpenedAt time.Time `json:"last_opened_at" table:"-"`
`33`	`33`	LastConnectionAt time.Time `json:"last_connection_at" table:"-"`
`34`	`34`	AutoOffThreshold Duration `json:"auto_off_threshold" table:"-"`
	`35`	+ SSHAvailable bool `json:"ssh_available" table:"-"`
`35`	`36`	`}`
`36`	`37`
`37`	`38`	`// RebuildMessage defines the message shown when an Environment requires a rebuild for it can be accessed.`