ceedling 1.1.6 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d99664eb478b97c839d72985434b355644836056256cd574d9d0868e7ece0f2d
-  data.tar.gz: c82999e6fe6a8eb48a3c3f33031453af444c4ef0fc98bb0be554879d6b6e6072
+  metadata.gz: 3c1edc565bc9fcb24accc9fd0d5001076fe86564cb0acd02c7d1fc092476c2c1
+  data.tar.gz: 0c5ec0119bc3249824177c6094afd3e3ef9ee7da698b92fed894924d45d83625
 SHA512:
-  metadata.gz: 2464ee642f445988fdf76aff593d659f6c41da9c5e8a78431d17c690383fa84d21141fd0335d5737a9827cd04e48a956aa18c44f32348084e1b1d7055a4bdecd
-  data.tar.gz: a3251efd857f8314fdcef2f7e743d056d3aca42f76e01455f58b2c1caa7730aae1ca199c7c21bdc812ab2f50cbe4314be7f64c1ea56589ba2fbd4924a29b0e0a
+  metadata.gz: 6efc0307567637d4019978131f45758d694b97ea93a4a7ada5ff6be8c682d70eff9d8d453de4882cc46344bb1b0aa098dbf7982582a7d7a168818caba2bd7e51
+  data.tar.gz: 6366fddeaff5572f317efffb161ff64378cae4e6b2dea30aa11f3baf4aac1777611331483d071a080cb9a01aa1e4087409d5314559881ae0a12ce753a1f86311

data/GIT_COMMIT_SHA

@@ -1 +1 @@
-4a45278
+885dc91

data/Gemfile

@@ -15,6 +15,10 @@ gem "rake", ">= 12", "< 14"
 gem "rr"
 gem "require_all"
 
+# `rexml` has been removed from the default gems in some Ruby versions -- needed
+# explicitly by the gcov Partials system-test cases, which parse gcovr's XML output.
+gem "rexml"
+
 # Ceedling dependencies
 gem "diy", "~> 1.1"
 gem "constructor", "~> 2"

data/Gemfile.lock

@@ -11,6 +11,7 @@ GEM
     parallel (1.28.0)
     rake (13.2.1)
     require_all (3.0.0)
+    rexml (3.4.4)
     rr (3.1.2)
     rspec (3.13.2)
       rspec-core (~> 3.13.0)
@@ -48,6 +49,7 @@ DEPENDENCIES
   parallel (~> 1.26)
   rake (>= 12, < 14)
   require_all
+  rexml
   rr
   rspec (~> 3.8)
   thor (~> 1.3)

data/README.md

