ceedling 1.1.6 → 1.1.8

data/docs/mkdocs/plugins/gcov/reportgenerator.md

@@ -4,55 +4,137 @@ The `ReportGenerator` utility may be configured with the following configuration
 
 All generated reports are found in `<build root>/artifacts/gcov/ReportGenerator/`.
 
+## Example configuration
+
 ```yaml
 :gcov:
   :report_generator:
-    # Optional directory for storing persistent coverage information.
-    # Can be used in future reports to show coverage evolution.
-    :history_directory: <path>
+    :history_directory: build/artifacts/gcov/history
+    :file_filters: "-./vendor/*;-./build/*;-./test/*;+./src/*"
+    :verbosity: Warning
+    :tag: "release-1.4.0"
+    :num_parallel_threads: 4
+    :gcov_exclude:
+      - some_excluded_file
+    :custom_args:
+      - "-title:MyProject"
+```
+
+## Plugin configuration
+
+### `:history_directory`
+
+Optional directory for storing persistent coverage information. Can be used
+in future reports to show coverage evolution.
+
+---
+
+### `:plugins`
+
+Optional plugin files for custom reports or custom history storage (separated
+by semicolon).
+
+**Example:** `plugin.dll;*.dll`
+
+---
+
+### `:assembly_filters`
+
+Optional list of assemblies that should be included or excluded in the
+report (separated by semicolon). Exclusion filters take precedence over
+inclusion filters. Wildcards are allowed, but not regular expressions.
+
+**Example:** `+<included>;-<excluded>`
+
+---
+
+### `:class_filters`
+
+Optional list of classes that should be included or excluded in the report
+(separated by semicolon). Exclusion filters take precedence over inclusion
+filters. Wildcards are allowed, but not regular expressions.
+
+**Example:** `+<included>;-<excluded>`
+
+---
+
+### `:file_filters`
+
+Optional list of files that should be included or excluded in the report
+(separated by semicolon). Exclusion filters take precedence over inclusion
+filters. Wildcards are allowed, but not regular expressions. Ceedling places
+your own patterns first, ahead of the exclusions it generates automatically
+for test paths, the build root, and (when Partials are in use) Partial
+source files, so your patterns take precedence.
 
-    # Optional plugin files for custom reports or custom history storage (separated by semicolon).
-    :plugins: <plugin.dll>;<*.dll>
+**Example:** `"-./vendor/*;-./build/*;-./test/*;-./lib/*;+./src/*"`
 
-    # Optional list of assemblies that should be included or excluded in the report (separated by semicolon).
-    # Exclusion filters take precedence over inclusion filters.
-    # Wildcards are allowed, but not regular expressions.
-    :assembly_filters: +<included>;-<excluded>
+---
 
-    # Optional list of classes that should be included or excluded in the report (separated by semicolon).
-    # Exclusion filters take precedence over inclusion filters.
-    # Wildcards are allowed, but not regular expressions.
-    :class_filters: +<included>;-<excluded>
+### `:verbosity`
 
-    # Optional list of files that should be included or excluded in the report (separated by semicolon).
-    # Exclusion filters take precedence over inclusion filters.
-    # Wildcards are allowed, but not regular expressions.
-    # Example: "-./vendor/*;-./build/*;-./test/*;-./lib/*;+./src/*"
-    :file_filters: +<included>;-<excluded>
+The verbosity level of the log messages.
 
-    # The verbosity level of the log messages.
-    # Values: Verbose, Info, Warning, Error, Off (defaults to Warning)
-    :verbosity: <level>
+**Values:** `Verbose`, `Info`, `Warning`, `Error`, `Off`
 
-    # Optional tag or build version.
-    :tag: <tag>
+**Default:** `Warning`
 
