ceedling 1.1.5 → 1.1.7

data/plugins/gcov/lib/gcovr_reportinator.rb

@@ -50,6 +50,28 @@ class GcovrReportinator < GcovReportinator
         "(found #{@gcovr_version.major}.#{@gcovr_version.minor})"
       )
     end
+
+    # --decisions requires gcovr 6+; --fail-under-decision (which depends on --decisions)
+    # is a distinct, later addition requiring gcovr 7+ -- confirmed directly against real
+    # gcovr 6.0, which rejects --fail-under-decision outright as an unrecognized argument.
+    # Raised here, upfront, rather than left to surface as gcovr's own opaque CLI error or
+    # silently dropped -- either of which would leave a configured coverage threshold
+    # quietly never actually checked.
+    gcovr_opts = @config[GCOVR_SETTING_PREFIX.to_sym] || {}
+
+    if !gcovr_opts[:fail_under_decision].nil? && !min_version?( @gcovr_version, 7, 0 )
+      raise CeedlingException.new(
+        ":gcov ↳ :gcovr ↳ :fail_under_decision ➡️ requires gcovr 7 or higher " \
+        "(found #{@gcovr_version.major}.#{@gcovr_version.minor})"
+      )
+    end
+
+    if gcovr_opts[:decisions] && !min_version?( @gcovr_version, 6, 0 )
+      raise CeedlingException.new(
+        ":gcov ↳ :gcovr ↳ :decisions ➡️ requires gcovr 6 or higher " \
+        "(found #{@gcovr_version.major}.#{@gcovr_version.minor})"
+      )
+    end
   end
 
   # Generate the gcovr report(s) specified in the options.
@@ -112,6 +134,14 @@ class GcovrReportinator < GcovReportinator
       args += "--merge-mode-functions \"#{gcovr_opts[:merge_mode_function]}\" " unless gcovr_opts[:merge_mode_function].nil?
     end
 
