ceedling 1.1.10 → 1.2.1

data/assets/fixtures/tests_with_conditional_mocks/test/test_Case_02.c

@@ -0,0 +1,31 @@
+#include "unity.h"
+#include "mock_MyModuleConfig.h"
+
+// Issue #1083: MyModuleConfig.h, reached only through its mock, decides which module
+// mocks this test needs
+#ifdef MODULE_1_ENABLED
+#include "mock_MyModulePart1.h"
+#endif
+
+#ifdef MODULE_2_ENABLED
+#include "mock_MyModulePart2.h"
+#endif
+
+#include "Case_02.h"
+
+void test_function_sums_the_enabled_modules(void)
+{
+  int expected = 1;
+
+  Module0_FunctionToCall_ExpectAndReturn( 1 );
+#ifdef MODULE_1_ENABLED
+  Module1_FunctionToCall_ExpectAndReturn( 2 );
+  expected += 2;
+#endif
+#ifdef MODULE_2_ENABLED
+  Module2_FunctionToCall_ExpectAndReturn( 4 );
+  expected += 4;
+#endif
+
+  TEST_ASSERT_EQUAL( expected, FunctionToTest( 0 ) );
+}

data/assets/fixtures/tests_with_conditional_mocks/test/test_FeatureConfig.c

@@ -0,0 +1,15 @@
+#include "unity.h"
+#include "FeatureConfig.h"
+
+void test_always_runs(void)
+{
+  TEST_PASS();
+}
+
+// The header alone decides whether this test case exists
+#ifdef FEATURE_X
+void test_feature_x_runs_when_enabled(void)
+{
+  TEST_PASS();
+}
+#endif

data/assets/fixtures/tests_with_conditional_mocks/test/test_reader.c

@@ -0,0 +1,13 @@
+#include "unity.h"
+#include "reader.h"
+
+// A macro names the mock, so only the preprocessor sees this #include
+#define WIDGET_MOCK "mock_widget.h"
+#include WIDGET_MOCK
+
+void test_reader_returns_the_widget_reading(void)
+{
+  widget_read_ExpectAndReturn( 7 );
+
+  TEST_ASSERT_EQUAL( 7, reader() );
+}

data/assets/fixtures/tests_with_duplicate_test_names/integration/test_foo.c

@@ -0,0 +1,21 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#include "unity.h"
+
+void setUp(void)
+{
+}
+
+void tearDown(void)
+{
+}
+
+void test_this_is_the_integration_directory_test_foo(void)
+{
+  TEST_ASSERT_EQUAL(2, 2);
+}

data/assets/fixtures/tests_with_duplicate_test_names/unit/test_foo.c

@@ -0,0 +1,21 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#include "unity.h"
+
+void setUp(void)
+{
+}
+
+void tearDown(void)
+{
+}
+
+void test_this_is_the_unit_directory_test_foo(void)
+{
+  TEST_ASSERT_EQUAL(1, 1);
+}

data/assets/fixtures/tests_with_fallback_conditionals/src/conditional_module.c

@@ -0,0 +1,28 @@
+/* =========================================================================
+ * Conditional Module implementation — © 2024 résumé.
+ * ========================================================================= */
+
+#include "conditional_module.h"
+
+/* Include optional dependency only when feature enabled — naïve guard. */
+#ifdef CONDITIONAL_FEATURE
+#include "optional_dep.h"
+#endif
+
+void ConditionalModule_Init(void)
+{
+  /* Call optional dep only when feature active — Ünïcödé-safe comment. */
+#ifdef CONDITIONAL_FEATURE
+  OptionalDep_DoWork();
+
+  /* Regression coverage for a compound `#if defined(A) && defined(B)` condition
+   * in fallback mode. NEVER_DEFINED_FEATURE is never defined by any test config
+   * for this fixture. A misparse that evaluates only the first macro name (A)
+   * instead of falling through to the conservative "complex expression ->
+   * active" treatment would read this line as `defined(NEVER_DEFINED_FEATURE)`
+   * alone -- always false -- and wrongly exclude this call from the partial. */
+#if defined(NEVER_DEFINED_FEATURE) && defined(CONDITIONAL_FEATURE)
+  OptionalDep_DoWork();
+#endif
+#endif
+}

