Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow ssh/config to accept string, or array of strings #1129

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion lib/kamal/commands/base.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ def initialize(config)
end

def run_over_ssh(*command, host:)
"ssh#{ssh_proxy_args} -t #{config.ssh.user}@#{host} -p #{config.ssh.port} '#{command.join(" ").gsub("'", "'\\\\''")}'"
"ssh#{ssh_proxy_args}#{ssh_config_args} -t #{config.ssh.user}@#{host} -p #{config.ssh.port} '#{command.join(" ").gsub("'", "'\\\\''")}'"
end

def container_id_for(container_name:, only_running: false)
Expand Down Expand Up @@ -94,5 +94,16 @@ def ssh_proxy_args
" -o ProxyCommand='#{config.ssh.proxy.command_line_template}'"
end
end

def ssh_config_args
case config.ssh.config
when true, nil
""
when false
" -F none"
when String
" -F #{Shellwords.escape(config.ssh.config)}"
end
end
end
end
2 changes: 1 addition & 1 deletion lib/kamal/configuration/docs/ssh.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,5 @@ ssh:
#
# Set to true to load the default OpenSSH config files (~/.ssh/config,
# /etc/ssh_config), to false ignore config files, or to a file path
# (or array of paths) to load specific configuration. Defaults to true.
# to load specific configuration. Defaults to true.
config: true
8 changes: 6 additions & 2 deletions lib/kamal/configuration/ssh.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ class Kamal::Configuration::Ssh

def initialize(config:)
@ssh_config = config.raw_config.ssh || {}
validate! ssh_config
validate! ssh_config, with: Kamal::Configuration::Validator::Ssh
end

def user
Expand Down Expand Up @@ -38,8 +38,12 @@ def key_data
ssh_config["key_data"]
end

def config
ssh_config["config"]
end

def options
{ user: user, port: port, proxy: proxy, logger: logger, keepalive: true, keepalive_interval: 30, keys_only: keys_only, keys: keys, key_data: key_data }.compact
{ user: user, port: port, proxy: proxy, logger: logger, keepalive: true, keepalive_interval: 30, keys_only: keys_only, keys: keys, key_data: key_data, config: config }.compact
end

def to_h
Expand Down
19 changes: 19 additions & 0 deletions lib/kamal/configuration/validator/ssh.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
class Kamal::Configuration::Validator::Ssh < Kamal::Configuration::Validator
SPECIAL_KEYS = [ "config" ]

def validate!
validate_against_example! \
config.except(*SPECIAL_KEYS),
example.except(*SPECIAL_KEYS)

validate_config_key! if config.key?("config")
end

private

def validate_config_key!
with_context(config["config"]) do
validate_type! config["config"], TrueClass, String
end
end
end
10 changes: 10 additions & 0 deletions test/commands/app_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,16 @@ class CommandsAppTest < ActiveSupport::TestCase
assert_equal "ssh -t [email protected] -p 2222 'ls'", new_command.run_over_ssh("ls", host: "1.1.1.1")
end

test "run over ssh with custom config" do
@config[:ssh] = { "config" => "config/ssh config" }
assert_equal "ssh -F config/ssh\\ config -t [email protected] -p 22 'ls'", new_command.run_over_ssh("ls", host: "1.1.1.1")
end

test "run over ssh with no config" do
@config[:ssh] = { "config" => false }
assert_equal "ssh -F none -t [email protected] -p 22 'ls'", new_command.run_over_ssh("ls", host: "1.1.1.1")
end

test "run over ssh with proxy" do
@config[:ssh] = { "proxy" => "2.2.2.2" }
assert_equal "ssh -J [email protected] -t [email protected] -p 22 'ls'", new_command.run_over_ssh("ls", host: "1.1.1.1")
Expand Down
10 changes: 10 additions & 0 deletions test/configuration/ssh_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,14 @@ class ConfigurationSshTest < ActiveSupport::TestCase
config = Kamal::Configuration.new(@deploy.tap { |c| c.merge!(ssh: { "proxy" => "[email protected]" }) })
assert_equal "[email protected]", config.ssh.options[:proxy].jump_proxies
end

test "ssh options with disabled ssh_config" do
config = Kamal::Configuration.new(@deploy.tap { |c| c.merge!(ssh: { "config" => false }) })
assert_equal false, config.ssh.options[:config]
end

test "ssh options with path to an ssh_config-file" do
config = Kamal::Configuration.new(@deploy.tap { |c| c.merge!(ssh: { "config" => "config/ssh_config" }) })
assert_equal "config/ssh_config", config.ssh.options[:config]
end
end