ceedling 1.1.10 → 1.2.0

data/site-local/plugins/report-tests-ide-stdout.html

@@ -89,10 +89,34 @@
     </div>
     <div data-md-component="announce">
       
+        <aside class="md-banner">
+          <div class="md-banner__inner md-grid md-typeset">
+            
+            
+  
+
+          </div>
+          
+        </aside>
+      
     </div>
     
       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
         
+          <aside class="md-banner md-banner--warning">
+            <div class="md-banner__inner md-grid md-typeset">
+              
+  
+    You are not viewing the latest version.
+    <a href="../..">
+      <strong>Click here to go to latest.</strong>
+    </a>
+  
+
+            </div>
+            <script>var el=document.querySelector("[data-md-component=outdated]"),base=new URL(".."),outdated=__md_get("__outdated",sessionStorage,base);!0===outdated&&el&&(el.hidden=!1)</script>
+          </aside>
+        
       </div>
     
     
@@ -332,7 +356,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="../project/release-history.html" class="md-tabs__link">
+        <a href="../project/index.html" class="md-tabs__link">
           
   
   
@@ -641,6 +665,8 @@
         
       
         
+      
+        
       
         
       
@@ -788,6 +814,34 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../getting-started/builds.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Builds
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     
     
       
@@ -814,7 +868,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_5" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_6" >
         
           
           <div class="md-nav__link md-nav__container">
@@ -836,14 +890,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3_5">
+        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_3_6">
             <span class="md-nav__icon md-icon"></span>
             
   
@@ -2412,6 +2466,8 @@
         
       
         
+      
+        
       
         
       
@@ -2597,6 +2653,45 @@
     </span>
   </a>
   
+    <nav class="md-nav" aria-label="Configuration">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#format" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        :format
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#absolute_paths" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        :absolute_paths
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#multi-line-messages" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Multi-line messages
+      
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
         <li class="md-nav__item">
@@ -2608,6 +2703,56 @@
     </span>
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#ide-setup" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        IDE Setup
+      
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="IDE Setup">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#eclipse-cdt" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Eclipse CDT
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#vs-code" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        VS Code
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#clion" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        CLion
+      
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
     </ul>
@@ -3140,16 +3285,116 @@
   
   
     <li class="md-nav__item">
-      <a href="bullseye.html" class="md-nav__link">
+      <a href="sanitize.html" class="md-nav__link">
         
   
   
   <span class="md-ellipsis">
     
   
+    Sanitize (ASan, UBSan & Leaks)
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    
+    
+      
+        
+          
+        
+      
+        
+      
+    
+    
+    
+      
+      
+        
+          
+          
+        
+      
+    
+    
+    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
+      
+        
+        
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_13" >
+        
+          
+          <div class="md-nav__link md-nav__container">
+            <a href="bullseye/index.html" class="md-nav__link ">
+              
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Bullseye (Coverage)
+  
+
+    
+  </span>
+  
+  
+
+            </a>
+            
+              
+              <label class="md-nav__link " for="__nav_6_13" id="__nav_6_13_label" tabindex="">
+                <span class="md-nav__icon md-icon"></span>
+              </label>
+            
+          </div>
+        
+        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_13_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_6_13">
+            <span class="md-nav__icon md-icon"></span>
+            
+  
     Bullseye (Coverage)
   
 
+          </label>
+          <ul class="md-nav__list" data-md-scrollfix>
+            
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="bullseye/licensing.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Licensing
+  
+
     
   </span>
   
@@ -3161,6 +3406,14 @@
 
               
             
+          </ul>
+        </nav>
+      
+    </li>
+  
+
+              
+            
               
                 
   
@@ -3630,6 +3883,12 @@
     
       
         
+          
+        
+      
+        
+      
+        
       
         
       
@@ -3649,8 +3908,9 @@
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
         
           
-          <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
-            
+          <div class="md-nav__link md-nav__container">
+            <a href="../project/index.html" class="md-nav__link ">
+              
   
   
   <span class="md-ellipsis">
