ceedling 0.31.1 → 1.0.1

data/assets/tests_with_defines/src/adc_hardware.c

@@ -1,3 +1,10 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
 #include "adc_hardware.h"
 #include "adc_hardware_configurator.h"
 
@@ -5,7 +12,7 @@ void AdcHardware_Init(void)
 {
   #ifdef SPECIFIC_CONFIG
   Adc_ResetSpec();
-  #elif STANDARD_CONFIG
+  #elif defined(STANDARD_CONFIG)
   Adc_Reset();
   #endif
 }

data/assets/tests_with_defines/src/adc_hardware.h

@@ -1,3 +1,10 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
 #ifndef _ADCHARDWARE_H
 #define _ADCHARDWARE_H
 

data/assets/tests_with_defines/src/adc_hardware_configurator.c

@@ -1,10 +1,17 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
 #include "adc_hardware_configurator.h"
 
 #ifdef SPECIFIC_CONFIG
 void Adc_ResetSpec(void)
 {
 }
-#elif STANDARD_CONFIG
+#elif defined(STANDARD_CONFIG)
 void Adc_Reset(void)
 {
 }

data/assets/tests_with_defines/src/adc_hardware_configurator.h

@@ -1,9 +1,16 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
 #ifndef _ADCHARDWARECONFIGURATOR_H
 #define _ADCHARDWARECONFIGURATOR_H
 
 #ifdef SPECIFIC_CONFIG
 void Adc_ResetSpec(void);
-#elif STANDARD_CONFIG
+#elif defined(STANDARD_CONFIG)
 void Adc_Reset(void);
 #endif
 

data/assets/tests_with_defines/test/test_adc_hardware.c

@@ -1,3 +1,10 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
 #include "unity.h"
 #include "adc_hardware.h"
 #include "mock_adc_hardware_configurator.h"

data/assets/tests_with_defines/test/test_adc_hardware_special.c

@@ -1,3 +1,10 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
 #include "unity.h"
 #include "adc_hardware.h"
 #include "mock_adc_hardware_configurator.h"

data/assets/tests_with_preprocessing/src/adc_hardwareA.c

@@ -0,0 +1,17 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#include "adc_hardwareA.h"
+#include "adc_hardware_configuratorA.h"
+
+void AdcHardware_Init(void)
+{
+  // Reusing outer test file preprocessing symbol to prevent linking failure
+  #ifdef PREPROCESSING_TESTS
+  Adc_Reset();
+  #endif
+}

data/assets/tests_with_preprocessing/src/adc_hardwareA.h

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

data/assets/tests_with_preprocessing/src/adc_hardwareB.c

@@ -0,0 +1,14 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#include "adc_hardwareB.h"
+#include "adc_hardware_configuratorB.h"
+
+void AdcHardware_Init(void)
+{
+  Adc_Reset();
+}

data/assets/tests_with_preprocessing/src/adc_hardwareB.h

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

data/assets/tests_with_preprocessing/src/adc_hardwareC.c

@@ -0,0 +1,14 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#include "adc_hardwareC.h"
+#include "adc_hardware_configuratorC.h"
+
+void AdcHardware_Init(void)
+{
+  Adc_Reset();
+}

data/assets/tests_with_preprocessing/src/adc_hardwareC.h

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

data/assets/tests_with_preprocessing/src/adc_hardware_configuratorA.h

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

data/assets/tests_with_preprocessing/src/adc_hardware_configuratorB.h

@@ -0,0 +1,15 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#ifndef _ADCHARDWARECONFIGURATOR_H
+#define _ADCHARDWARECONFIGURATOR_H
+
+#ifdef PREPROCESSING_MOCKS
+void Adc_Reset(void);
+#endif
+
+#endif // _ADCHARDWARECONFIGURATOR_H

data/assets/tests_with_preprocessing/src/adc_hardware_configuratorC.h

@@ -0,0 +1,15 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#ifndef _ADCHARDWARECONFIGURATOR_H
+#define _ADCHARDWARECONFIGURATOR_H
+
+#ifdef PREPROCESSING_MOCKS
+void Adc_Reset(void);
+#endif
+
+#endif // _ADCHARDWARECONFIGURATOR_H

data/assets/tests_with_preprocessing/test/test_adc_hardwareA.c

@@ -0,0 +1,41 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#include "unity.h"
+#include "adc_hardwareA.h"
+#ifdef PREPROCESSING_TESTS
+#include "mock_adc_hardware_configuratorA.h"
+#endif
+
+void setUp(void)
+{
+}
+
+void tearDown(void)
+{
+}
+
+#ifdef PREPROCESSING_TESTS
+void test_init_should_call_adc_reset(void)
+{
+  Adc_Reset_Expect();
+
+  AdcHardware_Init();
+}
+#endif
+
+#ifndef PREPROCESSING_TESTS
+void test_caseA_should_fail(void)
+{
+  TEST_FAIL_MESSAGE("Intentional failure");
+}
+
+void test_caseB_should_fail(void)
+{
+  TEST_FAIL_MESSAGE("Intentional failure");
+}
+#endif

data/assets/tests_with_preprocessing/test/test_adc_hardwareB.c

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

data/assets/tests_with_preprocessing/test/test_adc_hardwareC.c

@@ -0,0 +1,29 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#include "unity.h"
+#include "adc_hardwareC.h"
+#ifdef PREPROCESSING_TESTS
+#include "mock_adc_hardware_configuratorC.h"
+#endif
+
+void setUp(void)
+{
+}
+
+void tearDown(void)
+{
+}
+
+#ifdef PREPROCESSING_TESTS
+void test_init_should_call_adc_reset(void)
+{
+  Adc_Reset_Expect();
+
+  AdcHardware_Init();
+}
+#endif

