Class: Bolt::Transport::Local::Connection

Inherits:
Object
  • Object
show all
Defined in:
lib/bolt/transport/local/connection.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(target) ⇒ Connection

Returns a new instance of Connection.



15
16
17
18
19
20
 
# File 'lib/bolt/transport/local/connection.rb', line 15

def initialize(target)
  @target = target
  # The familiar problem: Etc.getlogin is broken on osx
  @user = ENV['USER'] || Etc.getlogin
  @logger = Bolt::Logger.logger(self)
end

Instance Attribute Details

#logger ⇒ Object

Returns the value of attribute logger.



13
14
15
 
# File 'lib/bolt/transport/local/connection.rb', line 13

def logger
  @logger
end

#target ⇒ Object

Returns the value of attribute target.



13
14
15
 
# File 'lib/bolt/transport/local/connection.rb', line 13

def target
  @target
end

#user ⇒ Object

Returns the value of attribute user.



13
14
15
 
# File 'lib/bolt/transport/local/connection.rb', line 13

def user
  @user
end

Instance Method Details

#download_file(source, dest, _download) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/bolt/transport/local/connection.rb', line 48

def download_file(source, dest, _download)
  @logger.trace { "Downloading #{source} to #{dest}" }
  # Create the destination directory for the target, or the
  # copied file will have the target's name
  FileUtils.mkdir_p(dest)
  # Mimic the behavior of `cp --remove-destination`
  # since the flag isn't supported on MacOS
  FileUtils.cp_r(source, dest, remove_destination: true)
rescue StandardError => e
  message = "Could not download file to #{dest}: #{e}"
  raise Bolt::Node::FileError.new(message, 'DOWNLOAD_ERROR')
end

#execute(command) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/bolt/transport/local/connection.rb', line 61

def execute(command)
  if Bolt::Util.windows?
    # If it's already a powershell command then invoke it normally.
    # Otherwise, wrap it in powershell.exe.
    unless command.start_with?('powershell.exe')
      cmd = Bolt::Shell::Powershell::Snippets.exit_with_code(command)
      command = ['powershell.exe', *Bolt::Shell::Powershell::PS_ARGS, '-Command', cmd]
    end
  end

  Open3.popen3(*command)
end

#max_command_length ⇒ Object 



80
81
82
83
84
 
# File 'lib/bolt/transport/local/connection.rb', line 80

def max_command_length
  if Bolt::Util.windows?
    32000
  end
end

#reset_cwd? ⇒ Boolean

This is used by the Bash shell to decide whether to ‘cd` before executing commands as a run-as user

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/bolt/transport/local/connection.rb', line 76

def reset_cwd?
  false
end

#shell ⇒ Object 



22
23
24
25
26
27
28
 
# File 'lib/bolt/transport/local/connection.rb', line 22

def shell
  @shell ||= if Bolt::Util.windows?
               Bolt::Shell::Powershell.new(target, self)
             else
               Bolt::Shell::Bash.new(target, self)
             end
end

#upload_file(source, dest) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/bolt/transport/local/connection.rb', line 30

def upload_file(source, dest)
  @logger.trace { "Uploading #{source} to #{dest}" }
  if source.is_a?(StringIO)
    Tempfile.create(File.basename(dest)) do |f|
      f.write(source.read)
      f.close
      FileUtils.mv(f, dest)
    end
  else
    # Mimic the behavior of `cp --remove-destination`
    # since the flag isn't supported on MacOS
    FileUtils.cp_r(source, dest, remove_destination: true)
  end
rescue StandardError => e
  message = "Could not copy file to #{dest}: #{e}"
  raise Bolt::Node::FileError.new(message, 'COPY_ERROR')
end