Class: Bolt::Transport::Docker
- Inherits:
-
Base
- Object
- Base
- Bolt::Transport::Docker
show all
- Defined in:
- lib/bolt/transport/docker.rb,
lib/bolt/transport/docker/connection.rb
Defined Under Namespace
Classes: Connection
Constant Summary
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
-
#connected?(target) ⇒ Boolean
-
#provided_features ⇒ Object
-
#run_command(target, command, _options = {}) ⇒ Object
-
#run_script(target, script, arguments, _options = {}) ⇒ Object
-
#run_task(target, task, arguments, _options = {}) ⇒ Object
-
#upload(target, source, destination, _options = {}) ⇒ Object
-
#with_connection(target) {|conn| ... } ⇒ Object
Methods inherited from Base
#assert_batch_size_one, #batch_command, #batch_connected?, #batch_script, #batch_task, #batch_upload, #batches, #default_input_method, #envify_params, filter_options, #initialize, #select_implementation, #unwrap_sensitive_args, #with_events
Class Method Details
.options ⇒ Object
10
11
12
|
# File 'lib/bolt/transport/docker.rb', line 10
def self.options
%w[service-url service-options tmpdir]
end
|
.validate(options) ⇒ Object
18
19
20
21
22
23
24
25
26
27
28
29
30
|
# File 'lib/bolt/transport/docker.rb', line 18
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
if (opts = options['service-options'])
unless opts.instance_of?(Hash)
raise Bolt::ValidationError, 'service-options must be a hash'
end
end
end
|
Instance Method Details
#connected?(target) ⇒ Boolean
120
121
122
123
124
|
# File 'lib/bolt/transport/docker.rb', line 120
def connected?(target)
with_connection(target) { true }
rescue Bolt::Node::ConnectError
false
end
|
#provided_features ⇒ Object
14
15
16
|
# File 'lib/bolt/transport/docker.rb', line 14
def provided_features
['shell']
end
|
#run_command(target, command, _options = {}) ⇒ Object
59
60
61
62
63
64
|
# File 'lib/bolt/transport/docker.rb', line 59
def run_command(target, command, _options = {})
with_connection(target) do |conn|
stdout, stderr, exitcode = conn.execute(*Shellwords.split(command), {})
Bolt::Result.for_command(target, stdout.join, stderr.join, exitcode)
end
end
|
#run_script(target, script, arguments, _options = {}) ⇒ Object
66
67
68
69
70
71
72
73
74
75
76
77
|
# File 'lib/bolt/transport/docker.rb', line 66
def run_script(target, script, arguments, _options = {})
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.join, stderr.join, exitcode)
end
end
end
|
#run_task(target, task, arguments, _options = {}) ⇒ Object
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
|
# File 'lib/bolt/transport/docker.rb', line 79
def run_task(target, task, arguments, _options = {})
implementation = task.select_implementation(target, provided_features)
executable = implementation['path']
input_method = implementation['input_method']
= implementation['files']
input_method ||= 'both'
arguments = unwrap_sensitive_args(arguments)
with_connection(target) do |conn|
execute_options = {}
conn.with_remote_tempdir do |dir|
if .empty?
task_dir = dir
else
arguments['_installdir'] = dir
task_dir = File.join(dir, task.tasks_dir)
conn.mkdirs([task_dir] + .map { |file| File.join(dir, File.dirname(file['name'])) })
.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.join, stderr.join, exitcode)
end
end
end
|
#upload(target, source, destination, _options = {}) ⇒ Object
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
# File 'lib/bolt/transport/docker.rb', line 38
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.join}"
raise Bolt::Node::FileError.new(message, 'MV_ERROR')
end
end
Bolt::Result.for_upload(target, source, destination)
end
end
|
#with_connection(target) {|conn| ... } ⇒ Object
32
33
34
35
36
|
# File 'lib/bolt/transport/docker.rb', line 32
def with_connection(target)
conn = Connection.new(target)
conn.connect
yield conn
end
|