ceedling 0.30.0 → 0.31.0

data/lib/ceedling/preprocessinator_extractor.rb

@@ -27,4 +27,27 @@ class PreprocessinatorExtractor
 
     return lines
   end
+
+  def extract_base_file_from_preprocessed_directives(filepath)
+    # preprocessing by way of toolchain preprocessor eliminates directives only
+    # like #ifdef's and leave other code
+
+    # iterate through all lines and only get last chunk of file after a last
+    # '#'line containing file name of our filepath
+
+    base_name  = File.basename(filepath)
+    pattern    = /^#.*(\s|\/|\\|\")#{Regexp.escape(base_name)}/
+    found_file = false # have we found the file we care about?
+
+    lines = []
+    File.readlines(filepath).each do |line|
+      lines << line
+
+      if line =~ pattern
+        lines = []
+      end
+    end
+
+    return lines
+  end
 end

data/lib/ceedling/preprocessinator_file_handler.rb

@@ -18,4 +18,17 @@ class PreprocessinatorFileHandler
     @file_wrapper.write(preprocessed_filepath, contents.join("\n"))
   end
 
+  def preprocess_file_directives(filepath, includes)
+    preprocessed_filepath = @file_path_utils.form_preprocessed_file_filepath(filepath)
+
+    command = @tool_executor.build_command_line(@configurator.tools_test_file_preprocessor_directives, [], filepath, preprocessed_filepath)
+    @tool_executor.exec(command[:line], command[:options])
+
+    contents = @preprocessinator_extractor.extract_base_file_from_preprocessed_directives(preprocessed_filepath)
+
+    includes.each{|include| contents.unshift("#include \"#{include}\"")}
+
+    @file_wrapper.write(preprocessed_filepath, contents.join("\n"))
+  end
+
 end

data/lib/ceedling/preprocessinator_includes_handler.rb

@@ -2,7 +2,7 @@
 
 class PreprocessinatorIncludesHandler
 
-  constructor :configurator, :tool_executor, :task_invoker, :file_path_utils, :yaml_wrapper, :file_wrapper
+  constructor :configurator, :tool_executor, :task_invoker, :file_path_utils, :yaml_wrapper, :file_wrapper, :file_finder
   @@makefile_cache = {}
 
   # shallow includes: only those headers a source file explicitly includes
@@ -65,6 +65,7 @@ class PreprocessinatorIncludesHandler
     to_process = [filepath]
     ignore_list = []
     list = []
+    all_mocks = []
 
     include_paths = @configurator.project_config_hash[:collection_paths_include]
     include_paths = [] if include_paths.nil?
@@ -73,8 +74,7 @@ class PreprocessinatorIncludesHandler
     while to_process.length > 0
       target = to_process.shift()
       ignore_list << target