data/assets/uncovered_example_file.c

@@ -1,3 +1,10 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
 // This file is to test abort on uncovered files feature
 
 int multiply_numbers(int a, int b) {

data/bin/actions_wrapper.rb

@@ -0,0 +1,50 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+require 'thor'
+require 'fileutils'
+
+# Wrapper for handy Thor Actions
+class ActionsWrapper
+  include Thor::Base
+  include Thor::Actions
+
+  JUNK_FILE_EXCLUDE_REGEX = 
+
+  # Most important mixin method is Thor::Actions class method `source_root()` we call externally
+
+  def _directory(src, *args)
+    # Insert exclusion of macOS and Windows preview junk files if an exclude pattern is not present
+    # Thor's use of args is an array of call arguments, some of which can be single key/value hash options
+    if !args.any? {|h| h.class != Hash ? false : !h[:exclude_pattern].nil?}
+      args << {:exclude_pattern => /(\.DS_Store)|(thumbs\.db)/}
+    end
+
+    directory( src, *args )
+  end
+
+  def _copy_file(src, *args)
+    copy_file( src, *args )
+  end
+
+  def _touch_file(src)
+    FileUtils.touch(src)
+  end
+
+  def _chmod(src, mode, *args)
+    chmod( src, mode, *args )
+  end
+
+  def _empty_directory(dest, *args)
+    empty_directory( dest, *args )
+  end
+
+  def _gsub_file(path, flag, *args, &block)
+    gsub_file( path, flag, *args, &block )
+  end
+
+end

data/bin/app_cfg.rb

@@ -0,0 +1,134 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+require "io/console"
+
+# Create our global application configuration option set
+# This approach bridges clean Ruby and Rake
+
+class CeedlingAppConfig
+
+  def initialize()
+    # Default installation location determined from the location of this file
+    ceedling_root_path = File.join( File.dirname( __FILE__ ), '..' )
+
+    # Create internal hash of needed values
+    @app_cfg = {
+      # Base path of any Ceedling installation
+      :ceedling_root_path => '',
+
+      # Ceedling installation base path + /lib
+      :ceedling_lib_base_path => '',
+
+      # Ceedling installation base path + /lib/ceedling
+      :ceedling_lib_path => '',
+
+      # Ceedling installation base path + /plugins
+      :ceedling_plugins_path => '',
+
+      # Ceedling installation base path + /vendor
+      :ceedling_vendor_path => '',
+
+      # Ceedling installation base path + /examples
+      :ceedling_examples_path => '',
+
+      # Ceedling lib path + lib/ceedling/rakefile.rb
+      :ceedling_rakefile_filepath => '',
+
+      # Blank initial value for completeness
+      :project_config => {},
+
+      # Default path (in build directory) to hold logs
+      :logging_path => '',
+
+      # If logging enabled, the filepath for Ceedling's log (may be explicitly set to be outside :logging_path)
+      :log_filepath => '',
+
+      # Only specified in project config (no command line or environment variable)
+      :default_tasks => ['test:all'],
+
+      # Default, blank test case filters
+      :include_test_case => '',
+      :exclude_test_case => '',
+
+      # Default to task categry other than build/plugin tasks
+      :build_tasks? => false,
+
+      # Default to `exit(1)` upon failing test cases
+      :tests_graceful_fail? => false,
+
+      # Set terminal width (in columns) to a default
+      :terminal_width => 120,
+    }
+
+    set_paths( ceedling_root_path )
+
+    # Try to query terminal width (not always available on all platforms)
+    begin
+      @app_cfg[:terminal_width] = (IO.console.winsize)[1]
+    rescue
+      # Do nothing; allow value already set to stand as default
+    end
+  end 
+
+  def set_project_config(config)
+    @app_cfg[:project_config] = config
+  end
+
+  def set_logging_path(path)
+    @app_cfg[:logging_path] = path
+  end
+
+  def set_log_filepath(filepath)
+    @app_cfg[:log_filepath] = filepath
+  end
+
+  def set_include_test_case(matcher)
+    @app_cfg[:include_test_case] = matcher
+  end
+
+  def set_exclude_test_case(matcher)
+    @app_cfg[:exclude_test_case] = matcher
+  end
+
+  def set_build_tasks(enable)
+    @app_cfg[:build_tasks?] = enable
+  end
+
+  def set_tests_graceful_fail(enable)
+    @app_cfg[:tests_graceful_fail?] = enable
+  end
+
+  def set_paths(root_path)
+    _root_path = File.expand_path( root_path )
+    lib_base_path = File.join( _root_path, 'lib' )
+    lib_path = File.join( lib_base_path, 'ceedling' )
+
+    @app_cfg[:ceedling_root_path]     = _root_path
+    @app_cfg[:ceedling_lib_base_path] = lib_base_path
+    @app_cfg[:ceedling_lib_path]      = lib_path
+    @app_cfg[:ceedling_vendor_path]   = File.join( _root_path, 'vendor' )
+    @app_cfg[:ceedling_plugins_path]  = File.join( _root_path, 'plugins' )
+    @app_cfg[:ceedling_examples_path] = File.join( _root_path, 'examples' )
+
+    @app_cfg[:ceedling_rakefile_filepath] = File.join( lib_path, 'rakefile.rb' )
+  end
+
+  def build_tasks?()
+    return @app_cfg[:build_tasks?]
+  end
+
+  def tests_graceful_fail?()
+    return @app_cfg[:tests_graceful_fail?]
+  end
+
+  # External accessor to preserve hash-like read accesses
+  def [](key)
+    return @app_cfg[key]
+  end
+
+end