Gcov plugin: port confirmed bug fixes from the next_version review pass

Simple, targeted patches -- master's own (older, pre-delta-builds) code
shape, no refactor or new unit-test infrastructure -- porting the bug fixes
confirmed during the recent next_version Gcov plugin review
(gcov-plugin-review branch). Manually validated via
throwtheswitch/madsciencelab-plugins Docker plus one light new system-test
case.

- :gcov ↳ :gcovr ↳ :decisions version floor corrected 6.0 -> 5.1 -- gcovr's
  own changelog and a real gcovr 5.1/5.0 pip install confirm --decisions was
  introduced in 5.1, not 6.0.
- :fail_under_* now rejects 0 (documented range is 1-100; 0 was silently
  accepted as a threshold that could never actually fail).
- :object_directory/:source_encoding values are now quoted -- an unquoted
  value containing a space previously broke the constructed gcovr command
  line.
- Regex-metacharacter-injection risk fixed in both :gcovr's and
  :report_generator's auto-generated exclusion patterns -- :test_file_prefix,
  :mock_prefix, and build-root path values are now Regexp.escape'd before
  being spliced into exclusion regexes.
- :mcdc's GCC-version check moved out of Gcov#setup(), which runs for every
  build the plugin is merely enabled for, into a lazily-invoked, memoized
  check that fires only on a real gcov-context compile/link.
- gcovr_exec_exception? now reports every simultaneously violated
  :fail_under_* threshold instead of only the first.
- Added the missing .dup guard in
  ReportGeneratorReportinator#collect_reportgenerator_opts, mirroring the
  existing guard on the gcovr side.
- gcovr 7.0+ deprecated flag migration: :branches/:sort_uncovered/
  :sort_percentage now use --txt-metric branch/--sort uncovered-number/
  --sort uncovered-percent at gcovr 7.0+, silencing gcovr's own deprecation
  warnings; the pre-7.0 names are still used automatically below that.
- Removed dead code: gcovr_reportinator.rb set an internal :mcdc flag no
  code path ever read. Confirmed via Docker (gcovr 8.6) that --decisions has
  no effect on GCC's own condition/MC-DC data in either JSON or HTML --
  gcovr's Condition-labeled content is byte-identical with and without it;
  only a separate, additive Decision column depends on the flag.
- ConsoleReportinator#log_coverage_report: a Partial-implementation source
  whose gcov output can't be matched at all now logs the same "Found no
  coverage results" COMPLAIN the equivalent non-Partial case already did,
  instead of silently producing no report and no log.

Explicitly not ported: the broader DRY refactor (ToolVersionGating,
build_args_from_table, etc.) and the new unit-test suite from the
next_version pass -- out of scope per plan (simple patches only); the
ReportGenerator coverage-threshold feature -- a new feature, not a bug fix.

New system-test case: project_with_gcov_fail_under_line_rejects_zero
(spec/system/support/gcov_common_test_cases.rb), regression-locking the `0`
rejection specifically, matching the existing
project_with_gcov_fail_under_decision pattern from the #1080 fix.

Small doc corrections alongside the code they describe: :decisions'
"Requires" floor in gcovr.md/reference/gcov-plugin.md, and the
:branches/:sort_uncovered/:sort_percentage deprecated-flag notes.

Verified: full unit suite (1978 examples, 0 failures), mkdocs build
--strict, and the full Gcov system-test suite (26 examples, 0 failures) via
throwtheswitch/madsciencelab-plugins:1.1.6 Docker.

No Changelog entry in this commit -- the 1.1.8 section (both branches) is a
separate, later step.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

Author: mkarlesky

docs/mkdocs/plugins/gcov/gcovr.md

@@ -128,7 +128,7 @@ Report the decision coverage. For HTML, JSON, and the summary report.
 
 Implied automatically whenever `:fail_under_decision` is set.
 
-**Requires:** `gcovr` 6.0 or higher
+**Requires:** `gcovr` 5.1 or higher
 
 ---
 
@@ -163,21 +163,26 @@ Select the source file character encoding. (`gcovr --source-encoding`)
 ### `:branches`
 
 Report the branch coverage instead of the line coverage. Applies to the text
