1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
|
require 'helper'
require 'securerandom'
require 'benchmark'
module SSHKit
module Backend
class TestNetssh < FunctionalTest
def setup
super
@output = String.new
SSHKit.config.output_verbosity = :debug
SSHKit.config.output = SSHKit::Formatter::SimpleText.new(@output)
end
def a_host
VagrantWrapper.hosts['one']
end
def test_simple_netssh
Netssh.new(a_host) do
execute 'date'
execute :ls, '-l'
with rails_env: :production do
within '/tmp' do
as :root do
execute :touch, 'restart.txt'
end
end
end
end.run
command_lines = @output.lines.select { |line| line.start_with?('Command:') }
assert_equal [
"Command: /usr/bin/env date\n",
"Command: /usr/bin/env ls -l\n",
"Command: if test ! -d /tmp; then echo \"Directory does not exist '/tmp'\" 1>&2; false; fi\n",
"Command: if ! sudo -u root whoami > /dev/null; then echo \"You cannot switch to user 'root' using sudo, please check the sudoers file\" 1>&2; false; fi\n",
"Command: cd /tmp && ( export RAILS_ENV=\"production\" ; sudo -u root RAILS_ENV=\"production\" -- sh -c /usr/bin/env\\ touch\\ restart.txt )\n"
], command_lines
end
def test_redaction
# Be sure redaction in the logs is showing [REDACTED]
Netssh.new(a_host) do
execute :echo, 'password:', redact('PASSWORD')
execute :echo, 'password:', redact(10000)
execute :echo, 'password:', redact(['test1','test2'])
execute :echo, 'password:', redact({:test => 'test_value'})
end.run
command_lines = @output.lines.select { |line| line.start_with?('Command:') }
assert_equal [
"Command: /usr/bin/env echo password: [REDACTED]\n",
"Command: /usr/bin/env echo password: [REDACTED]\n",
"Command: /usr/bin/env echo password: [REDACTED]\n",
"Command: /usr/bin/env echo password: [REDACTED]\n"
], command_lines
# Be sure the actual command executed without *REDACTED*
Netssh.new(a_host) do
file_name = 'test.file'
execute :touch, redact("'#{file_name}'") # Test and be sure single quotes are included in actual command; expected /usr/bin/env touch 'test.file'
execute :ls, 'test.file'
end.run
ls_lines = @output.lines.select { |line| line.start_with?("\ttest.file") }
assert_equal [
"\ttest.file\n"
], ls_lines
# Cleanup
Netssh.new(a_host) do
execute :rm, ' -f test.file'
end.run
end
def test_group_netssh
Netssh.new(a_host) do
as user: :root, group: :admin do
execute :touch, 'restart.txt'
end
end.run
command_lines = @output.lines.select { |line| line.start_with?('Command:') }
assert_equal [
"Command: if ! sudo -u root whoami > /dev/null; then echo \"You cannot switch to user 'root' using sudo, please check the sudoers file\" 1>&2; false; fi\n",
"Command: sudo -u root -- sh -c sg\\ admin\\ -c\\ /usr/bin/env\\\\\\ touch\\\\\\ restart.txt\n"
], command_lines
end
def test_capture
captured_command_result = nil
Netssh.new(a_host) do |_host|
captured_command_result = capture(:uname)
end.run
assert_includes %W(Linux Darwin), captured_command_result
end
def test_ssh_option_merge
keepalive_opt = { keepalive: true }
test_host = a_host.dup
test_host.ssh_options = keepalive_opt
host_ssh_options = {}
SSHKit::Backend::Netssh.config.ssh_options = { forward_agent: false }
Netssh.new(test_host) do |host|
capture(:uname)
host_ssh_options = host.ssh_options
end.run
assert_equal [:forward_agent, *keepalive_opt.keys, :known_hosts, :logger, :password_prompt].sort, host_ssh_options.keys.sort
assert_equal false, host_ssh_options[:forward_agent]
assert_equal keepalive_opt.values.first, host_ssh_options[keepalive_opt.keys.first]
assert_instance_of SSHKit::Backend::Netssh::KnownHosts, host_ssh_options[:known_hosts]
end
def test_env_vars_substituion_in_subshell
captured_command_result = nil
Netssh.new(a_host) do |_host|
with some_env_var: :some_value do
captured_command_result = capture(:echo, '$SOME_ENV_VAR')
end
end.run
assert_equal "some_value", captured_command_result
end
def test_execute_raises_on_non_zero_exit_status_and_captures_stdout_and_stderr
err = assert_raises SSHKit::Command::Failed do
Netssh.new(a_host) do |_host|
execute :echo, "'Test capturing stderr' 1>&2; false"
end.run
end
assert_equal "echo exit status: 1\necho stdout: Nothing written\necho stderr: Test capturing stderr\n", err.message
end
def test_test_does_not_raise_on_non_zero_exit_status
Netssh.new(a_host) do |_host|
test :false
end.run
end
def test_upload_and_then_capture_file_contents
actual_file_contents = ""
file_name = File.join("/tmp", SecureRandom.uuid)
File.open file_name, 'w+' do |f|
f.write "Some Content\nWith a newline and trailing spaces \n "
end
Netssh.new(a_host) do
upload!(file_name, file_name)
actual_file_contents = capture(:cat, file_name, strip: false)
end.run
assert_equal "Some Content\nWith a newline and trailing spaces \n ", actual_file_contents
end
def test_upload_within
file_name = SecureRandom.uuid
file_contents = "Some Content"
dir_name = SecureRandom.uuid
actual_file_contents = ""
Netssh.new(a_host) do |_host|
within("/tmp") do
execute :mkdir, "-p", dir_name
within(dir_name) do
upload!(StringIO.new(file_contents), file_name)
end
end
actual_file_contents = capture(:cat, "/tmp/#{dir_name}/#{file_name}", strip: false)
end.run
assert_equal file_contents, actual_file_contents
end
def test_upload_string_io
file_contents = ""
Netssh.new(a_host) do |_host|
file_name = File.join("/tmp", SecureRandom.uuid)
upload!(StringIO.new('example_io'), file_name)
file_contents = download!(file_name)
end.run
assert_equal "example_io", file_contents
end
def test_upload_large_file
size = 25
fills = SecureRandom.random_bytes(1024*1024)
file_name = "/tmp/file-#{size}.txt"
File.open(file_name, 'wb') do |f|
(size).times {f.write(fills) }
end
file_contents = ""
Netssh.new(a_host) do
upload!(file_name, file_name)
file_contents = download!(file_name)
end.run
assert_equal File.open(file_name, 'rb').read, file_contents
end
def test_upload_via_pathname
file_contents = ""
Netssh.new(a_host) do |_host|
file_name = Pathname.new(File.join("/tmp", SecureRandom.uuid))
upload!(StringIO.new('example_io'), file_name)
file_contents = download!(file_name)
end.run
assert_equal "example_io", file_contents
end
def test_interaction_handler
captured_command_result = nil
Netssh.new(a_host) do
command = 'echo Enter Data; read the_data; echo Captured $the_data;'
captured_command_result = capture(command, interaction_handler: {
"Enter Data\n" => "SOME DATA\n",
"Captured SOME DATA\n" => nil
})
end.run
assert_equal("Enter Data\nCaptured SOME DATA", captured_command_result)
end
def test_connection_pool_keepalive
# ensure we enable connection pool
SSHKit::Backend::Netssh.pool.idle_timeout = 10
Netssh.new(a_host) do |_host|
test :false
end.run
sleep 2.5
captured_command_result = nil
Netssh.new(a_host) do |_host|
captured_command_result = capture(:echo, 'some_value')
end.run
assert_equal "some_value", captured_command_result
end
end
end
end
|