+    # --fail-under-decision is a no-op to gcovr without --decisions also present (that's
+    # what actually turns decision-coverage analysis on) -- :fail_under_decision implies
+    # it automatically so the threshold option can never be configured into silently
+    # failing outright. initialize already guarantees gcovr 6+ whenever either is set
+    # (7+ specifically whenever :fail_under_decision is set), matching this method's own
+    # 6+ gate above.
+    args += "--decisions " if gcovr_opts[:decisions] || !gcovr_opts[:fail_under_decision].nil?
+
     [:fail_under_line,
      :fail_under_branch,
      :fail_under_decision,
@@ -327,7 +357,7 @@ class GcovrReportinator < GcovReportinator
   # configuration must come from the gcovr configuration file itself.
   IGNORED_WHEN_CONFIG_FILE_SET = [
     :report_include, :report_exclude, :gcov_filter, :gcov_exclude, :exclude_directories,
-    :branches, :sort_uncovered, :sort_percentage, :print_summary, :gcov_executable,
+    :branches, :decisions, :sort_uncovered, :sort_percentage, :print_summary, :gcov_executable,
     :exclude_unreachable_branches, :exclude_throw_branches, :use_gcov_files, :gcov_ignore_parse_errors,
     :keep, :delete, :threads, :merge_mode_function,
     :fail_under_line, :fail_under_branch, :fail_under_decision, :fail_under_function,

data/plugins/valgrind/lib/valgrind.rb

@@ -101,7 +101,7 @@ class Valgrind < Plugin
         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/site-local/configuration/project-file.html

@@ -1684,6 +1684,34 @@
     </span>
   </a>
   
+    <nav class="md-nav" aria-label="Some YAML Learnin’">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#yaml-highlights-overview" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        YAML highlights &amp; overview
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#yaml-anchors-aliases-and-extensions" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        YAML anchors, aliases, and extensions
+      
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
         <li class="md-nav__item">
@@ -4102,6 +4130,34 @@
     </span>
   </a>
   
+    <nav class="md-nav" aria-label="Some YAML Learnin’">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#yaml-highlights-overview" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        YAML highlights &amp; overview
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#yaml-anchors-aliases-and-extensions" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        YAML anchors, aliases, and extensions
+      
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
         <li class="md-nav__item">
@@ -4241,10 +4297,20 @@
 example of a complete project configuration.</p>
 </div>
 <h2 id="some-yaml-learnin">Some YAML Learnin’</h2>
-<p>Please consult YAML documentation for the finer points of format
-and to understand details of our YAML-based configuration file.</p>
 <p>We recommend <a href="http://en.wikipedia.org/wiki/Yaml">Wikipedia’s entry on YAML</a>
-for this. A few highlights from that reference page:</p>
+and <a href="https://www.educative.io/blog/advanced-yaml-syntax-cheatsheet">educative.io’s advanced YAML cheatsheet</a>
+for a simple overview of YAML and its syntax sufficient for 
+understanding your Ceedling project configuration.</p>
+<div class="admonition tip">
+<p class="admonition-title"><code>ceedling dumpconfig</code> to verify your YAML</p>
+<p>Ceedling provides a means to export the final result of YAML
+processing for your inspection via <a href="../getting-started/command-line.html#ceedling-dumpconfig-filepath-sections"><code>dumpconfig</code></a>.
+Dump output includes the resolution of advanced YAML features and 
+Ceedling’s own manipulations. This is a good way to troubleshoot 
+your project configuration.</p>
+</div>
+<h3 id="yaml-highlights-overview">YAML highlights &amp; overview</h3>
+<p>A few points from the preceding references:</p>
 <ul>
 <li>
 <p>YAML streams are encoded using the set of printable Unicode
@@ -4279,12 +4345,16 @@ for this. A few highlights from that reference page:</p>
   punctuation can generally be represented without needing
   to be enclosed in quotes.</p>
 </li>
-<li>
-<p>Repeated nodes are initially denoted by an ampersand (<code>&amp;</code>) and
-  thereafter referenced with an asterisk (<code>*</code>). These are known as
-  anchors and aliases in YAML speak.</p>
-</li>
 </ul>
+<h3 id="yaml-anchors-aliases-and-extensions">YAML anchors, aliases, and extensions</h3>
+<p>YAML provides several “shortcuts” for referencing and modifying blocks
+of YAML so you can avoid duplication. This is advanced YAML and 
+well beyond the scope of Ceedling documentation. However, know that
+Ceedling’s YAML parser is entirely capable of handling these advanced 
+aspects of YAML.</p>
+<p>See this <a href="https://www.educative.io/blog/advanced-yaml-syntax-cheatsheet#anchors">cheatsheet entry</a> 
+and <a href="https://blog.daemonl.com/2016/02/yaml.html">this guide</a>
+for much more on these powerful but finicky features.</p>
 <h2 id="notes-on-project-file-structure">Notes on Project File Structure</h2>
 <ul>
 <li>

data/site-local/configuration/reference/cexception.html

@@ -2344,10 +2344,10 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#exmaple-cmock-yaml" class="md-nav__link">
+  <a href="#example-cmock-yaml" class="md-nav__link">
     <span class="md-ellipsis">
       
-        Exmaple :cmock YAML
+        Example :cmock YAML
       
     </span>
   </a>
@@ -4046,10 +4046,10 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#exmaple-cmock-yaml" class="md-nav__link">
+  <a href="#example-cmock-yaml" class="md-nav__link">
     <span class="md-ellipsis">
       
-        Exmaple :cmock YAML
+        Example :cmock YAML
       
     </span>
   </a>
@@ -4155,7 +4155,7 @@
 
 <h1 id="cexception"><code>:cexception</code></h1>
 <p><strong>Configure CException’s features</strong></p>
-<h2 id="exmaple-cmock-yaml">Exmaple <code>:cmock</code> YAML</h2>
+<h2 id="example-cmock-yaml">Example <code>:cmock</code> YAML</h2>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">:cexception</span><span class="p">:</span>
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w">  </span><span class="nt">:defines</span><span class="p">:</span>
 <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w">    </span><span class="c1"># Enables CException `#include`ing CExceptionConfig.h</span>

data/site-local/configuration/reference/cmock.html

@@ -2288,10 +2288,10 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#exmaple-cmock-yaml" class="md-nav__link">
+  <a href="#example-cmock-yaml" class="md-nav__link">
     <span class="md-ellipsis">
       
-        Exmaple :cmock YAML
+        Example :cmock YAML
       
     </span>
   </a>
@@ -4112,10 +4112,10 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#exmaple-cmock-yaml" class="md-nav__link">
+  <a href="#example-cmock-yaml" class="md-nav__link">
     <span class="md-ellipsis">
       
-        Exmaple :cmock YAML
+        Example :cmock YAML
       
     </span>
   </a>
@@ -4290,7 +4290,7 @@
 <p>Ceedling sets values for a subset of CMock settings. All CMock options are
 available to be set, but only those options set by Ceedling in an automated
 fashion are documented below. See <a href="https://github.com/ThrowTheSwitch/CMock/blob/master/docs/CMock_Summary.md">CMock documentation</a>.</p>
-<h2 id="exmaple-cmock-yaml">Exmaple <code>:cmock</code> YAML</h2>
+<h2 id="example-cmock-yaml">Example <code>:cmock</code> YAML</h2>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">:cmock</span><span class="p">:</span>
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w">  </span><span class="nt">:when_no_prototypes</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">:warn</span>
 <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w">  </span><span class="nt">:enforce_strict_ordering</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">TRUE</span>

data/site-local/configuration/reference/unity.html

@@ -2260,10 +2260,10 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#exmaple-unity-yaml" class="md-nav__link">
+  <a href="#example-unity-yaml" class="md-nav__link">
     <span class="md-ellipsis">
       
-        Exmaple :unity YAML
+        Example :unity YAML
       
     </span>
   </a>
@@ -4057,10 +4057,10 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#exmaple-unity-yaml" class="md-nav__link">
+  <a href="#example-unity-yaml" class="md-nav__link">
     <span class="md-ellipsis">
       
-        Exmaple :unity YAML
+        Example :unity YAML
       
     </span>
   </a>
@@ -4177,7 +4177,7 @@
 
 <h1 id="unity"><code>:unity</code></h1>
 <p><strong>Configure Unity’s features</strong></p>
-<h2 id="exmaple-unity-yaml">Exmaple <code>:unity</code> YAML</h2>
+<h2 id="example-unity-yaml">Example <code>:unity</code> YAML</h2>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">:unity</span><span class="p">:</span>
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w">  </span><span class="nt">:defines</span><span class="p">:</span>
 <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">UNITY_INT_WIDTH=16</span><span class="w">   </span><span class="c1"># 16 bit processor without support for 32 bit instructions</span>

data/site-local/getting-started/quick-start.html

@@ -4185,6 +4185,12 @@ configuration file could be as simple as this:</p>
 through running build tasks. Jump down just a teeny bit to see what the Ceedling 
 command line looks like and navigate to all the documentation for the steps 
 listed immediately below.</p>
+<div class="admonition warning">
+<p class="admonition-title">C toolchain requirement</p>
+<p>Ceedling requires a command line C toolchain be available in your path and is
+flexible enough to work with most anything. By default, Ceedling is ready to 
+work with <a href="https://gcc.gnu.org">GCC</a> out of the box (we recommend <a href="http://www.mingw.org/">MinGW</a> on Windows).</p>
+</div>
 <ol>
 <li><a href="installation.html">Install Ceedling</a></li>
 <li>Create a project<ul>
@@ -4200,16 +4206,14 @@ listed immediately below.</p>
 </li>
 <li>Run Ceedling tasks (see next section) from the working directory of your project.</li>
 </ol>
-<div class="admonition note">
-<p class="admonition-title">Note</p>
-<p>Ceedling requires a command line C toolchain be available in your path. It’s 
-flexible enough to work with most anything on any platform. By default, Ceedling 
-is ready to work with <a href="https://gcc.gnu.org">GCC</a> out of the box (we recommend the <a href="http://www.mingw.org/">MinGW</a> project 
-on Windows).</p>
+<p>A common build strategy is to use your target toolchain for release builds—with or 
+without Ceedling—but rely on Ceedling + GCC for test builds (more on this 
+<a href="../overview/index.html">here</a>).</p>
+<div class="admonition tip">
+<p class="admonition-title">Ceedling VS Code extension</p>
+<p>If you are a Visual Studio Code user, you may want to install the
+<a href="https://marketplace.visualstudio.com/items?itemName=throw-the-switch.vscode-ceedling">Ceedling extension</a>.</p>
 </div>
-<p>A common build strategy with tooling other than GCC is to use your target 
-toolchain for release builds—with or without Ceedling—but rely on Ceedling + 
-GCC for test builds (more on all this <a href="../overview/index.html">here</a>).</p>
 <h2 id="command-line-build-tasks">Command Line &amp; Build Tasks</h2>
 <p>Once you have Ceedling installed, you always have access to <code>ceedling help</code>.</p>
 <p>Once you have Ceedling installed, you have options for project creation