-report only. (`gcovr --branches`)
+report only. 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 entries by increasing number of uncovered lines. Applies to text and HTML
-reports. (`gcovr --sort-uncovered`)
+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 entries by increasing percentage of uncovered lines. Applies to text and
-HTML reports. (`gcovr --sort-percentage`)
+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.
 
 ---
 

docs/mkdocs/reference/gcov-plugin.md

@@ -229,7 +229,7 @@ Report the decision coverage. For HTML, JSON, and the summary report.
 
 Implied automatically whenever `:fail_under_decision` is set.
 
-**Requires:** `gcovr` 6.0 or higher
+**Requires:** `gcovr` 5.1 or higher
 
 ---
 
@@ -262,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.
 
 ---
 

plugins/gcov/lib/console_reportinator.rb

@@ -169,6 +169,13 @@ def log_coverage_report(test, source, results, gcov_source)
         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

plugins/gcov/lib/gcov.rb

@@ -70,16 +70,12 @@ def setup
 
     @mutex = Mutex.new()
 
-    # Validate MC/DC configuration against GCC version (only incurs gcc --version when :mcdc: TRUE)
-    if @project_config[:gcov_mcdc]
-      gcc_version = get_gcc_version()
-      if gcc_version.major < 14
-        raise CeedlingException.new(
-          ":gcov ↳ :mcdc ➡️ Modified condition/decision coverage requires GCC 14 or higher " \
-          "(found #{gcc_version.major}.#{gcc_version.minor})"
-        )
-      end
-    end
+    # See validate_mcdc_gcc_version! below for why this isn't checked eagerly here --
+    # setup() runs for every build this plugin is merely *enabled* for, not only real
+    # gcov: builds. Shelling out to `gcc --version` here would make GCC-version
+    # validation (and a build-breaking exception on too-old a GCC) fire even for builds
+    # that never touch :mcdc at all, e.g. plain `test:all`.
+    @mcdc_gcc_checked = false
   end
 
   # Called within class and also externally by plugin Rakefile
@@ -179,6 +175,8 @@ def pre_compile_execute(arg_hash)
 
       # Compile all non-assembly files with coverage; gcovr --exclude filters non-production files from reports
       if File.extname(source) != EXTENSION_ASSEMBLY
+        validate_mcdc_gcc_version!
+
         arg_hash[:tool] = TOOLS_GCOV_COMPILER
         arg_hash[:msg] = @reportinator.generate_module_progress(
           operation: "Compiling with coverage",
@@ -192,6 +190,8 @@ def pre_compile_execute(arg_hash)
 
   def pre_link_execute(arg_hash)
     if arg_hash[:context] == GCOV_SYM
+      validate_mcdc_gcc_version!
+
       @cli_gcov_task = true
       arg_hash[:tool] = TOOLS_GCOV_LINKER
       arg_hash[:flags] += ['-fcondition-coverage'] if @project_config[:gcov_mcdc]
@@ -364,6 +364,25 @@ def build_reportinators(config)
     return reportinators
   end
 
+  # Lazily validates :mcdc against the installed GCC version -- called from every
+  # gcov-context build hook that could otherwise emit -fcondition-coverage (compile,
+  # link), memoized so `gcc --version` runs at most once regardless of how many source
+  # files or hooks fire before it. See setup()'s own comment for why this isn't checked
+  # eagerly there.
+  def validate_mcdc_gcc_version!
+    return if @mcdc_gcc_checked
+    @mcdc_gcc_checked = true
+    return unless @project_config[:gcov_mcdc]
+
+    gcc_version = get_gcc_version()
+    if gcc_version.major < 14
+      raise CeedlingException.new(
+        ":gcov ↳ :mcdc ➡️ Modified condition/decision coverage requires GCC 14 or higher " \
+        "(found #{gcc_version.major}.#{gcc_version.minor})"
+      )
+    end
+  end
+
   def get_gcc_version()
     command = @tool_executor.build_command_line( TOOLS_GCOV_GCC_VERSION, [])
 

plugins/gcov/lib/gcovr_reportinator.rb

@@ -66,9 +66,12 @@ def initialize(system_objects, config)
       )
     end
 
