Class: Bolt::Transport::Docker

Inherits:
Base
  • Object
show all
Defined in:
lib/bolt/transport/docker.rb,
lib/bolt/transport/docker/connection.rb

Defined Under Namespace

Classes: Connection

Constant Summary collapse

OPTIONS = 
{
  "host"          => "Host name.",
  "interpreters"  => "A map of an extension name to the absolute path of an executable, "\
                      "enabling you to override the shebang defined in a task executable. The "\
                      "extension can optionally be specified with the `.` character (`.py` and "\
                      "`py` both map to a task executable `task.py`) and the extension is case "\
                      "sensitive. When a target's name is `localhost`, Ruby tasks run with the "\
                      "Bolt Ruby interpreter by default.",
  "service-url"   => "URL of the Docker host used for API requests.",
  "shell-command" => "A shell command to wrap any Docker exec commands in, such as `bash -lc`.",
  "tmpdir"        => "The directory to upload and execute temporary files on the target.",
  "tty"           => "Whether to enable tty on exec commands."
}.freeze

Constants inherited from Base

Base::ENVIRONMENT_METHODS, Base::STDIN_METHODS

Instance Attribute Summary

Attributes inherited from Base

#logger

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#assert_batch_size_one, #batch_command, #batch_connected?, #batch_script, #batch_task, #batch_upload, #batches, #default_input_method, default_options, #envify_params, filter_options, #initialize, #select_implementation, #select_interpreter, #unwrap_sensitive_args, #with_events

Constructor Details

This class inherits a constructor from Bolt::Transport::Base

Class Method Details

.options ⇒ Object 



24
25
26
 
# File 'lib/bolt/transport/docker.rb', line 24

def self.options
  OPTIONS.keys
end

.validate(options) ⇒ Object 



32
33
34
35
36
37
38
 
# File 'lib/bolt/transport/docker.rb', line 32

def self.validate(options)
  if (url = options['service-url'])
    unless url.instance_of?(String)
      raise Bolt::ValidationError, 'service-url must be a string'
    end
  end
end

Instance Method Details

#connected?(target) ⇒ Boolean

Returns:

  • (Boolean) 


135
136
137
138
139
 
# File 'lib/bolt/transport/docker.rb', line 135

def connected?(target)
  with_connection(target) { true }
rescue Bolt::Node::ConnectError
  false
end

#provided_features ⇒ Object 



28
29
30
 
# File 'lib/bolt/transport/docker.rb', line 28

def provided_features
  ['shell']
end

#run_command(target, command, options = {}) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/bolt/transport/docker.rb', line 67

def run_command(target, command, options = {})
  options[:tty] = target.options['tty']

  if target.options['shell-command'] && !target.options['shell-command'].empty?
    # escape any double quotes in command
    command = command.gsub('"', '\"')
    command = "#{target.options['shell-command']} \" #{command}\""
  end
  with_connection(target) do |conn|
    stdout, stderr, exitcode = conn.execute(*Shellwords.split(command), options)
    Bolt::Result.for_command(target, stdout, stderr, exitcode, 'command', command)
  end
end

#run_script(target, script, arguments, _options = {}) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/bolt/transport/docker.rb', line 81

def run_script(target, script, arguments, _options = {})
  # unpack any Sensitive data
  arguments = unwrap_sensitive_args(arguments)

  with_connection(target) do |conn|
    conn.with_remote_tempdir do |dir|
      remote_path = conn.write_remote_executable(dir, script)
      stdout, stderr, exitcode = conn.execute(remote_path, *arguments, {})
      Bolt::Result.for_command(target, stdout, stderr, exitcode, 'script', script)
    end
  end
end

#run_task(target, task, arguments, _options = {}) ⇒ Object 



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
 
# File 'lib/bolt/transport/docker.rb', line 94

def run_task(target, task, arguments, _options = {})
  implementation = task.select_implementation(target, provided_features)
  executable = implementation['path']
  input_method = implementation['input_method']
  extra_files = implementation['files']
  input_method ||= 'both'

  # unpack any Sensitive data
  arguments = unwrap_sensitive_args(arguments)
  with_connection(target) do |conn|
    execute_options = {}
    execute_options[:interpreter] = select_interpreter(executable, target.options['interpreters'])
    conn.with_remote_tempdir do |dir|
      if extra_files.empty?
        task_dir = dir
      else
        # TODO: optimize upload of directories
        arguments['_installdir'] = dir
        task_dir = File.join(dir, task.tasks_dir)
        conn.mkdirs([task_dir] + extra_files.map { |file| File.join(dir, File.dirname(file['name'])) })
        extra_files.each do |file|
          conn.write_remote_file(file['path'], File.join(dir, file['name']))
        end
      end

      remote_task_path = conn.write_remote_executable(task_dir, executable)

      if STDIN_METHODS.include?(input_method)
        execute_options[:stdin] = StringIO.new(JSON.dump(arguments))
      end

      if ENVIRONMENT_METHODS.include?(input_method)
        execute_options[:environment] = envify_params(arguments)
      end

      stdout, stderr, exitcode = conn.execute(remote_task_path, execute_options)
      Bolt::Result.for_task(target, stdout, stderr, exitcode, task.name)
    end
  end
end

#upload(target, source, destination, _options = {}) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/bolt/transport/docker.rb', line 46

def upload(target, source, destination, _options = {})
  with_connection(target) do |conn|
    conn.with_remote_tempdir do |dir|
      basename = File.basename(destination)
      tmpfile = "#{dir}/#{basename}"
      if File.directory?(source)
        conn.write_remote_directory(source, tmpfile)
      else
        conn.write_remote_file(source, tmpfile)
      end

      _, stderr, exitcode = conn.execute('mv', tmpfile, destination, {})
      if exitcode != 0
        message = "Could not move temporary file '#{tmpfile}' to #{destination}: #{stderr}"
        raise Bolt::Node::FileError.new(message, 'MV_ERROR')
      end
    end
    Bolt::Result.for_upload(target, source, destination)
  end
end

#with_connection(target) {|conn| ... } ⇒ Object

Yields:

  • (conn) 


40
41
42
43
44
 
# File 'lib/bolt/transport/docker.rb', line 40

def with_connection(target)
  conn = Connection.new(target)
  conn.connect
  yield conn
end