ceedling 0.30.0 → 0.31.0

data/config/test_environment.rb

@@ -5,7 +5,6 @@
   'test',
   'vendor/behaviors/lib',
   'vendor/hardmock/lib',
-  'vendor/deep_merge/lib',
 ].each do |dir|
   $LOAD_PATH.unshift( File.join( File.expand_path(File.dirname(__FILE__) + "/../"), dir) )
 end

data/docs/CeedlingPacket.md

@@ -1,4 +1,4 @@
-[All code is copyright © 2010-2020 Ceedling Project
+[All code is copyright © 2010-2021 Ceedling Project
 by Mike Karlesky, Mark VanderVoord, and Greg Williams.
 
 This Documentation Is Released Under a
@@ -818,6 +818,23 @@ project: global project settings
 
   **Default**: FALSE
 
+* `use_preprocessor_directives`:
+
+  After standard preprocessing when `use_test_preprocessor` is used
+  macros are fully expanded to C code. Some features, for example
+  TEST_CASE() or TEST_RANGE() from Unity require not-fully preprocessed
+  file to be detected by Ceedling. To do this gcc directives-only
+  option is used to expand only conditional compilation statements,
+  handle directives, but do not expand macros preprocessor and leave
+  the other content of file untouched.
+
+  With this option enabled, `use_test_preprocessor` must be also enabled
+  and gcc must exist in an accessible system search path. For other
+  compilers behavior can be changed by `test_file_preprocessor_directives`
+  compiler tool.
+
+  **Default**: FALSE
+
 * `use_deep_dependencies`:
 
   The base rules and tasks that Ceedling creates using Rake capture most
@@ -1298,13 +1315,16 @@ Example [:extension] YAML blurb
 
 * `<test_name>`:
 
-  Add preprocessor definitions for specified `<test_name>`. For example:
+  Replace standard `test` definitions for specified `<test_name>`definitions. For example:
 ```yaml
   :defines:
+    :test:
+      - FOO_STANDARD_CONFIG
     :test_foo_config:
-      - FOO_SPECIFIC_FEATURE
+      - FOO_SPECIFIC_CONFIG
 ```
-  `ceedling test:foo_config` will now have `FOO_SPECIFIC_FEATURE` defined, none of the other tests will.
+  `ceedling test:foo_config` will now have `FOO_SPECIFIC_CONFIG` defined instead of
+  `FOO_STANDARD_CONFIG`. None of the other tests will have `FOO_SPECIFIC_SPECIFIC`.
 
   **Default**: `[]` (empty)
 
@@ -1680,12 +1700,21 @@ tools.
 * `test_file_preprocessor`:
 
   Preprocessor of test files (macros, conditional compilation statements)
-
    - `${1}`: input source file
    - `${2}`: preprocessed output source file
 
   **Default**: `gcc`
 
+* `test_file_preprocessor_directives`:
+
+  Preprocessor of test files to expand only conditional compilation statements,
+  handle directives, but do not expand macros
+
+   - `${1}`: input source file
+   - `${2}`: not-fully preprocessed output source file
+
+  **Default**: `gcc`
+
 * `test_dependencies_generator`:
 
   Discovers deep dependencies of source & test (for incremental builds)
@@ -2199,7 +2228,31 @@ You've got options.
 Adding Handy Rake Tasks for Your Project (without Fancy Pants Custom Plugins)
 -----------------------------------------------------------------------------
 
-Simple as snot.
+Add a file `rakefile.rb` at the root of your project that loads Ceedling. This
+differs whether you are using the gem version or a local Ceedling version.
+
+Gem Version:
+```ruby
+require('Ceedling')
+Ceedling.load_project
+```
+
+Local Ceedling Version (assuming local ceedling is in `vendor/ceedling`):
+```ruby
+PROJECT_CEEDLING_ROOT = "vendor/ceedling"
+load "#{PROJECT_CEEDLING_ROOT}/lib/ceedling.rb"
+Ceedling.load_project
+```
+
+Now you simply add your rake task to the file e.g.:
+```ruby
+desc "Print hello world in sh" # Only tasks with description are listed by ceedling -T
+task :hello_world do
+  sh "echo Hello World!"
+end
+```
+
+The task can now be called with: `ceedling hello_world` 
 
 Working with Non-Desktop Testing Environments
 ---------------------------------------------

data/examples/blinky/project.yml

@@ -10,6 +10,8 @@
   :build_root: build
   :release_build: TRUE
   :test_file_prefix: test_
+  :which_ceedling: gem
+  :ceedling_version: '?'
 
 #You'll have to specify these
 :environment:
@@ -92,7 +94,7 @@
 
 :plugins:
   :load_paths:
-    - vendor/ceedling/plugins
+    - "#{Ceedling.load_path}"
   :enabled:
     - stdout_pretty_tests_report
     - module_generator

data/examples/blinky/rakefile.rb

@@ -1,5 +1,4 @@
-PROJECT_CEEDLING_ROOT = "vendor/ceedling"
-load "#{PROJECT_CEEDLING_ROOT}/lib/ceedling.rb"
+require "ceedling"
 Ceedling.load_project
 
 task :default => %w[ test:all release ]

data/examples/temp_sensor/build/test/cache/AdcConductor.h

@@ -0,0 +1,20 @@
+#include "src/Types.h"
+
+
+
+
+
+
+
+
+void AdcConductor_Init(void);
+
+void AdcConductor_Run(void);
+
+
+
+bool AdcConductor_JustHereToTest(void);
+
+bool AdcConductor_AlsoHereToTest(void);
+
+bool AdcConductor_YetAnotherTest(void);

data/examples/temp_sensor/build/test/cache/AdcHardware.h

@@ -0,0 +1,16 @@
+#include "src/Types.h"
+
+
+
+
+
+
+
+
+void AdcHardware_Init(void);
+
+void AdcHardware_StartConversion(void);
+
+bool AdcHardware_GetSampleComplete(void);
+
+uint16 AdcHardware_GetSample(void);

data/examples/temp_sensor/build/test/cache/AdcHardwareConfigurator.h

@@ -0,0 +1,14 @@
+#include "src/Types.h"
+
+
+
+
+
+
+
+
+void Adc_Reset(void);
+
+void Adc_ConfigureMode(void);
+
+void Adc_EnableTemperatureChannel(void);

data/examples/temp_sensor/build/test/cache/AdcModel.h

@@ -0,0 +1,20 @@
+#include "src/Types.h"
+
+
+
+
+
+
+
+
+bool AdcModel_DoGetSample(void);
+
+void AdcModel_ProcessInput(uint16 millivolts);
+
+
+
+bool AdcModel_DoNothingExceptTestASpecialType(EXAMPLE_STRUCT_T ExampleStruct);
+
+bool AdModel_DoNothingExceptTestPointers(uint32* pExample);
+
+EXAMPLE_STRUCT_T AdcModel_DoNothingExceptReturnASpecialType(void);

data/examples/temp_sensor/build/test/cache/AdcTemperatureSensor.h

@@ -0,0 +1,14 @@
+#include "src/Types.h"
+
+
+
+
+
+
+
+
+void Adc_StartTemperatureSensorConversion(void);
+
+bool Adc_TemperatureSensorSampleReady(void);
+
+uint16 Adc_ReadTemperatureSensor(void);

data/examples/temp_sensor/build/test/cache/Executor.h

@@ -0,0 +1,12 @@
+#include "src/Types.h"
+
+
+
+
+
+
+
+
+void Executor_Init(void);
+
+bool Executor_Run(void);

data/examples/temp_sensor/build/test/cache/IntrinsicsWrapper.h

@@ -0,0 +1,9 @@
+
+
+
+
+
+
+void Interrupt_Enable(void);
+
+void Interrupt_Disable(void);

data/examples/temp_sensor/build/test/cache/Model.h

@@ -0,0 +1,10 @@
+#include "src/Types.h"
+
+
+
+
+
+
+
+
+void Model_Init(void);

data/examples/temp_sensor/build/test/cache/TaskScheduler.h

@@ -0,0 +1,16 @@
+#include "src/Types.h"
+
+
+
+
+
+
+
+
+void TaskScheduler_Init(void);
+
+void TaskScheduler_Update(uint32 time);
+
+bool TaskScheduler_DoUsart(void);
+
+bool TaskScheduler_DoAdc(void);

data/examples/temp_sensor/build/test/cache/TemperatureCalculator.h

@@ -0,0 +1,10 @@
+#include "src/Types.h"
+
+
+
+
+
+
+
+
+float TemperatureCalculator_Calculate(uint16 millivolts);

data/examples/temp_sensor/build/test/cache/TemperatureFilter.h

@@ -0,0 +1,14 @@
+#include "src/Types.h"
+
+
+
+
+
+
+
+
+void TemperatureFilter_Init(void);
+
+float TemperatureFilter_GetTemperatureInCelcius(void);
+
+void TemperatureFilter_ProcessInput(float temperature);

data/examples/temp_sensor/build/test/cache/TestAdcConductor.c

@@ -0,0 +1,169 @@
+#include "MockAdcHardware.h"
+#include "MockAdcModel.h"
+#include "src/AdcConductor.h"
+#include "src/Types.h"
+#include "test/support/UnityHelper.h"
+#include "/Library/Ruby/Gems/2.6.0/gems/ceedling-0.31.0/vendor/unity/src/unity.h"
+
+
+
+
+void setUp(void)
+
+{
+
+}
+
+
+
+void tearDown(void)
+
+{
+
+}
+
+
+
+void testInitShouldCallHardwareInit(void)
+
+{
+
+  AdcHardware_Init_CMockExpect(19);
+
+  AdcConductor_Init();
+
+}
+
+
+
+void testRunShouldNotDoAnythingIfItIsNotTime(void)
+
+{
+
+  AdcModel_DoGetSample_CMockExpectAndReturn(25, (0));
+
+
+
+  AdcConductor_Run();
+
+}
+
+
+
+void testRunShouldNotPassAdcResultToModelIfSampleIsNotComplete(void)
+
+{
+
+  AdcModel_DoGetSample_CMockExpectAndReturn(32, (1));
+
+  AdcHardware_GetSampleComplete_CMockExpectAndReturn(33, (0));
+
+
+
+  AdcConductor_Run();
+
+}
+
+
+
+void testRunShouldGetLatestSampleFromAdcAndPassItToModelAndStartNewConversionWhenItIsTime(void)
+
+{
+
+  AdcModel_DoGetSample_CMockExpectAndReturn(40, (1));
+
+  AdcHardware_GetSampleComplete_CMockExpectAndReturn(41, (1));
+
+  AdcHardware_GetSample_CMockExpectAndReturn(42, 293U);
+
+  AdcModel_ProcessInput_CMockExpect(43, 293U);
+
+  AdcHardware_StartConversion_CMockExpect(44);
+
+
+
+  AdcConductor_Run();
+
+}
+
+
+
+void testJustHereToTest_Should_ProperlyPassAStructAndVerifyIt(void)
+
+{
+
+    EXAMPLE_STRUCT_T TestStruct;
+
+    TestStruct.x = 5;
+
+    TestStruct.y = 7;
+
+
+
+    AdcModel_DoNothingExceptTestASpecialType_CMockExpectAndReturn(55, TestStruct, (1));
+
+
+
+    do {if ((AdcConductor_JustHereToTest())) {} else {UnityFail( ((" Expected TRUE Was FALSE")), (UNITY_UINT)((UNITY_UINT)(57)));}} while(0);
+
+}
+
+void test_AdcConductor_AlsoHereToTest_Should_ProperlyReturnAStructAsExpected1(void)
+
+{
+
+    EXAMPLE_STRUCT_T TestStruct;
+
+    TestStruct.x = 99;
+
+    TestStruct.y = 1;
+
+
+
+    AdcModel_DoNothingExceptReturnASpecialType_CMockExpectAndReturn(88, TestStruct);
+
+
+
+    do {if ((AdcConductor_AlsoHereToTest())) {} else {UnityFail( ((" Expected TRUE Was FALSE")), (UNITY_UINT)((UNITY_UINT)(90)));}} while(0);
+
+}
+
+
+
+void test_AdcConductor_AlsoHereToTest_Should_ProperlyReturnAStructAsExpected2(void)
+
+{
+
+    EXAMPLE_STRUCT_T TestStruct;
+
+    TestStruct.x = 98;
+
+    TestStruct.y = 1;
+
+
+
+    AdcModel_DoNothingExceptReturnASpecialType_CMockExpectAndReturn(99, TestStruct);
+
+
+
+    do {if (!(AdcConductor_AlsoHereToTest())) {} else {UnityFail( ((" Expected FALSE Was TRUE")), (UNITY_UINT)((UNITY_UINT)(101)));}} while(0);
+
+}
+
+
+
+void test_AdcConductor_YetAnotherTest_Should_VerifyThatPointersToStructsAreTestable(void)
+
+{
+
+    uint32 TestNum = 3;
+
+
+
+    AdModel_DoNothingExceptTestPointers_CMockExpectAndReturn(108, &TestNum, (1));
+
+
+
+    do {if ((AdcConductor_YetAnotherTest())) {} else {UnityFail( ((" Expected TRUE Was FALSE")), (UNITY_UINT)((UNITY_UINT)(110)));}} while(0);
+
+}