feat: Add support for ssh_port config for host

sikalabs · Jan 27, 2024 · 11667e4 · 11667e4
1 parent 7b4074e
commit 11667e4
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 1 deletion.
diff --git a/pkg/config/config.go b/pkg/config/config.go
@@ -8,6 +8,7 @@ type ConfigMeta struct {
 
 type ConfigHost struct {
 	SSHTarget    string                 `yaml:"ssh_target"`
+	SSHPort      int                    `yaml:"ssh_port"`
 	SSHPassword  string                 `yaml:"ssh_password"`
 	SSHOptions   []string               `yaml:"ssh_options"`
 	SudoPassword string                 `yaml:"sudo_password"`

diff --git a/pkg/libtask/libtask.go b/pkg/libtask/libtask.go
@@ -2,6 +2,7 @@ package libtask
 
 type TaskInput struct {
 	SSHTarget               string
+	SSHPort                 int
 	SSHPassword             string
 	SSHOptions              []string
 	NoStrictHostKeyChecking bool

diff --git a/pkg/run/run.go b/pkg/run/run.go
@@ -116,13 +116,18 @@ func Run(
 					if !quietOutput {
 						fmt.Printf("+ play: %s (%d/%d)\n", play.Name, playI, lenPlays)
 						fmt.Printf("  task: %s (%d/%d)\n", t.Name, taskI, lenTasks)
-						fmt.Printf("  host: %s (%d/%d)\n", host.SSHTarget, hostI, lenHosts)
+						if host.SSHPort == 0 {
+							fmt.Printf("  host: %s (%d/%d)\n", host.SSHTarget, hostI, lenHosts)
+						} else {
+							fmt.Printf("  host: %s (port %d) (%d/%d)\n", host.SSHTarget, host.SSHPort, hostI, lenHosts)
+						}
 						if play.Sudo {
 							fmt.Printf("  sudo: %t\n", play.Sudo)
 						}
 					}
 					taskInput := libtask.TaskInput{
 						SSHTarget:               host.SSHTarget,
+						SSHPort:                 host.SSHPort,
 						SSHPassword:             host.SSHPassword,
 						SSHOptions:              host.SSHOptions,
 						SudoPassword:            host.SudoPassword,

diff --git a/pkg/utils/exec_utils/exec_utils.go b/pkg/utils/exec_utils/exec_utils.go
@@ -59,6 +59,9 @@ func SSH(taskInput libtask.TaskInput, cmdArray ...string) error {
 	if taskInput.NoStrictHostKeyChecking {
 		args = append([]string{"-o", "StrictHostKeyChecking=no"}, args...)
 	}
+	if taskInput.SSHPort != 0 {
+		args = append([]string{"-p", fmt.Sprintf("%d", taskInput.SSHPort)}, args...)
+	}
 	for _, option := range taskInput.SSHOptions {
 		args = append([]string{"-o", option}, args...)
 	}
@@ -74,6 +77,9 @@ func rawSCP(taskInput libtask.TaskInput, localPath string, remotePath string) er
 	if taskInput.NoStrictHostKeyChecking {
 		args = append([]string{"-o", "StrictHostKeyChecking=no"}, args...)
 	}
+	if taskInput.SSHPort != 0 {
+		args = append([]string{"-P", fmt.Sprintf("%d", taskInput.SSHPort)}, args...)
+	}
 	if taskInput.SSHPassword != "" {
 		return Exec(taskInput, "sshpass", append([]string{"-p", taskInput.SSHPassword, "scp"}, args...)...)
 	} else {
@@ -86,6 +92,9 @@ func rawSCPRemoteToLocal(taskInput libtask.TaskInput, remotePath string, localPa
 	if taskInput.NoStrictHostKeyChecking {
 		args = append([]string{"-o", "StrictHostKeyChecking=no"}, args...)
 	}
+	if taskInput.SSHPort != 0 {
+		args = append([]string{"-P", fmt.Sprintf("%d", taskInput.SSHPort)}, args...)
+	}
 	if taskInput.SSHPassword != "" {
 		return Exec(taskInput, "sshpass", append([]string{"-p", taskInput.SSHPassword, "scp"}, args...)...)
 	} else {