Class: Bolt::Executor

Inherits:
Object
  • Object
show all
Defined in:
lib/bolt/executor.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = Bolt::Config.new, analytics = Bolt::Analytics::NoopClient.new, noop = nil, bundled_content: nil) ⇒ Executor

Returns a new instance of Executor.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/bolt/executor.rb', line 21

def initialize(config = Bolt::Config.new,
               analytics = Bolt::Analytics::NoopClient.new,
               noop = nil,
               bundled_content: nil)
  @config = config
  @analytics = analytics
  @bundled_content = bundled_content
  @logger = Logging.logger[self]
  @plan_logging = false

  @transports = Bolt::TRANSPORTS.each_with_object({}) do |(key, val), coll|
    coll[key.to_s] = Concurrent::Delay.new do
      val.new
    end
  end
  @reported_transports = Set.new

  @noop = noop
  @run_as = nil
  @pool = Concurrent::ThreadPoolExecutor.new(max_threads: @config[:concurrency])
  @logger.debug { "Started with #{@config[:concurrency]} max thread(s)" }
  @notifier = Bolt::Notifier.new
end

Instance Attribute Details

#noop ⇒ Object (readonly)

Returns the value of attribute noop.



18
19
20
 
# File 'lib/bolt/executor.rb', line 18

def noop
  @noop
end

#plan_logging ⇒ Object

Returns the value of attribute plan_logging.



19
20
21
 
# File 'lib/bolt/executor.rb', line 19

def plan_logging
  @plan_logging
end

#run_as ⇒ Object

Returns the value of attribute run_as.



19
20
21
 
# File 'lib/bolt/executor.rb', line 19

def run_as
  @run_as
end

#transports ⇒ Object (readonly)

Returns the value of attribute transports.



18
19
20
 
# File 'lib/bolt/executor.rb', line 18

def transports
  @transports
end

Instance Method Details

#await_results(promises) ⇒ Object

Create a ResultSet from the results of all promises.



99
100
101
 
# File 'lib/bolt/executor.rb', line 99

def await_results(promises)
  ResultSet.new(promises.map(&:value))
end

#batch_execute(targets, &block) ⇒ Object

Execute the given block on a list of nodes in parallel, one thread per “batch”.

This is the main driver of execution on a list of targets. It first groups targets by transport, then divides each group into batches as defined by the transport. Each batch, along with the corresponding transport, is yielded to the block in turn and the results all collected into a single ResultSet.



110
111
112
113
 
# File 'lib/bolt/executor.rb', line 110

def batch_execute(targets, &block)
  promises = queue_execute(targets, &block)
  await_results(promises)
end

#file_upload(targets, source, destination, options = {}, &callback) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/bolt/executor.rb', line 213

def file_upload(targets, source, destination, options = {}, &callback)
  description = options.fetch('_description', "file upload from #{source} to #{destination}")
  log_action(description, targets) do
    notify = proc { |event| @notifier.notify(callback, event) if callback }
    options = { '_run_as' => run_as }.merge(options) if run_as

    results = batch_execute(targets) do |transport, batch|
      with_node_logging("Uploading file #{source} to #{destination}", batch) do
        transport.batch_upload(batch, source, destination, options, &notify)
      end
    end

    @notifier.shutdown
    results
  end
end

#finish_plan(plan_result) ⇒ Object 



245
246
247
 
# File 'lib/bolt/executor.rb', line 245

def finish_plan(plan_result)
  transport('pcp').finish_plan(plan_result)
end

#log_action(description, targets) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/bolt/executor.rb', line 115

def log_action(description, targets)
  # When running a plan, info messages like starting a task are promoted to notice.
  log_method = @plan_logging ? :notice : :info
  target_str = if targets.length > 5
                 "#{targets.count} targets"
               else
                 targets.map(&:uri).join(', ')
               end

  @logger.send(log_method, "Starting: #{description} on #{target_str}")

  start_time = Time.now
  results = yield
  duration = Time.now - start_time

  failures = results.error_set.length
  plural = failures == 1 ? '' : 's'

  @logger.send(log_method, "Finished: #{description} with #{failures} failure#{plural} in #{duration.round(2)} sec")

  results
end

#queue_execute(targets) ⇒ Object

Starts executing the given block on a list of nodes in parallel, one thread per “batch”.

This is the main driver of execution on a list of targets. It first groups targets by transport, then divides each group into batches as defined by the transport. Yields each batch, along with the corresponding transport, to the block in turn and returns an array of result promises.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/bolt/executor.rb', line 59

