ceedling 0.13.0 → 0.15.0

data/lib/{generator_helper.rb → ceedling/generator_helper.rb}

@@ -1,40 +1,40 @@
-require 'constants'
-
-
-class GeneratorHelper
-
-  constructor :streaminator
-
-
-  def test_results_error_handler(executable, shell_result)
-    notice = ''
-    error  = false
-    
-    if (shell_result[:output].nil? or shell_result[:output].strip.empty?)
-      error = true
-      # mirror style of generic tool_executor failure output
-      notice  = "\n" +
-                "ERROR: Test executable \"#{File.basename(executable)}\" failed.\n" +
-                "> Produced no output to $stdout.\n"
-    elsif ((shell_result[:output] =~ TEST_STDOUT_STATISTICS_PATTERN).nil?)
-      error = true
-      # mirror style of generic tool_executor failure output
-      notice  = "\n" +
-                "ERROR: Test executable \"#{File.basename(executable)}\" failed.\n" +
-                "> Produced no final test result counts in $stdout:\n" +
-                "#{shell_result[:output].strip}\n"
-    end
-    
-    if (error)
-      # since we told the tool executor to ignore the exit code, handle it explicitly here
-      notice += "> And exited with status: [#{shell_result[:exit_code]}] (count of failed tests).\n" if (shell_result[:exit_code] != nil)
-      notice += "> And then likely crashed.\n"                                                       if (shell_result[:exit_code] == nil)
-
-      notice += "> This is often a symptom of a bad memory access in source or test code.\n\n"
-
-      @streaminator.stderr_puts(notice, Verbosity::COMPLAIN)
-      raise      
-    end
-  end
-  
-end
+require 'ceedling/constants'
+
+
+class GeneratorHelper
+
+  constructor :streaminator
+
+
+  def test_results_error_handler(executable, shell_result)
+    notice = ''
+    error  = false
+    
+    if (shell_result[:output].nil? or shell_result[:output].strip.empty?)
+      error = true
+      # mirror style of generic tool_executor failure output
+      notice  = "\n" +
+                "ERROR: Test executable \"#{File.basename(executable)}\" failed.\n" +
+                "> Produced no output to $stdout.\n"
+    elsif ((shell_result[:output] =~ TEST_STDOUT_STATISTICS_PATTERN).nil?)
+      error = true
+      # mirror style of generic tool_executor failure output
+      notice  = "\n" +
+                "ERROR: Test executable \"#{File.basename(executable)}\" failed.\n" +
+                "> Produced no final test result counts in $stdout:\n" +
+                "#{shell_result[:output].strip}\n"
+    end
+    
+    if (error)
+      # since we told the tool executor to ignore the exit code, handle it explicitly here
+      notice += "> And exited with status: [#{shell_result[:exit_code]}] (count of failed tests).\n" if (shell_result[:exit_code] != nil)
+      notice += "> And then likely crashed.\n"                                                       if (shell_result[:exit_code] == nil)
+
+      notice += "> This is often a symptom of a bad memory access in source or test code.\n\n"
+
+      @streaminator.stderr_puts(notice, Verbosity::COMPLAIN)
+      raise      
+    end
+  end
+  
+end

data/lib/{generator_test_results.rb → ceedling/generator_test_results.rb}

