Class: OnceoverFormatter
- Inherits:
-
Object
show all
- Defined in:
- lib/onceover/rspec/formatters.rb
Constant Summary
collapse
- COMPILATION_ERROR =
%r{error during compilation: (?<error>.*)}
- ERROR_WITH_LOCATION =
%r{(?<error>.*?)\s(at )?(\((file: (?<file>.*?), )?line: (?<line>\d+)(, column: (?<column>\d+))?\))(; )?}
- ERROR_WITHOUT_LOCATION =
%r{(?<error>.*?)\son node}
Instance Method Summary
collapse
Constructor Details
Returns a new instance of OnceoverFormatter.
12
13
14
15
|
# File 'lib/onceover/rspec/formatters.rb', line 12
def initialize output
@output = output
@previous_role = nil
end
|
Instance Method Details
#black(text) ⇒ Object
176
177
178
|
# File 'lib/onceover/rspec/formatters.rb', line 176
def black(text)
RSpec::Core::Formatters::ConsoleCodes.wrap(text, :black)
end
|
#blue(text) ⇒ Object
192
193
194
|
# File 'lib/onceover/rspec/formatters.rb', line 192
def blue(text)
RSpec::Core::Formatters::ConsoleCodes.wrap(text, :blue)
end
|
#bold(text) ⇒ Object
208
209
210
|
# File 'lib/onceover/rspec/formatters.rb', line 208
def bold(text)
RSpec::Core::Formatters::ConsoleCodes.wrap(text, :bold)
end
|
#calculate_relative_source(file) ⇒ Object
This method calculates where the original source file is relative to the user’s current location. This is more compliacted than it sounds because if we are running from the root of the controlrepo and we have an error in:
/Users/dylan/git/puppet_controlrepo/.onceover/etc/puppetlabs/code/environments/production/site/role/manifests/lb.pp
We need that to end up pointing at the original source file not the cached one i.e.
site/role/manifests/lb.pp
159
160
161
162
163
164
165
166
167
168
169
|
# File 'lib/onceover/rspec/formatters.rb', line 159
def calculate_relative_source(file)
return nil if file.nil?
file = Pathname.new(file)
tempdir = Pathname.new(RSpec.configuration.onceover_tempdir)
root = Pathname.new(RSpec.configuration.onceover_root)
environmentpath = Pathname.new(RSpec.configuration.onceover_environmentpath)
file.relative_path_from(tempdir + environmentpath + "production").to_s
end
|
#class_name(text) ⇒ Object
Below are defined the styles for the output
172
173
174
|
# File 'lib/onceover/rspec/formatters.rb', line 172
def class_name(text)
RSpec::Core::Formatters::ConsoleCodes.wrap(text, :bold)
end
|
#cyan(text) ⇒ Object
200
201
202
|
# File 'lib/onceover/rspec/formatters.rb', line 200
def cyan(text)
RSpec::Core::Formatters::ConsoleCodes.wrap(text, :cyan)
end
|
#dump_failures(notification) ⇒ Object
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
# File 'lib/onceover/rspec/formatters.rb', line 54
def dump_failures notification
require 'onceover/controlrepo'
failures = (notification)
@output << "\n\n\n"
failures.each do |name, errors|
@output << Onceover::Controlrepo.evaluate_template('error_summary.yaml.erb', binding)
end
@output << "\n"
end
|
#example_failed(notification) ⇒ Object
44
45
46
47
|
# File 'lib/onceover/rspec/formatters.rb', line 44
def example_failed notification
@output << "\b\b"
@output << "#{red('F')} "
end
|
#example_group_started(notification) ⇒ Object
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
# File 'lib/onceover/rspec/formatters.rb', line 17
def example_group_started notification
if notification.group.parent_groups == [notification.group]
role = notification.group.description
if role != @previous_role
@output << "\n"
@output << class_name("#{notification.group.description}:")
padding = (longest_group - role.length) + 1
padding.times { @output << ' ' }
@previous_role = role
end
else
@output << '? '
end
end
|
#example_passed(notification) ⇒ Object
39
40
41
42
|
# File 'lib/onceover/rspec/formatters.rb', line 39
def example_passed notification
@output << "\b\b"
@output << "#{green('P')} "
end
|
#example_pending(notification) ⇒ Object
49
50
51
52
|
# File 'lib/onceover/rspec/formatters.rb', line 49
def example_pending notification
@output << "\b\b"
@output << "#{yellow('?')} "
end
|
Extaracts data out of RSpec failres
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
# File 'lib/onceover/rspec/formatters.rb', line 89
def (fails)
metadata = fails[0].metadata
raw_error = metadata[:execution_result].exception.to_s
factsets = fails.map { |f| f.metadata[:example_group][:description].gsub('using fact set ','') }
results = parse_errors(raw_error)
results.map do |r|
r[:factsets] = factsets
r
end
end
|
This method takes a notification and formats it into a hash that can be printed easily
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
# File 'lib/onceover/rspec/formatters.rb', line 71
def notification
grouped = notification.failed_examples.group_by { |e| e.metadata[:example_group][:parent_example_group][:description]}
grouped.each do |role, failures|
grouped[role] = failures.group_by { |f| f.metadata[:execution_result].exception.to_s }
end
grouped.each do |role, failures|
grouped[role] = failures.map { |_description, fails| (fails)}.flatten
end
grouped
end
|
#green(text) ⇒ Object
184
185
186
|
# File 'lib/onceover/rspec/formatters.rb', line 184
def green(text)
RSpec::Core::Formatters::ConsoleCodes.wrap(text, :green)
end
|
#longest_group ⇒ Object
212
213
214
|
# File 'lib/onceover/rspec/formatters.rb', line 212
def longest_group
RSpec.configuration.world.example_groups.max { |a,b| a.description.length <=> b.description.length}.description.length
end
|
#magenta(text) ⇒ Object
196
197
198
|
# File 'lib/onceover/rspec/formatters.rb', line 196
def magenta(text)
RSpec::Core::Formatters::ConsoleCodes.wrap(text, :magenta)
end
|
#parse_errors(raw_error) ⇒ Object
Parses information out of a string error
105
106
107
108
109
110
111
112
113
114
115
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
144
145
146
|
# File 'lib/onceover/rspec/formatters.rb', line 105
def parse_errors(raw_error)
match = COMPILATION_ERROR.match(raw_error)
if match
compilation_error = match['error']
if ERROR_WITH_LOCATION.match(compilation_error)
scanned_errors = match['error'].scan(ERROR_WITH_LOCATION)
scanned_errors.delete_if { |e| e.first.empty? }
scanned_errors.map do |error_matches|
{
text: error_matches[0],
file: calculate_relative_source(error_matches[1]),
line: error_matches[2],
column: error_matches[3],
}
end
elsif ERROR_WITHOUT_LOCATION.match(compilation_error)
scanned_errors = match['error'].scan(ERROR_WITHOUT_LOCATION)
scanned_errors.delete_if { |e| e.first.empty? }
scanned_errors.map do |error_matches|
{
text: error_matches[0],
}
end
else
[{
text: raw_error,
}]
end
else
[{
text: raw_error,
}]
end
end
|
#red(text) ⇒ Object
180
181
182
|
# File 'lib/onceover/rspec/formatters.rb', line 180
def red(text)
RSpec::Core::Formatters::ConsoleCodes.wrap(text, :red)
end
|
#white(text) ⇒ Object
204
205
206
|
# File 'lib/onceover/rspec/formatters.rb', line 204
def white(text)
RSpec::Core::Formatters::ConsoleCodes.wrap(text, :white)
end
|
#yellow(text) ⇒ Object
188
189
190
|
# File 'lib/onceover/rspec/formatters.rb', line 188
def yellow(text)
RSpec::Core::Formatters::ConsoleCodes.wrap(text, :yellow)
end
|