ceedling 0.30.0 → 0.31.0

data/plugins/gcov/config/defaults.yml

@@ -37,6 +37,10 @@
     :executable: gcov
     :optional: TRUE
     :arguments:
+      - -b
+      - -c
+      - -r
+      - -x
       - ${1}
   :gcov_gcovr_post_report:
     :executable: gcovr

data/plugins/gcov/gcov.rake

@@ -75,7 +75,7 @@ namespace GCOV_SYM do
   task source_coverage: COLLECTION_ALL_SOURCE.pathmap("#{GCOV_BUILD_OUTPUT_PATH}/%n#{@ceedling[:configurator].extension_object}")
 
   desc 'Run code coverage for all tests'
-  task all: [:directories] do
+  task all: [:test_deps] do
     @ceedling[:configurator].replace_flattened_config(@ceedling[GCOV_SYM].config)
     @ceedling[:test_invoker].setup_and_invoke(COLLECTION_ALL_TESTS, GCOV_SYM)
     @ceedling[:configurator].restore_config
@@ -91,7 +91,7 @@ namespace GCOV_SYM do
   end
 
   desc 'Run tests by matching regular expression pattern.'
-  task :pattern, [:regex] => [:directories] do |_t, args|
+  task :pattern, [:regex] => [:test_deps] do |_t, args|
     matches = []
 
     COLLECTION_ALL_TESTS.each do |test|
@@ -108,7 +108,7 @@ namespace GCOV_SYM do
   end
 
   desc 'Run tests whose test path contains [dir] or [dir] substring.'
-  task :path, [:dir] => [:directories] do |_t, args|
+  task :path, [:dir] => [:test_deps] do |_t, args|
     matches = []
 
     COLLECTION_ALL_TESTS.each do |test|
@@ -125,7 +125,7 @@ namespace GCOV_SYM do
   end
 
   desc 'Run code coverage for changed files'
-  task delta: [:directories] do
+  task delta: [:test_deps] do
     @ceedling[:configurator].replace_flattened_config(@ceedling[GCOV_SYM].config)
     @ceedling[:test_invoker].setup_and_invoke(COLLECTION_ALL_TESTS, GCOV_SYM, force_run: false)
     @ceedling[:configurator].restore_config
@@ -140,7 +140,7 @@ namespace GCOV_SYM do
            @ceedling[:file_finder].find_test_from_file_path(test)
          end
        ]) do |test|
-    @ceedling[:rake_wrapper][:directories].invoke
+    @ceedling[:rake_wrapper][:test_deps].invoke
     @ceedling[:configurator].replace_flattened_config(@ceedling[GCOV_SYM].config)
     @ceedling[:test_invoker].setup_and_invoke([test.source], GCOV_SYM)
     @ceedling[:configurator].restore_config

data/plugins/gcov/lib/gcov.rb

@@ -95,12 +95,15 @@ class Gcov < Plugin
       end
     end
 
-    ignore_file_list = @ceedling[:configurator].project_config_hash[:gcov_uncovered_ignore_list] || []
-    ignore_uncovered_list = []
-    ignore_file_list.each do |source|
-      ignore_uncovered_list.push(Dir.glob(source).reject{|f| File.directory?(f)})
+    ignore_path_list = @ceedling[:file_system_utils].collect_paths(@ceedling[:configurator].project_config_hash[:gcov_uncovered_ignore_list] || [])
+    ignore_uncovered_list = @ceedling[:file_wrapper].instantiate_file_list
+    ignore_path_list.each do |path|
+      if File.exists?(path) and not File.directory?(path)
+        ignore_uncovered_list.include(path)
+      else
+        ignore_uncovered_list.include(File.join(path, "*#{EXTENSION_SOURCE}"))
+      end
     end
-    ignore_uncovered_list.flatten!
 
     found_uncovered = false
     COLLECTION_ALL_SOURCE.each do |source|

data/plugins/gcov/lib/gcovr_reportinator.rb

@@ -21,8 +21,6 @@ class GcovrReportinator
       args = args_common
       args += args_builder_cobertura(opts, false)
       args += args_builder_sonarqube(opts, false)
