Class: Bolt::Outputter::Human

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

Constant Summary collapse

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

Instance Method Summary collapse

Methods inherited from Bolt::Outputter

for_format

Constructor Details

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

Returns a new instance of Human.



14
15
16
17
18
19
20
 
# File 'lib/bolt/outputter/human.rb', line 14

def initialize(color, verbose, trace, 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
end

Instance Method Details

#colorize(color, string) ⇒ Object 



22
23
24
25
26
27
28
 
# File 'lib/bolt/outputter/human.rb', line 22

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

#duration_to_string(duration) ⇒ Object 



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/bolt/outputter/human.rb', line 376

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

Returns:

  • (Boolean) 


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

def enabled?
  @disable_depth == 0
end

#fatal_error(err) ⇒ Object 



359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/bolt/outputter/human.rb', line 359

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 



121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/bolt/outputter/human.rb', line 121

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

#handle_event(event) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/bolt/outputter/human.rb', line 39

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(event)
  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)
    end
  end
end

#indent(indent, string) ⇒ Object 



30
31
32
33
 
# File 'lib/bolt/outputter/human.rb', line 30

def indent(indent, string)
  indent = ' ' * indent
  string.gsub(/^/, indent.to_s)
end

#plan_logging? ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/bolt/outputter/human.rb', line 71

def plan_logging?
  @plan_depth > 0
end

#print_apply_result(apply_result, elapsed_time) ⇒ Object