-    # Optional list of one or more regular expressions to exclude gcov notes files that match these filters.
+---
+
+### `:tag`
+
+Optional tag or build version.
+
+---
+
+### `:gcov_exclude`
+
+Optional list of one or more regular expressions to exclude gcov notes
+(`.gcno`) files that match these filters from coverage processing — these
+files are never run through `gcov` at all. A trailing `.gcov` or `.gcno`
+suffix on a pattern is stripped automatically, so either form works.
+
+```yaml
+:gcov:
+  :report_generator:
     :gcov_exclude:
       - <regex>
       - ...
+```
+
+**Default:** `[]`
 
-    # Optionally set the number of threads to use in parallel. Defaults to 1.
-    :threads: <count>
+---
 
-    # 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
-    # Note: This can be accomplished with Ceedling's tool configuration options outside of plugin 
-    #       configuration but is supported here to collect configuration options in one place.
+### `:num_parallel_threads`
+
+Optionally set the number of threads ReportGenerator uses in parallel. Drives
+both of ReportGenerator's own `numberOfReportsParsedInParallel` and
+`numberOfReportsMergedInParallel` settings together.
+
+**Default:** unset (ReportGenerator's own default applies)
+
+---
+
+### `:custom_args`
+
+Optional list of one or more command line arguments to pass to Report
+Generator. Useful for configuring Risk Hotspots and other settings not
+covered by the options above. See the
+[ReportGenerator settings wiki](https://github.com/danielpalme/ReportGenerator/wiki/Settings).
+
+Note: This can be accomplished with Ceedling's tool configuration options
+outside of plugin configuration but is supported here to collect
+configuration options in one place.
+
+```yaml
+:gcov:
+  :report_generator:
     :custom_args:
       - <argument>
       - ...
 ```
 
+**Default:** `[]`
+
 <br/><br/>

data/docs/mkdocs/reference/gcov-plugin.md

@@ -213,8 +213,24 @@ Exit with status 4 if total branch coverage is below this percentage.
 Exit with status 8 if total decision coverage is below this percentage.
 (`gcovr --fail-under-decision`)
 
+`gcovr` treats `--fail-under-decision` as a no-op without `--decisions` also
+present — setting this option implies `:decisions` (below) automatically.
+
 **Values:** `1`–`100`
 
+**Requires:** `gcovr` 7.0 or higher
+
+---
+
+### `:decisions`
+
+Report the decision coverage. For HTML, JSON, and the summary report.
+(`gcovr --decisions`)
+
+Implied automatically whenever `:fail_under_decision` is set.
+
+**Requires:** `gcovr` 5.1 or higher
+
 ---
 
 ### `:fail_under_function`
@@ -246,21 +262,26 @@ Source file character encoding. (`gcovr --source-encoding`)
 ### `:branches`
 
 Report branch coverage instead of line coverage. Applies to text reports only.
-(`gcovr --branches`)
+Uses `gcovr --txt-metric branch` on `gcovr` 7.0+ (`--branches` is deprecated as
+of 7.0, though still functional); `gcovr --branches` below it.
 
 ---
 
 ### `:sort_uncovered`
 
 Sort report entries by increasing number of uncovered lines. Applies to text
-and HTML reports. (`gcovr --sort-uncovered`)
+and HTML reports. Uses `gcovr --sort uncovered-number` on `gcovr` 7.0+
+(`--sort-uncovered` is deprecated as of 7.0, though still functional);
+`gcovr --sort-uncovered` below it.
 
 ---
 
 ### `:sort_percentage`
 
 Sort report entries by increasing percentage of uncovered lines. Applies to
-text and HTML reports. (`gcovr --sort-percentage`)
+text and HTML reports. Uses `gcovr --sort uncovered-percent` on `gcovr` 7.0+
+(`--sort-percentage` is deprecated as of 7.0, though still functional);
+`gcovr --sort-percentage` below it.
 
 ---
 
@@ -552,11 +573,13 @@ are excluded from report generation.
 
 ---
 
-### `:threads`
+### `:num_parallel_threads`
 
-Number of parallel threads to use during report generation.
+Number of parallel threads to use during report generation. Drives both
+ReportGenerator's own `numberOfReportsParsedInParallel` and
+`numberOfReportsMergedInParallel` settings together.
 
-**Default:** `1`
+**Default:** unset (ReportGenerator's own default applies)
 
 ---
 

data/docs/mkdocs/snapshot/plugins/gcov/config/defaults.yml

@@ -27,7 +27,6 @@
 
   :report_generator:
     :verbosity: Warning           # Default verbosity
-    :collection_paths_source: []  # Explicitly defined as default empty array to simplify option validation code
     :custom_args: []              # Explicitly defined as default empty array to simplify option validation code
     :gcov_exclude: []             # Explicitly defined as default empty array to simplify option validation code
 ...

data/lib/ceedling/c_extractor/c_extractor_declarations.rb

@@ -402,16 +402,17 @@ class CExtractorDeclarations
       return $1.strip
     end
 
-    # Find the name in the text and take everything before it (including pointer specifiers)
-    idx = text.rindex(name)
-    return nil if idx.nil?
-
-    type_part = text[0...idx]
-    # Include any pointer specifiers attached to the name
-    if text[idx..] =~ /^#{Regexp.escape(name)}/
-      # Look for * immediately before name (with optional space)
-      type_part = type_part.rstrip
-    end
+    # Find the name in the text and take everything before it (including pointer specifiers).
+    # A plain rindex(name) would find the last substring occurrence of `name` anywhere in
+    # text, even inside an unrelated longer identifier that merely ends with it (e.g. `name`
+    # "count" inside a type-side identifier like "recount") -- \b anchors this to a whole
+    # identifier occurrence. Greedy `.*` in a single match (not scan) naturally finds the
+    # rightmost such occurrence, since it consumes as much as possible before backtracking
+    # just enough to let the trailing \bname\b still match.
+    match = text.match(/\A(.*)\b#{Regexp.escape(name)}\b/m)
+    return nil if match.nil?
+
+    type_part = match[1]
     type_part.strip
   end
 

data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb

@@ -241,9 +241,46 @@ class CExtractorPreprocessing
     text = scanner.scan(/#/)
 
     until scanner.eos?
-      text << (scanner.scan(/[^"'\\\n]*/) || '')
+      # '/' is excluded here (alongside the quote/backslash/newline characters
+      # already excluded) so a comment marker is never swallowed into this plain
+      # literal run -- it has to be seen and dispatched on its own below, before
+      # any '"' or "'" inside the comment's own text gets mistaken for the start
+      # of a string/char literal (see the // and /* branches for why that matters).
+      text << (scanner.scan(/[^"'\\\n\/]*/) || '')
+
+      if scanner.scan(%r{//})
+        # A trailing line comment (e.g. "// don't change this") can contain an
+        # apostrophe or quote that isn't a literal delimiter at all. Consumed the
+        # ordinary way, that stray quote would send skip_c_string hunting for a
+        # closing match, straight through this directive's own newline and into
+        # whatever follows -- silently merging the next #define into this one.
+        # Comment content is captured verbatim and never scanned for literals.
+        #
+        # A '\' immediately before the physical newline still splices lines here,
+        # same as everywhere else in a directive (line splicing is a translation
+        # phase that happens before comments are stripped), so the comment -- and
+        # the directive -- keeps going onto the next physical line rather than
+        # ending at that newline.
+        before = scanner.pos - 2
+        loop do
+          scanner.scan(/[^\\\n]*/)
+          break if scanner.eos?
+          break unless scanner.scan(/\\\n/) || scanner.scan(/\\/)
+        end
+        text << scanner.string[before...scanner.pos]
+
+      elsif scanner.scan(%r{/\*})
+        # A block comment can legitimately span physical lines without ending the
+        # directive (only an un-commented newline does that) -- its content, quotes
+        # included, is likewise never scanned for literals, only for its own close.
+        before = scanner.pos - 2
+        scanner.skip_until(%r{\*/}) || scanner.terminate
+        text << scanner.string[before...scanner.pos]
+
+      elsif scanner.scan(%r{/})
+        text << '/'
 
-      if (ch = scanner.peek(1)) == '"' || ch == "'"
+      elsif (ch = scanner.peek(1)) == '"' || ch == "'"
         before = scanner.pos
         @c_extractor_code_text.skip_c_string(scanner, ch)
         text << scanner.string[before...scanner.pos]

data/lib/ceedling/generators/generator_test_results_backtrace.rb

@@ -66,13 +66,17 @@ class GeneratorTestResultsBacktrace
       # Attribute each group member its own real result line, if Unity printed one
       group.each do |test_case|
         case crash_result[:output]
-        # Success test case
-        when /(^#{Regexp.escape(filename)}:\d+:#{Regexp.escape(test_case[:test])}:PASS\s*$)/
+        # Success test case -- tolerates a trailing duration suffix (e.g. `PASS (12 ms)`,
+        # UNITY_INCLUDE_EXEC_TIME), matching the real format generator_test_results.rb's
+        # own parser already recognizes for it.
+        when /(^#{Regexp.escape(filename)}:\d+:#{Regexp.escape(test_case[:test])}:PASS(\s\(.*ms\))?\s*$)/
           group_results[:passed]  += 1
           group_results[:output] << $1
 
-        # Ignored test case
-        when /(^#{Regexp.escape(filename)}:\d+:#{Regexp.escape(test_case[:test])}:IGNORE\s*$)/
+        # Ignored test case -- tolerates a trailing message (TEST_IGNORE_MESSAGE), same as
+        # FAIL below. Before this fix, a message-carrying ignore fell through to "unresolved"
+        # and was misreported as crash evidence -- IGNORE was only recognized bare.
+        when /(^#{Regexp.escape(filename)}:\d+:#{Regexp.escape(test_case[:test])}:IGNORE(:.+)?\s*$)/
           group_results[:ignored] += 1
           group_results[:output] << $1
 
@@ -91,9 +95,11 @@ class GeneratorTestResultsBacktrace
         # Prefer whichever unresolved member's own C symbol is actually named in the gdb
         # backtrace (works regardless of position in the group); fall back to the first
         # unresolved member if no member's symbol can be found in the transcript (e.g. a
-        # brief crash report with no frame information at all).
+        # brief crash report with no frame information at all). \b anchors the symbol so a
+        # shorter unresolved symbol that's merely a suffix of a longer one actually named in
+        # the frame (e.g. "foo" vs "my_foo") can't steal the attribution.
         crashed_case = unresolved.find do |tc|
-          crash_result[:output].match?( /#{Regexp.escape(tc[:symbol])}\s*\(\)\sat/ )
+          crash_result[:output].match?( /\b#{Regexp.escape(tc[:symbol])}\s*\(\)\sat/ )
         end
         crashed_case ||= unresolved.first
 
@@ -260,13 +266,17 @@ class GeneratorTestResultsBacktrace
       # Attribute each group member its own real result line, if Unity printed one
       group.each do |test_case|
         case crash_result[:output]
-        # Success test case
-        when /(^#{Regexp.escape(filename)}:\d+:#{Regexp.escape(test_case[:test])}:PASS\s*$)/
+        # Success test case -- tolerates a trailing duration suffix (e.g. `PASS (12 ms)`,
+        # UNITY_INCLUDE_EXEC_TIME), matching the real format generator_test_results.rb's
+        # own parser already recognizes for it.
+        when /(^#{Regexp.escape(filename)}:\d+:#{Regexp.escape(test_case[:test])}:PASS(\s\(.*ms\))?\s*$)/
           group_results[:passed]  += 1
           group_results[:output] << $1
 
-        # Ignored test case
-        when /(^#{Regexp.escape(filename)}:\d+:#{Regexp.escape(test_case[:test])}:IGNORE\s*$)/
+        # Ignored test case -- tolerates a trailing message (TEST_IGNORE_MESSAGE), same as
+        # FAIL below. Before this fix, a message-carrying ignore fell through to "unresolved"
+        # and was misreported as crash evidence -- IGNORE was only recognized bare.
+        when /(^#{Regexp.escape(filename)}:\d+:#{Regexp.escape(test_case[:test])}:IGNORE(:.+)?\s*$)/
           group_results[:ignored] += 1
           group_results[:output] << $1
 
@@ -450,7 +460,7 @@ class GeneratorTestResultsBacktrace
     output.lines.filter_map do |line|
       line = line.strip
       next if line.empty?
-      next if line =~ /^#{filename}.+:(PASS|FAIL|IGNORE)/
+      next if line =~ /^#{Regexp.escape(filename)}.+:(PASS|FAIL|IGNORE)/
       line
     end
   end

data/lib/ceedling/generators/generator_test_runner.rb

@@ -129,7 +129,11 @@ class GeneratorTestRunner
       break if remaining.empty?
 
       next_case = remaining.first
-      if (line =~ /#{next_case[:test]}/)
+      # Escaped (a raw test name can contain regex metacharacters) and \b-anchored on both
+      # sides so an unrelated line that merely contains this test's name as a substring --
+      # e.g. a helper function like `reset_test_ab_state()` sitting before `test_ab` itself
+      # -- can't steal its line number and cascade misalignment to every case after it.
+      if (line =~ /\b#{Regexp.escape(next_case[:test])}\b/)
         next_case[:line_number] = line_num
         remaining.shift
       end

data/lib/ceedling/plugins/plugin_reportinator.rb

@@ -95,6 +95,15 @@ class PluginReportinator
     return aggregated_results
   end
       
+  # A build's own test results -- pass or fail -- are core information a user
+  # silencing routine build chatter still wants to see; ERRORS is the floor
+  # for both, not just for a failing run. Centralized here so every plugin
+  # printing post-build test results (report_tests_stdout_plugin, gcov,
+  # valgrind) agrees on the same answer instead of each hardcoding its own.
+  def test_results_floor_verbosity
+    Verbosity::ERRORS
+  end
+
   def run_test_results_report(hash, verbosity=Verbosity::NORMAL)
     if @test_results_template.nil?
       raise CeedlingException.new( "No test results report template has been set." )

data/lib/ceedling/plugins/report_tests_stdout_plugin.rb

@@ -50,7 +50,7 @@ class ReportTestsStdoutPlugin < Plugin
 
     results = @plugin_reportinator.assemble_test_results( @result_list )
     hash = { :context => TEST_SYM, :results => results }
-    verbosity = (results[:counts][:failed] > 0) ? Verbosity::ERRORS : Verbosity::NORMAL
+    verbosity = @plugin_reportinator.test_results_floor_verbosity
 
     # Print unit test suite results
     @plugin_reportinator.run_test_results_report( hash, verbosity )

data/lib/ceedling/preprocess/preprocessinator_line_marker_includes_extractor.rb

@@ -82,7 +82,12 @@ require 'set'
 
 # Parse GCC preprocessor output (from -fdirectives-only) to extract system include directives
 class PreprocessinatorLineMarkerIncludesExtractor
-  LINE_MARKER_REGEX = /^#\s+(\d+)\s+"([^"]+)"(?:\s+(\d+(?:\s+\d+)*))?$/ unless const_defined?(:LINE_MARKER_REGEX)
+  # Leading whitespace is tolerated (`^\s*`, not just `^`): GCC's -fdirectives-only output
+  # replaces a top-level #include with a line marker that inherits that #include's own
+  # original indentation (GH #1268) -- an indented `#include "x.h"` produces an indented
+  # `    # 1 "x.h" 1`, not the flush-left marker every OTHER marker GCC generates uses.
+  # Without this, such an include is silently missing from the extracted list entirely.
+  LINE_MARKER_REGEX = /^\s*#\s+(\d+)\s+"([^"]+)"(?:\s+(\d+(?:\s+\d+)*))?$/ unless const_defined?(:LINE_MARKER_REGEX)
 
   SYSTEM = :system  unless const_defined?(:SYSTEM)
   USER   = :user    unless const_defined?(:USER)

data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb

@@ -236,8 +236,15 @@ class PreprocessinatorReconstructor
   def extract_macro_defs(file_contents, include_guard)
     macro_definitions = extract_multiline_directives( file_contents, 'define' )
 
-    # Remove an include guard if provided
-    macro_definitions.reject! {|macro| macro.include?( include_guard ) } if !include_guard.nil?
+    # Remove an include guard if provided. A plain substring test here would also reject
+    # any ordinary macro whose name or value happens to contain the guard string -- e.g.
+    # guard RTC_H matching inside RTC_HOUR_SECONDS' own name, or inside RTC_DAY_SECONDS'
+    # value, which references RTC_HOUR_SECONDS (GH #1266). Anchoring to "#define <guard>"
+    # followed by whitespace or end-of-line only matches the guard definition itself.
+    if !include_guard.nil?
+      include_guard_regex = /^\s*#\s*define\s+#{Regexp.escape(include_guard)}(?:\s|$)/
+      macro_definitions.reject! {|macro| macro =~ include_guard_regex }
+    end
 
     return macro_definitions
   end
@@ -271,10 +278,16 @@ class PreprocessinatorReconstructor
   def _scan_expansion_for_file(input, filepath, &block)
     # Expand filepath under inspection to ensure proper match
     extraction_filepath = File.expand_path( filepath )
-    # Preprocessor directive blocks generally take the form of '# <digits> <text> [optional digits]'
-    directive   = /^# \d+ \"/
+    # Preprocessor directive blocks generally take the form of '# <digits> <text> [optional digits]'.
+    # Leading whitespace is tolerated (`^\s*`, not just `^`): GCC's -fdirectives-only output
+    # replaces a top-level #include with a line marker that inherits that #include's own
+    # original indentation (GH #1268) -- an indented `#include "x.h"` produces an indented
+    # `    # 1 "x.h" 1`, not the flush-left marker every OTHER marker GCC generates uses.
+    # Failing to recognize such a marker here leaves `extract` stuck at whatever it already
+    # was instead of correctly toggling off, leaking the ignored file's content into output.
+    directive   = /^\s*# \d+ \"/
     # Line markers have the specific form of '# <digits> "path/filename.ext" [optional digits]' (see above)
-    line_marker = /^#\s(\d+)\s\"(.+)\"/
+    line_marker = /^\s*#\s(\d+)\s\"(.+)\"/
     # Boolean to ping pong between line-by-line extract/ignore
     extract = false
 

data/lib/version.rb

@@ -15,7 +15,7 @@
 module Ceedling
   module Version
     # Convenience constants for gem building, etc.
-    GEM = '1.1.6'
+    GEM = '1.1.8'
     TAG = GEM
 
     # If run as a script print Ceedling's version to $stdout

data/plugins/gcov/config/defaults.yml

@@ -27,7 +27,6 @@
 
   :report_generator:
     :verbosity: Warning           # Default verbosity
-    :collection_paths_source: []  # Explicitly defined as default empty array to simplify option validation code
     :custom_args: []              # Explicitly defined as default empty array to simplify option validation code
     :gcov_exclude: []             # Explicitly defined as default empty array to simplify option validation code
 ...

data/plugins/gcov/lib/console_reportinator.rb

@@ -169,6 +169,13 @@ class ConsoleReportinator < GcovReportinator
         section       = section.reject { |line| line.include?( File.basename( source,'.*') ) }
         report        = section.map { |line| report_name + ' | ' + line }.join('')
         @loginator.log( report )
+      else
+        # A Partial whose remapped name still doesn't match any File header in gcov's
+        # output -- without this, a Partial's unparseable coverage silently produces no
+        # report and no log at all, unlike the equivalent non-Partial case just below.
+        @loginator.lazy( Verbosity::COMPLAIN ) do
+          "Found no coverage results for #{test}::#{File.basename(source)}"
+        end
       end
 
     # Otherwise, found no coverage results