-      # Note: In gcovr 4.2, the JSON report is output only when the --output option is specified.
-      # Hopefully we can remove --output after a future gcovr release.
       args += args_builder_json(opts, true)
       # As of gcovr version 4.2, the --html argument must appear last.
       args += args_builder_html(opts, false)
@@ -207,6 +205,8 @@ class GcovrReportinator
       end
 
       args += "--json-pretty " if gcovr_opts[:json_pretty]
+      # Note: In gcovr 4.2, the JSON report is output only when the --output option is specified.
+      # Hopefully we can remove --output after a future gcovr release.
       args += "--json #{use_output_option ? "--output " : ""} \"#{artifacts_file_json}\" "
     end
 

data/plugins/gcov/lib/reportgenerator_reportinator.rb

@@ -23,14 +23,41 @@ class ReportGeneratorReportinator
         File.delete(gcov_file)
       end
 
+      # Use a custom gcov executable, if specified.
+      GCOV_TOOL_CONFIG[:executable] = rg_opts[:gcov_executable] unless rg_opts[:gcov_executable].nil?
+
       # Avoid running gcov on the mock, test, unity, and cexception gcov notes files to save time.
-      gcno_exclude_regex = /(\/|\\)(#{opts[:cmock_mock_prefix]}.*|#{opts[:project_test_file_prefix]}.*|#{VENDORS_FILES.join('|')})\.gcno/
+      gcno_exclude_str = "#{opts[:cmock_mock_prefix]}.*"
+      gcno_exclude_str += "|#{opts[:project_test_file_prefix]}.*"
+      gcno_exclude_str += "|#{VENDORS_FILES.join('|')}"
+
+      # Avoid running gcov on custom specified .gcno files.
+      if !(rg_opts.nil?) && !(rg_opts[:gcov_exclude].nil?) && !(rg_opts[:gcov_exclude].empty?)
+        for gcno_exclude_expression in rg_opts[:gcov_exclude]
+          if !(gcno_exclude_expression.nil?) && !(gcno_exclude_expression.empty?)
+            # We want to filter .gcno files, not .gcov files.
+            # We will generate .gcov files from .gcno files.
+            gcno_exclude_expression = gcno_exclude_expression.chomp("\\.gcov")
+            gcno_exclude_expression = gcno_exclude_expression.chomp(".gcov")
+            # The .gcno extension will be added later as we create the regex.
+            gcno_exclude_expression = gcno_exclude_expression.chomp("\\.gcno")
+            gcno_exclude_expression = gcno_exclude_expression.chomp(".gcno")
+            # Append the custom expression.
+            gcno_exclude_str += "|#{gcno_exclude_expression}"
+          end
+        end
+      end
+
+      gcno_exclude_regex = /(\/|\\)(#{gcno_exclude_str})\.gcno/
 
       # Generate .gcov files by running gcov on gcov notes files (*.gcno).
       for gcno_filepath in Dir.glob(File.join(GCOV_BUILD_PATH, "**", "*.gcno"))
         match_data = gcno_filepath.match(gcno_exclude_regex)
         if match_data.nil? || (match_data[1].nil? && match_data[1].nil?)
-          run_gcov("-b -c -r -x \"#{gcno_filepath}\"")
+          # Ensure there is a matching gcov data file.
+          if File.file?(gcno_filepath.gsub(".gcno", ".gcda"))
+            run_gcov("\"#{gcno_filepath}\"")
+          end
         end
       end
 
@@ -84,9 +111,13 @@ class ReportGeneratorReportinator
 
   REPORT_GENERATOR_SETTING_PREFIX = "gcov_report_generator"
 
+  # Deep clone the gcov tool config, so we can modify it locally if specified via options.
+  GCOV_TOOL_CONFIG = Marshal.load(Marshal.dump(TOOLS_GCOV_GCOV_POST_REPORT))
+
   # Build the ReportGenerator arguments.
   def args_builder(opts)
     rg_opts = get_opts(opts)
+    report_type_count = 0
 
     args = ""
     args += "\"-reports:*.gcov\" "
@@ -100,6 +131,7 @@ class ReportGeneratorReportinator
         rg_report_type = REPORT_TYPE_TO_REPORT_GENERATOR_REPORT_NAME[report_type.upcase]
         if !(rg_report_type.nil?)
           args += rg_report_type + ";"
+          report_type_count = report_type_count + 1
         end
       end
 
@@ -126,6 +158,16 @@ class ReportGeneratorReportinator
     args += "\"-filefilters:#{file_filters}\" "
     args += "\"-verbosity:#{rg_opts[:verbosity] || "Warning"}\" "
     args += "\"-tag:#{rg_opts[:tag]}\" " unless rg_opts[:tag].nil?
+    args += "\"settings:createSubdirectoryForAllReportTypes=true\" " unless report_type_count <= 1
+    args += "\"settings:numberOfReportsParsedInParallel=#{rg_opts[:num_parallel_threads]}\" " unless rg_opts[:num_parallel_threads].nil?
+    args += "\"settings:numberOfReportsMergedInParallel=#{rg_opts[:num_parallel_threads]}\" " unless rg_opts[:num_parallel_threads].nil?
+
+    # Append custom arguments.
+    if !(rg_opts[:custom_args].nil?) && !(rg_opts[:custom_args].empty?)
+      for custom_arg in rg_opts[:custom_args]
+        args += "\"#{custom_arg}\" " unless custom_arg.nil? || custom_arg.empty?
+      end
+    end
 
     return args
   end
@@ -146,7 +188,7 @@ class ReportGeneratorReportinator
 
   # Run gcov with the given arguments.
   def run_gcov(args)
-    command = @ceedling[:tool_executor].build_command_line(TOOLS_GCOV_GCOV_POST_REPORT, [], args)
+    command = @ceedling[:tool_executor].build_command_line(GCOV_TOOL_CONFIG, [], args)
     return @ceedling[:tool_executor].exec(command[:line], command[:options])
   end
 

data/spec/gcov/gcov_deployment_spec.rb

@@ -28,6 +28,7 @@ describe "Ceedling" do
       it { can_test_projects_with_gcov_with_fail }
       it { can_test_projects_with_gcov_with_fail_because_of_uncovered_files }
       it { can_test_projects_with_gcov_with_success_because_of_ignore_uncovered_list }
+      it { can_test_projects_with_gcov_with_success_because_of_ignore_uncovered_list_with_globs }
       it { can_test_projects_with_gcov_with_compile_error }
       it { can_fetch_project_help_for_gcov }
       it { can_create_html_report }

data/spec/gcov/gcov_test_cases_spec.rb

@@ -7,6 +7,49 @@ require 'pp'
 
 module GcovTestCases
 
+  def _add_gcov_section_in_project(project_file_path, name, values)
+    project_file_contents = File.readlines(project_file_path)
+    name_index = project_file_contents.index(":gcov:\n")
+
+    if name_index.nil?
+      # Something wrong with project.yml file, no project section?
+      return
+    end
+
+    project_file_contents.insert(name_index + 1, "  :#{name}:\n")
+    values.each.with_index(2) do |value, index|
+      project_file_contents.insert(name_index + index, "    - #{value}\n")
+    end
+
+    File.open(project_file_path, "w+") do |f|
+      f.puts(project_file_contents)
+    end
+  end
+  
+  def _add_gcov_option_in_project(project_file_path, option, value)
+    project_file_contents = File.readlines(project_file_path)
+    option_index = project_file_contents.index(":gcov:\n")
+
+    if option_index.nil?
+      # Something wrong with project.yml file, no project section?
+      return
+    end
+
+    project_file_contents.insert(option_index + 1, "  :#{option}: #{value}\n")
+  
+    File.open(project_file_path, "w+") do |f|
+      f.puts(project_file_contents)
+    end
+  end
+
+  def add_gcov_section(name, values)
+    _add_gcov_section_in_project("project.yml", name, values)
+  end
+
+  def add_gcov_option(option, value)
+    _add_gcov_option_in_project("project.yml", option, value)
+  end
+
   def can_test_projects_with_gcov_with_success
     @c.with_context do
       Dir.chdir @proj_name do
@@ -46,7 +89,8 @@ module GcovTestCases
   def can_test_projects_with_gcov_with_fail_because_of_uncovered_files
     @c.with_context do
       Dir.chdir @proj_name do
-        FileUtils.cp test_asset_path("project_with_guts_gcov_abortonuncovered.yml"), "project.yml"
+        FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
+        add_gcov_option("abort_on_uncovered", "TRUE")
         FileUtils.cp test_asset_path("example_file.h"), 'src/'
         FileUtils.cp test_asset_path("example_file.c"), 'src/'
         FileUtils.cp test_asset_path("uncovered_example_file.c"), 'src/'
@@ -65,7 +109,9 @@ module GcovTestCases
   def can_test_projects_with_gcov_with_success_because_of_ignore_uncovered_list
     @c.with_context do
       Dir.chdir @proj_name do
-        FileUtils.cp test_asset_path("project_with_guts_gcov_abortonuncovered.yml"), "project.yml"
+        FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
+        add_gcov_option("abort_on_uncovered", "TRUE")
+        add_gcov_section("uncovered_ignore_list", ["src/foo_file.c"])
         FileUtils.cp test_asset_path("example_file.h"), "src/"
         FileUtils.cp test_asset_path("example_file.c"), "src/"
         FileUtils.cp test_asset_path("uncovered_example_file.c"), "src/foo_file.c" # "src/foo_file.c" is in the ignore uncovered list
@@ -81,6 +127,29 @@ module GcovTestCases
     end
   end
 
+  def can_test_projects_with_gcov_with_success_because_of_ignore_uncovered_list_with_globs
+    @c.with_context do
+      Dir.chdir @proj_name do
+        FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
+        add_gcov_option("abort_on_uncovered", "TRUE")
+        add_gcov_section("uncovered_ignore_list", ["src/B/**"])
+        FileUtils.mkdir_p(["src/A", "src/B/C"])
+        FileUtils.cp test_asset_path("example_file.h"), "src/A"
+        FileUtils.cp test_asset_path("example_file.c"), "src/A"
+        FileUtils.cp test_asset_path("uncovered_example_file.c"), "src/B/C/foo_file.c" # "src/B/**" is in the ignore uncovered list
+        FileUtils.cp test_asset_path("test_example_file_success.c"), "test/"
+
+        output = `bundle exec ruby -S ceedling gcov:all 2>&1`
+        expect($?.exitstatus).to match(0)
+        expect(output).to match(/TESTED:\s+\d/)
+        expect(output).to match(/PASSED:\s+\d/)
+        expect(output).to match(/FAILED:\s+\d/)
+        expect(output).to match(/IGNORED:\s+\d/)
+      end
+    end
+  end
+
+
   def can_test_projects_with_gcov_with_compile_error
     @c.with_context do
       Dir.chdir @proj_name do

data/spec/preprocessinator_extractor_spec.rb

@@ -42,4 +42,40 @@ describe PreprocessinatorExtractor do
     # # xit "should ignore formatting"
     # # xit "should ignore whitespace"
   end
+
+  context "#extract_base_file_from_preprocessed_directives" do
+    it "should extract last chunk of text after last '#'line containing file name of our filepath" do
+      file_path = "path/to/WANT.c"
+      input_str = [
+        '# 1 "some/file/we/do/not/care/about.c" 5',
+        '#pragma trash',
+        'some_text_we_do_not_want();',
+        '# 1 "some/file/we/DO/WANT.c" 99999',
+        'some_text_we_do_not_want();',
+        '#pragma want',
+        'some_creepy_text_we_not_want();',
+        '# 1 "some/useless/file.c" 9',
+        'a set of junk',
+        'more junk',
+        '# 1 "holy/shoot/yes/WANT.c" 10',
+        '#pragma want',
+        '#define INCREDIBLE_DEFINE 911',
+        'some_additional_awesome_want_text();',
+        'holy_crepes_more_awesome_text();',
+        '# oh darn',
+      ]
+
+      expect_str = [
+        '#pragma want',
+        '#define INCREDIBLE_DEFINE 911',
+        'some_additional_awesome_want_text();',
+        'holy_crepes_more_awesome_text();',
+        '# oh darn',
+      ]
+
+      expect(File).to receive(:readlines).with(file_path).and_return( input_str )
+
+      expect(subject.extract_base_file_from_preprocessed_directives(file_path)).to eq expect_str
+    end
+  end
 end

data/spec/preprocessinator_includes_handler_spec.rb

@@ -9,6 +9,7 @@ describe PreprocessinatorIncludesHandler do
     @file_path_utils = double('file_path_utils')
     @yaml_wrapper    = double('yaml_wrapper')
     @file_wrapper    = double('file_wrapper')
+    @file_finder     = double('file_finder')
   end
 
   subject do
@@ -19,6 +20,7 @@ describe PreprocessinatorIncludesHandler do
       :file_path_utils => @file_path_utils,
       :yaml_wrapper    => @yaml_wrapper,
       :file_wrapper    => @file_wrapper,
+      :file_finder     => @file_finder
     )
   end
 
@@ -75,19 +77,27 @@ describe PreprocessinatorIncludesHandler do
       expect(@tool_executor).to receive(:build_command_line).and_return({:line => "", :options => ""})
       expect(@tool_executor).to receive(:exec).and_return({ :output => %q{
         _test_DUMMY.o: Build/temp/_test_DUMMY.c \
+          source/new_some_header1.h \
           source/some_header1.h \
           source/some_lib/some_header2.h \
           source/some_other_lib/some_header2.h \
+          source/DUMMY.c \
+          @@@@new_some_header1.h \
           @@@@some_header1.h \
-          @@@@some_lib/some_header2.h
-          @@@@some_other_lib/some_header2.h
+          @@@@some_lib/some_header2.h \
+          @@@@some_other_lib/some_header2.h \
+          @@@@source/DUMMY.c
       }})
       # execute method
-      results = subject.extract_includes_helper("/dummy_file_1.c", [], [])
+      results = subject.extract_includes_helper("/dummy_file_1.c", [], [], [])
       # validate results
       expect(results).to eq [
-        ['source/some_header1.h', 'source/some_lib/some_header2.h', 'source/some_other_lib/some_header2.h', 'Build/temp/_test_DUMMY.c'],
-        []
+        [ 'source/new_some_header1.h',
+          'source/some_header1.h',
+          'source/some_lib/some_header2.h',
+          'source/some_other_lib/some_header2.h',
+          'source/DUMMY.c'],
+        [], []
       ]
     end
 
@@ -109,20 +119,19 @@ describe PreprocessinatorIncludesHandler do
           source\some_lib1\some_lib\some_header2.h \
           source\some_other_lib\some_header2.h \
           @@@@some_header1.h \
-          @@@@some_lib/some_header2.h
-          @@@@some_lib1/some_lib/some_header2.h
+          @@@@some_lib/some_header2.h \
+          @@@@some_lib1/some_lib/some_header2.h \
           @@@@some_other_lib/some_header2.h
       }})
       # execute method