Parameters:

  • apply_result (Bolt::ResultSet) —

    A ResultSet object representing the result of a ‘bolt apply`



328
329
330
 
# File 'lib/bolt/outputter/human.rb', line 328

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

#print_groups(groups) ⇒ Object 



321
322
323
324
325
 
# File 'lib/bolt/outputter/human.rb', line 321

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

#print_head ⇒ Object 



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

def print_head; end

#print_message(message) ⇒ Object 



372
373
374
 
# File 'lib/bolt/outputter/human.rb', line 372

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

#print_message_event(event) ⇒ Object 



355
356
357
 
# File 'lib/bolt/outputter/human.rb', line 355

def print_message_event(event)
  print_message(event[:message])
end

#print_module_list(module_list) ⇒ Object 



286
287
288
289
290
291
292
293
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 286

def print_module_list(module_list)
  module_list.each do |path, modules|
    if (mod = modules.find { |m| m[:internal_module_group] })
      @stream.puts(mod[:internal_module_group])
    else
      @stream.puts(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

      print_table(module_info)
    end

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

#print_plan_finish(event) ⇒ Object 



160
161
162
163
164
165
 
# File 'lib/bolt/outputter/human.rb', line 160

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

#print_plan_info(plan) ⇒ Object

Parameters:

  • plan (Hash) —

    A hash representing the plan



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

def print_plan_info(plan)
  # Building lots of strings...
  pretty_params = +""
  plan_info = +""
  usage = +"bolt plan run #{plan['name']}"

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

  plan_info << "\n#{plan['name']}"
  plan_info << "\n\n"
  plan_info << "USAGE:\n#{usage}\n\n"
  plan_info << "PARAMETERS:\n#{pretty_params}\n" if plan['parameters']
  plan_info << "MODULE:\n"

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

#print_plan_result(plan_result) ⇒ Object

Parameters:



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/bolt/outputter/human.rb', line 333

def print_plan_result(plan_result)
  value = plan_result.value
  if value.nil?
    @stream.puts("Plan completed successfully with no result")
  elsif value.is_a? Bolt::ApplyFailure
    @stream.puts(colorize(:red, value.message))
  elsif value.is_a? Bolt::ResultSet
    value.each { |result| print_result(result) }
    print_summary(value)
  else
    @stream.puts(::JSON.pretty_generate(plan_result, quirks_mode: true))
  end
end

#print_plan_start(event) ⇒ Object 



150
151
152
153
154
155
156
157
158
 
# File 'lib/bolt/outputter/human.rb', line 150

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

#print_plans(plans, modulepath) ⇒ Object 



279
280
281
282
283
284
 
# File 'lib/bolt/outputter/human.rb', line 279

def print_plans(plans, modulepath)
  print_table(plans)
  print_message("\nMODULEPATH:\n#{modulepath.join(File::PATH_SEPARATOR)}\n"\
                  "\nUse `bolt plan show <plan-name>` to view "\
                  "details and parameters for a specific plan.")
end

#print_puppetfile_result(success, puppetfile, moduledir) ⇒ Object 



347
348
349
350
351
352
353
 
# File 'lib/bolt/outputter/human.rb', line 347

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

#print_result(result) ⇒ 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
119
 
# File 'lib/bolt/outputter/human.rb', line 79

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

  if result.message
    @stream.puts(remove_trail(indent(2, result.message)))
  end

  # There is more information to output
  if result.generic_value
    # Use special handling if the result looks like a command or script result
    if result.generic_value.keys == %w[stdout stderr exit_code]
      unless result['stdout'].strip.empty?
        @stream.puts(indent(2, "STDOUT:"))
        @stream.puts(indent(4, result['stdout']))
      end
      unless result['stderr'].strip.empty?
        @stream.puts(indent(2, "STDERR:"))
        @stream.puts(indent(4, result['stderr']))
      end
    else
      @stream.puts(indent(2, ::JSON.pretty_generate(result.generic_value)))
    end
  end
end

#print_start(target) ⇒ Object 



75
76
77
 
# File 'lib/bolt/outputter/human.rb', line 75

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

#print_step_finish(description:, result:, duration:, **_kwargs) ⇒ Object 



143
144
145
146
147
148
 
# File 'lib/bolt/outputter/human.rb', line 143

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

#print_step_start(description:, targets:, **_kwargs) ⇒ Object 



134
135
136
137
138
139
140
141
 
# File 'lib/bolt/outputter/human.rb', line 134

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

#print_summary(results, elapsed_time = nil) ⇒ Object 



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/bolt/outputter/human.rb', line 167

def print_summary(results, elapsed_time = nil)
  ok_set = results.ok_set
  unless ok_set.empty?
    @stream.puts format('Successful on %<size>d node%<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 node%<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 node%<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

#print_table(results) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/bolt/outputter/human.rb', line 192

def print_table(results)
  # lazy-load expensive gem code
  require 'terminal-table'

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

#print_targets(options) ⇒ Object 



314
315
316
317
318
319
 
# File 'lib/bolt/outputter/human.rb', line 314

def print_targets(options)
  targets = options[:targets].map(&:name)
  count = "#{targets.count} target#{'s' unless targets.count == 1}"
  @stream.puts targets.join("\n")
  @stream.puts colorize(:green, count)
end

#print_task_info(task) ⇒ Object

Parameters:

  • task (Hash) —

    A hash representing the task



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/bolt/outputter/human.rb', line 218

def print_task_info(task)
  # Building lots of strings...
  pretty_params = +""
  task_info = +""
  usage = +"bolt task run --nodes <node-name> #{task['name']}"

  task['metadata']['parameters']&.each do |k, v|
    pretty_params << "- #{k}: #{v['type'] || 'Any'}\n"
    pretty_params << "    #{v['description']}\n" if v['description']
    usage << if v['type'].is_a?(Puppet::Pops::Types::POptionalType)
               " [#{k}=<value>]"
             else
               " #{k}=<value>"
             end
  end

  usage << " [--noop]" if task['metadata']['supports_noop']

  task_info << "\n#{task['name']}"
  task_info << " - #{task['metadata']['description']}" if task['metadata']['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'][0]['path'].chomp("/tasks/#{task['files'][0]['name']}")
  task_info << if path.start_with?(Bolt::PAL::MODULES_PATH)
                 "built-in module"
               else
                 path
               end
  @stream.puts(task_info)
end

#print_tasks(tasks, modulepath) ⇒ Object 



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

def print_tasks(tasks, modulepath)
  print_table(tasks)
  print_message("\nMODULEPATH:\n#{modulepath.join(File::PATH_SEPARATOR)}\n"\
                  "\nUse `bolt task show <task-name>` to view "\
                  "details and parameters for a specific task.")
end

#remove_trail(string) ⇒ Object 



35
36
37
 
# File 'lib/bolt/outputter/human.rb', line 35

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