Class: ChefMetal::Transport::SSH

Inherits:
ChefMetal::Transport show all
Defined in:
lib/chef_metal/transport/ssh.rb

Defined Under Namespace

Classes: SSHResult

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(host, username, ssh_options, options) ⇒ SSH

Returns a new instance of SSH.



8
9
10
11
12
13
14
15
 
# File 'lib/chef_metal/transport/ssh.rb', line 8

def initialize(host, username, ssh_options, options)
  require 'net/ssh'
  require 'net/scp'
  @host = host
  @username = username
  @ssh_options = ssh_options
  @options = options
end

Instance Attribute Details

#host ⇒ Object (readonly)

Returns the value of attribute host.



17
18
19
 
# File 'lib/chef_metal/transport/ssh.rb', line 17

def host
  @host
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



20
21
22
 
# File 'lib/chef_metal/transport/ssh.rb', line 20

def options
  @options
end

#ssh_options ⇒ Object (readonly)

Returns the value of attribute ssh_options.



19
20
21
 
# File 'lib/chef_metal/transport/ssh.rb', line 19

def ssh_options
  @ssh_options
end

#username ⇒ Object (readonly)

Returns the value of attribute username.



18
19
20
 
# File 'lib/chef_metal/transport/ssh.rb', line 18

def username
  @username
end

Instance Method Details

#available? ⇒ Boolean

Returns:

  • (Boolean) 


123
124
125
126
127
128
129
 
# File 'lib/chef_metal/transport/ssh.rb', line 123

def available?
  execute('pwd')
  true
rescue Errno::ETIMEDOUT, Errno::ECONNREFUSED, Errno::ECONNRESET, Net::SSH::AuthenticationFailed, Net::SSH::Disconnect, Net::SSH::HostKeyMismatch
  Chef::Log.debug("#{username}@#{host} unavailable: could not execute 'pwd' on #{host}: #{$!.inspect}")
  false
end

#disconnect ⇒ Object 



112
113
114
115
116
117
118
119
120
121
 
# File 'lib/chef_metal/transport/ssh.rb', line 112

def disconnect
  if @session
    begin
      Chef::Log.debug("Closing SSH session on #{username}@#{host}")
      @session.close
    rescue
    end
    @session = nil
  end
end

#download_file(path, local_path) ⇒ Object 



70
71
72
73
 
# File 'lib/chef_metal/transport/ssh.rb', line 70

def download_file(path, local_path)
  Chef::Log.debug("Downloading file #{path} from #{username}@#{host} to local #{local_path}")
  download(path, local_path)
end

#execute(command, execute_options = {}) ⇒ Object 



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
 
# File 'lib/chef_metal/transport/ssh.rb', line 22

def execute(command, execute_options = {})
  Chef::Log.info("Executing #{options[:prefix]}#{command} on #{username}@#{host}")
  stdout = ''
  stderr = ''
  exitstatus = nil
  channel = session.open_channel do |channel|
    # Enable PTY unless otherwise specified, some instances require this
    unless options[:ssh_pty_enable] == false
      channel.request_pty do |chan, success|
         raise "could not get pty" if !success && options[:ssh_pty_enable]
      end
    end


    channel.exec("#{options[:prefix]}#{command}") do |ch, success|
      raise "could not execute command: #{command.inspect}" unless success

      channel.on_data do |ch2, data|
        stdout << data
        stream_chunk(execute_options, data, nil)
      end

      channel.on_extended_data do |ch2, type, data|
        stderr << data
        stream_chunk(execute_options, nil, data)
      end

      channel.on_request "exit-status" do |ch, data|
        exitstatus = data.read_long
      end
    end
  end

  channel.wait

  Chef::Log.info("Completed #{command} on #{username}@#{host}: exit status #{exitstatus}")
  Chef::Log.debug("Stdout was:\n#{stdout}") if stdout != '' && !options[:stream] && !options[:stream_stdout]
  Chef::Log.info("Stderr was:\n#{stderr}") if stderr != '' && !options[:stream] && !options[:stream_stderr]
  SSHResult.new(command, execute_options, stdout, stderr, exitstatus)
end

#make_url_available_to_remote(local_url) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
 
# File 'lib/chef_metal/transport/ssh.rb', line 101

def make_url_available_to_remote(local_url)
  uri = URI(local_url)
  host = Socket.getaddrinfo(uri.host, uri.scheme, nil, :STREAM)[0][3]
  if host == '127.0.0.1' || host == '[::1]'
    # TODO IPv6
    Chef::Log.debug("Forwarding local server 127.0.0.1:#{uri.port} to port #{uri.port} on #{username}@#{host}")
    session.forward.remote(uri.port, "127.0.0.1", uri.port)
  end
  local_url
end

#read_file(path) ⇒ Object 



63
64
65
66
67
68
 
# File 'lib/chef_metal/transport/ssh.rb', line 63

def read_file(path)
  Chef::Log.debug("Reading file #{path} from #{username}@#{host}")
  result = StringIO.new
  download(path, result)
  result.string
end

#upload_file(local_path, path) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/chef_metal/transport/ssh.rb', line 88

def upload_file(local_path, path)
  if options[:prefix]
    # Make a tempfile on the other side, upload to that, and sudo mv / chown / etc.
    remote_tempfile = "/tmp/#{File.basename(path)}.#{Random.rand(2**32)}"
    Chef::Log.debug("Uploading #{local_path} to #{remote_tempfile} on #{username}@#{host}")
    Net::SCP.new(session).upload!(local_path, remote_tempfile)
    execute("mv #{remote_tempfile} #{path}")
  else
    Chef::Log.debug("Uploading #{local_path} to #{path} on #{username}@#{host}")
    Net::SCP.new(session).upload!(local_path, path)
  end
end

#write_file(path, content) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/chef_metal/transport/ssh.rb', line 75

def write_file(path, content)
  if options[:prefix]
    # Make a tempfile on the other side, upload to that, and sudo mv / chown / etc.
    remote_tempfile = "/tmp/#{File.basename(path)}.#{Random.rand(2**32)}"
    Chef::Log.debug("Writing #{content.length} bytes to #{remote_tempfile} on #{username}@#{host}")
    Net::SCP.new(session).upload!(StringIO.new(content), remote_tempfile)
    execute("mv #{remote_tempfile} #{path}")
  else
    Chef::Log.debug("Writing #{content.length} bytes to #{path} on #{username}@#{host}")
    Net::SCP.new(session).upload!(StringIO.new(content), path)
  end
end