-      results = subject.extract_includes_helper("/dummy_file_2.c", [], [])
+      results = subject.extract_includes_helper("/dummy_file_2.c", [], [], [])
       # validate results
       expect(results).to eq [
         ['source/some_header1.h',
           'source/some_lib/some_header2.h',
           'source/some_lib1/some_lib/some_header2.h',
-          'source/some_other_lib/some_header2.h',
-          'Build/temp/_test_DUMMY.c'],
-        []
+          'source/some_other_lib/some_header2.h'],
+        [], []
       ]
     end
 
@@ -144,11 +153,11 @@ describe PreprocessinatorIncludesHandler do
           @@@@some_lib/some_header2.h
       }})
       # execute method
-      results = subject.extract_includes_helper("/dummy_file_3.c", [], [])
+      results = subject.extract_includes_helper("/dummy_file_3.c", [], [], [])
       # validate results
       expect(results).to eq [
-        ['source/some_header1.h', 'Build/temp/_test_DUMMY.c'],
-        []
+        ['source/some_header1.h'],
+        [], []
       ]
     end
 
@@ -164,7 +173,6 @@ describe PreprocessinatorIncludesHandler do
       expect(@file_wrapper).to receive(:write)
       expect(@tool_executor).to receive(:build_command_line).and_return({:line => "", :options => ""})
       expect(@tool_executor).to receive(:exec).and_return({ :output => %q{
-        _test_DUMMY.o: Build/temp/_test_DUMMY.c \
         _test_DUMMY.o: Build/temp/_test_DUMMY.c \
           source\some_header1.h \
           source\some_lib\some_header2.h \
@@ -177,16 +185,59 @@ describe PreprocessinatorIncludesHandler do
           @@@@some_other_lib/some_header2.h
       }})
       # execute method