data/assets/{tests_with_fallback_conditionals → fixtures/tests_with_fallback_conditionals}/test/test_conditionals.c

@@ -29,10 +29,17 @@ void tearDown(void)
 {
 }
 
-/* Test with feature enabled: partial includes OptionalDep_DoWork() call — naïve test. */
+/* Test with feature enabled: partial includes OptionalDep_DoWork() call — naïve test.
+ * Two expected calls, not one: conditional_module.c's ConditionalModule_Init() has a
+ * second, compound-guarded `#if defined(NEVER_DEFINED_FEATURE) && defined(CONDITIONAL_FEATURE)`
+ * call to OptionalDep_DoWork() alongside the plain `#ifdef CONDITIONAL_FEATURE` one.
+ * NEVER_DEFINED_FEATURE is never defined by any test config here -- a misparse
+ * reading only the first macro name would evaluate that compound condition as
+ * inactive (excluding the second call) instead of conservatively active. */
 #ifdef CONDITIONAL_FEATURE
 void test_init_calls_optional_dep(void)
 {
+  OptionalDep_DoWork_Expect();
   OptionalDep_DoWork_Expect();
   ConditionalModule_Init();
 }

data/assets/fixtures/tests_with_multiple_assembly_extensions/src/asm_helper_lower.s

@@ -0,0 +1,2 @@
+.globl asm_helper_lower_marker
+asm_helper_lower_marker:

data/assets/fixtures/tests_with_multiple_assembly_extensions/src/asm_helper_upper.S

@@ -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
+========================================================================= */
+
+/* Deliberately empty of real instructions -- this file exists only to prove
+   Ceedling discovers and compiles an uppercase `.S` assembly file alongside
+   a lowercase `.s` sibling under one shared :extension -> :assembly setting. */
+
+.globl asm_helper_upper_marker
+asm_helper_upper_marker:

data/assets/fixtures/tests_with_multiple_assembly_extensions/src/counter_module.c

@@ -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
+========================================================================= */
+
+#include "counter_module.h"
+
+int CounterModule_GetValue(void)
+{
+  return 42;
+}

data/assets/fixtures/tests_with_multiple_assembly_extensions/src/counter_module.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 _COUNTER_MODULE_H
+#define _COUNTER_MODULE_H
+
+int CounterModule_GetValue(void);
+
+#endif // _COUNTER_MODULE_H

data/assets/fixtures/tests_with_multiple_assembly_extensions/test/test_counter_module.c

@@ -0,0 +1,27 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#include "unity.h"
+#include "counter_module.h"
+
+// Neither assembly file has a corresponding header, so Ceedling's usual naming-convention
+// pickup doesn't apply -- TEST_SOURCE_FILE() is what pulls each into this executable's build.
+TEST_SOURCE_FILE("asm_helper_lower.s")
+TEST_SOURCE_FILE("asm_helper_upper.S")
+
+void setUp(void)
+{
+}
+
+void tearDown(void)
+{
+}
+
+void test_GetValue_should_return_expected_constant(void)
+{
+  TEST_ASSERT_EQUAL(42, CounterModule_GetValue());
+}

data/assets/fixtures/tests_with_subdir_includes/src/module/app/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 APP_CONFIG_H
+#define APP_CONFIG_H
+
+#define APP_MAGIC 5
+
+#endif // APP_CONFIG_H

data/assets/fixtures/tests_with_subdir_includes/src/module/drivers/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 DRIVERS_CONFIG_H
+#define DRIVERS_CONFIG_H
+
+#define DRIVER_MAGIC 3
+
+#endif // DRIVERS_CONFIG_H

data/assets/fixtures/tests_with_subdir_includes/src/module/sensor.c

