ceedling 1.1.5 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a54ad80f099a4117063db064305062de3ef308e0d6a34f5285ad616540c21239
-  data.tar.gz: aad1cd6bf73dc6710908593a9ec0c493404f13c1ecce8d7f285c2cd537b41b7f
+  metadata.gz: 6379bc5002c0b3bbd2f670bffcbaf91afba5c0b5a8ea5438b626f758d8144f8d
+  data.tar.gz: 9b1dec28ef0fb39d47b41fb868522a1398f0b055f74e877a4afc64009fdb7ac3
 SHA512:
-  metadata.gz: 0ee2a51402a1ca62a0e42f5c9c0b7cfb47871b4723fd33096ef22d90c0dc5ae7c7eb7944833e354a745c9d1123192ed6b92fb195537a8c9d69bd9c81e0330530
-  data.tar.gz: 2bfd96e070e2fa703f08e85587296690a930734a5eb409c709fd5bca2cd2875aa0b9eb8cb1dca9484852ab37ffc668f9d387fce1ed0c05fc90cd69507982dbcd
+  metadata.gz: d8db68c457e06b77007d1e954c4512a4c7e84abd13918546c31b5e05c4021e01e7ebafb5d3e85e0268d1742716e227d7860cdcc763f41f683c5d119f4841a998
+  data.tar.gz: 32ae8949567ae23bf7afff0deea71e66e06ea5dd6c56fcdde1dd561c5404020550ca9a65b11840f19ffde3a702fed80e73c2de03af0b8a1341490605a9b6b266

data/GIT_COMMIT_SHA

@@ -1 +1 @@
-57b6a98
+b1534f9

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.7** 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/assets/tests_with_conditional_includes/src/feature_config.h

@@ -0,0 +1,13 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#ifndef FEATURE_CONFIG_H
+#define FEATURE_CONFIG_H
+
+#define FEATURE_LEVEL (2)
+
+#endif // FEATURE_CONFIG_H

data/assets/tests_with_conditional_includes/src/feature_extra.h

@@ -0,0 +1,13 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#ifndef FEATURE_EXTRA_H
+#define FEATURE_EXTRA_H
+
+#define FEATURE_EXTRA_MACRO (7)
+
+#endif // FEATURE_EXTRA_H

data/assets/tests_with_conditional_includes/src/local_flag_extra.h

@@ -0,0 +1,13 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#ifndef LOCAL_FLAG_EXTRA_H
+#define LOCAL_FLAG_EXTRA_H
+
+#define LOCAL_FLAG_MACRO (11)
+
+#endif // LOCAL_FLAG_EXTRA_H

data/assets/tests_with_conditional_includes/src/nested_extra.h

@@ -0,0 +1,13 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#ifndef NESTED_EXTRA_H
+#define NESTED_EXTRA_H
+
+#define NESTED_MACRO (17)
+
+#endif // NESTED_EXTRA_H

data/assets/tests_with_conditional_includes/src/nested_wrapper.h

@@ -0,0 +1,16 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+/* widget.c includes this wrapper directly; nested_extra.h is only ever
+ * reached transitively through it, never named directly by widget.c. */
+
+#ifndef NESTED_WRAPPER_H
+#define NESTED_WRAPPER_H
+
+#include "nested_extra.h"
+
+#endif // NESTED_WRAPPER_H

data/assets/tests_with_conditional_includes/src/project_flag_extra.h

@@ -0,0 +1,13 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#ifndef PROJECT_FLAG_EXTRA_H
+#define PROJECT_FLAG_EXTRA_H
+
+#define PROJECT_FLAG_MACRO (13)
+
+#endif // PROJECT_FLAG_EXTRA_H

data/assets/tests_with_conditional_includes/src/widget.c