-      results = subject.extract_includes_helper("/dummy_file_4.c", [], [])
+      results = subject.extract_includes_helper("/dummy_file_4.c", [], [], [])
       # validate results
       expect(results).to eq [
         ['source/some_header1.h',
           'source/some_lib/some_header2.h',
-          'source/some_other_lib/some_header2.h',
-          'Build/temp/_test_DUMMY.c'],
-        []
+          'source/some_other_lib/some_header2.h'],
+        [], []
       ]
     end
+
+    it 'should correctly filter auto link deep dependencies with mocks' do
+      # create test state/variables
+      # mocks/stubs/expected calls
+      expect(@configurator).to receive(:project_config_hash).and_return(:collection_paths_include => [])
+      expect(@configurator).to receive(:extension_header).and_return('.h').exactly(3).times
+      expect(@configurator).to receive(:extension_source).and_return('.c').exactly(3).times
+      expect(@configurator).to receive(:tools_test_includes_preprocessor).exactly(3).times
+      expect(@file_wrapper).to receive(:read).and_return("").exactly(3).times
+      expect(@file_wrapper).to receive(:write).exactly(3).times
+      expect(@file_finder).to receive(:find_compilation_input_file).and_return("assets\example_file.c")
+      expect(@tool_executor).to receive(:build_command_line).and_return({:line => "", :options => ""}).exactly(3).times
+      expect(@configurator).to receive(:project_config_hash).and_return(:project_auto_link_deep_dependencies => true).exactly(2).times
+      expect(@configurator).to receive(:project_config_hash).and_return({:cmock_mock_prefix => 'mock_'})
+      expect(@configurator).to receive(:project_config_hash).and_return(:project_auto_link_deep_dependencies => true).exactly(4).times
+      expect(@configurator).to receive(:project_config_hash).and_return({:cmock_mock_prefix => 'mock_'})
+      expect(@configurator).to receive(:project_config_hash).and_return(:project_auto_link_deep_dependencies => true).exactly(4).times
+      expect(@configurator).to receive(:project_config_hash).and_return({:cmock_mock_prefix => 'mock_'})
+      expect(@configurator).to receive(:project_config_hash).and_return(:project_auto_link_deep_dependencies => true).exactly(2).times
+      expect(@file_path_utils).to receive(:form_temp_path).and_return("_test_DUMMY.c")
+      expect(@file_path_utils).to receive(:form_temp_path).and_return("assets\_example_file.h")
+      expect(@file_path_utils).to receive(:form_temp_path).and_return("assets\_example_file.c")
+      expect(@tool_executor).to receive(:exec).and_return({ :output => %q{
+        _test_DUMMY.o: build/temp/_test_DUMMY.c \
+          assets\example_file.h \
+          build\mocks\mock_dependency.h \
+          @@@@assets/example_file.h \
+          @@@@build/mocks/mock_dependency.h
+      }})
+      expect(@tool_executor).to receive(:exec).and_return({ :output => %q{
+        assets\_example_file.o: assets\_example_file.h
+      }})
+      expect(@tool_executor).to receive(:exec).and_return({ :output => %q{
+        assets\_example_file.o: assets\_example_file.c \
+          source\dependency.h \
+          @@@@source/dependency.h
+      }})
+      # execute method
+      results = subject.extract_includes("test_dummy.c")
+      # validate results
+      expect(results).to eq [
+        'assets/example_file.h',
+        'build/mocks/mock_dependency.h']
+    end
   end
 
   context 'invoke_shallow_includes_list' do