Class: OnceoverFormatter

Inherits:
Object
  • Object
show all
Defined in:
lib/onceover/rspec/formatters.rb

Direct Known Subclasses

OnceoverFormatterParallel

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

#initialize(output) ⇒ OnceoverFormatter

Returns a new instance of OnceoverFormatter.



18
19
20
21
 
# File 'lib/onceover/rspec/formatters.rb', line 18

def initialize output
  @output        = output
  @previous_role = nil
end

Instance Method Details

#black(text) ⇒ Object 



182
183
184
 
# File 'lib/onceover/rspec/formatters.rb', line 182

def black(text)
  RSpec::Core::Formatters::ConsoleCodes.wrap(text, :black)
end

#blue(text) ⇒ Object 



198
199
200
 
# File 'lib/onceover/rspec/formatters.rb', line 198

def blue(text)
  RSpec::Core::Formatters::ConsoleCodes.wrap(text, :blue)
end

#bold(text) ⇒ Object 



214
215
216
 
# File 'lib/onceover/rspec/formatters.rb', line 214

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



165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/onceover/rspec/formatters.rb', line 165

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)

  # Calculate the full relative path
  file.relative_path_from(tempdir + environmentpath + "production").to_s
end

#class_name(text) ⇒ Object

Below are defined the styles for the output



178
179
180
 
# File 'lib/onceover/rspec/formatters.rb', line 178

def class_name(text)
  RSpec::Core::Formatters::ConsoleCodes.wrap(text, :bold)
end

#cyan(text) ⇒ Object 



206
207
208
 
# File 'lib/onceover/rspec/formatters.rb', line 206

def cyan(text)
  RSpec::Core::Formatters::ConsoleCodes.wrap(text, :cyan)
end

#dump_failures(notification) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/onceover/rspec/formatters.rb', line 60

def dump_failures notification
  require 'onceover/controlrepo'

  failures = extract_failures(notification)

  # Put some spacing before the results
  @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 



50
51
52
53
 
# File 'lib/onceover/rspec/formatters.rb', line 50

def example_failed notification
  @output << "\b\b"
  @output << "#{red('F')} "
end

#example_group_started(notification) ⇒ Object 



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

def example_group_started notification
  if notification.group.parent_groups == [notification.group]
    # If this is the highest level group (The role)
    role = notification.group.description
    if role != @previous_role
      @output << "\n"
      @output << class_name("#{notification.group.description}:")

      # Calculate the padding required
      padding = (longest_group - role.length) + 1
      # Create padding
      padding.times { @output << ' ' }

      # Save the role name
      @previous_role = role
    end
  else
    # If not then this will be a test for that role
    @output << '? '
  end
end

#example_passed(notification) ⇒ Object 



45
46
47
48
 
# File 'lib/onceover/rspec/formatters.rb', line 45

def example_passed notification
  @output << "\b\b"
  @output << "#{green('P')} "
end

#example_pending(notification) ⇒ Object 



55
56
57
58
 
# File 'lib/onceover/rspec/formatters.rb', line 55

def example_pending notification
  @output << "\b\b"
  @output << "#{yellow('?')} "
end

#extract_failure_data(fails) ⇒ Object

Extaracts data out of RSpec failres



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/onceover/rspec/formatters.rb', line 95

def extract_failure_data(fails)
  # The only difference between these failures should be the factsets that it
  # failed on. Extract that list then just use the first failure for the rest
  # of the data as it should be the same
  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)
  # Add the details of the factsets tio each result
  results.map do |r|
    r[:factsets] = factsets
    r
  end
end

#extract_failures(notification) ⇒ Object

This method takes a notification and formats it into a hash that can be printed easily



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/onceover/rspec/formatters.rb', line 77

def extract_failures notification
  # Group by role
  grouped = notification.failed_examples.group_by { |e| e.metadata[:example_group][:parent_example_group][:description]}

  # Further group by error
  grouped.each do |role, failures|
    grouped[role] = failures.group_by { |f| f.metadata[:execution_result].exception.to_s }
  end

  # Extract the errors and remove all RSpec objects
  grouped.each do |role, failures|
    grouped[role] = failures.map { |_description, fails| extract_failure_data(fails)}.flatten
  end

  grouped
end

#green(text) ⇒ Object 



190
191
192
 
# File 'lib/onceover/rspec/formatters.rb', line 190

def green(text)
  RSpec::Core::Formatters::ConsoleCodes.wrap(text, :green)
end

#longest_group ⇒ Object 



218
219
220
 
# File 'lib/onceover/rspec/formatters.rb', line 218

def longest_group
  RSpec.configuration.world.example_groups.max { |a,b| a.description.length <=> b.description.length}.description.length
end

#magenta(text) ⇒ Object 



202
203
204
 
# File 'lib/onceover/rspec/formatters.rb', line 202

def magenta(text)
  RSpec::Core::Formatters::ConsoleCodes.wrap(text, :magenta)
end

#parse_errors(raw_error) ⇒ Object

Parses information out of a string error



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
147
148
149
150
151
152
 
# File 'lib/onceover/rspec/formatters.rb', line 111

def parse_errors(raw_error)
  # Check if the error is a compilation error
  match = COMPILATION_ERROR.match(raw_error)
  if match
    compilation_error = match['error']
    # Check if we car parse it
    if ERROR_WITH_LOCATION.match(compilation_error)
      scanned_errors = match['error'].scan(ERROR_WITH_LOCATION)

      # Delete any matches where there was no error text
      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)

      # Delete any matches where there was no error text
      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 



186
187
188
 
# File 'lib/onceover/rspec/formatters.rb', line 186

def red(text)
  RSpec::Core::Formatters::ConsoleCodes.wrap(text, :red)
end

#white(text) ⇒ Object 



210
211
212
 
# File 'lib/onceover/rspec/formatters.rb', line 210

def white(text)
  RSpec::Core::Formatters::ConsoleCodes.wrap(text, :white)
end

#yellow(text) ⇒ Object 



194
195
196
 
# File 'lib/onceover/rspec/formatters.rb', line 194

def yellow(text)
  RSpec::Core::Formatters::ConsoleCodes.wrap(text, :yellow)
end