@@ -3664,8 +3924,14 @@
   
   
 
-            <span class="md-nav__icon md-icon"></span>
-          </label>
+            </a>
+            
+              
+              <label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="0">
+                <span class="md-nav__icon md-icon"></span>
+              </label>
+            
+          </div>
         
         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_8">
@@ -3679,6 +3945,8 @@
           <ul class="md-nav__list" data-md-scrollfix>
             
               
+            
+              
                 
   
   
@@ -3712,6 +3980,34 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../project/sbom.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Software Bill of Materials
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../project/upgrade.html" class="md-nav__link">
         
@@ -3783,6 +4079,8 @@
       
         
       
+        
+      
         
       
     
@@ -3873,6 +4171,34 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../development/releases.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Branching & Releases
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     
     
       
@@ -3899,7 +4225,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10_3" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10_4" >
         
           
           <div class="md-nav__link md-nav__container">
@@ -3921,14 +4247,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_10_3" id="__nav_10_3_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_10_4" id="__nav_10_4_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_10_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_10_3">
+        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_10_4_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_10_4">
             <span class="md-nav__icon md-icon"></span>
             
   
@@ -4096,6 +4422,45 @@
     </span>
   </a>
   
+    <nav class="md-nav" aria-label="Configuration">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#format" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        :format
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#absolute_paths" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        :absolute_paths
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#multi-line-messages" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Multi-line messages
+      
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
         <li class="md-nav__item">
@@ -4107,6 +4472,56 @@
     </span>
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#ide-setup" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        IDE Setup
+      
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="IDE Setup">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#eclipse-cdt" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Eclipse CDT
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#vs-code" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        VS Code
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#clion" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        CLion
+      
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
     </ul>
@@ -4178,50 +4593,238 @@
 
 
 <h1 id="ide-test-suite-console-report">IDE Test Suite Console Report</h1>
-<p>Prints to the console ($stdout) test suite results with a test failure filepath and line number format understood by nearly any IDE.</p>
+<p>Prints test suite results to the console (<code>$stdout</code>), listing failed and ignored
+tests in a form IDEs read as problems.</p>
 <h2 id="plugin-overview">Plugin Overview</h2>
-<p>This plugin is intended to be used in place of the more commonly used "pretty" 
-test report plugin. Like its sibling, this plugin ollects raw test results from
-the individual test executables of your test suite and presents them in a more 
-readable summary form.</p>
-<p>The format of test results produced by this plugin is identical to its prettier
-sibling with one key difference — test failures are listed in such a way that 
-filepaths, line numbers, and test case function names can be easily parsed by 
-a typical IDE. The formatting of test failure messages uses a simple, defacto 
-standard of a sort recognized almost universally.</p>
-<p>The end result is that test failures in your IDE's build window can become 
-links that jump directly to failing test cases.</p>
+<p>This plugin replaces the more commonly used "pretty" test report plugin that defaults
+for command line use. Like its sibling, it collects raw test results from the test 
+executables of your test suite and prints them in summary form.</p>
+<p>The difference is how it lists failed and ignored tests. By default, each one
+prints in the shape of a GCC diagnostic. An IDE that reads GCC output turns each
+line into a problem that links to the test.</p>
+<p>Example:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>test/TestModel.c:21:1: error: testInitShouldCallSchedulerAndTemperatureFilterInit: Function TaskScheduler_Init() called more times than expected.
+</code></pre></div>
+<p>A failed test is an <code>error</code>. An ignored test is a <code>warning</code>. The line names the
+test file, the test’s line, the test case, and Unity’s message.</p>
+<p>Unity reports a line but no column, so the column is always <code>1</code>.</p>
+<p>Eclipse CDT, VS Code, and CLion all read this shape. So do many other IDEs and
+tools that understand GCC output, including ones not covered here.</p>
 <h2 id="setup">Setup</h2>
