Class: Bolt::Outputter::Human

Inherits:
Bolt::Outputter show all
Defined in:
lib/bolt/outputter/human.rb

Direct Known Subclasses

Rainbow

Constant Summary collapse

COLORS =
{
  red:    "31",
  green:  "32",
  yellow: "33",
  cyan:   "36"
}.freeze

Instance Method Summary collapse

Methods inherited from Bolt::Outputter

for_format, #indent, #spin

Constructor Details

#initialize(color, verbose, trace, spin, stream = $stdout) ⇒ Human



17
18
19
20
21
22
23
24
# File 'lib/bolt/outputter/human.rb', line 17

def initialize(color, verbose, trace, spin, stream = $stdout)
  super
  # Plans and without_default_logging() calls can both be nested, so we
  # track each of them with a "stack" consisting of an integer.
  @plan_depth = 0
  @disable_depth = 0
  @pinwheel = %w[- \\ | /]
end

Instance Method Details

#colorize(color, string) ⇒ Object



26
27
28
29
30
31
32
# File 'lib/bolt/outputter/human.rb', line 26

def colorize(color, string)
  if @color && @stream.isatty
    "\033[#{COLORS[color]}m#{string}\033[0m"
  else
    string
  end
end

#duration_to_string(duration) ⇒ Object



575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'lib/bolt/outputter/human.rb', line 575

def duration_to_string(duration)
  hrs = (duration / 3600).floor
  mins = ((duration % 3600) / 60).floor
  secs = (duration % 60)
  if hrs > 0
    "#{hrs} hr, #{mins} min, #{secs.round} sec"
  elsif mins > 0
    "#{mins} min, #{secs.round} sec"
  else
    # Include 2 decimal places if the duration is under a minute
    "#{secs.round(2)} sec"
  end
end

#enabled?Boolean



107
108
109
# File 'lib/bolt/outputter/human.rb', line 107

def enabled?
  @disable_depth == 0
end

#fatal_error(err) ⇒ Object



523
524
525
526
527
528
529
530
531
532
533
534
# File 'lib/bolt/outputter/human.rb', line 523

def fatal_error(err)
  @stream.puts(colorize(:red, err.message))
  if err.is_a? Bolt::RunFailure
    @stream.puts ::JSON.pretty_generate(err.result_set)
  end

  if @trace && err.backtrace
    err.backtrace.each do |line|
      @stream.puts(colorize(:red, "\t#{line}"))
    end
  end
end

#format_log(log) ⇒ Object



186
187
188
189
190
191
192
193
194
195
196
197
# File 'lib/bolt/outputter/human.rb', line 186

def format_log(log)
  color = case log['level']
          when 'warn'
            :yellow
          when 'err'
            :red
          end
  source = "#{log['source']}: " if log['source']
  message = "#{log['level'].capitalize}: #{source}#{log['message']}"
  message = colorize(color, message) if color
  message
end

#format_table(results, padding_left = 0, padding_right = 3) ⇒ Object



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/bolt/outputter/human.rb', line 276

def format_table(results, padding_left = 0, padding_right = 3)
  # lazy-load expensive gem code
  require 'terminal-table'

  Terminal::Table.new(
    rows: results,
    style: {
      border_x: '',
      border_y: '',
      border_i: '',
      padding_left: padding_left,
      padding_right: padding_right,
      border_top: false,
      border_bottom: false
    }
  )
end

#handle_event(event) ⇒ Object



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
97
98
99
100
101
102
103
104
105
# File 'lib/bolt/outputter/human.rb', line 71

def handle_event(event)
  case event[:type]
  when :enable_default_output
    @disable_depth -= 1
  when :disable_default_output
    @disable_depth += 1
  when :message
    print_message(event[:message])
  end

  if enabled?
    case event[:type]
    when :node_start
      print_start(event[:target]) if @verbose
    when :node_result
      print_result(event[:result]) if @verbose
    when :step_start
      print_step_start(**event) if plan_logging?
    when :step_finish
      print_step_finish(**event) if plan_logging?
    when :plan_start
      print_plan_start(event)
    when :plan_finish
      print_plan_finish(event)
    when :container_start
      print_container_start(event) if plan_logging?
    when :container_finish
      print_container_finish(event) if plan_logging?
    when :start_spin
      start_spin
    when :stop_spin
      stop_spin
    end
  end
end

#plan_logging?Boolean



111
112
113
# File 'lib/bolt/outputter/human.rb', line 111