-    if gcovr_opts[:decisions] && !min_version?( @gcovr_version, 6, 0 )
+    # --decisions was introduced in gcovr 5.1, not 6.0 -- confirmed directly against
+    # gcovr's own changelog and a real gcovr 5.1/5.0 install (5.1 accepts --decisions
+    # and proceeds; 5.0 rejects it outright as unrecognized).
+    if gcovr_opts[:decisions] && !min_version?( @gcovr_version, 5, 1 )
       raise CeedlingException.new(
-        ":gcov ↳ :gcovr ↳ :decisions ➡️ requires gcovr 6 or higher " \
+        ":gcov ↳ :gcovr ↳ :decisions ➡️ requires gcovr 5.1 or higher " \
         "(found #{@gcovr_version.major}.#{@gcovr_version.minor})"
       )
     end
@@ -116,9 +119,18 @@ def args_builder_common(gcovr_opts, gcovr_version)
     args += "--gcov-filter \"#{gcovr_opts[:gcov_filter]}\" " unless gcovr_opts[:gcov_filter].nil?
     args += "--gcov-exclude \"#{gcovr_opts[:gcov_exclude]}\" " unless gcovr_opts[:gcov_exclude].nil?
     args += "--exclude-directories \"#{gcovr_opts[:exclude_directories]}\" " unless gcovr_opts[:exclude_directories].nil?
-    args += "--branches " if gcovr_opts[:branches]
-    args += "--sort-uncovered " if gcovr_opts[:sort_uncovered]
-    args += "--sort-percentage " if gcovr_opts[:sort_percentage]
+    # gcovr 7.0 deprecated --branches/--sort-uncovered/--sort-percentage in favor of
+    # these renamed equivalents (still functional, but warn, below 7.0); use whichever
+    # form the detected gcovr_version actually expects.
+    if gcovr_opts[:branches]
+      args += (min_version?(gcovr_version, 7, 0) ? "--txt-metric branch " : "--branches ")
+    end
+    if gcovr_opts[:sort_uncovered]
+      args += (min_version?(gcovr_version, 7, 0) ? "--sort uncovered-number " : "--sort-uncovered ")
+    end
+    if gcovr_opts[:sort_percentage]
+      args += (min_version?(gcovr_version, 7, 0) ? "--sort uncovered-percent " : "--sort-percentage ")
+    end
     args += "--print-summary " if gcovr_opts[:print_summary]
     args += "--gcov-executable \"#{gcovr_opts[:gcov_executable]}\" " unless gcovr_opts[:gcov_executable].nil?
     args += "--exclude-unreachable-branches " if gcovr_opts[:exclude_unreachable_branches]
@@ -152,18 +164,24 @@ def args_builder_common(gcovr_opts, gcovr_version)
       next if gcovr_opts[opt].nil?
 
       value = gcovr_opts[opt]
-      
+
       # Value sanity checks for :fail_under_* settings
       if opt.to_s =~ /fail_/
         if not value.is_a? Integer
           raise CeedlingException.new(":gcov ↳ :gcovr ↳ :#{opt} ➡️ '#{value}' must be an integer")
-        elsif (value < 0) || (value > 100)
-          raise CeedlingException.new(":gcov ↳ :gcovr ↳ :#{opt} ➡️ '#{value}' must be an integer percentage 0 – 100")
+        elsif (value < 1) || (value > 100)
+          raise CeedlingException.new(":gcov ↳ :gcovr ↳ :#{opt} ➡️ '#{value}' must be an integer percentage 1 – 100")
         end
       end
-      
-      # If the YAML key has a value, trasnform key into command line argument with value and concatenate
-      args += "--#{opt.to_s.gsub('_','-')} #{value} " unless value.nil?
+
+      # :source_encoding/:object_directory are quoted (unlike the already-validated,
+      # always-integer :fail_under_* values) so a value containing a space doesn't
+      # break the constructed command line.
+      if [:source_encoding, :object_directory].include?(opt)
+        args += "--#{opt.to_s.gsub('_','-')} \"#{value}\" " unless value.nil?
+      else
+        args += "--#{opt.to_s.gsub('_','-')} #{value} " unless value.nil?
+      end
     end
 
     return args
@@ -409,30 +427,42 @@ def collect_gcovr_opts(opts)
       _opts[:report_exclude] = excludes unless excludes.empty?
     end
 
