synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-15 22:20:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
This allows deleting ssh config options
This commit is contained in:
Steven Masley
2023-03-28 11:06:42 -05:00
committed by GitHub
parent 1176256a44
commit a8346bd8ea
2 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
cli/configssh.go
View File

@ -62,7 +62,7 @@ func (o *sshConfigOptions) addOptions(options ...string) error {
} }
func (o *sshConfigOptions) addOption(option string) error { func (o *sshConfigOptions) addOption(option string) error {
key, _, err := codersdk.ParseSSHConfigOption(option) key, value, err := codersdk.ParseSSHConfigOption(option)
if err != nil { if err != nil {
return err return err
} }
@ -77,11 +77,20 @@ func (o *sshConfigOptions) addOption(option string) error {
continue continue
} }
if strings.EqualFold(existingKey, key) { 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 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 return nil
} }

3
cli/configssh_test.go
View File

@ -66,6 +66,7 @@ func TestConfigSSH(t *testing.T) {
const hostname = "test-coder." const hostname = "test-coder."
const expectedKey = "ConnectionAttempts" const expectedKey = "ConnectionAttempts"
const removeKey = "ConnectionTimeout"
client := coderdtest.New(t, &coderdtest.Options{ client := coderdtest.New(t, &coderdtest.Options{
IncludeProvisionerDaemon: true, IncludeProvisionerDaemon: true,
ConfigSSH: codersdk.SSHConfigResponse{ ConfigSSH: codersdk.SSHConfigResponse{
@ -73,6 +74,7 @@ func TestConfigSSH(t *testing.T) {
SSHConfigOptions: map[string]string{ SSHConfigOptions: map[string]string{
// Something we can test for // Something we can test for
expectedKey: "3", expectedKey: "3",
removeKey: "",
}, },
}, },
}) })
@ -176,6 +178,7 @@ func TestConfigSSH(t *testing.T) {
fileContents, err := os.ReadFile(sshConfigFile) fileContents, err := os.ReadFile(sshConfigFile)
require.NoError(t, err, "read ssh config file") require.NoError(t, err, "read ssh config file")
require.Contains(t, string(fileContents), expectedKey, "ssh config file contains expected key") 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)) home := filepath.Dir(filepath.Dir(sshConfigFile))
// #nosec // #nosec