Class: GeneratorTestResults

Inherits:
Object show all
Defined in:
lib/ceedling/generators/generator_test_results.rb

Overview

Sample Test Results Output File (YAML)

The following corresponds to the test executable output above.

TestUsartModel.fail:

:source:

:file: test/TestUsartModel.c
:dirname: test
:basename: TestUsartModel.c

:successes:

  • :test: testGetBaudRateRegisterSettingShouldReturnAppropriateBaudRateRegisterSetting :line: 24 :message: '' :unity_test_time: 0
  • :test: testGetFormattedTemperatureFormatsTemperatureFromCalculatorAppropriately :line: 49 :message: '' :unity_test_time: 0
  • :test: testShouldReturnErrorMessageUponInvalidTemperatureValue :line: 55 :message: '' :unity_test_time: 0
  • :test: testShouldReturnWakeupMessage :line: 61 :message: '' :unity_test_time: 0 :failures:
  • :test: testFail :line: 39 :message: Expected 2 Was 3 :unity_test_time: 0 :ignores:
  • :test: testIgnore :line: 34 :message: '' :unity_test_time: 0 :counts: :total: 6 :passed: 4 :failed: 1 :ignored: 1 :stdout: [] :time: 0.006512000225484371

Instance Method Summary collapse

Instance Method Details

#create_crash_failure(source, shell_result, test_cases) ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/ceedling/generators/generator_test_results.rb', line 206

def create_crash_failure(source, shell_result, test_cases)
  count = test_cases.size()

  output = []
  test_cases.each do |test_case|
    output << "#{source}:#{test_case[:line_number]}:#{test_case[:test]}:FAIL: Test executable crashed"
  end

  shell_result[:output] = 
    regenerate_test_executable_stdout(
      total:   count,
      failed:  count,
      ignored: 0,
      output:  output
    )

  shell_result[:exit_code] = count

  return shell_result
end

#filter_test_cases(test_cases) ⇒ Object

Filter list of test cases: --test_case --exclude_test_case

Returns:

  • Array - list of the test_case hashses :line_number



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/ceedling/generators/generator_test_results.rb', line 182

def filter_test_cases(test_cases)
  _test_cases = test_cases.clone 

  # Filter tests which contain test_case_name passed by `--test_case` argument
  if !@configurator.include_test_case.empty?
    begin
      _test_cases.delete_if { |i| !(i[:test] =~ /#{@configurator.include_test_case}/) }
    rescue RegexpError => e
      raise CeedlingException.new( "Invalid --test_case regex '#{@configurator.include_test_case}': #{e.message}" )
    end
  end

  # Filter tests which contain test_case_name passed by `--exclude_test_case` argument
  if !@configurator.exclude_test_case.empty?
    begin
      _test_cases.delete_if { |i| i[:test] =~ /#{@configurator.exclude_test_case}/ }
    rescue RegexpError => e
      raise CeedlingException.new( "Invalid --exclude_test_case regex '#{@configurator.exclude_test_case}': #{e.message}" )
    end
  end

  return _test_cases
end

#process_and_write_results(unity_shell_result) ⇒ Object 



97
98
99
100
101
102
103
104
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
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
 
# File 'lib/ceedling/generators/generator_test_results.rb', line 97

def process_and_write_results(unity_shell_result)

  executable  = unity_shell_result[:executable]
  output_file = unity_shell_result[:result_file]
  test_file   = unity_shell_result[:test_file]

  results = get_results_structure

  results[:source][:dirname] = File.dirname(test_file)
  results[:source][:basename] = File.basename(test_file)
  results[:source][:file] = test_file
  results[:time] = unity_shell_result[:time] unless unity_shell_result[:time].nil?

  # When Unity is built with UNITY_OUTPUT_COLOR, ANSI escape sequences wrap
  # test-result tokens and the summary result token, e.g.:
  #   test_foo.c:24:test_bar:\e[0;32mPASS\e[0m
  #   test_foo.c:39:test_baz:\e[0;31mFAIL\e[0m: Expected 2 Was 3
  #   ---------\n2 Tests 0 Failures 0 Ignored\n\e[0;32mOK\e[0m
  # Strip them up front so that all downstream regex anchors and literal
  # tokens (including TEST_STDOUT_STATISTICS) work correctly.
  raw_output = unity_shell_result[:output].gsub(/\e\[[\d;]*[mK]/, '')

  # Process test statistics
  if (raw_output =~ PATTERNS::TEST_STDOUT_STATISTICS)
    results[:counts][:total] =   $1.to_i
    results[:counts][:failed] =  $2.to_i
    results[:counts][:ignored] = $3.to_i
    results[:counts][:passed] = (results[:counts][:total] - results[:counts][:failed] - results[:counts][:ignored])
  else
    raise CeedlingException.new( "Could not parse output for `#{executable}` ⏩️ \"#{unity_shell_result[:output]}\"" )
  end

  # Remove test statistics lines
  output_string = raw_output.sub( PATTERNS::TEST_STDOUT_STATISTICS, '' )

  # Process test executable results line-by-line
  output_string.lines do |line|
    # Process Unity test executable output
    chomped_line = line.chomp
    case chomped_line
    when /(:IGNORE)/
      elements = extract_line_elements( executable, line, results[:source][:file] )
      results[:ignores] << elements[0] 
      results[:stdout] << elements[1] unless (elements[1].nil? || elements[1].empty?)

    when /(:PASS$)/
      elements = extract_line_elements( executable, line, results[:source][:file] )
      results[:successes] << elements[0] 
      results[:stdout] << elements[1] unless (elements[1].nil? || elements[1].empty?)

    when /(:PASS \(.* ms\)$)/
      elements = extract_line_elements( executable, line, results[:source][:file] )
      results[:successes] << elements[0] 
      results[:stdout] << elements[1] unless (elements[1].nil? || elements[1].empty?)

    when /(:FAIL)/
      elements = extract_line_elements( executable, line, results[:source][:file] )
      results[:failures] << elements[0]
      results[:stdout] << elements[1] unless (elements[1].nil? || elements[1].empty?)

    # Collect up all other output
    else
      results[:stdout] << chomped_line unless chomped_line.empty?
    end
  end

  @loginator.log("Test results from #{File.basename(executable)} => #{results}", Verbosity::DEBUG)

  @sanity_checker.verify( results, unity_shell_result[:exit_code] )

  output_file = output_file.ext( @configurator.extension_testfail ) if (results[:counts][:failed] > 0)

  msg = @reportinator.generate_progress("Collecting test results from #{File.basename(executable)} to #{output_file}")
  @loginator.log(msg, Verbosity::OBNOXIOUS)

  @yaml_wrapper.dump(output_file, results)

  return { :result_file => output_file, :results => results }
end

#regenerate_test_executable_stdout(total:, failed:, ignored:, output: []) ⇒ Object

Fill out a template to mimic Unity's test executable output



228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/ceedling/generators/generator_test_results.rb', line 228

def regenerate_test_executable_stdout(total:, failed:, ignored:, output:[])
  values = {
    :total => total,
    :failed => failed,
    :ignored => ignored,
    :output => output.map {|line| line.strip()}.join("\n"),
    :result => (failed > 0) ? 'FAIL' : 'OK'
  }

  return UNITY_TEST_RESULTS_TEMPLATE % values
end

#setup ⇒ Object 



92
93
94
95
 
# File 'lib/ceedling/generators/generator_test_results.rb', line 92

def setup()
  # Aliases
  @sanity_checker = @generator_test_results_sanity_checker
end