@@ -0,0 +1,30 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+/* Three headers here all share the basename config.h -- drivers/config.h,
+ * app/config.h (both subdirectories of this file's own directory), and
+ * ../shared/config.h (reached only via a `..`-relative directive, resolving up
+ * to src/shared/config.h). Every configured Ceedling search path already
+ * covers each of their containing directories individually (src/** is
+ * recursive), so a compile succeeding proves the generated Partial file's own
+ * #include lines carried each one's real, disambiguating path -- collapsing
+ * any two of the three to a bare "config.h" leaves at least one of
+ * DRIVER_MAGIC/APP_MAGIC/SHARED_MAGIC undeclared, a guaranteed compile error
+ * regardless of which file a bare, ambiguous "config.h" happened to resolve
+ * to first. */
+
+#include "sensor.h"
+#include "drivers/config.h"
+#include "app/config.h"
+#include "../shared/config.h"
+
+static int Sensor__ReadScaled(void)
+{
+    return SHARED_MAGIC * (DRIVER_MAGIC ^ APP_MAGIC);
+}
+
+int Sensor_ReadScaled(void) { return Sensor__ReadScaled(); }

data/assets/fixtures/tests_with_subdir_includes/src/module/sensor.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 SENSOR_H
+#define SENSOR_H
+
+int Sensor_ReadScaled(void);
+
+#endif // SENSOR_H

data/assets/fixtures/tests_with_subdir_includes/src/shared/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 SHARED_CONFIG_H
+#define SHARED_CONFIG_H
+
+#define SHARED_MAGIC 7
+
+#endif // SHARED_CONFIG_H

data/assets/fixtures/tests_with_subdir_includes/test/test_sensor.c

@@ -0,0 +1,32 @@
+/* =========================================================================
+    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
+ * End-to-end proof that the generated Partial implementation file for sensor.c
+ * carries each of its three same-basename config.h #includes with its own real,
+ * disambiguating path -- a nested subdirectory (drivers/config.h, app/config.h)
+ * and a `..`-relative one (../shared/config.h, resolved to src/shared/config.h).
+ * See sensor.c for why any two of the three colliding on a bare "config.h"
+ * guarantees a compile error rather than merely a wrong runtime value. */
+
+#include "unity.h"
+#include "ceedling.h"
+
+#include TEST_PARTIAL_ALL_MODULE(sensor)
+
+void setUp(void)
+{
+}
+
+void tearDown(void)
+{
+}
+
+void test_ReadScaled_ReturnsExpectedValue(void)
+{
+    TEST_ASSERT_EQUAL_INT(42, Sensor_ReadScaled());
+}

data/bin/actionator.rb

