feat: Allow unsetting ssh config options from deployment (#6847)

Emyrk · web-flow · commit a8346bd8eaf7 · 2023-03-28T11:06:42.000-05:00
This allows deleting ssh config options
diff --git a/cli/configssh.go b/cli/configssh.go
@@ -62,7 +62,7 @@ func (o *sshConfigOptions) addOptions(options ...string) error {
 }
 
 func (o *sshConfigOptions) addOption(option string) error {
-	key, _, err := codersdk.ParseSSHConfigOption(option)
+	key, value, err := codersdk.ParseSSHConfigOption(option)
 	if err != nil {
 		return err
 	}
@@ -77,11 +77,20 @@ func (o *sshConfigOptions) addOption(option string) error {
 			continue
 		}
 		if strings.EqualFold(existingKey, key) {
-			o.sshOptions[i] = option
+			if value == "" {
+				// Delete existing option.
+				o.sshOptions = append(o.sshOptions[:i], o.sshOptions[i+1:]...)
+			} else {
+				// Override existing option.
+				o.sshOptions[i] = option
+			}
 			return nil
 		}
 	}
-	o.sshOptions = append(o.sshOptions, option)
+	// Only append the option if it is not empty.
+	if value != "" {
+		o.sshOptions = append(o.sshOptions, option)
+	}
 	return nil
 }
 
diff --git a/cli/configssh_test.go b/cli/configssh_test.go
@@ -66,13 +66,15 @@ func TestConfigSSH(t *testing.T) {
 
 	const hostname = "test-coder."
 	const expectedKey = "ConnectionAttempts"
+	const removeKey = "ConnectionTimeout"
 	client := coderdtest.New(t, &coderdtest.Options{
 		IncludeProvisionerDaemon: true,
 		ConfigSSH: codersdk.SSHConfigResponse{
 			HostnamePrefix: hostname,
 			SSHConfigOptions: map[string]string{
 				// Something we can test for
 				expectedKey: "3",
+				removeKey:   "",
 			},
 		},
 	})
@@ -176,6 +178,7 @@ func TestConfigSSH(t *testing.T) {
 	fileContents, err := os.ReadFile(sshConfigFile)
 	require.NoError(t, err, "read ssh config file")
 	require.Contains(t, string(fileContents), expectedKey, "ssh config file contains expected key")
+	require.NotContains(t, string(fileContents), removeKey, "ssh config file should not have removed key")
 
 	home := filepath.Dir(filepath.Dir(sshConfigFile))
 	// #nosec

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ func (o *sshConfigOptions) addOptions(options ...string) error {`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`func (o *sshConfigOptions) addOption(option string) error {`
`65`		`- key, _, err := codersdk.ParseSSHConfigOption(option)`
	`65`	`+ key, value, err := codersdk.ParseSSHConfigOption(option)`
`66`	`66`	`if err != nil {`
`67`	`67`	`return err`
`68`	`68`	`}`
`@@ -77,11 +77,20 @@ func (o *sshConfigOptions) addOption(option string) error {`
`77`	`77`	`continue`
`78`	`78`	`}`
`79`	`79`	`if strings.EqualFold(existingKey, key) {`
`80`		`- o.sshOptions[i] = option`
	`80`	`+ if value == "" {`
	`81`	`+ // Delete existing option.`
	`82`	`+ o.sshOptions = append(o.sshOptions[:i], o.sshOptions[i+1:]...)`
	`83`	`+ } else {`
	`84`	`+ // Override existing option.`
	`85`	`+ o.sshOptions[i] = option`
	`86`	`+ }`
`81`	`87`	`return nil`
`82`	`88`	`}`
`83`	`89`	`}`
`84`		`- o.sshOptions = append(o.sshOptions, option)`
	`90`	`+ // Only append the option if it is not empty.`
	`91`	`+ if value != "" {`
	`92`	`+ o.sshOptions = append(o.sshOptions, option)`
	`93`	`+ }`
`85`	`94`	`return nil`
`86`	`95`	`}`
`87`	`96`