Class: Vagrant::Action::Builtin::SSHRun

Inherits:
Object
  • Object
show all
Includes:
Util
Defined in:
lib/vagrant/action/builtin/ssh_run.rb

Overview

This class will run a single command on the remote machine and will mirror the output to the UI. The resulting exit status of the command will exist in the :ssh_run_exit_status key in the environment.

Instance Method Summary collapse

Constructor Details

#initialize(app, env) ⇒ SSHRun

Returns a new instance of SSHRun.



17
18
19
20
 
# File 'lib/vagrant/action/builtin/ssh_run.rb', line 17

def initialize(app, env)
  @app    = app
  @logger = Log4r::Logger.new("vagrant::action::builtin::ssh_run")
end

Instance Method Details

#call(env) ⇒ Object

Raises:



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
 
# File 'lib/vagrant/action/builtin/ssh_run.rb', line 22

def call(env)
  # Grab the SSH info from the machine or the environment
  info = env[:ssh_info]
  info ||= env[:machine].ssh_info

  # If the result is nil, then the machine is telling us that it is
  # not yet ready for SSH, so we raise this exception.
  raise Errors::SSHNotReady if info.nil?

  info[:private_key_path] ||= []

  if info[:keys_only] && info[:private_key_path].empty?
    raise Errors::SSHRunRequiresKeys
  end

  # Get the command and wrap it in a login shell
  command = ShellQuote.escape(env[:ssh_run_command], "'")
  command = "#{env[:machine].config.ssh.shell} -c '#{command}'"

  # Execute!
  opts = env[:ssh_opts] || {}
  opts[:extra_args] ||= []

  # Allow the user to specify a tty or non-tty manually, but if they
  # don't then we default to a TTY
  if !opts[:extra_args].include?("-t") &&
      !opts[:extra_args].include?("-T") &&
      env[:tty]
    opts[:extra_args] << "-t"
  end

  opts[:extra_args] << command
  opts[:subprocess] = true
  env[:ssh_run_exit_status] = Util::SSH.exec(info, opts)

  # Call the next middleware
  @app.call(env)
end