@@ -0,0 +1,234 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+require 'ceedling/constants'
+require 'ceedling/exceptions'
+
+# Actionator performs the file operations behind `ceedling new`, `ceedling example`,
+# `ceedling upgrade`, and the vendoring of Ceedling into a project. It replaces the
+# narrow slice of Thor::Actions that Ceedling used, reached previously through an
+# ActionsWrapper mixin.
+#
+# Thor::Actions was dropped to remove the `erb` gem as a Ceedling dependency.
+# Thor loads `erb` at require time for its own template action, which Ceedling never
+# called. Thor itself remains Ceedling's CLI framework. Only the Actions mixin is gone.
+#
+# Status line output is deliberately byte-compatible with what Thor::Actions emitted,
+# so upgrading Ceedling does not change the appearance of these commands. The one
+# intentional difference is the policy deciding whether to colorize. Thor consulted
+# the stream and the TERM and NO_COLOR environment variables. Actionator consults
+# Ceedling's own decorator policy, which honors CEEDLING_DECORATORS, and additionally
+# requires a terminal so redirected output stays free of escape sequences.
+#
+# Two Thor behaviors are deliberately not reproduced. Thor prompted on stdin when a
+# destination file existed with differing content and neither force nor skip was
+# given, which would hang a build. Actionator raises instead. Thor also interpolated
+# `%method%` sequences found in destination paths by calling the named method.
+# Destination paths here are user-supplied project names, so that behavior is a
+# hazard rather than a feature.
+class Actionator
+
+  constructor :file_wrapper, :loginator
+
+  JUNK_FILE_EXCLUDE_REGEX = /(\.DS_Store)|(thumbs\.db)/
+
+  BOLD  = "\e[1m"
+  CLEAR = "\e[0m"
+
+  # Thor's own verb-to-color assignments, preserved so status lines are unchanged.
+  VERB_COLORS = {
+    :create    => "\e[32m", # green
+    :exist     => "\e[34m", # blue
+    :identical => "\e[34m", # blue
+    :force     => "\e[33m", # yellow
+    :remove    => "\e[31m", # red
+    :chmod     => "\e[32m", # green
+    :gsub      => "\e[32m", # green
+  }.freeze
+
+  # Width Thor right-justified its status verbs to, followed by a two space gutter.
+  VERB_WIDTH = 12
+
+  attr_accessor :source_root, :destination_root
+
+  # Captured once rather than read per call. A later Dir.chdir must not change how
+  # relative destinations resolve or how status line paths are shortened partway
+  # through a command.
+  def setup
+    @source_root = nil
+    @destination_root = @file_wrapper.get_expanded_path( '.' )
+  end
+
+
+  def copy_file(source, destination, force: false, verbose: true)
+    src  = resolve_source( source )
+    dest = resolve_destination( destination )
+
+    if !@file_wrapper.exist?( dest )
+      write_file( src, dest )
+      status( :create, dest, verbose )
+      return
+    end
+
+    if @file_wrapper.compare( src, dest )
+      status( :identical, dest, verbose )
+      return
+    end
+
+    unless force
+      raise CeedlingException.new(
+        "Refusing to overwrite differing file #{relative_destination( dest )} without force"
+      )
+    end
+
+    status( :force, dest, verbose )
+    write_file( src, dest )
+  end
+
+
+  def copy_directory(source, destination, force: false, verbose: true,
+                     exclude_pattern: JUNK_FILE_EXCLUDE_REGEX)
+    # Trailing separators arrive from the vendored component paths in cli_helper.
+    # They would otherwise survive into the glob and into the rebasing below.
+    src  = resolve_source( source ).sub( /\/+\z/, '' )
+    dest = resolve_destination( destination )
+
+    # Thor reported the destination directory itself ahead of its contents.
+    make_directory( dest, verbose: verbose )
+
+    # FileWrapper#directory_listing does not escape glob metacharacters, and a
+    # Ceedling install path can contain them. See issue #104.
+    listing = @file_wrapper.directory_listing( File.join( escape_globs( src ), '**', '*' ) )
+
+    listing.each do |entry|
+      next if @file_wrapper.directory?( entry )
+      next if entry.match( exclude_pattern )
+
+      copy_file( entry, rebase( entry, src, dest ), force: force, verbose: verbose )
+    end
+  end
+
+
+  def make_directory(destination, verbose: true)
+    dest = resolve_destination( destination )
+    existed = @file_wrapper.exist?( dest )
+
+    @file_wrapper.mkdir( dest ) unless existed
+    status( existed ? :exist : :create, dest, verbose )
+  end
+
+
+  # Reports before testing for existence, matching Thor. The upgrade path removes a
+  # vendor directory that legitimately may not be there, and its output has always
+  # named the directory either way.
+  def remove_directory(path, verbose: true)
+    dest = resolve_destination( path )
+
+    status( :remove, dest, verbose )
+    @file_wrapper.rm_rf( dest ) if @file_wrapper.exist?( dest )
+  end
+
+
+  # Prints nothing. This never went through Thor, so it never produced a status line.
+  def touch_file(path)
+    @file_wrapper.touch( path )
+  end
+
+
+  def chmod(path, mode, verbose: true)
+    dest = resolve_destination( path )
+
+    status( :chmod, dest, verbose )
+    @file_wrapper.chmod( dest, mode )
+  end
+
+
+  # Does not raise when the pattern matches nothing, matching Thor's non-bang
+  # variant. Both call sites stamp conditionally, so no match is a legitimate result.
+  def gsub_file(path, pattern, replacement, verbose: true)
+    dest = resolve_destination( path )
+
+    status( :gsub, dest, verbose )
+
+    contents = @file_wrapper.read_binary( dest )
+    @file_wrapper.write( dest, contents.gsub( pattern, replacement ), 'wb' )
+  end
+
+  ### Private ###
+
+  private
+
+  def resolve_source(source)
+    raise CeedlingException.new( 'Actionator source root has not been set' ) if @source_root.nil?
+
+    # An absolute source is returned unchanged, which matters because cli_helper
+    # passes absolute paths for gathered documentation and license files while
+    # cli_handler passes paths relative to the Ceedling installation.
+    src = File.expand_path( source, @source_root )
+
+    unless @file_wrapper.exist?( src )
+      raise CeedlingException.new(
+        "Could not find '#{source}' relative to Ceedling source root '#{@source_root}'"
+      )
+    end
+
+    return src
+  end
+
+
+  def resolve_destination(destination)
+    return File.expand_path( destination, @destination_root )
+  end
+
+
+  # Binary mode is required. A text-mode write translates line endings on Windows,
+  # which corrupts the vendored ceedling launch script and vendored source files.
+  def write_file(source, destination)
+    @file_wrapper.mkdir( @file_wrapper.dirname( destination ) )
+    @file_wrapper.write( destination, @file_wrapper.read_binary( source ), 'wb' )
+  end
+
+
+  def rebase(entry, source_dir, destination_dir)
+    return File.join( destination_dir, entry.sub( source_dir, '' ) )
+  end
+
+
+  def escape_globs(path)
+    return path.gsub( /[*?{}\[\]]/ ) { |char| '\\' + char }
+  end
+
+
+  def status(verb, path, verbose)
+    return unless verbose
+
+    label = verb.to_s.rjust( VERB_WIDTH )
+    label = BOLD + VERB_COLORS[verb] + label + CLEAR if colorize?
+
+    @loginator.console( "#{label}  #{relative_destination( path )}", LogLabels::NONE )
+  end
+
+
+  def colorize?
+    return @loginator.decorators && $stdout.tty?
+  end
+
+
+  # Shortens a path that sits under the destination root, so `ceedling new` reports
+  # myproject/src rather than an absolute path the user never typed.
+  def relative_destination(path)
+    root = @destination_root
+    return path unless path.start_with?( root )
+
+    remainder = path[root.size..]
+    return '' if remainder.nil? || remainder.empty?
+    return path unless remainder.start_with?( File::SEPARATOR )
+
+    return remainder[1..]
+  end
+
+end

