Class: GeneratorHelper

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

Instance Method Summary collapse

Instance Method Details

#log_test_results_crash(executable, shell_result, backtrace) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/ceedling/generators/generator_helper.rb', line 55

def log_test_results_crash(executable, shell_result, backtrace)
  runner = File.basename(executable)

  notice = "Test executable `#{runner}` seems to have crashed -- likely terminating early due to a bad code reference.\n"

  # Check for empty output
  if (shell_result[:output].nil? or shell_result[:output].strip.empty?)
    # Mirror style of generic tool_executor failure output
    notice += "> Produced no output (including no final test result counts).\n"

  # Check for no test results
  elsif ((shell_result[:output] =~ PATTERNS::TEST_STDOUT_STATISTICS).nil?)
    # Mirror style of generic tool_executor failure output
    notice += "> Produced some output but contains no final test result counts.\n"
  end
  
  notice += "> Causes can include: bad memory access, stack overflow, heap error, or bad branch in source or test code.\n"

  # Incorporate knowledge of the backtrace setting into a recommendation
  case backtrace
  when :simple
    notice += "> Consider configuring :project ↳ :use_backtrace to use the :gdb option to find the cause (see documentation).\n"
  when :none
    notice += "> Consider configuring :project ↳ :use_backtrace to help find the cause (see documentation).\n"
  end

  @loginator.log( notice, Verbosity::ERRORS, LogLabels::CRASH )
end

#test_crash?(test_filename, executable, shell_result) ⇒ Boolean

Returns:

  • (Boolean) 


16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/ceedling/generators/generator_helper.rb', line 16

def test_crash?(test_filename, executable, shell_result)
  runner = File.basename(executable)

  crash = false

  # Unix Signal 11 ==> SIGSEGV
  # Applies to Unix-like systems including MSYS on Windows
  if (shell_result[:status].termsig == 11)
    @loginator.lazy( Verbosity::DEBUG, LogLabels::CRASH ) do 
      "#{runner} process terminated with SIGSEGV (Unix Signal 11)"
    end
    crash = true
  end

  # No test results found in test executable output
  if (shell_result[:output] =~ PATTERNS::TEST_STDOUT_STATISTICS).nil?
    # No debug logging here because we log this condition in the error log handling below
    crash = true
  end

  # Scan STDERR line by line for a segfault variant that is not attributed to the test file.
  # A line starting with test_filename is a Unity-reported test-case result, not an OS crash.
  # Checking each line individually avoids false negatives when attributed and bare segfault
  # lines coexist in the same stderr output.
  segfault_pattern = /Seg.*fault/i
  bare_segfault = shell_result[:stderr].each_line.any? do |line|
    line.match?(segfault_pattern) && !line.start_with?(test_filename)
  end

  if bare_segfault
    @loginator.lazy( Verbosity::DEBUG, LogLabels::CRASH ) do
      "#{runner} STDERR reports segmentation fault"
    end
    crash = true
  end

  return crash
end