def plan_logging?
  @plan_depth > 0
end


562
563
564
565
566
567
568
569
570
571
572
573
# File 'lib/bolt/outputter/human.rb', line 562

def print_action_error(error)
  # Running everything through 'wrap' messes with newlines. Separating
  # into lines and wrapping each individually ensures separate errors are
  # distinguishable.
  first, *remaining = error.lines
  first = colorize(:red, indent(2, "#{wrap(first, 76)}"))
  wrapped = remaining.map { |l| wrap(l) }
  to_print = wrapped.map { |line| colorize(:red, indent(4, line)) }
  step = [first, *to_print, "\n"].join

  @stream.puts(step)
end


552
553
554
555
556
557
558
559
560
# File 'lib/bolt/outputter/human.rb', line 552

def print_action_step(step)
  first, *remaining = wrap(step, 76).lines

  first     = indent(2, "#{first}")
  remaining = remaining.map { |line| indent(4, line) }
  step      = [first, *remaining, "\n"].join

  @stream.puts(step)
end


487
488
489
# File 'lib/bolt/outputter/human.rb', line 487

def print_apply_result(apply_result, elapsed_time)
  print_summary(apply_result, elapsed_time)
end


219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/bolt/outputter/human.rb', line 219

def print_container_finish(event)
  result = if event[:result].is_a?(Bolt::ContainerFailure)
             event[:result].result
           else
             event[:result]
           end

  if result.success?
    @stream.puts(colorize(:green, "Finished: run container '#{result.object}' succeeded."))
  else
    @stream.puts(colorize(:red, "Finished: run container '#{result.object}' failed."))
  end
  print_container_result(result) if @verbose
end


119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/bolt/outputter/human.rb', line 119

def print_container_result(result)
  if result.success?
    @stream.puts(colorize(:green, "Finished running container #{result.object}:"))
  else
    @stream.puts(colorize(:red, "Failed running container #{result.object}:"))
  end

  if result.error_hash
    @stream.puts(colorize(:red, remove_trail(indent(2, result.error_hash['msg']))))
    return 0
  end

  # Only print results if there's something other than empty string and hash
  safe_value = result.safe_value
  if safe_value['stdout'].strip.empty? && safe_value['stderr'].strip.empty?
    @stream.puts(indent(2, "Running container #{result.object} completed successfully with no result"))
  else
    unless safe_value['stdout'].strip && safe_value['stdout'].strip.empty?
      @stream.puts(indent(2, "STDOUT:"))
      @stream.puts(indent(4, safe_value['stdout']))
    end
    unless safe_value['stderr'].strip.empty?
      @stream.puts(indent(2, "STDERR:"))
      @stream.puts(indent(4, safe_value['stderr']))
    end
  end
end


215
216
217
# File 'lib/bolt/outputter/human.rb', line 215

def print_container_start(image:, **_kwargs)
  @stream.puts(colorize(:green, "Starting: run container '#{image}'"))
end


540
541
542
# File 'lib/bolt/outputter/human.rb', line 540

def print_error(message)
  @stream.puts(colorize(:red, message))
end


480
481
482
483
484
# File 'lib/bolt/outputter/human.rb', line 480

def print_groups(groups)
  count = "#{groups.count} group#{'s' unless groups.count == 1}"
  @stream.puts groups.join("\n")
  @stream.puts colorize(:green, count)
end


416
417
418
# File 'lib/bolt/outputter/human.rb', line 416

def print_guide(guide, _topic)
  @stream.puts(guide)
end


15
# File 'lib/bolt/outputter/human.rb', line 15

def print_head; end


536
537
538
# File 'lib/bolt/outputter/human.rb', line 536

def print_message(message)
  @stream.puts(message)
end


420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
# File 'lib/bolt/outputter/human.rb', line 420

def print_module_list(module_list)
  module_list.each do |path, modules|
    if (mod = modules.find { |m| m[:internal_module_group] })
      @stream.puts(colorize(:cyan, mod[:internal_module_group]))
    else
      @stream.puts(colorize(:cyan, path))
    end

    if modules.empty?
      @stream.puts('(no modules installed)')
    else
      module_info = modules.map do |m|
        version = if m[:version].nil?
                    m[:internal_module_group].nil? ? '(no metadata)' : '(built-in)'
                  else
                    m[:version]
                  end

        [m[:name], version]
      end

      @stream.puts format_table(module_info, 2, 1)
    end

    @stream.write("\n")
  end