-<p>Enable the plugin in your project.yml by adding <code>report_tests_ide_stdout</code> to 
-the list of enabled plugins instead of any other <code>report_tests_*_stdout</code> 
-plugin.</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">:plugins</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">:enabled</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">report_tests_ide_stdout</span>
+<p>Enable the plugin in your project.yml by adding <code>report_tests_ide_stdout</code> to the
+list of enabled plugins instead of any other <code>report_tests_*_stdout</code> plugin.</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nt">:plugins</span><span class="p">:</span>
+<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w">  </span><span class="nt">:enabled</span><span class="p">:</span>
+<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">report_tests_ide_stdout</span>
 </code></pre></div>
 <h2 id="configuration">Configuration</h2>
-<p>No additional configuration is needed once the plugin is enabled.</p>
+<p>Two settings shape the report. Neither is required.</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="nt">:report_tests_ide_stdout</span><span class="p">:</span>
+<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w">  </span><span class="nt">:format</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">:gcc</span><span class="w">            </span><span class="c1"># Default</span>
+<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w">  </span><span class="nt">:absolute_paths</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">TRUE</span><span class="w">    </span><span class="c1"># No default. Each format sets its own path form.</span>
+</code></pre></div>
+<h3 id="format"><code>:format</code></h3>
+<p><code>:format</code> chooses how each failed and ignored test is listed.</p>
+<table>
+<thead>
+<tr>
+<th><code>:format</code></th>
+<th>Lines</th>
+<th>Paths unless <code>:absolute_paths</code> is set</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>:gcc</code></td>
+<td>GCC diagnostic shape (default)</td>
+<td>Relative</td>
+</tr>
+<tr>
+<td><code>:legacy</code></td>
+<td>The shape before Ceedling 1.2.0</td>
+<td>Relative</td>
+</tr>
+<tr>
+<td><code>:vscode</code></td>
+<td>Same as <code>:gcc</code></td>
+<td>Relative</td>
+</tr>
+<tr>
+<td><code>:eclipse</code></td>
+<td>Same as <code>:gcc</code></td>
+<td>Relative</td>
+</tr>
+<tr>
+<td><code>:clion</code></td>
+<td>Same as <code>:gcc</code></td>
+<td>Absolute and required</td>
+</tr>
+</tbody>
+</table>
+<p>Use <code>:gcc</code> with any tool that reads GCC output.</p>
+<p>The IDE names are shortcuts (other settings are not required when these aliases
+are used). Each stands for the <code>:gcc</code> settings that IDE needs. More names may be 
+added later.</p>
+<p>A format may be written as a symbol or a string, in any letter case.</p>
+<p><code>:legacy</code> restores the lines this plugin printed before Ceedling 1.2.0. Every line
+of a message repeats the file, line, and test case, and the message is quoted.</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>test/TestModel.c:21:testInitShouldCallSchedulerAndTemperatureFilterInit: &quot;Function TaskScheduler_Init() called more times than expected.&quot;
+</code></pre></div>
+<p>Few IDEs read <code>:legacy</code> lines as problems without extra configuration.</p>
+<h3 id="absolute_paths"><code>:absolute_paths</code></h3>
+<p>Paths are relative to your project’s root unless a format says otherwise. Set
+<code>:absolute_paths</code> to <code>TRUE</code> for full paths. Set it to <code>FALSE</code> for relative paths.</p>
+<p>When <code>:absolute_paths</code> is not set, each format’s own path form applies. When it is
+set, it overrides that path form, unless the named IDE cannot read the result.
+CLion’s output filters find only absolute paths. So <code>:clion</code> with
+<code>:absolute_paths: FALSE</code> stops the build with a configuration error.</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="nt">:report_tests_ide_stdout</span><span class="p">:</span>
+<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w">  </span><span class="nt">:format</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">:eclipse</span>
+<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="w">  </span><span class="nt">:absolute_paths</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">TRUE</span>
+</code></pre></div>
+<h3 id="multi-line-messages">Multi-line messages</h3>
+<p>The first line of a message goes on the test’s line. The remaining lines follow,
+indented four spaces. Your IDE shows one problem for the test, and the console
+keeps the whole message.</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>test/TestModel.c:30:1: error: testFilterShouldReset: Expected 5 Was 4
+<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>    Filter state at failure: RESET_PENDING
+</code></pre></div>
 <h2 id="example-output">Example Output</h2>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="w"> </span>&gt;<span class="w"> </span>ceedling<span class="w"> </span>test:Model