def queue_execute(targets)
  targets.group_by(&:protocol).flat_map do |protocol, protocol_targets|
    transport = transport(protocol)
    report_transport(transport, protocol_targets.count)
    transport.batches(protocol_targets).flat_map do |batch|
      batch_promises = Array(batch).each_with_object({}) do |target, h|
        h[target] = Concurrent::Promise.new(executor: :immediate)
      end
      # Pass this argument through to avoid retaining a reference to a
      # local variable that will change on the next iteration of the loop.
      @pool.post(batch_promises) do |result_promises|
        begin
          results = yield transport, batch
          Array(results).each do |result|
            result_promises[result.target].set(result)
          end
        # NotImplementedError can be thrown if the transport is implemented improperly
        rescue StandardError, NotImplementedError => e
          result_promises.each do |target, promise|
            promise.set(Bolt::Result.from_exception(target, e))
          end
        ensure
          # Make absolutely sure every promise gets a result to avoid a
          # deadlock. Use whatever exception is causing this block to
          # execute, or generate one if we somehow got here without an
          # exception and some promise is still missing a result.
          result_promises.each do |target, promise|
            next if promise.fulfilled?
            error = $ERROR_INFO || Bolt::Error.new("No result was returned for #{target.uri}",
                                                   "puppetlabs.bolt/missing-result-error")
            promise.set(Bolt::Result.from_exception(target, error))
          end
        end
      end
      batch_promises.values
    end
  end
end

#report_bundled_content(mode, name) ⇒ Object 



148
149
150
151
152
 
# File 'lib/bolt/executor.rb', line 148

def report_bundled_content(mode, name)
  if @bundled_content&.include?(name)
    @analytics&.event('Bundled Content', mode, name)
  end
end

#report_function_call(function) ⇒ Object 



144
145
146
 
# File 'lib/bolt/executor.rb', line 144

def report_function_call(function)
  @analytics&.event('Plan', 'call_function', function)
end

#report_transport(transport, count) ⇒ Object 



138
139
140
141
142
 
# File 'lib/bolt/executor.rb', line 138

def report_transport(transport, count)
  name = transport.class.name.split('::').last.downcase
  @analytics&.event('Transport', 'initialize', name, count) unless @reported_transports.include?(name)
  @reported_transports.add(name)
end

#run_command(targets, command, options = {}, &callback) ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/bolt/executor.rb', line 161

def run_command(targets, command, options = {}, &callback)
  description = options.fetch('_description', "command '#{command}'")
  log_action(description, targets) do
    notify = proc { |event| @notifier.notify(callback, event) if callback }
    options = { '_run_as' => run_as }.merge(options) if run_as

    results = batch_execute(targets) do |transport, batch|
      with_node_logging("Running command '#{command}'", batch) do
        transport.batch_command(batch, command, options, &notify)
      end
    end

    @notifier.shutdown
    results
  end
end

#run_script(targets, script, arguments, options = {}, &callback) ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/bolt/executor.rb', line 178

def run_script(targets, script, arguments, options = {}, &callback)
  description = options.fetch('_description', "script #{script}")
  log_action(description, targets) do
    notify = proc { |event| @notifier.notify(callback, event) if callback }
    options = { '_run_as' => run_as }.merge(options) if run_as

    results = batch_execute(targets) do |transport, batch|
      with_node_logging("Running script #{script} with '#{arguments}'", batch) do
        transport.batch_script(batch, script, arguments, options, &notify)
      end
    end

    @notifier.shutdown
    results
  end
end

#run_task(targets, task, arguments, options = {}, &callback) ⇒ Object 



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/bolt/executor.rb', line 195

def run_task(targets, task, arguments, options = {}, &callback)
  description = options.fetch('_description', "task #{task.name}")
  log_action(description, targets) do
    notify = proc { |event| @notifier.notify(callback, event) if callback }
    options = { '_run_as' => run_as }.merge(options) if run_as
    arguments['_task'] = task.name

    results = batch_execute(targets) do |transport, batch|
      with_node_logging("Running task #{task.name} with '#{arguments}' via #{task.input_method}", batch) do
        transport.batch_task(batch, task, arguments, options, &notify)
      end
    end

    @notifier.shutdown
    results
  end
end

#start_plan(plan_context) ⇒ Object

Plan context doesn’t make sense for most transports but it is tightly coupled with the orchestrator transport since the transport behaves differently when a plan is running. In order to limit how much this pollutes the transport API we only handle the orchestrator transport here. Since we callt this function without resolving targets this will result in the orchestrator transport always being initialized during plan runs. For now that’s ok.

In the future if other transports need this or if we want a plan stack we’ll need to refactor.



240
241
242
243
 
# File 'lib/bolt/executor.rb', line 240

def start_plan(plan_context)
  transport('pcp').plan_context = plan_context
  @plan_logging = true
end

#transport(transport) ⇒ Object

Raises:



45
46
47
48
49
50
51
 
# File 'lib/bolt/executor.rb', line 45

def transport(transport)
  impl = @transports[transport || 'ssh']
  raise(Bolt::UnknownTransportError, transport) unless impl
  # If there was an error creating the transport, ensure it gets thrown
  impl.no_error!
  impl.value
end

#with_node_logging(description, batch) ⇒ Object 



154
155
156
157
158
159
 
# File 'lib/bolt/executor.rb', line 154

def with_node_logging(description, batch)
  @logger.info("#{description} on #{batch.map(&:uri)}")
  result = yield
  @logger.info(result.to_json)
  result
end