@@ -0,0 +1,48 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#include "widget.h"
+
+/* (a) Conditional include gated on a project-level :defines macro. */
+#ifdef PROJECT_FLAG
+#include "project_flag_extra.h"
+#endif
+
+#define LOCAL_FLAG (1)
+
+/* (b) Conditional include gated on a macro #define'd earlier in this same file. */
+#if LOCAL_FLAG
+#include "local_flag_extra.h"
+#endif
+
+/* (c) Reached only transitively, via nested_wrapper.h's own #include -- never
+ * itself named directly by this file. Must not appear as a duplicate,
+ * spuriously-promoted top-level #include in generated output. */
+#include "nested_wrapper.h"
+
+static int Widget__FromProjectFlag(void)
+{
+#ifdef PROJECT_FLAG
+    return PROJECT_FLAG_MACRO;
+#else
+    return 0;
+#endif
+}
+
+static int Widget__FromLocalFlag(void)
+{
+    return LOCAL_FLAG_MACRO;
+}
+
+static int Widget__FromNested(void)
+{
+    return NESTED_MACRO;
+}
+
+int Widget_FromProjectFlag(void) { return Widget__FromProjectFlag(); }
+int Widget_FromLocalFlag(void)   { return Widget__FromLocalFlag(); }
+int Widget_FromNested(void)      { return Widget__FromNested(); }

data/assets/tests_with_conditional_includes/src/widget.h

@@ -0,0 +1,15 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#ifndef WIDGET_H
+#define WIDGET_H
+
+int Widget_FromProjectFlag(void);
+int Widget_FromLocalFlag(void);
+int Widget_FromNested(void);
+
+#endif // WIDGET_H

data/assets/tests_with_conditional_includes/src/widget_feature.c

@@ -0,0 +1,29 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+/* Reproduces issue #1223: a conditional #include guarded by a macro defined
+ * in an EARLIER #include in this same file (as opposed to a project :defines
+ * macro or a same-file #define, both of which already work correctly -- see
+ * widget.c). Ceedling's bare-includes extraction pass runs against an
+ * isolated, sibling-free copy of this file and so never actually opens
+ * feature_config.h to learn FEATURE_LEVEL's value, evaluating the #if below
+ * as false and silently dropping feature_extra.h from the generated Partial
+ * even though FEATURE_LEVEL is genuinely > 1. */
+
+#include "widget_feature.h"
+#include "feature_config.h"     /* defines FEATURE_LEVEL (2) */
+
+#if FEATURE_LEVEL > 1
+#include "feature_extra.h"      /* defines FEATURE_EXTRA_MACRO */
+#endif
+
+static int WidgetFeature__FromFeatureLevel(void)
+{
+    return FEATURE_EXTRA_MACRO;
+}
+
+int WidgetFeature_FromFeatureLevel(void) { return WidgetFeature__FromFeatureLevel(); }

data/assets/tests_with_conditional_includes/src/widget_feature.h

@@ -0,0 +1,13 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#ifndef WIDGET_FEATURE_H
+#define WIDGET_FEATURE_H
+
+int WidgetFeature_FromFeatureLevel(void);
+
+#endif // WIDGET_FEATURE_H

data/assets/tests_with_conditional_includes/test/test_widget.c

@@ -0,0 +1,44 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+/* Partials pattern: TEST_PARTIAL_ALL_MODULE
+ * Exercises three #include-discovery scenarios that already work correctly
+ * without any source fix -- a regression guard locked in before touching
+ * the includes-discovery pipeline:
+ *   (a) conditional include gated on a project :defines macro
+ *   (b) conditional include gated on a same-file #define
+ *   (c) a header reached only transitively (never itself directly
+ *       #include'd by widget.c) correctly not duplicated in as a false
+ *       top-level entry */
+
+#include "unity.h"
+#include "ceedling.h"
+
+#include TEST_PARTIAL_ALL_MODULE(widget)
+
+void setUp(void)
+{
+}
+
+void tearDown(void)
+{
+}
+
+void test_FromProjectFlag_ReturnsProjectFlagMacro(void)
+{
+    TEST_ASSERT_EQUAL_INT(13, Widget__FromProjectFlag());
+}
+
+void test_FromLocalFlag_ReturnsLocalFlagMacro(void)
+{
+    TEST_ASSERT_EQUAL_INT(11, Widget__FromLocalFlag());
+}
+
+void test_FromNested_ReturnsNestedMacro(void)
+{
+    TEST_ASSERT_EQUAL_INT(17, Widget__FromNested());
+}