-      # puts "[HELL] Processing: \t\t#{target}"
-      new_deps, new_to_process = extract_includes_helper(target, include_paths, ignore_list)
+      new_deps, new_to_process, all_mocks = extract_includes_helper(target, include_paths, ignore_list, all_mocks)
       list += new_deps
       to_process += new_to_process
       if (!@configurator.project_config_hash.has_key?(:project_auto_link_deep_dependencies) or
@@ -89,65 +89,49 @@ class PreprocessinatorIncludesHandler
     return list
   end
 
-  def extract_includes_helper(filepath, include_paths, ignore_list)
+  def extract_includes_helper(filepath, include_paths, ignore_list, mocks)
     # Extract the dependencies from the make rule
-    hdr_ext = @configurator.extension_header
     make_rule = self.form_shallow_dependencies_rule(filepath)
-    dependencies = make_rule.split.find_all {|path| path.end_with?(hdr_ext) }.uniq
-    dependencies.map! {|hdr| hdr.gsub('\\','/') }
-
-    # Separate the real files form the annotated ones and remove the '@@@@'
-    annotated_headers, real_headers = dependencies.partition {|hdr| hdr =~ /^@@@@/ }
-    annotated_headers.map! {|hdr| hdr.gsub('@@@@','') }
-    # Matching annotated_headers values against real_headers to ensure that
-    # annotated_headers contain full path entries (as returned by make rule)
-    annotated_headers.map! {|hdr| real_headers.find {|real_hdr| !real_hdr.match(/(.*\/)?#{Regexp.escape(hdr)}/).nil? } }
-    annotated_headers = annotated_headers.compact
-
-    # Find which of our annotated headers are "real" dependencies. This is
-    # intended to weed out dependencies that have been removed due to build
-    # options defined in the project yaml and/or in the headers themselves.
-    list = annotated_headers.find_all do |annotated_header|
-      # find the index of the "real" include that matches the annotated one.
-      idx = real_headers.find_index do |real_header|
-        real_header =~ /^(.*\/)?#{Regexp.escape(annotated_header)}$/
-      end
-      # If we found a real include, delete it from the array and return it,
-      # otherwise return nil. Since nil is falsy this has the effect of making
-      # find_all return only the annotated headers for which a real include was
-      # found/deleted
-      idx ? real_headers.delete_at(idx) : nil
-    end.compact
+    target_file = make_rule.split[0].gsub(':', '').gsub('\\','/')
+    base = File.basename(target_file, File.extname(target_file))
+    make_rule_dependencies = make_rule.gsub(/.*#{Regexp.escape(base)}\S*/, '').gsub(/\\$/, '')
+    
+    # Extract the headers dependencies from the make rule
+    hdr_ext = @configurator.extension_header
+    headers_dependencies = make_rule_dependencies.split.find_all {|path| path.end_with?(hdr_ext) }.uniq
+    headers_dependencies.map! {|hdr| hdr.gsub('\\','/') }
+    full_path_headers_dependencies = extract_full_path_dependencies(headers_dependencies)
 
-    # Extract direct dependencies that were also added
+    # Extract the sources dependencies from the make rule
     src_ext = @configurator.extension_source
-    sdependencies = make_rule.split.find_all {|path| path.end_with?(src_ext) }.uniq
-    sdependencies.map! {|hdr| hdr.gsub('\\','/') }
-    list += sdependencies
+    sources_dependencies = make_rule_dependencies.split.find_all {|path| path.end_with?(src_ext) }.uniq
+    sources_dependencies.map! {|src| src.gsub('\\','/') }
+    full_path_sources_dependencies = extract_full_path_dependencies(sources_dependencies)
 
+    list = full_path_headers_dependencies + full_path_sources_dependencies
     to_process = []
 
     if @configurator.project_config_hash.has_key?(:project_auto_link_deep_dependencies) && @configurator.project_config_hash[:project_auto_link_deep_dependencies]
+      mock_prefix = @configurator.project_config_hash[:cmock_mock_prefix]
       # Creating list of mocks
-      mocks = annotated_headers.find_all do |annotated_header|
-        File.basename(annotated_header) =~ /^#{@configurator.project_config_hash[:cmock_mock_prefix]}.*$/
+      mocks += full_path_headers_dependencies.find_all do |header|
+        File.basename(header) =~ /^#{mock_prefix}.*$/
       end.compact
 
       # Creating list of headers that should be recursively pre-processed
-      # Skipping mocks and unity.h
-      headers_to_deep_link = annotated_headers.select do |annotated_header|
-        !(mocks.include? annotated_header) and (annotated_header.match(/^(.*\/)?unity\.h$/).nil?)
+      # Skipping mocks and vendor headers
+      headers_to_deep_link = full_path_headers_dependencies.select do |hdr|
+        !(mocks.include? hdr) and (hdr.match(/^(.*\/)(#{VENDORS_FILES.join('|')}) + #{Regexp.escape(hdr_ext)}$/).nil?)
       end
-      headers_to_deep_link.map! {|hdr| File.expand_path(hdr)}
+      headers_to_deep_link.map! {|hdr| File.expand_path(hdr) }
+      headers_to_deep_link.compact!
 
+      # ignore real file when both mock and real file exist
       mocks.each do |mock|
-        dirname = File.dirname(mock)
-        #basename = File.basename(mock).delete_prefix(@configurator.project_config_hash[:cmock_mock_prefix])
-        basename = File.basename(mock).sub(@configurator.project_config_hash[:cmock_mock_prefix], '')
-        if dirname != "."
-          ignore_list << File.join(dirname, basename)
-        else
-          ignore_list << basename
+        list.each do |filename|
+          if File.basename(filename) == File.basename(mock).sub(mock_prefix, '')
+            ignore_list << filename
+          end
         end
       end.compact
 
@@ -161,21 +145,45 @@ class PreprocessinatorIncludesHandler
             include_paths.none? {|include_path| hdr =~ /^#{include_path}\.*/})
           if File.exist?(hdr)
             to_process << hdr
-            #source_file = hdr.delete_suffix(hdr_ext) + src_ext
-            source_file = hdr.chomp(hdr_ext) + src_ext
-            if source_file != hdr and File.exist?(source_file)
-              to_process << source_file
-            end
+            src = @file_finder.find_compilation_input_file(hdr, :ignore)
+            to_process << src if src
           end
         end
       end
     end
 
-    return list, to_process
+    return list, to_process, mocks
 
   end
 
   def write_shallow_includes_list(filepath, list)
     @yaml_wrapper.dump(filepath, list)
   end
+
+  private
+
+  def extract_full_path_dependencies(dependencies)
+    # Separate the real files form the annotated ones and remove the '@@@@'
+    annotated_files, real_files = dependencies.partition {|file| file =~ /^@@@@/}
+    annotated_files.map! {|file| file.gsub('@@@@','') }
+    # Matching annotated_files values against real_files to ensure that
+    # annotated_files contain full path entries (as returned by make rule)
+    annotated_files.map! {|file| real_files.find {|real| !real.match(/^(.*\/)?#{Regexp.escape(file)}$/).nil?}}
+    annotated_files = annotated_files.compact
+
+    # Find which of our annotated files are "real" dependencies. This is
+    # intended to weed out dependencies that have been removed due to build
+    # options defined in the project yaml and/or in the files themselves.
+    return annotated_files.find_all do |annotated_file|
+      # find the index of the "real" file that matches the annotated one.
+      idx = real_files.find_index do |real_file|
+        real_file =~ /^(.*\/)?#{Regexp.escape(annotated_file)}$/
+      end
+      # If we found a real file, delete it from the array and return it,
+      # otherwise return nil. Since nil is falsy this has the effect of making
+      # find_all return only the annotated filess for which a real file was
+      # found/deleted
+      idx ? real_files.delete_at(idx) : nil
+    end.compact
+  end
 end

data/lib/ceedling/project_config_manager.rb

@@ -25,8 +25,8 @@ class ProjectConfigManager
 
   def filter_internal_sources(sources)
     filtered_sources = sources.clone
-    filtered_sources.delete_if { |item| item =~ /#{CMOCK_MOCK_PREFIX}.+#{EXTENSION_SOURCE}$/ }
-    filtered_sources.delete_if { |item| item =~ /#{VENDORS_FILES.map{|source| '\b' + source.ext(EXTENSION_SOURCE) + '\b'}.join('|')}$/ }
+    filtered_sources.delete_if { |item| item =~ /#{CMOCK_MOCK_PREFIX}.+#{Regexp.escape(EXTENSION_SOURCE)}$/ }
+    filtered_sources.delete_if { |item| item =~ /#{VENDORS_FILES.map{|source| '\b' + Regexp.escape(source.ext(EXTENSION_SOURCE)) + '\b'}.join('|')}$/ }
     return filtered_sources
   end
 

data/lib/ceedling/rakefile.rb

@@ -10,7 +10,6 @@ $LOAD_PATH.unshift( CEEDLING_LIB )
 $LOAD_PATH.unshift( File.join(CEEDLING_VENDOR, 'unity/auto') )
 $LOAD_PATH.unshift( File.join(CEEDLING_VENDOR, 'diy/lib') )
 $LOAD_PATH.unshift( File.join(CEEDLING_VENDOR, 'cmock/lib') )
-$LOAD_PATH.unshift( File.join(CEEDLING_VENDOR, 'deep_merge/lib') )
 
 require 'rake'
 

data/lib/ceedling/rules_tests.rake

@@ -66,7 +66,7 @@ namespace TEST_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[:test_invoker].setup_and_invoke([test.source])
   end
 end

data/lib/ceedling/setupinator.rb

@@ -25,8 +25,8 @@ class Setupinator
     @ceedling[:configurator].populate_cmock_defaults( config_hash )
     @ceedling[:configurator].find_and_merge_plugins( config_hash )
     @ceedling[:configurator].merge_imports( config_hash )
-    @ceedling[:configurator].tools_setup( config_hash )
     @ceedling[:configurator].eval_environment_variables( config_hash )
+    @ceedling[:configurator].tools_setup( config_hash )
     @ceedling[:configurator].eval_paths( config_hash )
     @ceedling[:configurator].standardize_paths( config_hash )
     @ceedling[:configurator].validate( config_hash )

data/lib/ceedling/tasks_tests.rake

@@ -1,13 +1,15 @@
 require 'ceedling/constants'
 
-task :test => [:directories] do
+task :test_deps => [:directories]
+
+task :test => [:test_deps] do
   Rake.application['test:all'].invoke
 end
 
 namespace TEST_SYM do
 
   desc "Run all unit tests (also just 'test' works)."
-  task :all => [:directories] do
+  task :all => [:test_deps] do
     @ceedling[:test_invoker].setup_and_invoke(COLLECTION_ALL_TESTS)
   end
 
@@ -21,17 +23,17 @@ namespace TEST_SYM do
   end
 
   desc "Run tests for changed files."
-  task :delta => [:directories] do
+  task :delta => [:test_deps] do
     @ceedling[:test_invoker].setup_and_invoke(COLLECTION_ALL_TESTS, TEST_SYM, {:force_run => false})
   end
 
   desc "Just build tests without running."
-  task :build_only => [:directories] do
+  task :build_only => [:test_deps] do
     @ceedling[:test_invoker].setup_and_invoke(COLLECTION_ALL_TESTS, TEST_SYM, {:build_only => true})
   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 { |test| matches << test if (test =~ /#{args.regex}/) }
@@ -44,7 +46,7 @@ namespace TEST_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 { |test| matches << test if File.dirname(test).include?(args.dir.gsub(/\\/, '/')) }

data/lib/ceedling/test_invoker.rb

@@ -63,6 +63,7 @@ class TestInvoker
           tst_defs_cfg = Array.new(defs_bkp)
           if @configurator.project_config_hash.has_key?(def_test_key.to_sym)
             tst_defs_cfg.replace(@configurator.project_config_hash[def_test_key.to_sym])
+            tst_defs_cfg .concat(COLLECTION_DEFINES_VENDOR) if COLLECTION_DEFINES_VENDOR
           end
           if @configurator.defines_use_test_definition
             tst_defs_cfg << File.basename(test, ".*").strip.upcase.sub(/@.*$/, "")

data/lib/ceedling/version.rb

@@ -44,7 +44,7 @@ module Ceedling
       eval("#{name} = '#{a.join(".")}'")
     end
 
-    GEM = "0.30.0"
+    GEM = "0.31.0"
     CEEDLING = GEM
   end
 end

data/out.fail

@@ -0,0 +1,24 @@
+---
+:source:
+  :path: some/place
+  :file: test_example.c
+:successes: []
+:failures:
+- :test: test_one
+  :line: 257
+  :message: ''
+  :unity_test_time: 0
+- :test: test_two
+  :line: 269
+  :message: ''
+  :unity_test_time: 0
+:ignores: []
+:counts:
+  :total: 2
+  :passed: 0
+  :failed: 2
+  :ignored: 0
+:stdout:
+- Verbose output one
+- Verbous output two
+:time: 0.0

data/plugins/bullseye/bullseye.rake

@@ -73,7 +73,7 @@ namespace BULLSEYE_SYM do
   task source_coverage: COLLECTION_ALL_SOURCE.pathmap("#{BULLSEYE_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[BULLSEYE_SYM].config)
     @ceedling[BULLSEYE_SYM].enableBullseye(true)
     @ceedling[:test_invoker].setup_and_invoke(COLLECTION_ALL_TESTS, BULLSEYE_SYM)
@@ -90,7 +90,7 @@ namespace BULLSEYE_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 BULLSEYE_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|
@@ -126,7 +126,7 @@ namespace BULLSEYE_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[BULLSEYE_SYM].config)
     @ceedling[BULLSEYE_SYM].enableBullseye(true)
     @ceedling[:test_invoker].setup_and_invoke(COLLECTION_ALL_TESTS, BULLSEYE_SYM, {:force_run => false})
@@ -142,7 +142,7 @@ namespace BULLSEYE_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[BULLSEYE_SYM].config)
     @ceedling[BULLSEYE_SYM].enableBullseye(true)
     @ceedling[:test_invoker].setup_and_invoke([test.source], BULLSEYE_SYM)

data/plugins/dependencies/README.md

@@ -107,7 +107,7 @@ couple of fields:
   - `:custom` -- This tells Ceedling that we want to use a custom command or commands to fetch the code.
 - `:source` -- This is the path or url to fetch code when using the zip or git method.
 - `:tag`/`:branch` -- This is the specific tag or branch that you wish to retrieve (git only. optional).
-- `:hash` -- This is the specific SHA1 hash you want to fetch (git only. optional).
+- `:hash` -- This is the specific SHA1 hash you want to fetch (git only. optional, requires a deep clone).
 - `:revision` -- This is the specific revision you want to fetch (svn only. optional).
 - `:executable` -- This is a list of commands to execute when using the `:custom` method
 

data/plugins/dependencies/dependencies.rake

@@ -142,3 +142,6 @@ namespace :files do
     puts "file count: #{deps.size}"
   end
 end
+
+# Make sure that we build dependencies before attempting to tackle any of the unit tests
+Rake::Task[:test_deps].enhance ['dependencies:make']

data/plugins/dependencies/lib/dependencies.rb

@@ -120,9 +120,15 @@ class Dependencies < Plugin
             when :git
               branch = blob[:fetch][:tag] || blob[:fetch][:branch] || ''
               branch = ("-b " + branch) unless branch.empty?
-              retval = [ "git clone #{branch} --depth 1 #{blob[:fetch][:source]} ." ]
-              retval << "git checkout #{blob[:fetch][:hash]}" unless blob[:fetch][:hash].nil?
-              retval
+              unless blob[:fetch][:hash].nil?
+                # Do a deep clone to ensure the commit we want is available
+                retval = [ "git clone #{branch} #{blob[:fetch][:source]} ." ]
+                # Checkout the specified commit
+                retval << "git checkout #{blob[:fetch][:hash]}"
+              else
+                # Do a thin clone
+                retval = [ "git clone #{branch} --depth 1 #{blob[:fetch][:source]} ." ]
+              end
             when :svn
               revision = blob[:fetch][:revision] || ''
               revision = ("--revision " + branch) unless branch.empty?

data/plugins/gcov/README.md

@@ -353,6 +353,9 @@ default behaviors of gcovr:
 
   # When using the ``abort_on_uncovered`` option, the files in this list will not
   # trigger a failure.
+  # Ceedling globs described in the Ceedling packet ``Path`` section can be used
+  # when directories are placed on the list. Globs are limited to matching directories
+  # and not files.
   :uncovered_ignore_list: []
 ```
 
@@ -392,6 +395,24 @@ All generated reports may be found in `build/artifacts/gcov/ReportGenerator`.
 
     # Optional tag or build version.
     :tag: <tag>
+
+    # Optional list of one or more regular expressions to exclude gcov notes files that match these filters.
+    :gcov_exclude:
+      - <exclude_regex1>
+      - <exclude_regex2>
+
+    # Optionally use a particular gcov executable. Defaults to gcov.
+    :gcov_executable: <gcov_cmd>
+
+    # Optionally set the number of threads to use in parallel. Defaults to 1.
+    :num_parallel_threads: <num_threads>
+
+    # Optional list of one or more command line arguments to pass to Report Generator.
+    # Useful for configuring Risk Hotspots and Other Settings.
+    # https://github.com/danielpalme/ReportGenerator/wiki/Settings
+    :custom_args:
+      - <custom_arg1>
+      - <custom_arg2>
 ```
 
 ## Example Usage