+<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="w"> </span>&gt;<span class="w"> </span>ceedling<span class="w"> </span>test:Model
+</code></pre></div>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>--------------------
+<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>IGNORED TEST SUMMARY
+<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a>--------------------
+<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a>test/TestModel.c:36:1: warning: testFilterShouldSettle: Awaiting new sensor driver
+<a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a>
+<a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a>-------------------
+<a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a>FAILED TEST SUMMARY
+<a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a>-------------------
+<a id="__codelineno-7-9" name="__codelineno-7-9" href="#__codelineno-7-9"></a>test/TestModel.c:21:1: error: testInitShouldCallSchedulerAndTemperatureFilterInit: Function TaskScheduler_Init() called more times than expected.
+<a id="__codelineno-7-10" name="__codelineno-7-10" href="#__codelineno-7-10"></a>
+<a id="__codelineno-7-11" name="__codelineno-7-11" href="#__codelineno-7-11"></a>--------------------
+<a id="__codelineno-7-12" name="__codelineno-7-12" href="#__codelineno-7-12"></a>OVERALL TEST SUMMARY
+<a id="__codelineno-7-13" name="__codelineno-7-13" href="#__codelineno-7-13"></a>--------------------
+<a id="__codelineno-7-14" name="__codelineno-7-14" href="#__codelineno-7-14"></a>TESTED:  3
+<a id="__codelineno-7-15" name="__codelineno-7-15" href="#__codelineno-7-15"></a>PASSED:  1
+<a id="__codelineno-7-16" name="__codelineno-7-16" href="#__codelineno-7-16"></a>FAILED:  1
+<a id="__codelineno-7-17" name="__codelineno-7-17" href="#__codelineno-7-17"></a>IGNORED: 1
+<a id="__codelineno-7-18" name="__codelineno-7-18" href="#__codelineno-7-18"></a>
+<a id="__codelineno-7-19" name="__codelineno-7-19" href="#__codelineno-7-19"></a>---------------------
+<a id="__codelineno-7-20" name="__codelineno-7-20" href="#__codelineno-7-20"></a>BUILD FAILURE SUMMARY
+<a id="__codelineno-7-21" name="__codelineno-7-21" href="#__codelineno-7-21"></a>---------------------
+<a id="__codelineno-7-22" name="__codelineno-7-22" href="#__codelineno-7-22"></a> • Unit test failures.
+</code></pre></div>
+<p>The Gcov, Bullseye, and Valgrind plugins print their test results through this
+plugin when it is enabled. Their failed and ignored tests are listed the same way.</p>
+<h2 id="ide-setup">IDE Setup</h2>
+<p>An IDE reads only output it captures. Run Ceedling from within the IDE, as a build,
+task, or tool, as each section below describes.</p>
+<h3 id="eclipse-cdt">Eclipse CDT</h3>
+<p>Eclipse CDT finds problems by matching build output against regular expressions.
+Its GCC error parser reads this plugin’s default lines.</p>
+<ol>
+<li>Use a Makefile project that runs Ceedling as its build. In <em>Project Properties</em> ↳
+   <em>C/C++ Build</em> ↳ <em>Builder Settings</em>, clear <em>Use default build command</em> and set the
+   build command to <code>ceedling</code>. On the <em>Behavior</em> tab, set the build target to
+   <code>test:all</code>.</li>
+<li>In <em>C/C++ Build</em> ↳ <em>Settings</em> ↳ <em>Error Parsers</em>, enable <em>GNU gcc/g++ Error Parser</em>.</li>
+<li>Build the project. Failed tests appear in the <em>Problems</em> view as errors, and
+   ignored tests as warnings.</li>
+</ol>
+<p>Eclipse reads output only from builds. Ceedling run in a terminal or as an
+external tool creates no Eclipse problems to be matched and linked.</p>
+<p>Eclipse checks a few special-purpose patterns before its error pattern. A failure
+message containing the words <em>required from</em> or <em>instantiated from</em> appears as
+information rather than an error.</p>
+<h3 id="vs-code">VS Code</h3>
+<p>VS Code reads problems from a task’s output through a problem matcher. The C/C++
+extension supplies a <code>$gcc</code> matcher that reads this plugin’s default lines.</p>
+<p>Add a task to <code>.vscode/tasks.json</code>:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="p">{</span>
+<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a><span class="w">  </span><span class="nt">&quot;version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2.0.0&quot;</span><span class="p">,</span>
+<a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a><span class="w">  </span><span class="nt">&quot;tasks&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
+<a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a><span class="w">    </span><span class="p">{</span>
+<a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a><span class="w">      </span><span class="nt">&quot;label&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Ceedling: test all&quot;</span><span class="p">,</span>
+<a id="__codelineno-8-6" name="__codelineno-8-6" href="#__codelineno-8-6"></a><span class="w">      </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;shell&quot;</span><span class="p">,</span>
+<a id="__codelineno-8-7" name="__codelineno-8-7" href="#__codelineno-8-7"></a><span class="w">      </span><span class="nt">&quot;command&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ceedling test:all&quot;</span><span class="p">,</span>
+<a id="__codelineno-8-8" name="__codelineno-8-8" href="#__codelineno-8-8"></a><span class="w">      </span><span class="nt">&quot;problemMatcher&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;$gcc&quot;</span><span class="p">,</span>
+<a id="__codelineno-8-9" name="__codelineno-8-9" href="#__codelineno-8-9"></a><span class="w">      </span><span class="nt">&quot;group&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;test&quot;</span>
+<a id="__codelineno-8-10" name="__codelineno-8-10" href="#__codelineno-8-10"></a><span class="w">    </span><span class="p">}</span>
+<a id="__codelineno-8-11" name="__codelineno-8-11" href="#__codelineno-8-11"></a><span class="w">  </span><span class="p">]</span>
+<a id="__codelineno-8-12" name="__codelineno-8-12" href="#__codelineno-8-12"></a><span class="p">}</span>
+</code></pre></div>
+<p>Without the C/C++ extension, give the task its own matcher:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="nt">&quot;problemMatcher&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
+<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="w">  </span><span class="nt">&quot;owner&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ceedling&quot;</span><span class="p">,</span>
+<a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="w">  </span><span class="nt">&quot;fileLocation&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;autoDetect&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;${workspaceFolder}&quot;</span><span class="p">],</span>
+<a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="w">  </span><span class="nt">&quot;pattern&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
+<a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="w">    </span><span class="nt">&quot;regexp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;^(.*?):(\\d+):(\\d+):\\s+(warning|error):\\s+(.*)$&quot;</span><span class="p">,</span>
+<a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a><span class="w">    </span><span class="nt">&quot;file&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
+<a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a><span class="w">    </span><span class="nt">&quot;line&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span>
+<a id="__codelineno-9-8" name="__codelineno-9-8" href="#__codelineno-9-8"></a><span class="w">    </span><span class="nt">&quot;column&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span>
+<a id="__codelineno-9-9" name="__codelineno-9-9" href="#__codelineno-9-9"></a><span class="w">    </span><span class="nt">&quot;severity&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span>
+<a id="__codelineno-9-10" name="__codelineno-9-10" href="#__codelineno-9-10"></a><span class="w">    </span><span class="nt">&quot;message&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span>
+<a id="__codelineno-9-11" name="__codelineno-9-11" href="#__codelineno-9-11"></a><span class="w">  </span><span class="p">}</span>
+<a id="__codelineno-9-12" name="__codelineno-9-12" href="#__codelineno-9-12"></a><span class="p">}</span>
 </code></pre></div>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>-------------------