end


244
245
246
247
248
249
# File 'lib/bolt/outputter/human.rb', line 244

def print_plan_finish(event)
  @plan_depth -= 1
  plan = event[:plan]
  duration = event[:duration]
  @stream.puts(colorize(:green, "Finished: plan #{plan} in #{duration_to_string(duration)}"))
end


357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
# File 'lib/bolt/outputter/human.rb', line 357

def print_plan_info(plan)
  # Building lots of strings...
  pretty_params = +""
  plan_info = +""
  usage = if Bolt::Util.powershell?
            +"Invoke-BoltPlan -Name #{plan['name']}"
          else
            +"bolt plan run #{plan['name']}"
          end

  plan['parameters'].each do |name, p|
    pretty_params << "- #{name}: #{p['type']}\n"
    pretty_params << "    Default: #{p['default_value']}\n" unless p['default_value'].nil?
    pretty_params << "    #{p['description']}\n" if p['description']
    usage << (p.include?('default_value') ? " [#{name}=<value>]" : " #{name}=<value>")
  end

  plan_info << "\n#{plan['name']}"
  plan_info << " - #{plan['description']}" if plan['description']
  plan_info << "\n\n"
  plan_info << "USAGE:\n#{usage}\n\n"
  plan_info << "PARAMETERS:\n#{pretty_params}\n" unless plan['parameters'].empty?
  plan_info << "MODULE:\n"

  path = plan['module']
  plan_info << if path.start_with?(Bolt::Config::Modulepath::MODULES_PATH)
                 "built-in module"
               else
                 path
               end
  @stream.puts(plan_info)
end


492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
# File 'lib/bolt/outputter/human.rb', line 492

def print_plan_result(plan_result)
  value = plan_result.value
  case value
  when nil
    @stream.puts("Plan completed successfully with no result")
  when Bolt::ApplyFailure, Bolt::RunFailure
    print_result_set(value.result_set)
  when Bolt::ContainerResult
    print_container_result(value)
  when Bolt::ContainerFailure
    print_container_result(value.result)
  when Bolt::ResultSet
    print_result_set(value)
  else
    @stream.puts(::JSON.pretty_generate(plan_result, quirks_mode: true))
  end
end


234
235
236
237
238
239
240
241
242
# File 'lib/bolt/outputter/human.rb', line 234

def print_plan_start(event)
  @plan_depth += 1
  # We use this event to both mark the start of a plan _and_ to enable
  # plan logging for `apply`, so only log the message if we were called
  # with a plan
  if event[:plan]
    @stream.puts(colorize(:green, "Starting: plan #{event[:plan]}"))
  end
end


390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
# File 'lib/bolt/outputter/human.rb', line 390

def print_plans(plans, modulepath)
  command = Bolt::Util.powershell? ? 'Get-BoltPlan -Name <PLAN NAME>' : 'bolt plan show <PLAN NAME>'

  plans = plans.map do |name, description|
    description = truncate(description, 72)
    [name, description]
  end

  @stream.puts colorize(:cyan, 'Plans')
  @stream.puts plans.any? ? format_table(plans, 2) : indent(2, 'No available plans')
  @stream.puts

  @stream.puts colorize(:cyan, 'Modulepath')
  @stream.puts indent(2, modulepath.join(File::PATH_SEPARATOR))
  @stream.puts

  @stream.puts colorize(:cyan, 'Additional information')
  @stream.puts indent(2, "Use '#{command}' to view details and parameters for a specific plan.")
end


544
545
546
# File 'lib/bolt/outputter/human.rb', line 544

def print_prompt(prompt)
  @stream.print(colorize(:cyan, indent(4, prompt)))
end


548
549
550
# File 'lib/bolt/outputter/human.rb', line 548

def print_prompt_error(message)
  @stream.puts(colorize(:red, indent(4, message)))
end


515
516
517
518
519
520
521
# File 'lib/bolt/outputter/human.rb', line 515

def print_puppetfile_result(success, puppetfile, moduledir)
  if success
    @stream.puts("Successfully synced modules from #{puppetfile} to #{moduledir}")
  else
    @stream.puts(colorize(:red, "Failed to sync modules from #{puppetfile} to #{moduledir}"))
  end
end


147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/bolt/outputter/human.rb', line 147