@@ -1,7 +1,7 @@
 Ceedling ![CI](https://github.com/ThrowTheSwitch/Ceedling/workflows/CI/badge.svg)
 ========
 
-**Ceedling 1.1.5** is the latest and greatest.
+**Ceedling 1.1.8** is the latest and greatest.
 
 See [_Release Notes_][release-notes], [_Changelog_](docs/Changelog.md), 
 [_Breaking Changes_][breaking-changes], and [_Known Issues_][known-issues].
@@ -101,6 +101,9 @@ awesomeness in the C language.
 1. **[CMock]**<sup>†</sup>, a code generating, 
    [function mocking & stubbing][test-doubles] kit for interaction-based testing.
 
+If you are a Visual Studio Code user, you may also be interested in the
+[Ceedling extension](https://marketplace.visualstudio.com/items?itemName=throw-the-switch.vscode-ceedling).
+
 <sup>†</sup> Through a [plugin][FFF-plugin], Ceedling also supports [FFF] for 
 [fake functions][test-doubles] as an alternative to CMock’s mocks and stubs.
 

data/docs/Changelog.md

@@ -10,6 +10,47 @@ This changelog is complemented by three other documents:
 
 ---
 
+# [1.1.8] — 2026-09-10
+
+## 💪 Fixed
+
+- Fixed a crashed test case in a parameterized group occasionally being misattributed to a different, shorter-named test case in the same group whose name happened to be a substring of the one actually named in the crash backtrace.
+- Fixed a test case's line number occasionally being misattributed to an unrelated helper function whose name merely contained the test's name as a substring, cascading incorrect line numbers to every test case after it in the same file.
+
+### Partials
+
+- [#1262](https://github.com/ThrowTheSwitch/Ceedling/issues/1262) Fixed a Partials-generated header occasionally concatenating two adjacent `#define` lines in one line causing a stray '#' compilation error. The triggering condition involved a `//` or `/* */` comment containing an apostrophe or quote (e.g. `// Don't ...`) that disrupted string literal handling.
+
+### Preprocessing
+
+- [#1266](https://github.com/ThrowTheSwitch/Ceedling/issues/1266) Fixed a reconstructed header silently dropping any macro whose name or value merely contained the header's own include guard as a substring (e.g. guard `RTC_H` matching inside `RTC_HOUR_SECONDS`), causing undeclared-identifier compile errors.
+- [#1268](https://github.com/ThrowTheSwitch/Ceedling/issues/1268) Fixed a mockable header's `#include` losing the enums, structs, and function prototypes of a conditionally-included file when that `#include` was indented inside its `#ifdef` block, causing undeclared-identifier compile errors.
+
+### Gcov plugin
+
+- Fixed `:gcov ↳ :gcovr ↳ :decisions` reporting an incorrect minimum-version requirement; the version check (and docs) now correctly require `gcovr` 5.1 or higher.
+- Fixed `:gcov ↳ :gcovr ↳ :fail_under_line`/`:fail_under_branch`/`:fail_under_decision`/`:fail_under_function` silently accepting `0`, contradicting the documented 1–100 range; `0` is now rejected.
+- Fixed `:gcov ↳ :gcovr ↳ :object_directory` and `:source_encoding` values containing a space breaking the constructed `gcovr` command line; both are now quoted consistently with every other string-valued option.
+- Fixed a regex-metacharacter-injection risk (e.g. a literal `.`) in `:gcov ↳ :gcovr`'s and `:gcov ↳ :report_generator`'s auto-generated exclusion patterns in `:test_file_prefix`, `:mock_prefix`, or the build root path could silently over- or under-match files.
+- Fixed `:gcov ↳ :mcdc` triggering a `gcc --version` check (and a potential build-breaking exception for an older compiler) on every build in which a project enables the Gcov plugin, not only `gcov:` builds.
+- Fixed only the first of multiple simultaneously violated `:gcov ↳ :gcovr ↳ :fail_under_*` thresholds being reported when a build-breaking exception is raised; every violated threshold is now listed.
+- Fixed a latent mutation risk in `:gcov ↳ :report_generator` option handling that could accumulate stale exclusion patterns across repeated report-generation calls within a single run.
+- `:gcov ↳ :gcovr ↳ :branches`/`:sort_uncovered`/`:sort_percentage` now use `gcovr`'s renamed `--txt-metric branch`/`--sort uncovered-number`/`--sort uncovered-percent` flags on `gcovr` 7.0+, silencing `gcovr`'s deprecation warnings for those options. The pre-7.0 flag names are still used automatically with older `gcovr`.
+- Fixed the Gcov console summary silently producing no report and no log line at all for a Partial-implementation source whose `gcov` output couldn't be matched. It now logs the same "Found no coverage results" message the equivalent non-Partial case already did.
+
+---
+
+# [1.1.7] — 2026-09-03
+
+## 💪 Fixed
+
+- [#1251](https://github.com/ThrowTheSwitch/Ceedling/issues/1251) Fixed _Overall Test Summary_ not printing at logging verbosity of warning or error level on an otherwise all-passing test run.
+- [#1252](https://github.com/ThrowTheSwitch/Ceedling/issues/1252) Fixed the Gcov plugin requiring `gcovr` to be installed for any build merely because the plugin was enabled, rather than only when a `gcov:` build actually runs.
+- [#1080](https://github.com/ThrowTheSwitch/Ceedling/issues/1080) Fixed `:gcov ↳ :gcovr ↳ :fail_under_decision` failing every `gcov:` build outright — `gcovr` itself requires `--decisions` alongside `--fail-under-decision`, which Ceedling never supplied. A new `:decisions` option is also available directly. Each now reports a clear error if configured against a `gcovr` too old to support it (6.0 for `:decisions`, 7.0 for `:fail_under_decision`).
+- Fixed a Unity `TEST_IGNORE_MESSAGE()` test case being misreported as crash evidence during crash-diagnosis retries when it shares a test file with a genuine crash.
+
+---
+
 # [1.1.6] — 2026-08-25
 
 ## 🌟 Added

data/docs/KnownIssues.md

@@ -20,6 +20,8 @@ Known issues are complemented by three other documents:
 1. While header file search paths are now customizable per executable, this currently only applies to the search paths the compiler uses. Distinguishing test files or header files of the same name in different directories for test runner and mock generation respectively continues to rely on educated guesses in Ceedling code.
 1. All header files needed for test compilation must be within the `:includes` path collection. Relative paths in include directives that extend outside the path collection will cause build problems.
 1. Any path for a C file specified with `TEST_SOURCE_FILE(...)` is in relation to **_project root_** — that is, from where you execute `ceedling` at the command line. If you move source files or change your directory structure, many of your `TEST_SOURCE_FILE(...)` calls may need to be updated. A more flexible and dynamic approach to path handling will come in a future update.
+1. In certain combinations of conditional preprocessing blocks with dependent symbols defined in another file, Ceedling can silently fail to extract computed includes (e.g. `#include SOME_MACRO()`).
+1. User includes (`#include "path/user.h"`) from source C files lose their relative path when Partial and mock header files are generated from source. Compilation failures can result from certain uncommon cases involving headers of the same names in different directories and a source file including both such headers.
 1. The Bullseye code coverage plugin has been temporarily disabled as of 1.0.0. The makers of Bullseye have generously provided a license for development, and the plugin will be available in the next minor release.
 
 ---
@@ -29,6 +31,7 @@ Known issues are complemented by three other documents:
 1. The new internal pipeline that allows builds to be parallelized and configured per-test-executable can mean a fair amount of duplication of steps. A header file may be mocked identically multiple times. The same source file may be compiled identically multiple times. The speed gains due to parallelization help make up for this. Future releases will concentrate on optimizing away duplication of build steps.
 1. While header file search paths are now customizable per executable, this currently only applies to the search paths the compiler uses. Distinguishing test files or header files of the same name in different directories for test runner and mock generation respectively continues to rely on educated guesses in Ceedling code.
 1. All header files needed for test compilation must be within the `:includes` path collection. Relative paths in include directives that extend outside the path collection will cause build problems.
+1. C locales and non-ASCII characters (e.g. ©️ in a comment block) can cause parsing failures. 
 1. System header includes `#include <system.h>` may not be properly distinguished from user includes `#include "user.h"` in many test preprocessing scenarios.
 1. Any path for a C file specified with `TEST_SOURCE_FILE(...)` is in relation to **_project root_** — that is, from where you execute `ceedling` at the command line. If you move source files or change your directory structure, many of your `TEST_SOURCE_FILE(...)` calls may need to be updated. A more flexible and dynamic approach to path handling will come in a future update.
 1. Ceedling’s many test preprocessing improvements are not presently able to preserve Unity’s special `TEST_CASE()` and `TEST_RANGE()` features. However, preprocessing of test files is much less frequently needed than preprocessing of mockable header files. Test preprocessing can now be configured to enable only one or the other. As such, these advanced Unity features can still be used in even sophisticated projects.

data/docs/mkdocs/configuration/project-file.md

@@ -8,11 +8,21 @@
 
 ## Some YAML Learnin’
 
-Please consult YAML documentation for the finer points of format
-and to understand details of our YAML-based configuration file.
-
 We recommend [Wikipedia’s entry on YAML](http://en.wikipedia.org/wiki/Yaml)
-for this. A few highlights from that reference page:
+and [educative.io’s advanced YAML cheatsheet](https://www.educative.io/blog/advanced-yaml-syntax-cheatsheet)
+for a simple overview of YAML and its syntax sufficient for 
+understanding your Ceedling project configuration.
+
+!!! tip "`ceedling dumpconfig` to verify your YAML"
+    Ceedling provides a means to export the final result of YAML
+    processing for your inspection via [`dumpconfig`](../getting-started/command-line.md#ceedling-dumpconfig-filepath-sections).
+    Dump output includes the resolution of advanced YAML features and 
+    Ceedling’s own manipulations. This is a good way to troubleshoot 
+    your project configuration.
+
+### YAML highlights & overview
+
+A few points from the preceding references:
 
 * YAML streams are encoded using the set of printable Unicode
   characters, either in UTF-8 or UTF-16.
@@ -40,9 +50,17 @@ for this. A few highlights from that reference page:
   punctuation can generally be represented without needing
   to be enclosed in quotes.
 
-* Repeated nodes are initially denoted by an ampersand (`&`) and
-  thereafter referenced with an asterisk (`*`). These are known as
-  anchors and aliases in YAML speak.
+### YAML anchors, aliases, and extensions
+
+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.
+
+See this [cheatsheet entry](https://www.educative.io/blog/advanced-yaml-syntax-cheatsheet#anchors) 
+and [this guide](https://blog.daemonl.com/2016/02/yaml.html)
+for much more on these powerful but finicky features.
 
 ## Notes on Project File Structure
 

data/docs/mkdocs/configuration/reference/cexception.md

@@ -2,7 +2,7 @@
 
 **Configure CException’s features**
 
-## Exmaple `:cmock` YAML
+## Example `:cmock` YAML
 
 ```yaml
 :cexception:

data/docs/mkdocs/configuration/reference/cmock.md

@@ -6,7 +6,7 @@ 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 [CMock documentation][cmock-docs].
 
-## Exmaple `:cmock` YAML
+## Example `:cmock` YAML
 
 ```yaml
 :cmock:

data/docs/mkdocs/configuration/reference/unity.md

@@ -2,7 +2,7 @@
 
 **Configure Unity’s features**
 
-## Exmaple `:unity` YAML
+## Example `:unity` YAML
 
 ```yaml
 :unity:

data/docs/mkdocs/getting-started/quick-start.md

@@ -36,6 +36,11 @@ 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.
 
+!!! warning "C toolchain requirement"
+    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 [GCC] out of the box (we recommend [MinGW] on Windows).
+
 1. [Install Ceedling](installation.md)
 1. Create a project
     * Use Ceedling to generate an example project (see next section), or
@@ -46,15 +51,13 @@ listed immediately below.
         1. Create a Ceedling project file in the root of your project directory.
 1. Run Ceedling tasks (see next section) from the working directory of your project.
 
-!!! note
-    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 [GCC] out of the box (we recommend the [MinGW] project 
-    on Windows).
+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 
+[here][overview]).
 
-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 [here][overview]).
+!!! tip "Ceedling VS Code extension"
+    If you are a Visual Studio Code user, you may want to install the
+    [Ceedling extension](https://marketplace.visualstudio.com/items?itemName=throw-the-switch.vscode-ceedling).
 
 [GCC]: https://gcc.gnu.org
 [MinGW]: http://www.mingw.org/