data/bin/app_cfg.rb

@@ -55,9 +55,17 @@ class CeedlingAppConfig
       :include_test_case => '',
       :exclude_test_case => '',
 
+      # Default to trusting delta-build staleness tracking (no forced rerun)
+      :force_test_rerun => false,
+
       # Default to task categry other than build/plugin tasks
       :build_tasks? => false,
 
+      # Whether the tasks build tests (test:, gcov:, ...) or a release, which decides what
+      # build/vendor needs
+      :test_build_tasks? => false,
+      :release_build_tasks? => false,
+
       # Default to `exit(1)` upon failing test cases
       :tests_graceful_fail? => false,
 
@@ -95,10 +103,22 @@ class CeedlingAppConfig
     @app_cfg[:exclude_test_case] = matcher
   end
 
+  def set_force_test_rerun(enable)
+    @app_cfg[:force_test_rerun] = enable
+  end
+
   def set_build_tasks(enable)
     @app_cfg[:build_tasks?] = enable
   end
 
+  def set_test_build_tasks(enable)
+    @app_cfg[:test_build_tasks?] = enable
+  end
+
+  def set_release_build_tasks(enable)
+    @app_cfg[:release_build_tasks?] = enable
+  end
+
   def set_tests_graceful_fail(enable)
     @app_cfg[:tests_graceful_fail?] = enable
   end
@@ -122,6 +142,14 @@ class CeedlingAppConfig
     return @app_cfg[:build_tasks?]
   end
 
+  def test_build_tasks?()
+    return @app_cfg[:test_build_tasks?]
+  end
+
+  def release_build_tasks?()
+    return @app_cfg[:release_build_tasks?]
+  end
+
   def tests_graceful_fail?()
     return @app_cfg[:tests_graceful_fail?]
   end