Module: ResultsProcessor

Included in:
PotentialBuild
Defined in:
lib/resultsprocessor.rb

Overview

Implementation for parsing of build messages

Instance Method Summary collapse

Instance Method Details

#get_win32_filename(function, name) ⇒ Object 



25
26
27
28
29
30
31
32
 
# File 'lib/resultsprocessor.rb', line 25

def get_win32_filename(function, name)
  # :nocov: we don't test on windows currently
  max_path = 1024
  short_name = ' ' * max_path
  lfn_size = Win32API.new('kernel32', function, %w[P P L], 'L').call(name, short_name, max_path)
  (1..max_path).include?(lfn_size) ? short_name[0..lfn_size - 1] : name # rubocop:disable Performance/RangeInclude
  # :nocov:
end

#match_type_to_possible_fortran(err_line) ⇒ Object 



54
55
56
57
58
 
# File 'lib/resultsprocessor.rb', line 54

def match_type_to_possible_fortran(err_line)
  type = 'error'
  type = 'warning' if err_line.include?('.f90') # this is a bad assumption, but right now fortran warnings are being taken as uncategorized build errors
  type
end

#parse_error_messages(src_dir, build_dir, output) ⇒ Object 



254
255
256
257
258
259
260
261
262
263
 
# File 'lib/resultsprocessor.rb', line 254

def parse_error_messages(src_dir, build_dir, output)
  results = []
  output.encode('UTF-8', :invalid => :replace).split("\n").each do |l|
    msg = parse_gcc_line(src_dir, build_dir, l)
    msg = parse_msvc_line(src_dir, build_dir, l) if msg.nil?
    msg = parse_generic_line(src_dir, build_dir, l) if msg.nil?
    results << msg unless msg.nil?
  end
  results
end

#parse_gcc_line(src_path, build_path, line) ⇒ Object 



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/resultsprocessor.rb', line 205

def parse_gcc_line(src_path, build_path, line)
  # 'Something.cc:32:4: multiple definition of variable'
  /(?<filename>.*):(?<line_number>[0-9]+):(?<column_number>[0-9]+): (?<message_type>.+?): (?<message>.*)/ =~ line
  pattern_found = !filename.nil? && !message_type.nil?
  message_is_error = !(%w[info note].include? message_type)
  if pattern_found && message_is_error
    CodeMessage.new(relative_path(filename, src_path, build_path), line_number, column_number, message_type, message)
  else
    /(?<filename>.*):(?<line_number>[0-9]+): (?<message>.*)/ =~ line    # catch linker errors

    pattern_found = !filename.nil? && !message.nil?
    linker_error = false
    linker_error = ['multiple definition', 'undefined'].any? { |word| message.include? word } unless message.nil?
    return nil unless pattern_found && linker_error

    CodeMessage.new(relative_path(filename, src_path, build_path), line_number, 0, 'error', message)
  end
end

#parse_generic_line(src_dir, build_dir, line) ⇒ Object 



153
154
155
156
157
158
 
# File 'lib/resultsprocessor.rb', line 153

def parse_generic_line(src_dir, build_dir, line)
  /\s*(?<filename>\S+):(?<line_number>[0-9]+): (?<message>.*)/ =~ line
  return CodeMessage.new(relative_path(filename, src_dir, build_dir), line_number, 0, 'error', message) if !filename.nil? && !message.nil?

  nil
end

#parse_msvc_line(src_dir, build_dir, line) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/resultsprocessor.rb', line 160

def parse_msvc_line(src_dir, build_dir, line)
  return nil if line.nil?

  /(?<filename>.+)\((?<line_number>[0-9]+)\): (?<message_type>.+?) (?<message_code>\S+): (?<message>.*) \[.*\]?/ =~ line
  pattern_found = !filename.nil? && !message_type.nil?
  message_is_error = !(%w[info note].include? message_type)
  if pattern_found && message_is_error
    CodeMessage.new(relative_path(recover_file_case(filename.strip), src_dir, build_dir), line_number, 0, message_type, "#{message_code} #{message}")
  else
    /(?<filename>.+) : (?<message_type>\S+) (?<message_code>\S+): (?<message>.*) \[.*\]?/ =~ line
    pattern_2_found = !filename.nil? && !message_type.nil?
    message_2_is_error = !(%w[info note].include? message_type)
    unless pattern_2_found && message_2_is_error      # one last pattern to try, doing it brute force

      if line.index(': ')&.positive?
        tokens = line.split(': ')
        if tokens.length >= 3
          filename = tokens[0]
          section_two_tokens = tokens[1].split
          message_type = section_two_tokens[0]
          message_code = section_two_tokens[1]
          message = tokens[2..-1].join(': ')
        end
      end
      pattern_3_found = !filename.nil? && !message_type.nil?
      message_3_is_error = !(%w[info note].include? message_type)
      return nil unless pattern_3_found && message_3_is_error && message_code

    end
    return nil unless filename

    CodeMessage.new(relative_path(recover_file_case(filename.strip), src_dir, build_dir), 0, 0, message_type, "#{message_code} #{message}")
  end