-<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>FAILED TEST SUMMARY
-<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a>-------------------
-<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a>test/TestModel.c:21:testInitShouldCallSchedulerAndTemperatureFilterInit: &quot;Function TaskScheduler_Init() called more times than expected.&quot;
-<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a>
-<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a>--------------------
-<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a>OVERALL TEST SUMMARY
-<a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a>--------------------
-<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a>TESTED:  1
-<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a>PASSED:  0
-<a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a>FAILED:  1
-<a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a>IGNORED: 0
-<a id="__codelineno-2-13" name="__codelineno-2-13" href="#__codelineno-2-13"></a>
-<a id="__codelineno-2-14" name="__codelineno-2-14" href="#__codelineno-2-14"></a>---------------------
-<a id="__codelineno-2-15" name="__codelineno-2-15" href="#__codelineno-2-15"></a>BUILD FAILURE SUMMARY
-<a id="__codelineno-2-16" name="__codelineno-2-16" href="#__codelineno-2-16"></a>---------------------
-<a id="__codelineno-2-17" name="__codelineno-2-17" href="#__codelineno-2-17"></a> • Unit test failures.
+<p>This matcher reads relative paths against the workspace folder. If your project
+sits in a folder below the workspace’s root, use <code>:absolute_paths: TRUE</code> with
+either matcher.</p>
+<p>VS Code’s terminal also links <code>file:line:column</code> text. Lines printed by Ceedling
+in the integrated terminal can be clicked without any task.</p>
+<h4 id="ceedling-for-vs-code">Ceedling for VS Code</h4>
+<p>The <a href="https://marketplace.visualstudio.com/items?itemName=throw-the-switch.vscode-ceedling">Ceedling for VS Code</a> extension runs your test suite in VS
+Code’s <em>Testing</em> view. It reads test results from the
+<a href="report-tests-log-factory.html">Test Suite Report Log Factory</a> plugin’s <code>cppunit</code>
+report, so enable that plugin and report too (note that more recent versions of
+the extension enable this for you).</p>
+<p>The extension can also add this plugin’s lines to the <em>Problems</em> view. Its <code>gcc</code>
+preset scans only <code>$stderr</code>, and this report prints to <code>$stdout</code>. Give it patterns
+of its own that scan <code>$stdout</code>:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="nt">&quot;ceedlingExplorer.problemMatching&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
+<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="w">  </span><span class="nt">&quot;mode&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;patterns&quot;</span><span class="p">,</span>
+<a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a><span class="w">  </span><span class="nt">&quot;patterns&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
+<a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a><span class="w">    </span><span class="p">{</span>
+<a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a><span class="w">      </span><span class="nt">&quot;scanStdout&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
+<a id="__codelineno-10-6" name="__codelineno-10-6" href="#__codelineno-10-6"></a><span class="w">      </span><span class="nt">&quot;severity&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;error&quot;</span><span class="p">,</span>
+<a id="__codelineno-10-7" name="__codelineno-10-7" href="#__codelineno-10-7"></a><span class="w">      </span><span class="nt">&quot;filePrefix&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;${projectPath}&quot;</span><span class="p">,</span>
+<a id="__codelineno-10-8" name="__codelineno-10-8" href="#__codelineno-10-8"></a><span class="w">      </span><span class="nt">&quot;regexp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;^(.*):(\\d+):(\\d+):\\s+error:\\s+(.*)$&quot;</span><span class="p">,</span>
+<a id="__codelineno-10-9" name="__codelineno-10-9" href="#__codelineno-10-9"></a><span class="w">      </span><span class="nt">&quot;file&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
+<a id="__codelineno-10-10" name="__codelineno-10-10" href="#__codelineno-10-10"></a><span class="w">      </span><span class="nt">&quot;line&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span>
+<a id="__codelineno-10-11" name="__codelineno-10-11" href="#__codelineno-10-11"></a><span class="w">      </span><span class="nt">&quot;column&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span>
+<a id="__codelineno-10-12" name="__codelineno-10-12" href="#__codelineno-10-12"></a><span class="w">      </span><span class="nt">&quot;message&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span>
+<a id="__codelineno-10-13" name="__codelineno-10-13" href="#__codelineno-10-13"></a><span class="w">    </span><span class="p">},</span>
+<a id="__codelineno-10-14" name="__codelineno-10-14" href="#__codelineno-10-14"></a><span class="w">    </span><span class="p">{</span>
+<a id="__codelineno-10-15" name="__codelineno-10-15" href="#__codelineno-10-15"></a><span class="w">      </span><span class="nt">&quot;scanStdout&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
+<a id="__codelineno-10-16" name="__codelineno-10-16" href="#__codelineno-10-16"></a><span class="w">      </span><span class="nt">&quot;severity&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;warning&quot;</span><span class="p">,</span>
+<a id="__codelineno-10-17" name="__codelineno-10-17" href="#__codelineno-10-17"></a><span class="w">      </span><span class="nt">&quot;filePrefix&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;${projectPath}&quot;</span><span class="p">,</span>
+<a id="__codelineno-10-18" name="__codelineno-10-18" href="#__codelineno-10-18"></a><span class="w">      </span><span class="nt">&quot;regexp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;^(.*):(\\d+):(\\d+):\\s+warning:\\s+(.*)$&quot;</span><span class="p">,</span>
+<a id="__codelineno-10-19" name="__codelineno-10-19" href="#__codelineno-10-19"></a><span class="w">      </span><span class="nt">&quot;file&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
+<a id="__codelineno-10-20" name="__codelineno-10-20" href="#__codelineno-10-20"></a><span class="w">      </span><span class="nt">&quot;line&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span>
+<a id="__codelineno-10-21" name="__codelineno-10-21" href="#__codelineno-10-21"></a><span class="w">      </span><span class="nt">&quot;column&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span>
+<a id="__codelineno-10-22" name="__codelineno-10-22" href="#__codelineno-10-22"></a><span class="w">      </span><span class="nt">&quot;message&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span>
+<a id="__codelineno-10-23" name="__codelineno-10-23" href="#__codelineno-10-23"></a><span class="w">    </span><span class="p">}</span>
+<a id="__codelineno-10-24" name="__codelineno-10-24" href="#__codelineno-10-24"></a><span class="w">  </span><span class="p">]</span>
+<a id="__codelineno-10-25" name="__codelineno-10-25" href="#__codelineno-10-25"></a><span class="p">}</span>
 </code></pre></div>