data/assets/tests_with_conditional_includes/test/test_widget_feature.c

@@ -0,0 +1,31 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+/* Partials pattern: TEST_PARTIAL_ALL_MODULE
+ * Regression test for #1223: without the fix, this fails to *compile* --
+ * FEATURE_EXTRA_MACRO is undeclared in the generated Partial implementation
+ * because feature_extra.h's conditional #include (guarded by a macro from
+ * an earlier #include in widget_feature.c) is silently dropped. See
+ * widget_feature.c for the full explanation. */
+
+#include "unity.h"
+#include "ceedling.h"
+
+#include TEST_PARTIAL_ALL_MODULE(widget_feature)
+
+void setUp(void)
+{
+}
+
+void tearDown(void)
+{
+}
+
+void test_FromFeatureLevel_ReturnsFeatureExtraMacro(void)
+{
+    TEST_ASSERT_EQUAL_INT(7, WidgetFeature__FromFeatureLevel());
+}

data/docs/Changelog.md

@@ -1,4 +1,4 @@
-p# 🌱 Ceedling Changelog
+# 🌱 Ceedling Changelog
 
 This format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
@@ -10,6 +10,35 @@ This changelog is complemented by three other documents:
 
 ---
 
+# [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
+
+- Latest patch releases of Unity, CMock, and CException.
+
+## 💪 Fixed
+
+- [#1223](https://github.com/ThrowTheSwitch/Ceedling/issues/1223) Fixed a conditional `#include` silently dropping out of generated code derived from preprocessed code, breaking compilation with an undeclared identifier error. The specific case involves a macro defined by another header included earlier in the same file.
+- [#1216](https://github.com/ThrowTheSwitch/Ceedling/issues/1216) Fixed self-test issue that caused docs-related failures when the local documentation was unavailable (generated in CI but not necessarily present during self tests).
+- [#1236](https://github.com/ThrowTheSwitch/Ceedling/issues/1236) Fixed an issue that converted system includes extracted from a test C file into user includes when generating a test runner (e.g. `#include <sys/stat.h>` became `#include "stat.h"`) and also stripped relative paths from all includes injected into a test runner.
+
+### Partials
+
+- [#1215](https://github.com/ThrowTheSwitch/Ceedling/issues/1215) Fixed `MOCK_PARTIAL_ALL_MODULE()`/`MOCK_PARTIAL_MODULE()` silently failing to partialize `inline` functions in some circumstances leading to duplicated symbols breaking compilation.
+
+---
+
 # [1.1.5] — 2026-08-19
 
 ## 💪 Fixed
@@ -254,6 +283,7 @@ When test preprocessing is enabled, Ceedling discovers whether your toolchain su
 
 ## 👋 Removed
 
+- `:use_deep_preprocessor` was a short-lived workaround option added after 1.0.0 for certain preprpocessing limitations. Those limitations are fully resolved, and test preprocessor options are now only `:use_test_preprocessor` and `:preprocess_force_fallback`. The latter should rarely be needed, leaving only the former as the only preprocessing feature toggle in Ceedling.
 - _CeedlingPacket.md_ user manual (superseded by [new documentation site](https://throwtheswitch.github.io/Ceedling/) and local bundle).
 - _PluginDevelopmentGuide.md_ (superseded by [new documentation site](https://throwtheswitch.github.io/Ceedling/) and local bundle).
 

data/docs/KnownIssues.md

@@ -29,6 +29,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/