-    _opts[:mcdc] = true if opts[:gcov_mcdc]
+    # No :mcdc-specific gcovr flag to set here -- GCC's own condition/MC-DC data flows
+    # into gcovr's reports unconditionally, in every format, regardless of --decisions
+    # (confirmed directly: gcovr's Condition-labeled HTML/JSON content is byte-identical
+    # with and without --decisions; that flag only adds its own separate, additive
+    # Decision data alongside it). :mcdc's own gcovr-version floor is still enforced in
+    # initialize -- there's just nothing more for gcovr's own CLI args to do here.
 
     return _opts
   end
 
 
   # Build a combined Python regex for gcovr's `--exclude` flag covering all
   # non-production file categories: test files, support files, and generated/framework files.
+  # Path/prefix values are config-driven, so they're Regexp-escaped -- interpolated raw, a
+  # metacharacter (e.g. a literal '.') in a project's own path would silently over- or
+  # under-match.
   def build_report_exclusions
     data = build_exclusion_data
     patterns = []
 
+    test_prefix    = Regexp.escape(data[:test_prefix].to_s)
+    build_root     = Regexp.escape(data[:build_root].to_s)
+    src_extension  = Regexp.escape(data[:src_extension].to_s)
+
     data[:test_paths].each do |path|
       # Test files (e.g. test_foo.c)
-      patterns << ".*#{path}.*/#{data[:test_prefix]}.+\\#{data[:src_extension]}$"
+      patterns << ".*#{Regexp.escape(path)}.*/#{test_prefix}.+\\#{src_extension}$"
     end
 
     # Support files (e.g. helpers, stubs, fixtures) — never production source
     data[:support_paths].each do |path|
-      patterns << ".*#{path}/.+\\#{data[:src_extension]}$"
+      patterns << ".*#{Regexp.escape(path)}/.+\\#{src_extension}$"
     end
 
     # Any generated files for tests or vendored framework C source files below the root of the build directory
-    patterns << ".*#{data[:build_root]}/.+\\#{EXTENSION_CORE_SOURCE}$"
+    patterns << ".*#{build_root}/.+\\#{EXTENSION_CORE_SOURCE}$"
 
     return patterns
   end
@@ -535,59 +565,43 @@ def min_version?(version, major, minor)
 
   # Output to console a human-friendly message on certain coverage failure exit codes.
   # Prefers the actual gcovr error text from stderr; falls back to descriptive strings.
-  # Perform the logic on whether to raise an exception
+  # gcovr's composite exit code bit-ORs every violated :fail_under_* threshold together --
+  # every violated bit is collected and reported, not just whichever is checked first.
   def gcovr_exec_exception?(opts, exitcode, boom, shell_result=nil)
+    violations = []
 
     # Special handling of exit code 2 with --fail-under-line
     if ((exitcode & 2) == 2) and !opts[:fail_under_line].nil?
       fallback = "Line coverage is less than the configured minimum of #{opts[:fail_under_line]}%"
-      msg = "Gcovr ⏩️ #{extract_gcovr_error_message( shell_result ) || fallback}"
-      if boom
-        raise CeedlingException.new(msg)
-      else
-        @loginator.log( msg, Verbosity::COMPLAIN )
-        # Clear bit in exit code
-        exitcode &= ~2
-      end
+      violations << "Gcovr ⏩️ #{extract_gcovr_error_message( shell_result ) || fallback}"
+      exitcode &= ~2
     end
 
     # Special handling of exit code 4 with --fail-under-branch
     if ((exitcode & 4) == 4) and !opts[:fail_under_branch].nil?
       fallback = "Branch coverage is less than the configured minimum of #{opts[:fail_under_branch]}%"
-      msg = "Gcovr ⏩️ #{extract_gcovr_error_message( shell_result ) || fallback}"
-      if boom
-        raise CeedlingException.new(msg)
-      else
-        @loginator.log( msg, Verbosity::COMPLAIN )
-        # Clear bit in exit code
-        exitcode &= ~4
-      end
+      violations << "Gcovr ⏩️ #{extract_gcovr_error_message( shell_result ) || fallback}"
+      exitcode &= ~4
     end
 
     # Special handling of exit code 8 with --fail-under-decision
     if ((exitcode & 8) == 8) and !opts[:fail_under_decision].nil?
       fallback = "Decision coverage is less than the configured minimum of #{opts[:fail_under_decision]}%"