end

#parse_python_or_latex_line(src_dir, build_dir, line) ⇒ Object 



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/resultsprocessor.rb', line 265

def parse_python_or_latex_line(src_dir, build_dir, line)
  line_number = nil  # Since we are just doing line-by-line parsing, it really limits what we can get, but we'll try our best anyway

  if line.include? 'LaTeX Error'    # ! LaTeX Error: Environment itemize undefined.

    /^.*Error: (?<message>.+)/ =~ line
    compiler_string = 'LaTeX'
  else
    # assume Python
    # TypeError: cannot concatenate 'str' and 'int' objects
    /File "(?<filename>.+)", line (?<line_number>[0-9]+),.*/ =~ line
    /^.*Error: (?<message>.+)/ =~ line
    compiler_string = 'Python'
  end

  return CodeMessage.new(relative_path(filename.strip, src_dir, build_dir), line_number, 0, 'error', 'error') if !filename.nil? && !line_number.nil?

  return CodeMessage.new(relative_path(compiler_string, src_dir, build_dir), 0, 0, 'error', message) unless message.nil?

  nil
end

#process_cmake_results(src_dir, build_dir, stderr, cmake_exit_code, is_package) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
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
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
 
# File 'lib/resultsprocessor.rb', line 60

def process_cmake_results(src_dir, build_dir, stderr, cmake_exit_code, is_package)
  results = []

  file = nil
  line = nil
  msg = ''
  type = nil

  $logger.info('Parsing cmake error results')

  previous_line = ''
  last_was_error_line = false

  stderr.encode('UTF-8', :invalid => :replace).split("\n").each do |err|
    # Append next line to the message context for a CMake error
    if last_was_error_line && !results.empty?
      stripped = err.strip
      if stripped != ''
        last_item = results.last
        last_item.message = "#{last_item.message}; #{stripped}"
        results[results.length - 1] = last_item
      end
    end

    last_was_error_line = false

    $logger.debug("Parsing cmake error Line: #{err}")
    if err.strip == ''
      if !file.nil? && !line.nil? && !msg.nil?
        results << CodeMessage.new(relative_path(file, src_dir, build_dir), line, 0, type, "#{previous_line}#{err}")
        last_was_error_line = true
      end
      file = nil
      line = nil
      msg = ''
      type = nil
    elsif file.nil?
      /^CMake Error: (?<message>.*)/ =~ err
      unless message.nil?
        results << CodeMessage.new(relative_path('CMakeLists.txt', src_dir, build_dir), 1, 0, 'error', "#{previous_line}#{err.strip}")
        last_was_error_line = true
      end

      /^ERROR: (?<message>.*)/ =~ err
      unless message.nil?
        results << CodeMessage.new(relative_path('CMakeLists.txt', src_dir, build_dir), 1, 0, 'error', "#{previous_line}#{err.strip}")
        last_was_error_line = true
      end

      /^WARNING: (?<message>.*)/ =~ err
      unless message.nil?
        results << CodeMessage.new(relative_path('CMakeLists.txt', src_dir, build_dir), 1, 0, 'warning', "#{previous_line}#{err.strip}")
        last_was_error_line = true
      end

      /CMake (?<message_type>\S+) at (?<filename>.*):(?<line_number>[0-9]+) \(\S+\):$/ =~ err

      if !filename.nil? && !line_number.nil?
        file = filename
        line = line_number
        type = message_type.nil? ? 'error' : message_type.downcase
      else
        /(?<filename>.*):(?<line_number>[0-9]+):$/ =~ err

        if !filename.nil? && !line_number.nil? && (filename !~ /file included/i) && (filename !~ /^\s*from\s+/i)
          file = filename
          line = line_number
          type = match_type_to_possible_fortran(err)
        end
      end
    else
      +msg << "\n" if msg != ''
      +msg << err
    end

    previous_line = err.strip
    previous_line += '; ' if previous_line != ''
  end

  # get any lingering message from the last line
  results << CodeMessage.new(relative_path(file, src_dir, build_dir), line, 0, type, msg) if !file.nil? && !line.nil? && !msg.nil?

  results.each { |r| $logger.debug("CMake error message parsed: #{r.inspect}") }

  if is_package
    @package_results.merge(results)
  else
    @build_results.merge(results)
  end

  cmake_exit_code.zero?