@@ -1,89 +1,86 @@
-require 'rubygems'
-require 'rake' # for .ext()
-require 'constants'
-
- 
-class GeneratorTestResults
-
-  constructor :configurator, :generator_test_results_sanity_checker, :yaml_wrapper
- 
-  def process_and_write_results(unity_shell_result, results_file, test_file)
-    output_file   = results_file
-    
-    results = get_results_structure
-    
-    results[:source][:path] = File.dirname(test_file)
-    results[:source][:file] = File.basename(test_file)
-    
-    # process test statistics
-    if (unity_shell_result[:output] =~ TEST_STDOUT_STATISTICS_PATTERN)
-      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])
-    end
-
-    # remove test statistics lines
-    output_string = unity_shell_result[:output].sub(TEST_STDOUT_STATISTICS_PATTERN, '')
-    
-    # bust up the output into individual lines
-    raw_unity_lines = output_string.split(/\n|\r\n/)
-    
-    raw_unity_lines.each do |line|
-      # process unity output
-      case line
-      when /(:IGNORE)/
-        elements = extract_line_elements(line, results[:source][:file])
-        results[:ignores]   << elements[0]
-        results[:stdout]    << elements[1] if (!elements[1].nil?)
-      when /(:PASS$)/
-        elements = extract_line_elements(line, results[:source][:file])
-        results[:successes] << elements[0]
-        results[:stdout]    << elements[1] if (!elements[1].nil?)
-      when /(:FAIL)/
-        elements = extract_line_elements(line, results[:source][:file])
-        results[:failures]  << elements[0]
-        results[:stdout]    << elements[1] if (!elements[1].nil?)
-      else # collect up all other
-        results[:stdout] << line.chomp
-      end
-    end
-    
-    @generator_test_results_sanity_checker.verify(results, unity_shell_result[:exit_code])
-    
-    output_file = results_file.ext(@configurator.extension_testfail) if (results[:counts][:failed] > 0)
-    
-    @yaml_wrapper.dump(output_file, results)
-    
-    return { :result_file => output_file, :result => results }
-  end
-
-  private
-
-  def get_results_structure
-    return {
-      :source    => {:path => '', :file => ''},
-      :successes => [],
-      :failures  => [],
-      :ignores   => [],
-      :counts    => {:total => 0, :passed => 0, :failed => 0, :ignored  => 0},
-      :stdout    => [],
-      }
-  end
-  
-  def extract_line_elements(line, filename)
-    # handle anything preceding filename in line as extra output to be collected
-    stdout = nil
-    stdout_regex = /(.+)#{Regexp.escape(filename)}.+/i
-    
-    if (line =~ stdout_regex)
-      stdout = $1.clone
-      line.sub!(/#{Regexp.escape(stdout)}/, '')
-    end
-    
-    # collect up test results minus and extra output
-    elements = (line.strip.split(':'))[1..-1]
-    return {:test => elements[1], :line => elements[0].to_i, :message => (elements[3..-1].join(':')).strip}, stdout
-  end
-
-end
+require 'rubygems'
+require 'rake' # for .ext()
+require 'ceedling/constants'
+
+ 
+class GeneratorTestResults
+
+  constructor :configurator, :generator_test_results_sanity_checker, :yaml_wrapper
+ 
+  def process_and_write_results(unity_shell_result, results_file, test_file)
+    output_file   = results_file
+    
+    results = get_results_structure
+    
+    results[:source][:path] = File.dirname(test_file)
+    results[:source][:file] = File.basename(test_file)
+    
+    # process test statistics
+    if (unity_shell_result[:output] =~ TEST_STDOUT_STATISTICS_PATTERN)
+      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])
+    end
+
+    # remove test statistics lines
+    output_string = unity_shell_result[:output].sub(TEST_STDOUT_STATISTICS_PATTERN, '')
+    
+    output_string.lines do |line|
+      # process unity output
+      case line
+      when /(:IGNORE)/
+        elements = extract_line_elements(line, results[:source][:file])
+        results[:ignores]   << elements[0]
+        results[:stdout]    << elements[1] if (!elements[1].nil?)
+      when /(:PASS$)/
+        elements = extract_line_elements(line, results[:source][:file])
+        results[:successes] << elements[0]
+        results[:stdout]    << elements[1] if (!elements[1].nil?)
+      when /(:FAIL)/
+        elements = extract_line_elements(line, results[:source][:file])
+        results[:failures]  << elements[0]
+        results[:stdout]    << elements[1] if (!elements[1].nil?)
+      else # collect up all other
+        results[:stdout] << line.chomp
+      end
+    end
+    
+    @generator_test_results_sanity_checker.verify(results, unity_shell_result[:exit_code])
+    
+    output_file = results_file.ext(@configurator.extension_testfail) if (results[:counts][:failed] > 0)
+    
+    @yaml_wrapper.dump(output_file, results)
+    
+    return { :result_file => output_file, :result => results }
+  end
+
+  private
+
+  def get_results_structure
+    return {
+      :source    => {:path => '', :file => ''},
+      :successes => [],
+      :failures  => [],
+      :ignores   => [],
+      :counts    => {:total => 0, :passed => 0, :failed => 0, :ignored  => 0},
+      :stdout    => [],
+      }
+  end
+  
+  def extract_line_elements(line, filename)
+    # handle anything preceding filename in line as extra output to be collected
+    stdout = nil
+    stdout_regex = /(.+)#{Regexp.escape(filename)}.+/i
+    
+    if (line =~ stdout_regex)
+      stdout = $1.clone
+      line.sub!(/#{Regexp.escape(stdout)}/, '')
+    end
+    
+    # collect up test results minus and extra output
+    elements = (line.strip.split(':'))[1..-1]
+    return {:test => elements[1], :line => elements[0].to_i, :message => (elements[3..-1].join(':')).strip}, stdout
+  end
+
+end

data/lib/{generator_test_results_sanity_checker.rb → ceedling/generator_test_results_sanity_checker.rb}

@@ -1,62 +1,64 @@
-require 'constants'
-require 'rubygems'
-require 'rake' # for ext() method
-
-
-class GeneratorTestResultsSanityChecker
-
-  constructor :configurator, :streaminator
-  
-  def verify(results, unity_exit_code)
-  
-    # do no sanity checking if it's disabled
-    return if (@configurator.sanity_checks == TestResultsSanityChecks::NONE)
-  
-    ceedling_ignores_count   = results[:ignores].size
-    ceedling_failures_count  = results[:failures].size
-    ceedling_tests_summation = (ceedling_ignores_count + ceedling_failures_count + results[:successes].size)
-
-    # Exit code handling is not a sanity check that can always be performed because 
-    # command line simulators may or may not pass through Unity's exit code
-    if (@configurator.sanity_checks >= TestResultsSanityChecks::THOROUGH)
-      # many platforms limit exit codes to a maximum of 255
-      if ((ceedling_failures_count != unity_exit_code) and (unity_exit_code < 255))
-        sanity_check_warning(results[:source][:file], "Unity's exit code (#{unity_exit_code}) does not match Ceedling's summation of failed test cases (#{ceedling_failures_count}).")
-      end
-      
-      if ((ceedling_failures_count < 255) and (unity_exit_code == 255))
-        sanity_check_warning(results[:source][:file], "Ceedling's summation of failed test cases (#{ceedling_failures_count}) is less than Unity's exit code (255 or more).")
-      end
-    end
-    
-    if (ceedling_ignores_count != results[:counts][:ignored])
-      sanity_check_warning(results[:source][:file], "Unity's final ignore count (#{results[:counts][:ignored]}) does not match Ceedling's summation of ignored test cases (#{ceedling_ignores_count}).")
-    end
-    
-    if (ceedling_failures_count != results[:counts][:failed])
-      sanity_check_warning(results[:source][:file], "Unity's final fail count (#{results[:counts][:failed]}) does not match Ceedling's summation of failed test cases (#{ceedling_failures_count}).")
-    end
-
-    if (ceedling_tests_summation != results[:counts][:total])
-      sanity_check_warning(results[:source][:file], "Unity's final test count (#{results[:counts][:total]}) does not match Ceedling's summation of all test cases (#{ceedling_tests_summation}).")
-    end
-    
-  end
-
-  private
-  
-  def sanity_check_warning(file, message)
-    notice = "\n" + 
-             "ERROR: Internal sanity check for test fixture '#{file.ext(@configurator.extension_executable)}' finds that #{message}\n" +
-             "  Possible causes:\n" +
-             "    1. Your test + source dereferenced a null pointer.\n" +
-             "    2. Your test + source indexed past the end of a buffer.\n" +
-             "    3. Your test + source committed a memory access violation.\n" +
-             "    4. Your test fixture produced an exit code of 0 despite execution ending prematurely.\n" +
-             "  Sanity check failures of test results are usually a symptom of interrupted test execution.\n\n"
-    
-    @streaminator.stderr_puts( notice )
-    raise
-  end
-
-end
+require 'rubygems'
+require 'rake' # for ext() method
+require 'ceedling/constants'
+
+
+class GeneratorTestResultsSanityChecker
+
+  constructor :configurator, :streaminator
+  
+  def verify(results, unity_exit_code)
+  
+    # do no sanity checking if it's disabled
+    return if (@configurator.sanity_checks == TestResultsSanityChecks::NONE)
+  
+    ceedling_ignores_count   = results[:ignores].size
+    ceedling_failures_count  = results[:failures].size
+    ceedling_tests_summation = (ceedling_ignores_count + ceedling_failures_count + results[:successes].size)
+
+    # Exit code handling is not a sanity check that can always be performed because 
+    # command line simulators may or may not pass through Unity's exit code
+    if (@configurator.sanity_checks >= TestResultsSanityChecks::THOROUGH)
+      # many platforms limit exit codes to a maximum of 255
+      if ((ceedling_failures_count != unity_exit_code) and (unity_exit_code < 255))
+        sanity_check_warning(results[:source][:file], "Unity's exit code (#{unity_exit_code}) does not match Ceedling's summation of failed test cases (#{ceedling_failures_count}).")
+      end
+      
+      if ((ceedling_failures_count < 255) and (unity_exit_code == 255))
+        sanity_check_warning(results[:source][:file], "Ceedling's summation of failed test cases (#{ceedling_failures_count}) is less than Unity's exit code (255 or more).")
+      end
+    end
+    
+    if (ceedling_ignores_count != results[:counts][:ignored])
+      sanity_check_warning(results[:source][:file], "Unity's final ignore count (#{results[:counts][:ignored]}) does not match Ceedling's summation of ignored test cases (#{ceedling_ignores_count}).")
+    end
+    
+    if (ceedling_failures_count != results[:counts][:failed])
+      sanity_check_warning(results[:source][:file], "Unity's final fail count (#{results[:counts][:failed]}) does not match Ceedling's summation of failed test cases (#{ceedling_failures_count}).")
+    end
+
+    if (ceedling_tests_summation != results[:counts][:total])
+      sanity_check_warning(results[:source][:file], "Unity's final test count (#{results[:counts][:total]}) does not match Ceedling's summation of all test cases (#{ceedling_tests_summation}).")
+    end
+    
+  end
+
+  private
+  
+ def sanity_check_warning(file, message)
+    unless defined?(CEEDLING_IGNORE_SANITY_CHECK)
+      notice = "\n" + 
+               "ERROR: Internal sanity check for test fixture '#{file.ext(@configurator.extension_executable)}' finds that #{message}\n" +
+               "  Possible causes:\n" +
+               "    1. Your test + source dereferenced a null pointer.\n" +
+               "    2. Your test + source indexed past the end of a buffer.\n" +
+               "    3. Your test + source committed a memory access violation.\n" +
+               "    4. Your test fixture produced an exit code of 0 despite execution ending prematurely.\n" +
+               "  Sanity check failures of test results are usually a symptom of interrupted test execution.\n\n"
+      
+      @streaminator.stderr_puts( notice )
+      raise
+    end
+  end
+
+end

data/lib/{generator_test_runner.rb → ceedling/generator_test_runner.rb}

@@ -1,63 +1,63 @@
-
-class GeneratorTestRunner
-
-  constructor :configurator, :file_path_utils, :file_wrapper
-
-  def find_test_cases(test_file)
-    tests = []
-    tests_and_line_numbers = []
-    lines = []
-    
-    # if we don't have preprocessor assistance, do some basic preprocessing of our own
-    if (not @configurator.project_use_test_preprocessor)
-      source = @file_wrapper.read(test_file)
-    
-      # remove line comments
-      source = source.gsub(/\/\/.*$/, '')
-      # remove block comments
-      source = source.gsub(/\/\*.*?\*\//m, '')
-    
-      # treat preprocessor directives as a logical line
-      lines = source.split(/(^\s*\#.*$) | (;|\{|\}) /x) # match ;, {, and } as end of lines
-    # otherwise, read the preprocessed file raw
-    else
-      lines = @file_wrapper.read( @file_path_utils.form_preprocessed_file_filepath(test_file) ).split(/;|\{|\}/)
-    end
-    
-    # step 1. find test functions in (possibly preprocessed) file
-    # (note that lines are not broken up at end of lines)
-    lines.each do |line|
-      if (line =~ /^\s*void\s+((T|t)est.*)\s*\(\s*(void)?\s*\)/m)
-        tests << ($1.strip)
-      end
-    end
-    
-    # step 2. associate test functions with line numbers in (non-preprocessed) original file
-    # (note that this time we must scan file contents broken up by end of lines)
-    raw_lines = @file_wrapper.read(test_file).split("\n")
-    raw_index = 0
-    
-    tests.each do |test|
-      raw_lines[raw_index..-1].each_with_index do |line, index|
-        # test function might be declared across lines; look for it by its name followed
-        #  by a few tell-tale signs
-        if (line =~ /#{test}\s*($|\(|\()/)
-          raw_index += (index + 1)
-          tests_and_line_numbers << {:test => test, :line_number => raw_index}
-          break
-        end
-      end
-    end
-    
-    return tests_and_line_numbers
-  end
-  
-  def generate(module_name, runner_filepath, test_cases, mock_list)
-    require 'generate_test_runner.rb'
-    @test_runner_generator ||= UnityTestRunnerGenerator.new( @configurator.get_runner_config )
-    @test_runner_generator.generate( module_name, 
-                                     runner_filepath, 
-                                     test_cases, 
-                                     mock_list)
-  end
-end
+
+class GeneratorTestRunner
+
+  constructor :configurator, :file_path_utils, :file_wrapper
+
+  def find_test_cases(test_file)
+    tests = []
+    tests_and_line_numbers = []
+    lines = []
+    
+    # if we don't have preprocessor assistance, do some basic preprocessing of our own
+    if (not @configurator.project_use_test_preprocessor)
+      source = @file_wrapper.read(test_file)
+    
+      # remove line comments
+      source = source.gsub(/\/\/.*$/, '')
+      # remove block comments
+      source = source.gsub(/\/\*.*?\*\//m, '')
+    
+      # treat preprocessor directives as a logical line
+      lines = source.split(/(^\s*\#.*$) | (;|\{|\}) /x) # match ;, {, and } as end of lines
+    # otherwise, read the preprocessed file raw
+    else
+      lines = @file_wrapper.read( @file_path_utils.form_preprocessed_file_filepath(test_file) ).split(/;|\{|\}/)
+    end
+    
+    # step 1. find test functions in (possibly preprocessed) file
+    # (note that lines are not broken up at end of lines)
+    lines.each do |line|
+      if (line =~ /^\s*void\s+((T|t)est.*)\s*\(\s*(void)?\s*\)/m)
+        tests << ($1.strip)
+      end
+    end
+    
+    # step 2. associate test functions with line numbers in (non-preprocessed) original file
+    # (note that this time we must scan file contents broken up by end of lines)
+    raw_lines = @file_wrapper.read(test_file).split("\n")
+    raw_index = 0
+    
+    tests.each do |test|
+      raw_lines[raw_index..-1].each_with_index do |line, index|
+        # test function might be declared across lines; look for it by its name followed
+        #  by a few tell-tale signs
+        if (line =~ /#{test}\s*($|\(|\()/)
+          raw_index += (index + 1)
+          tests_and_line_numbers << {:test => test, :line_number => raw_index}
+          break
+        end
+      end
+    end
+    
+    return tests_and_line_numbers
+  end
+  
+  def generate(module_name, runner_filepath, test_cases, mock_list)
+    require 'generate_test_runner.rb'
+    @test_runner_generator ||= UnityTestRunnerGenerator.new( @configurator.get_runner_config )
+    @test_runner_generator.generate( module_name, 
+                                     runner_filepath, 
+                                     test_cases, 
+                                     mock_list)
+  end
+end