def print_result(result)
  if result.success?
    @stream.puts(colorize(:green, "Finished on #{result.target.safe_name}:"))
  else
    @stream.puts(colorize(:red, "Failed on #{result.target.safe_name}:"))
  end

  if result.error_hash
    @stream.puts(colorize(:red, remove_trail(indent(2, result.error_hash['msg']))))
  end

  if result.is_a?(Bolt::ApplyResult) && @verbose
    result.resource_logs.each do |log|
      # Omit low-level info/debug messages
      next if %w[info debug].include?(log['level'])
      message = format_log(log)
      @stream.puts(indent(2, message))
    end
  end

  # Only print results if there's something other than empty string and hash
  if result.value.empty? || (result.value.keys == ['_output'] && !result.message?)
    @stream.puts(indent(2, "#{result.action.capitalize} completed successfully with no result"))
  else
    # Only print messages that have something other than whitespace
    if result.message?
      @stream.puts(remove_trail(indent(2, result.message)))
    end

    # Use special handling if the result looks like a command or script result
    if result.generic_value.keys == %w[stdout stderr merged_output exit_code]
      safe_value = result.safe_value
      @stream.puts(indent(2, safe_value['merged_output'])) unless safe_value['merged_output'].strip.empty?
    elsif result.generic_value.any?
      @stream.puts(indent(2, ::JSON.pretty_generate(result.generic_value)))
    end
  end
end


510
511
512
513
# File 'lib/bolt/outputter/human.rb', line 510

def print_result_set(result_set)
  result_set.each { |result| print_result(result) }
  print_summary(result_set)
end


115
116
117
# File 'lib/bolt/outputter/human.rb', line 115

def print_start(target)
  @stream.puts(colorize(:green, "Started on #{target.safe_name}..."))
end


208
209
210
211
212
213
# File 'lib/bolt/outputter/human.rb', line 208

def print_step_finish(description:, result:, duration:, **_kwargs)
  failures = result.error_set.length
  plural = failures == 1 ? '' : 's'
  message = "Finished: #{description} with #{failures} failure#{plural} in #{duration.round(2)} sec"
  @stream.puts(colorize(:green, message))
end


199
200
201
202
203
204
205
206
# File 'lib/bolt/outputter/human.rb', line 199

def print_step_start(description:, targets:, **_kwargs)
  target_str = if targets.length > 5
                 "#{targets.count} targets"
               else
                 targets.map(&:safe_name).join(', ')
               end
  @stream.puts(colorize(:green, "Starting: #{description} on #{target_str}"))
end


251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
# File 'lib/bolt/outputter/human.rb', line 251

def print_summary(results, elapsed_time = nil)
  ok_set = results.ok_set
  unless ok_set.empty?
    @stream.puts format('Successful on %<size>d target%<plural>s: %<names>s',
                        size: ok_set.size,
                        plural: ok_set.size == 1 ? '' : 's',
                        names: ok_set.targets.map(&:safe_name).join(','))
  end

  error_set = results.error_set
  unless error_set.empty?
    @stream.puts colorize(:red,
                          format('Failed on %<size>d target%<plural>s: %<names>s',
                                 size: error_set.size,
                                 plural: error_set.size == 1 ? '' : 's',
                                 names: error_set.targets.map(&:safe_name).join(',')))
  end

  total_msg = format('Ran on %<size>d target%<plural>s',
                     size: results.size,
                     plural: results.size == 1 ? '' : 's')
  total_msg << " in #{duration_to_string(elapsed_time)}" unless elapsed_time.nil?
  @stream.puts total_msg
end


472
473
474
475
476
477
478
# File 'lib/bolt/outputter/human.rb', line 472

def print_target_info(targets)
  @stream.puts ::JSON.pretty_generate(
    targets: targets.map(&:detail)
  )
  count = "#{targets.count} target#{'s' unless targets.count == 1}"
  @stream.puts colorize(:green, count)
end


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'lib/bolt/outputter/human.rb', line 448

def print_targets(target_list, inventoryfile)
  adhoc = colorize(:yellow, "(Not found in inventory file)")

  targets  = []
  targets += target_list[:inventory].map { |target| [target.name, nil] }
  targets += target_list[:adhoc].map { |target| [target.name, adhoc] }

  if targets.any?
    @stream.puts format_table(targets, 0, 2)
    @stream.puts
  end

  @stream.puts "INVENTORY FILE:"
  if File.exist?(inventoryfile)
    @stream.puts inventoryfile
  else
    @stream.puts wrap("Tried to load inventory from #{inventoryfile}, but the file does not exist")
  end

  @stream.puts "\nTARGET COUNT:"
  @stream.puts "#{targets.count} total, #{target_list[:inventory].count} from inventory, "\
               "#{target_list[:adhoc].count} adhoc"