end

#process_ctest_results(src_dir, build_dir, test_dir) ⇒ Object 



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/resultsprocessor.rb', line 332

def process_ctest_results(src_dir, build_dir, test_dir)
  unless File.directory?(test_dir)
    $logger.error("Error: test_dir #{test_dir} does not exist, cannot parse test results")
    return nil, []
  end

  messages = []
  results = []

  # messages can be in two locations:
  # the ctest generated Test.xml file will contain output from the ctests
  # but then also, we now have a test that checks the doc build log to make sure nothing was wrong in the LaTeX build
  # this kinda makes the test_result/build_result difference a bit muddy, but we'll make it work
  # the docs are built as part of the normal "make" command on CI, then the "ctest" command executes all the tests,
  #   including the ones that test the build logs, and those tests will have created json blobs.  We should find those
  #   and try to parse them to produce test results
  doc_build_dir = File.join(build_dir, 'doc')
  if File.exist? doc_build_dir
    Find.find(doc_build_dir) do |path|
      next unless path.match(/._errors.json/)

      f = File.open(path, 'r')
      contents = f.read
      json = JSON.parse(contents)
      json['issues'].each do |issue|
        severity_raw = issue['severity']
        status = 'failed'
        severity = 'error'
        severity = 'warning' if severity_raw.upcase == 'WARNING'
        full_message = ''
        full_message += issue['type']
        file_name = issue['locations'][0]['file']
        line_number = issue['locations'][0]['line']
        full_message += ": #{issue['message']}"
        doc_errors = [CodeMessage.new(file_name, line_number, 0, severity, full_message)]
        results << TestResult.new(file_name, status, 0, full_message, doc_errors, 1)
      end
    end
  end

  Find.find(test_dir) do |path|
    next unless path.match(/.*Test.xml/)

    # read the test.xml file but make sure to close it
    f = File.open(path, 'r')
    contents = f.read
    f.close    # then get the XML contents into a Ruby Hash

    xml = Hash.from_xml(contents)
    test_results = xml['Site']['Testing']
    t = test_results['Test']
    next if t.nil?

    tests = []
    tests << t
    tests.flatten!

    tests.each do |n|
      $logger.debug("N: #{n}")
      $logger.debug("Results: #{n['Results']}")
      r = n['Results']
      if n['Status'] == 'notrun'
        results << TestResult.new(n['Name'], n['Status'], 0, '', nil, 'notrun')
      elsif r
        m = r['Measurement']
        value = nil
        errors = nil

        unless m.nil? || m['Value'].nil?
          value = m['Value']
          errors = parse_error_messages(src_dir, build_dir, value)
          value.split("\n").each do |line|
            if /\[decent_ci:test_result:message\] (?<message>.+)/ =~ line
              messages << TestMessage.new(n['Name'], message)
            end
          end
        end

        nm = r['NamedMeasurement']

        unless nm.nil?
          failure_type = ''
          nm.each do |measurement|
            next if measurement['name'] != 'Exit Code'

            ft = measurement['Value']
            failure_type = ft unless ft.nil?
          end

          nm.each do |measurement|
            next if measurement['name'] != 'Execution Time'

            status_string = n['Status']
            status_string = 'warning' if !value.nil? && value =~ /\[decent_ci:test_result:warn\]/ && status_string == 'passed'
            results << TestResult.new(n['Name'], status_string, measurement['Value'], value, errors, failure_type)
          end
        end
      end
    end
  end
  return nil, messages if results.empty?

  [results, messages]
end

#process_gcc_results(src_path, build_path, stderr, gcc_exit_code) ⇒ Object 



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
251
252
 
# File 'lib/resultsprocessor.rb', line 224