+<p>These patterns also scan <code>$stderr</code>, as the extension’s patterns do by default, so
+compiler errors and warnings appear too.</p>
+<h3 id="clion">CLion</h3>
+<p>CLion links tool output to files through an External Tool’s output filters. Its
+filters find only absolute paths.</p>
+<ol>
+<li>Set <code>:format: :clion</code> in your project file.</li>
+<li>In <em>Settings</em> ↳ <em>Tools</em> ↳ <em>External Tools</em>, add a tool. Set <em>Program</em> to <code>ceedling</code>,
+   <em>Arguments</em> to <code>test:all</code>, and <em>Working directory</em> to <code>$ProjectFileDir$</code>.</li>
+<li>Under the tool’s <em>Advanced Options</em> ↳ <em>Output Filters</em>, add
+   <code>$FILE_PATH$:$LINE$:$COLUMN$.*</code>.</li>
+<li>Run the tool from <em>Tools</em> ↳ <em>External Tools</em>. Each failed and ignored test’s location
+   becomes a link in the Run window.</li>
+</ol>
+<p>CLion’s built-in test runner does not support Unity. For code insight, the
+<a href="compile-commands-json-db.html">Compile Commands JSON DB</a> plugin writes a compilation
+database that CLion can open as a project.</p>
 <p><br/><br/></p>