-      msg = "Gcovr ⏩️ #{extract_gcovr_error_message( shell_result ) || fallback}"
-      if boom
-        raise CeedlingException.new(msg)
-      else
-        @loginator.log( msg, Verbosity::COMPLAIN )
-        # Clear bit in exit code
-        exitcode &= ~8
-      end
+      violations << "Gcovr ⏩️ #{extract_gcovr_error_message( shell_result ) || fallback}"
+      exitcode &= ~8
     end
 
     # Special handling of exit code 16 with --fail-under-function
     if ((exitcode & 16) == 16) and !opts[:fail_under_function].nil?
       fallback = "Function coverage is less than the configured minimum of #{opts[:fail_under_function]}%"
-      msg = "Gcovr ⏩️ #{extract_gcovr_error_message( shell_result ) || fallback}"
-      if boom
-        raise CeedlingException.new(msg)
-      else
-        @loginator.log( msg, Verbosity::COMPLAIN )
-        # Clear bit in exit code
-        exitcode &= ~16
-      end
+      violations << "Gcovr ⏩️ #{extract_gcovr_error_message( shell_result ) || fallback}"
+      exitcode &= ~16
+    end
+
+    if boom
+      raise CeedlingException.new( violations.join("\n") ) unless violations.empty?
+    else
+      violations.each { |msg| @loginator.log( msg, Verbosity::COMPLAIN ) }
     end
 
     # A non-zero exit code is a problem

plugins/gcov/lib/reportgenerator_reportinator.rb

@@ -128,7 +128,9 @@ def build_optional_args(rg_opts, report_type_count)
 
   # Get the ReportGenerator options from the project options.
   def collect_reportgenerator_opts(opts)
-    _opts = opts[REPORT_GENERATOR_SETTING_PREFIX.to_sym]
+    # dup prevents repeated calls from accumulating mutations on the shared opts hash --
+    # mirrors GcovrReportinator#collect_gcovr_opts' identical guard and rationale.
+    _opts = opts[REPORT_GENERATOR_SETTING_PREFIX.to_sym].dup
 
     # Auto-generate -filefilters: exclusion patterns for test paths and the build root.
     # These exclude test files and all generated/framework files from coverage reports.
@@ -275,17 +277,19 @@ def build_filefilter_exclusions
   # Build filename-fragment patterns for the .gcno scan exclusion regex.
   # Excludes test files, generated mocks, and test runners from gcov processing.
   # The '.*' suffix handles source extensions embedded in .gcno filenames (e.g. test_foo.c.gcno).
+  # test_prefix/mock_prefix are config-driven, so they're Regexp-escaped -- unescaped, a
+  # metacharacter in either (e.g. a literal '.') would silently over- or under-match.
   def build_gcno_exclusions
     data = build_exclusion_data
     # Use [^\/\\]* (no path separators) rather than .* to match filenames only.
     # Ceedling names build output dirs after test files (e.g. build/gcov/out/test_foo/),
     # so .* would greedily match test_foo/bar.c and exclude ALL production sources.
     [
-      "#{data[:test_prefix]}[^\\/\\\\]*",  # test_foo.gcno
-      "#{data[:mock_prefix]}[^\\/\\\\]*",  # MockBar.gcno
-      "[^\\/\\\\]*_runner[^\\/\\\\]*",     # test_foo_runner.gcno
-      File.basename(UNITY_C_FILE, '.*'),   # unity.gcno
-      File.basename(CMOCK_C_FILE, '.*')    # cmock.gcno
+      "#{Regexp.escape(data[:test_prefix].to_s)}[^\\/\\\\]*",  # test_foo.gcno
+      "#{Regexp.escape(data[:mock_prefix].to_s)}[^\\/\\\\]*",  # MockBar.gcno
+      "[^\\/\\\\]*_runner[^\\/\\\\]*",                          # test_foo_runner.gcno
+      Regexp.escape(File.basename(UNITY_C_FILE, '.*')),        # unity.gcno
+      Regexp.escape(File.basename(CMOCK_C_FILE, '.*'))         # cmock.gcno
     ]
   end
 

spec/system/gcov_deployment_spec.rb

@@ -37,6 +37,7 @@
       test_case :project_with_gcov_success
       test_case :project_with_gcov_fail
       test_case :project_with_gcov_fail_under_decision
+      test_case :project_with_gcov_fail_under_line_rejects_zero
       test_case :gcov_console_report_with_system_header
       test_case :gcov_console_report_with_partial
       # TODO: Restore these tests when the :abort_on_uncovered option is restored in the Gcov plugin