Class: Bolt::Outputter::Human
Constant Summary
collapse
- COLORS =
{ red: "31",
green: "32",
yellow: "33" }.freeze
Instance Method Summary
collapse
for_format, #initialize, #print_message, #replace_data_type
Instance Method Details
#colorize(color, string) ⇒ Object
13
14
15
16
17
18
19
|
# File 'lib/bolt/outputter/human.rb', line 13
def colorize(color, string)
if @color && @stream.isatty
"\033[#{COLORS[color]}m#{string}\033[0m"
else
string
end
end
|
#fatal_error(err) ⇒ Object
173
174
175
176
177
178
179
180
181
182
183
184
|
# File 'lib/bolt/outputter/human.rb', line 173
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
|
#indent(indent, string) ⇒ Object
21
22
23
24
|
# File 'lib/bolt/outputter/human.rb', line 21
def indent(indent, string)
indent = ' ' * indent
string.gsub(/^/, indent.to_s)
end
|
#print_event(event) ⇒ Object
30
31
32
33
34
35
36
37
|
# File 'lib/bolt/outputter/human.rb', line 30
def print_event(event)
case event[:type]
when :node_start
print_start(event[:target])
when :node_result
print_result(event[:result])
end
end
|
#print_head ⇒ Object
11
|
# File 'lib/bolt/outputter/human.rb', line 11
def print_head; end
|
#print_plan_info(plan) ⇒ Object
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
# File 'lib/bolt/outputter/human.rb', line 146
def print_plan_info(plan)
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']
@stream.puts(plan_info)
end
|
#print_plan_result(plan_result) ⇒ Object
165
166
167
168
169
170
171
|
# File 'lib/bolt/outputter/human.rb', line 165
def print_plan_result(plan_result)
if plan_result.value.nil?
@stream.puts("Plan completed successfully with no result")
else
@stream.puts(::JSON.pretty_generate(plan_result, quirks_mode: true))
end
end
|
#print_result(result) ⇒ Object
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
# File 'lib/bolt/outputter/human.rb', line 43
def print_result(result)
if result.success?
@stream.puts(colorize(:green, "Finished on #{result.target.host}:"))
else
@stream.puts(colorize(:red, "Failed on #{result.target.host}:"))
end
if result.error_hash
@stream.puts(colorize(:red, remove_trail(indent(2, result.error_hash['msg']))))
end
if result.message
@stream.puts(remove_trail(indent(2, result.message)))
end
if result.generic_value
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
39
40
41
|
# File 'lib/bolt/outputter/human.rb', line 39
def print_start(target)
@stream.puts(colorize(:green, "Started on #{target.host}..."))
end
|
#print_summary(results, elapsed_time) ⇒ Object
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
# File 'lib/bolt/outputter/human.rb', line 76
def print_summary(results, elapsed_time)
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.names.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.names.join(',')))
end
@stream.puts format('Ran on %<size>d node%<plural>s in %<elapsed>.2f seconds',
size: results.size,
plural: results.size == 1 ? '' : 's',
elapsed: elapsed_time)
end
|
#print_table(results) ⇒ Object
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
# File 'lib/bolt/outputter/human.rb', line 100
def print_table(results)
@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_task_info(task) ⇒ Object
116
117
118
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
|
# File 'lib/bolt/outputter/human.rb', line 116
def print_task_info(task)
pretty_params = +""
task_info = +""
usage = +"bolt task run --nodes <node-name> #{task['name']}"
if task['parameters']
replace_data_type(task['parameters'])
task['parameters'].each do |k, v|
pretty_params << "- #{k}: #{v['type']}\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
end
usage << " [--noop]" if task['supports_noop']
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" if task['parameters']
@stream.puts(task_info)
end
|
#remove_trail(string) ⇒ Object
26
27
28
|
# File 'lib/bolt/outputter/human.rb', line 26
def remove_trail(string)
string.sub(/\s\z/, '')
end
|