def process_gcc_results(src_path, build_path, stderr, gcc_exit_code)
  results = []
  linker_msg = nil

  stderr.encode('UTF-8', :invalid => :replace).split("\n").each do |line|
    unless linker_msg.nil?
      if line.match(/^\s.*/)
        linker_msg += "\n#{line}"
      else
        results << CodeMessage.new('CMakeLists.txt', 0, 0, 'error', linker_msg)
        linker_msg = nil
      end
    end

    msg = parse_gcc_line(src_path, build_path, line)
    if !msg.nil?
      results << msg
    elsif line.match(/^Undefined symbols for architecture.*/)      # try to catch some goofy clang linker errors that don't give us very much info

      linker_msg = line
    end
  end

  results << CodeMessage.new('CMakeLists.txt', 0, 0, 'error', linker_msg) unless linker_msg.nil?

  @build_results.merge(results)

  gcc_exit_code.zero?
end

#process_lcov_results(out) ⇒ Object 



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/resultsprocessor.rb', line 305

def process_lcov_results(out)
  # Overall coverage rate:
  #  lines......: 67.9% (173188 of 255018 lines)
  #  functions..: 83.8% (6228 of 7433 functions)

  total_lines = 0
  covered_lines = 0
  total_functions = 0
  covered_functions = 0
  total_lines_str = nil
  covered_lines_str = nil
  total_functions_str = nil
  covered_functions_str = nil

  out.encode('UTF-8', :invalid => :replace).split("\n").each do |l|
    /.*\((?<covered_lines_str>[0-9]+) of (?<total_lines_str>[0-9]+) lines.*/ =~ l
    covered_lines = covered_lines_str.to_i unless covered_lines_str.nil?
    total_lines = total_lines_str.to_i unless total_lines_str.nil?

    /.*\((?<covered_functions_str>[0-9]+) of (?<total_functions_str>[0-9]+) functions.*/ =~ l
    covered_functions = covered_functions_str.to_i unless covered_functions_str.nil?
    total_functions = total_functions_str.to_i unless total_functions_str.nil?
  end

  [total_lines, covered_lines, total_functions, covered_functions]
end

#process_msvc_results(src_dir, build_dir, stdout, msvc_exit_code) ⇒ Object 



195
196
197
198
199
200
201
202
203
 
# File 'lib/resultsprocessor.rb', line 195

def process_msvc_results(src_dir, build_dir, stdout, msvc_exit_code)
  results = []
  stdout.encode('UTF-8', :invalid => :replace).split("\n").each do |err|
    msg = parse_msvc_line(src_dir, build_dir, err)
    results << msg unless msg.nil?
  end
  @build_results.merge(results)
  msvc_exit_code.zero?
end

#process_python_results(src_dir, build_dir, stdout, stderr, python_exit_code) ⇒ Object 



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/resultsprocessor.rb', line 287

def process_python_results(src_dir, build_dir, stdout, stderr, python_exit_code)
  results = []
  stdout.encode('UTF-8', :invalid => :replace).split("\n").each do |err|
    msg = parse_python_or_latex_line(src_dir, build_dir, err)
    results << msg unless msg.nil?
  end
  $logger.debug("stdout results: #{results}")
  @build_results.merge(results)
  results = []
  stderr.encode('UTF-8', :invalid => :replace).split("\n").each do |err|
    msg = parse_python_or_latex_line(src_dir, build_dir, err)
    results << msg unless msg.nil?
  end
  $logger.debug("stderr results: #{results}")
  @build_results.merge(results)
  python_exit_code.zero?
end

#recover_file_case(name) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/resultsprocessor.rb', line 34

def recover_file_case(name)
  if RbConfig::CONFIG['target_os'].match(/mingw|mswin/)    # :nocov: we don't test on windows currently

    require 'win32api'

    get_short_win32_filename = lambda do |this_name|
      get_win32_filename('GetShortPathName', this_name)
    end

    get_long_win32_filename = lambda do |this_name|
      get_win32_filename('GetLongPathName', this_name)
    end

    get_long_win32_filename.call(get_short_win32_filename.call(name))    # :nocov:

  else
    name
  end
end

#relative_path(path, src_dir, build_dir) ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/resultsprocessor.rb', line 11

def relative_path(path, src_dir, build_dir)
  Pathname.new("#{src_dir}/#{path}").realpath.relative_path_from(Pathname.new(this_src_dir).realdirpath)
rescue
  begin
    Pathname.new("#{build_dir}/#{path}").realpath.relative_path_from(Pathname.new(this_src_dir).realdirpath)
  rescue
    begin
      Pathname.new(path).realpath.relative_path_from(Pathname.new(this_src_dir).realdirpath)
    rescue
      Pathname.new(path)
    end
  end
end