end


315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
# File 'lib/bolt/outputter/human.rb', line 315

def print_task_info(task)
  # Building lots of strings...
  pretty_params = +""
  task_info = +""
  usage = if Bolt::Util.powershell?
            +"Invoke-BoltTask -Name #{task.name} -Targets <targets>"
          else
            +"bolt task run #{task.name} --targets <targets>"
          end

  task.parameters&.each do |k, v|
    pretty_params << "- #{k}: #{v['type'] || 'Any'}\n"
    pretty_params << "    Default: #{v['default'].inspect}\n" if v.key?('default')
    pretty_params << "    #{v['description']}\n" if v['description']
    usage << if v['type']&.start_with?("Optional")
               " [#{k}=<value>]"
             else
               " #{k}=<value>"
             end
  end

  if task.supports_noop
    usage << (Bolt::Util.powershell? ? ' [-Noop]' : ' [--noop]')
  end

  task_info << "\n#{task.name}"
  task_info << " - #{task.description}" if task.description
  task_info << "\n\n"
  task_info << "USAGE:\n#{usage}\n\n"
  task_info << "PARAMETERS:\n#{pretty_params}\n" unless pretty_params.empty?
  task_info << "MODULE:\n"

  path = task.files.first['path'].chomp("/tasks/#{task.files.first['name']}")
  task_info << if path.start_with?(Bolt::Config::Modulepath::MODULES_PATH)
                 "built-in module"
               else
                 path
               end
  @stream.puts(task_info)
end


294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'lib/bolt/outputter/human.rb', line 294

def print_tasks(tasks, modulepath)
  command = Bolt::Util.powershell? ? 'Get-BoltTask -Task <TASK NAME>' : 'bolt task show <TASK NAME>'

  tasks = tasks.map do |name, description|
    description = truncate(description, 72)
    [name, description]
  end

  @stream.puts colorize(:cyan, 'Tasks')
  @stream.puts tasks.any? ? format_table(tasks, 2) : indent(2, 'No available tasks')
  @stream.puts

  @stream.puts colorize(:cyan, 'Modulepath')
  @stream.puts indent(2, modulepath.join(File::PATH_SEPARATOR))
  @stream.puts

  @stream.puts colorize(:cyan, 'Additional information')
  @stream.puts indent(2, "Use '#{command}' to view details and parameters for a specific task.")
end


410
411
412
413
414
# File 'lib/bolt/outputter/human.rb', line 410

def print_topics(topics)
  print_message("Available topics are:")
  print_message(topics.join("\n"))
  print_message("\nUse 'bolt guide <TOPIC>' to view a specific guide.")
end

#remove_trail(string) ⇒ Object



52
53
54
# File 'lib/bolt/outputter/human.rb', line 52

def remove_trail(string)
  string.sub(/\s\z/, '')
end

#start_spinObject



34
35
36
37
38
39
40
41
42
43
# File 'lib/bolt/outputter/human.rb', line 34

def start_spin
  return unless @spin && @stream.isatty && !@spinning
  @spinning = true
  @spin_thread = Thread.new do
    loop do
      sleep(0.1)
      @stream.print(colorize(:cyan, @pinwheel.rotate!.first + "\b"))
    end
  end
end

#stop_spinObject



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

def stop_spin
  return unless @spin && @stream.isatty && @spinning
  @spinning = false
  @spin_thread.terminate
  @stream.print("\b")
end

#truncate(string, width = 80) ⇒ Object

Trims a string to a specified width, adding an ellipsis if it’s longer.



66
67
68
69
# File 'lib/bolt/outputter/human.rb', line 66

def truncate(string, width = 80)
  return string unless string.is_a?(String) && string.length > width
  string.lines.first[0...width].gsub(/\s\w+\s*$/, '...')
end

#wrap(string, width = 80) ⇒ Object

Wraps a string to the specified width. Lines only wrap at whitespace.



59
60
61
62
# File 'lib/bolt/outputter/human.rb', line 59

def wrap(string, width = 80)
  return string unless string.is_a?(String)
  string.gsub(/(.{1,#{width}})(\s+|\Z)/, "\\1\n")
end