Class: Bolt::Transport::Base
- Inherits:
-
Object
- Object
- Bolt::Transport::Base
- Defined in:
- lib/bolt/transport/base.rb
Overview
This class provides the default behavior for Transports. A Transport is responsible for uploading files and running commands, scripts, and tasks on Targets.
Bolt executes work on the Transport in “batches”. To do that, it calls the batches() method, which is responsible for dividing the list of Targets into batches according to how it wants to handle them. It will then call Transport#batch_task, or the corresponding method for another operation, passing a list of Targets. The Transport returns a list of Bolt::Result objects, one per Target. Each batch is executed on a separate thread, controlled by the ‘concurrency` setting, so many batches may be running in parallel.
The default batch implementation splits the list of Targets into batches of 1. It then calls run_task(), or a corresponding method for other operations, passing in the single Target.
Most Transport implementations, like the SSH and WinRM transports, don’t need to do their own batching, since they only operate on a single Target at a time. Those Transports can implement the run_task() and related methods, which will automatically handle running many Targets in parallel, and will handle publishing start and finish events for each Target.
Transports that need their own batching, like the Orch transport, can instead override the batches() method to split Targets into sets that can be executed together, and override the batch_task() and related methods to execute a batch of nodes. In that case, those Transports should accept a block argument and call it with a :node_start event for each Target before executing, and a :node_result event for each Target after execution.
Constant Summary collapse
- STDIN_METHODS =
%w[both stdin].freeze
- ENVIRONMENT_METHODS =
%w[both environment].freeze
Instance Attribute Summary collapse
-
#logger ⇒ Object
readonly
Returns the value of attribute logger.
Class Method Summary collapse
- .filter_options(unfiltered) ⇒ Object
-
.options ⇒ Object
Returns options this transport supports.
- .validate(_options) ⇒ Object
Instance Method Summary collapse
-
#assert_batch_size_one(method, targets) ⇒ Object
Raises an error if more than one target was given in the batch.
-
#batch_command(targets, command, options = {}, &callback) ⇒ Object
Runs the given command on a batch of nodes.
- #batch_connected?(targets) ⇒ Boolean
-
#batch_script(targets, script, arguments, options = {}, &callback) ⇒ Object
Runs the given script on a batch of nodes.
-
#batch_task(targets, task, arguments, options = {}, &callback) ⇒ Object
Runs the given task on a batch of nodes.
-
#batch_upload(targets, source, destination, options = {}, &callback) ⇒ Object
Uploads the given source file to the destination location on a batch of nodes.
-
#batches(targets) ⇒ Object
Split the given list of targets into a list of batches.
-
#connected?(_targets) ⇒ Boolean
Transports should override this method with their own implementation of a connection test.
- #default_input_method(_executable) ⇒ Object
-
#envify_params(params) ⇒ Object
Transform a parameter map to an environment variable map, with parameter names prefixed with ‘PT_’ and values transformed to JSON unless they’re strings.
-
#initialize ⇒ Base
constructor
A new instance of Base.
- #provided_features ⇒ Object
-
#run_command(*_args) ⇒ Object
Transports should override this method with their own implementation of running a command.
-
#run_script(*_args) ⇒ Object
Transports should override this method with their own implementation of running a script.
-
#run_task(*_args) ⇒ Object
Transports should override this method with their own implementation of running a task.
- #select_implementation(target, task) ⇒ Object
-
#unwrap_sensitive_args(arguments) ⇒ Object
Unwraps any Sensitive data in an arguments Hash, so the plain-text is passed to the Task/Script.
-
#upload(*_args) ⇒ Object
Transports should override this method with their own implementation of file upload.
- #with_events(target, callback) ⇒ Object
Constructor Details
#initialize ⇒ Base
Returns a new instance of Base.
59 60 61 |
# File 'lib/bolt/transport/base.rb', line 59 def initialize @logger = Logging.logger[self] end |
Instance Attribute Details
#logger ⇒ Object (readonly)
Returns the value of attribute logger.
43 44 45 |
# File 'lib/bolt/transport/base.rb', line 43 def logger @logger end |
Class Method Details
.filter_options(unfiltered) ⇒ Object
51 52 53 |
# File 'lib/bolt/transport/base.rb', line 51 def self.(unfiltered) unfiltered.select { |k| .include?(k) } end |
.options ⇒ Object
Returns options this transport supports
46 47 48 49 |
# File 'lib/bolt/transport/base.rb', line 46 def self. raise NotImplementedError, "self.options() or self.filter_options(unfiltered) must be implemented by the transport class" end |
.validate(_options) ⇒ Object
55 56 57 |
# File 'lib/bolt/transport/base.rb', line 55 def self.validate() raise NotImplementedError, "self.validate() must be implemented by the transport class" end |
Instance Method Details
#assert_batch_size_one(method, targets) ⇒ Object
Raises an error if more than one target was given in the batch.
The default implementations of batch_* strictly assume the transport is using the default batch size of 1. This method ensures that is the case and raises an error if it’s not.
113 114 115 116 117 118 |
# File 'lib/bolt/transport/base.rb', line 113 def assert_batch_size_one(method, targets) if targets.length > 1 = "#{self.class.name} must implement #{method} to support batches (got #{targets.length} nodes)" raise NotImplementedError, end end |
#batch_command(targets, command, options = {}, &callback) ⇒ Object
Runs the given command on a batch of nodes.
The default implementation only supports batches of size 1 and will fail otherwise.
Transports may override this method to implement their own batch processing.
139 140 141 142 143 144 145 146 |
# File 'lib/bolt/transport/base.rb', line 139 def batch_command(targets, command, = {}, &callback) assert_batch_size_one("batch_command()", targets) target = targets.first with_events(target, callback) do @logger.debug("Running command '#{command}' on #{target.uri}") run_command(target, command, (target, )) end end |
#batch_connected?(targets) ⇒ Boolean
176 177 178 179 |
# File 'lib/bolt/transport/base.rb', line 176 def batch_connected?(targets) assert_batch_size_one("connected?()", targets) connected?(targets.first) end |
#batch_script(targets, script, arguments, options = {}, &callback) ⇒ Object
Runs the given script on a batch of nodes.
The default implementation only supports batches of size 1 and will fail otherwise.
Transports may override this method to implement their own batch processing.
153 154 155 156 157 158 159 160 |
# File 'lib/bolt/transport/base.rb', line 153 def batch_script(targets, script, arguments, = {}, &callback) assert_batch_size_one("batch_script()", targets) target = targets.first with_events(target, callback) do @logger.debug { "Running script '#{script}' on #{target.uri}" } run_script(target, script, arguments, (target, )) end end |
#batch_task(targets, task, arguments, options = {}, &callback) ⇒ Object
Runs the given task on a batch of nodes.
The default implementation only supports batches of size 1 and will fail otherwise.
Transports may override this method to implement their own batch processing.
125 126 127 128 129 130 131 132 |
# File 'lib/bolt/transport/base.rb', line 125 def batch_task(targets, task, arguments, = {}, &callback) assert_batch_size_one("batch_task()", targets) target = targets.first with_events(target, callback) do @logger.debug { "Running task run '#{task}' on #{target.uri}" } run_task(target, task, arguments, (target, )) end end |
#batch_upload(targets, source, destination, options = {}, &callback) ⇒ Object
Uploads the given source file to the destination location on a batch of nodes.
The default implementation only supports batches of size 1 and will fail otherwise.
Transports may override this method to implement their own batch processing.
167 168 169 170 171 172 173 174 |
# File 'lib/bolt/transport/base.rb', line 167 def batch_upload(targets, source, destination, = {}, &callback) assert_batch_size_one("batch_upload()", targets) target = targets.first with_events(target, callback) do @logger.debug { "Uploading: '#{source}' to #{destination} on #{target.uri}" } upload(target, source, destination, (target, )) end end |
#batches(targets) ⇒ Object
Split the given list of targets into a list of batches. The default implementation returns single-node batches.
Transports may override this method, and the corresponding batch_* methods, to implement their own batch processing.
186 187 188 |
# File 'lib/bolt/transport/base.rb', line 186 def batches(targets) targets.map { |target| [target] } end |
#connected?(_targets) ⇒ Boolean
Transports should override this method with their own implementation of a connection test.
211 212 213 |
# File 'lib/bolt/transport/base.rb', line 211 def connected?(_targets) raise NotImplementedError, "connected?() must be implemented by the transport class" end |
#default_input_method(_executable) ⇒ Object
80 81 82 |
# File 'lib/bolt/transport/base.rb', line 80 def default_input_method(_executable) 'both' end |
#envify_params(params) ⇒ Object
Transform a parameter map to an environment variable map, with parameter names prefixed with ‘PT_’ and values transformed to JSON unless they’re strings.
101 102 103 104 105 106 |
# File 'lib/bolt/transport/base.rb', line 101 def envify_params(params) params.each_with_object({}) do |(k, v), h| v = v.to_json unless v.is_a?(String) h["PT_#{k}"] = v end end |
#provided_features ⇒ Object
76 77 78 |
# File 'lib/bolt/transport/base.rb', line 76 def provided_features [] end |
#run_command(*_args) ⇒ Object
Transports should override this method with their own implementation of running a command.
191 192 193 |
# File 'lib/bolt/transport/base.rb', line 191 def run_command(*_args) raise NotImplementedError, "run_command() must be implemented by the transport class" end |
#run_script(*_args) ⇒ Object
Transports should override this method with their own implementation of running a script.
196 197 198 |
# File 'lib/bolt/transport/base.rb', line 196 def run_script(*_args) raise NotImplementedError, "run_script() must be implemented by the transport class" end |
#run_task(*_args) ⇒ Object
Transports should override this method with their own implementation of running a task.
201 202 203 |
# File 'lib/bolt/transport/base.rb', line 201 def run_task(*_args) raise NotImplementedError, "run_task() must be implemented by the transport class" end |
#select_implementation(target, task) ⇒ Object
84 85 86 87 88 |
# File 'lib/bolt/transport/base.rb', line 84 def select_implementation(target, task) impl = task.select_implementation(target, provided_features) impl['input_method'] ||= default_input_method(impl['path']) impl end |
#unwrap_sensitive_args(arguments) ⇒ Object
Unwraps any Sensitive data in an arguments Hash, so the plain-text is passed to the Task/Script.
This works on deeply nested data structures composed of Hashes, Arrays, and and plain-old data types (int, string, etc).
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/bolt/transport/base.rb', line 220 def unwrap_sensitive_args(arguments) # Skip this if Puppet isn't loaded return arguments unless defined?(Puppet::Pops::Types::PSensitiveType::Sensitive) case arguments when Array # iterate over the array, unwrapping all elements arguments.map { |x| unwrap_sensitive_args(x) } when Hash # iterate over the arguments hash and unwrap all keys and values arguments.each_with_object({}) { |(k, v), h| h[unwrap_sensitive_args(k)] = unwrap_sensitive_args(v) } when Puppet::Pops::Types::PSensitiveType::Sensitive # this value is Sensitive, unwrap it unwrap_sensitive_args(arguments.unwrap) else # unknown data type, just return it arguments end end |
#upload(*_args) ⇒ Object
Transports should override this method with their own implementation of file upload.
206 207 208 |
# File 'lib/bolt/transport/base.rb', line 206 def upload(*_args) raise NotImplementedError, "upload() must be implemented by the transport class" end |
#with_events(target, callback) ⇒ Object
63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/bolt/transport/base.rb', line 63 def with_events(target, callback) callback&.call(type: :node_start, target: target) result = begin yield rescue StandardError, NotImplementedError => ex Bolt::Result.from_exception(target, ex) end callback&.call(type: :node_result, result: result) result end |