ceedling 0.28.3 → 0.29.0

data/vendor/cmock/vendor/unity/extras/fixture/test/unity_fixture_TestRunner.c

@@ -1,57 +1,32 @@
-/* Copyright (c) 2010 James Grenning and Contributed to Unity Project
- * ==========================================
- *  Unity Project - A Test Framework for C
- *  Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
- *  [Released under MIT License. Please refer to license.txt for details]
- * ========================================== */
-
-#include "unity_fixture.h"
-
-TEST_GROUP_RUNNER(UnityFixture)
-{
-    RUN_TEST_CASE(UnityFixture, PointerSetting);
-    RUN_TEST_CASE(UnityFixture, ForceMallocFail);
-    RUN_TEST_CASE(UnityFixture, ReallocSmallerIsUnchanged);
-    RUN_TEST_CASE(UnityFixture, ReallocSameIsUnchanged);
-    RUN_TEST_CASE(UnityFixture, ReallocLargerNeeded);
-    RUN_TEST_CASE(UnityFixture, ReallocNullPointerIsLikeMalloc);
-    RUN_TEST_CASE(UnityFixture, ReallocSizeZeroFreesMemAndReturnsNullPointer);
-    RUN_TEST_CASE(UnityFixture, CallocFillsWithZero);
-    RUN_TEST_CASE(UnityFixture, PointerSet);
-    RUN_TEST_CASE(UnityFixture, FreeNULLSafety);
-    RUN_TEST_CASE(UnityFixture, ConcludeTestIncrementsFailCount);
-}
-
-TEST_GROUP_RUNNER(UnityCommandOptions)
-{
-    RUN_TEST_CASE(UnityCommandOptions, DefaultOptions);
-    RUN_TEST_CASE(UnityCommandOptions, OptionVerbose);
-    RUN_TEST_CASE(UnityCommandOptions, OptionSelectTestByGroup);
-    RUN_TEST_CASE(UnityCommandOptions, OptionSelectTestByName);
-    RUN_TEST_CASE(UnityCommandOptions, OptionSelectRepeatTestsDefaultCount);
-    RUN_TEST_CASE(UnityCommandOptions, OptionSelectRepeatTestsSpecificCount);
-    RUN_TEST_CASE(UnityCommandOptions, MultipleOptions);
-    RUN_TEST_CASE(UnityCommandOptions, MultipleOptionsDashRNotLastAndNoValueSpecified);
-    RUN_TEST_CASE(UnityCommandOptions, UnknownCommandIsIgnored);
-    RUN_TEST_CASE(UnityCommandOptions, GroupOrNameFilterWithoutStringFails);
-    RUN_TEST_CASE(UnityCommandOptions, GroupFilterReallyFilters);
-    RUN_TEST_CASE(UnityCommandOptions, TestShouldBeIgnored);
-}
-
-TEST_GROUP_RUNNER(LeakDetection)
-{
-    RUN_TEST_CASE(LeakDetection, DetectsLeak);
-    RUN_TEST_CASE(LeakDetection, BufferOverrunFoundDuringFree);
-    RUN_TEST_CASE(LeakDetection, BufferOverrunFoundDuringRealloc);
-    RUN_TEST_CASE(LeakDetection, BufferGuardWriteFoundDuringFree);
-    RUN_TEST_CASE(LeakDetection, BufferGuardWriteFoundDuringRealloc);
-    RUN_TEST_CASE(LeakDetection, PointerSettingMax);
-}
-
-TEST_GROUP_RUNNER(InternalMalloc)
-{
-    RUN_TEST_CASE(InternalMalloc, MallocPastBufferFails);
-    RUN_TEST_CASE(InternalMalloc, CallocPastBufferFails);
-    RUN_TEST_CASE(InternalMalloc, MallocThenReallocGrowsMemoryInPlace);
-    RUN_TEST_CASE(InternalMalloc, ReallocFailDoesNotFreeMem);
-}
+/* Copyright (c) 2010 James Grenning and Contributed to Unity Project
+ * ==========================================
+ *  Unity Project - A Test Framework for C
+ *  Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
+ *  [Released under MIT License. Please refer to license.txt for details]
+ * ========================================== */
+
+#include "unity_fixture.h"
+
+TEST_GROUP_RUNNER(UnityFixture)
+{
+    RUN_TEST_CASE(UnityFixture, PointerSetting);
+    RUN_TEST_CASE(UnityFixture, PointerSet);
+    RUN_TEST_CASE(UnityFixture, FreeNULLSafety);
+    RUN_TEST_CASE(UnityFixture, ConcludeTestIncrementsFailCount);
+}
+
+TEST_GROUP_RUNNER(UnityCommandOptions)
+{
+    RUN_TEST_CASE(UnityCommandOptions, DefaultOptions);
+    RUN_TEST_CASE(UnityCommandOptions, OptionVerbose);
+    RUN_TEST_CASE(UnityCommandOptions, OptionSelectTestByGroup);
+    RUN_TEST_CASE(UnityCommandOptions, OptionSelectTestByName);
+    RUN_TEST_CASE(UnityCommandOptions, OptionSelectRepeatTestsDefaultCount);
+    RUN_TEST_CASE(UnityCommandOptions, OptionSelectRepeatTestsSpecificCount);
+    RUN_TEST_CASE(UnityCommandOptions, MultipleOptions);
+    RUN_TEST_CASE(UnityCommandOptions, MultipleOptionsDashRNotLastAndNoValueSpecified);
+    RUN_TEST_CASE(UnityCommandOptions, UnknownCommandIsIgnored);
+    RUN_TEST_CASE(UnityCommandOptions, GroupOrNameFilterWithoutStringFails);
+    RUN_TEST_CASE(UnityCommandOptions, GroupFilterReallyFilters);
+    RUN_TEST_CASE(UnityCommandOptions, TestShouldBeIgnored);
+}

data/vendor/cmock/vendor/unity/extras/memory/rakefile.rb

@@ -0,0 +1,45 @@
+# ==========================================
+#   Unity Project - A Test Framework for C
+#   Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
+#   [Released under MIT License. Please refer to license.txt for details]
+# ==========================================
+
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require_relative 'rakefile_helper'
+
+TEMP_DIRS = [
+  File.join(__dir__, 'build')
+].freeze
+
+TEMP_DIRS.each do |dir|
+  directory(dir)
+  CLOBBER.include(dir)
+end
+
+task prepare_for_tests: TEMP_DIRS
+
+# Load default configuration, for now
+DEFAULT_CONFIG_FILE = 'gcc_auto_stdint.yml'.freeze
+configure_toolchain(DEFAULT_CONFIG_FILE)
+
+task unit: [:prepare_for_tests] do
+  run_tests(false)
+  run_tests(true)
+end
+
+desc 'Build and test Unity Framework'
+task all: %i[clean unit]
+task default: %i[clobber all]
+task ci: %i[no_color default]
+task cruise: %i[no_color default]
+
+desc 'Load configuration'
+task :config, :config_file do |_t, args|
+  configure_toolchain(args[:config_file])
+end
+
+task :no_color do
+  $colour_output = false
+end

data/vendor/cmock/vendor/unity/extras/memory/rakefile_helper.rb

@@ -0,0 +1,187 @@
+# ==========================================
+#   Unity Project - A Test Framework for C
+#   Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
+#   [Released under MIT License. Please refer to license.txt for details]
+# ==========================================
+
+require 'yaml'
+require 'fileutils'
+require 'rbconfig'
+require_relative '../../auto/unity_test_summary'
+require_relative '../../auto/generate_test_runner'
+require_relative '../../auto/colour_reporter'
+
+$is_windows = (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)
+
+C_EXTENSION = '.c'.freeze
+
+def load_configuration(config_file)
+  return if $configured
+
+  $cfg_file = "#{__dir__}/../../test/targets/#{config_file}" unless config_file =~ /[\\|\/]/
+  $cfg = YAML.load(File.read($cfg_file))
+  $colour_output = false unless $cfg['colour']
+  $configured = true if config_file != DEFAULT_CONFIG_FILE
+end
+
+def configure_clean
+  CLEAN.include($cfg['compiler']['build_path'] + '*.*') unless $cfg['compiler']['build_path'].nil?
+end
+
+def configure_toolchain(config_file = DEFAULT_CONFIG_FILE)
+  config_file += '.yml' unless config_file =~ /\.yml$/
+  config_file = config_file unless config_file =~ /[\\|\/]/
+  load_configuration(config_file)
+  configure_clean
+end
+
+def tackit(strings)
+  result = if strings.is_a?(Array)
+             "\"#{strings.join}\""
+           else
+             strings
+           end
+  result
+end
+
+def squash(prefix, items)
+  result = ''
+  items.each { |item| result += " #{prefix}#{tackit(item)}" }
+  result
+end
+
+def build_compiler_fields
+  command = tackit($cfg['compiler']['path'])
+  defines = if $cfg['compiler']['defines']['items'].nil?
+              ''
+            else
+              decl = if $is_windows
+                       'UNITY_OUTPUT_CHAR_HEADER_DECLARATION=UnityOutputCharSpy_OutputChar(int)'
+                     else
+                       'UNITY_OUTPUT_CHAR_HEADER_DECLARATION=UnityOutputCharSpy_OutputChar\(int\)'
+                     end
+              squash($cfg['compiler']['defines']['prefix'], $cfg['compiler']['defines']['items'] + ['UNITY_OUTPUT_CHAR=UnityOutputCharSpy_OutputChar'] + [decl])
+            end
+  options = squash('', $cfg['compiler']['options'])
+  includes = squash($cfg['compiler']['includes']['prefix'], $cfg['compiler']['includes']['items'])
+  includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
+
+  { command: command, defines: defines, options: options, includes: includes }
+end
+
+def compile(file, _defines = [])
+  compiler = build_compiler_fields
+  unity_include = $cfg['compiler']['includes']['prefix'] + '../../src'
+  cmd_str = "#{compiler[:command]}#{compiler[:defines]}#{compiler[:options]}#{compiler[:includes]} #{unity_include} #{file} " \
+            "#{$cfg['compiler']['object_files']['prefix']}#{$cfg['compiler']['object_files']['destination']}" \
+            "#{File.basename(file, C_EXTENSION)}#{$cfg['compiler']['object_files']['extension']}"
+
+  execute(cmd_str)
+end
+
+def build_linker_fields
+  command = tackit($cfg['linker']['path'])
+  options = if $cfg['linker']['options'].nil?
+              ''
+            else
+              squash('', $cfg['linker']['options'])
+            end
+  includes = if $cfg['linker']['includes'].nil? || $cfg['linker']['includes']['items'].nil?
+               ''
+             else
+               squash($cfg['linker']['includes']['prefix'], $cfg['linker']['includes']['items'])
+             end.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
+
+  { command: command, options: options, includes: includes }
+end
+
+def link_it(exe_name, obj_list)
+  linker = build_linker_fields
+  cmd_str = "#{linker[:command]}#{linker[:options]}#{linker[:includes]} " +
+            (obj_list.map { |obj| "#{$cfg['linker']['object_files']['path']}#{obj} " }).join +
+            $cfg['linker']['bin_files']['prefix'] + ' ' +
+            $cfg['linker']['bin_files']['destination'] +
+            exe_name + $cfg['linker']['bin_files']['extension']
+  execute(cmd_str)
+end
+
+def build_simulator_fields
+  return nil if $cfg['simulator'].nil?
+
+  command = if $cfg['simulator']['path'].nil?
+              ''
+            else
+              (tackit($cfg['simulator']['path']) + ' ')
+            end
+  pre_support = if $cfg['simulator']['pre_support'].nil?
+                  ''
+                else
+                  squash('', $cfg['simulator']['pre_support'])
+                end
+  post_support = if $cfg['simulator']['post_support'].nil?
+                   ''
+                 else
+                   squash('', $cfg['simulator']['post_support'])
+                 end
+  { command: command, pre_support: pre_support, post_support: post_support }
+end
+
+def execute(command_string, verbose = true)
+  report command_string
+  output = `#{command_string}`.chomp
+  report(output) if verbose && !output.nil? && !output.empty?
+
+  raise "Command failed. (Returned #{$?.exitstatus})" if $?.exitstatus != 0
+
+  output
+end
+
+def report_summary
+  summary = UnityTestSummary.new
+  summary.root = __dir__
+  results_glob = "#{$cfg['compiler']['build_path']}*.test*"
+  results_glob.tr!('\\', '/')
+  results = Dir[results_glob]
+  summary.targets = results
+  summary.run
+end
+
+def run_tests(exclude_stdlib=false)
+  report 'Running Unity system tests...'
+
+  # Tack on TEST define for compiling unit tests
+  load_configuration($cfg_file)
+  test_defines = ['TEST']
+  $cfg['compiler']['defines']['items'] = [] if $cfg['compiler']['defines']['items'].nil?
+  $cfg['compiler']['defines']['items'] << 'UNITY_EXCLUDE_STDLIB_MALLOC' if exclude_stdlib
+
+  # Get a list of all source files needed
+  src_files  = Dir["#{__dir__}/src/*.c"]
+  src_files += Dir["#{__dir__}/test/*.c"]
+  src_files << '../../src/unity.c'
+
+  # Build object files
+  src_files.each { |f| compile(f, test_defines) }
+  obj_list = src_files.map { |f| File.basename(f.ext($cfg['compiler']['object_files']['extension'])) }
+
+  # Link the test executable
+  test_base = 'framework_test'
+  link_it(test_base, obj_list)
+
+  # Execute unit test and generate results file
+  simulator = build_simulator_fields
+  executable = $cfg['linker']['bin_files']['destination'] + test_base + $cfg['linker']['bin_files']['extension']
+  cmd_str = if simulator.nil?
+              executable + ' -v -r'
+            else
+              "#{simulator[:command]} #{simulator[:pre_support]} #{executable} #{simulator[:post_support]}"
+            end
+  output = execute(cmd_str)
+  test_results = $cfg['compiler']['build_path'] + test_base
+  test_results += if output.match(/OK$/m).nil?
+                    '.testfail'
+                  else
+                    '.testpass'
+                  end
+  File.open(test_results, 'w') { |f| f.print output }
+end

data/vendor/cmock/vendor/unity/extras/memory/readme.md

@@ -0,0 +1,49 @@
+# Unity Memory
+
+This Framework is an optional add-on to Unity.  By including unity.h and then
+unity_memory.h, you have the added ability to track malloc and free calls. This 
+addon requires that the stdlib functions be overridden by its own defines. These
+defines will still malloc / realloc / free etc, but will also track the calls
+in order to ensure that you don't have any memory leaks in your programs.
+
+Note that this is only useful in situations where a unit is in charge of both
+the allocation and deallocation of memory. When it is not symmetric, unit testing 
+can report a number of false failures. A more advanced runtime tool is required to
+track complete system memory handling.
+
+# Module API
+
+## `UnityMalloc_StartTest` and `UnityMalloc_EndTest`
+
+These must be called at the beginning and end of each test. For simplicity, they can
+be added to `setUp` and `tearDown` in order to do their job. When using the test
+runner generator scripts, these will be automatically added to the runner whenever
+unity_memory.h is included.
+
+## `UnityMalloc_MakeMallocFailAfterCount`
+
+This can be called from the tests themselves. Passing this function a number will
+force the reference counter to start keeping track of malloc calls. During that test,
+if the number of malloc calls exceeds the number given, malloc will immediately 
+start returning `NULL`. This allows you to test error conditions. Think of it as a 
+simplified mock.
+
+# Configuration
+
+## `UNITY_MALLOC` and `UNITY_FREE`
+
+By default, this module tries to use the real stdlib `malloc` and `free` internally. 
+If you would prefer it to use something else, like FreeRTOS's `pvPortMalloc` and 
+`pvPortFree`, then you can use these defines to make it so.
+
+## `UNITY_EXCLUDE_STDLIB_MALLOC`
+
+If you would like this library to ignore stdlib or other heap engines completely, and
+manage the memory on its own, then define this. All memory will be handled internally
+(and at likely lower overhead). Note that this is not a very featureful memory manager,
+but is sufficient for most testing purposes.
+
+## `UNITY_INTERNAL_HEAP_SIZE_BYTES`
+
+When using the built-in memory manager (see `UNITY_EXCLUDE_STDLIB_MALLOC`) this define
+allows you to set the heap size this library will use to manage the memory.

data/vendor/cmock/vendor/unity/extras/memory/src/unity_memory.c

@@ -0,0 +1,202 @@
+/* ==========================================
+ *  Unity Project - A Test Framework for C
+ *  Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
+ *  [Released under MIT License. Please refer to license.txt for details]
+ * ========================================== */
+
+#include "unity.h"
+#include "unity_memory.h"
+#include <string.h>
+
+#define MALLOC_DONT_FAIL -1
+static int malloc_count;
+static int malloc_fail_countdown = MALLOC_DONT_FAIL;
+
+void UnityMalloc_StartTest(void)
+{
+    malloc_count = 0;
+    malloc_fail_countdown = MALLOC_DONT_FAIL;
+}
+
+void UnityMalloc_EndTest(void)
+{
+    malloc_fail_countdown = MALLOC_DONT_FAIL;
+    if (malloc_count != 0)
+    {
+        UNITY_TEST_FAIL(Unity.CurrentTestLineNumber, "This test leaks!");
+    }
+}
+
+void UnityMalloc_MakeMallocFailAfterCount(int countdown)
+{
+    malloc_fail_countdown = countdown;
+}
+
+/* These definitions are always included from unity_fixture_malloc_overrides.h */
+/* We undef to use them or avoid conflict with <stdlib.h> per the C standard */
+#undef malloc
+#undef free
+#undef calloc
+#undef realloc
+
+#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
+static unsigned char unity_heap[UNITY_INTERNAL_HEAP_SIZE_BYTES];
+static size_t heap_index;
+#else
+#include <stdlib.h>
+#endif
+
+typedef struct GuardBytes
+{
+    size_t size;
+    size_t guard_space;
+} Guard;
+
+#define UNITY_MALLOC_ALIGNMENT (UNITY_POINTER_WIDTH / 8)
+static const char end[] = "END";
+
+static size_t unity_size_round_up(size_t size)
+{
+    size_t rounded_size;
+
+    rounded_size = ((size + UNITY_MALLOC_ALIGNMENT - 1) / UNITY_MALLOC_ALIGNMENT) * UNITY_MALLOC_ALIGNMENT;
+
+    return rounded_size;
+}
+
+void* unity_malloc(size_t size)
+{
+    char* mem;
+    Guard* guard;
+    size_t total_size;
+
+    total_size = sizeof(Guard) + unity_size_round_up(size + sizeof(end));
+
+    if (malloc_fail_countdown != MALLOC_DONT_FAIL)
+    {
+        if (malloc_fail_countdown == 0)
+            return NULL;
+        malloc_fail_countdown--;
+    }
+
+    if (size == 0) return NULL;
+#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
+    if (heap_index + total_size > UNITY_INTERNAL_HEAP_SIZE_BYTES)
+    {
+        guard = NULL;
+    }
+    else
+    {
+        /* We know we can get away with this cast because we aligned memory already */
+        guard = (Guard*)(void*)(&unity_heap[heap_index]);
+        heap_index += total_size;
+    }
+#else
+    guard = (Guard*)UNITY_MALLOC(total_size);
+#endif
+    if (guard == NULL) return NULL;
+    malloc_count++;
+    guard->size = size;
+    guard->guard_space = 0;
+    mem = (char*)&(guard[1]);
+    memcpy(&mem[size], end, sizeof(end));
+
+    return (void*)mem;
+}
+
+static int isOverrun(void* mem)
+{
+    Guard* guard = (Guard*)mem;
+    char* memAsChar = (char*)mem;
+    guard--;
+
+    return guard->guard_space != 0 || strcmp(&memAsChar[guard->size], end) != 0;
+}
+
+static void release_memory(void* mem)
+{
+    Guard* guard = (Guard*)mem;
+    guard--;
+
+    malloc_count--;
+#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
+    {
+        size_t block_size;
+
+        block_size = unity_size_round_up(guard->size + sizeof(end));
+
+        if (mem == unity_heap + heap_index - block_size)
+        {
+            heap_index -= (sizeof(Guard) + block_size);
+        }
+    }
+#else
+    UNITY_FREE(guard);
+#endif
+}
+
+void unity_free(void* mem)
+{
+    int overrun;
+
+    if (mem == NULL)
+    {
+        return;
+    }
+
+    overrun = isOverrun(mem);
+    release_memory(mem);
+    if (overrun)
+    {
+        UNITY_TEST_FAIL(Unity.CurrentTestLineNumber, "Buffer overrun detected during free()");
+    }
+}
+
+void* unity_calloc(size_t num, size_t size)
+{
+    void* mem = unity_malloc(num * size);
+    if (mem == NULL) return NULL;
+    memset(mem, 0, num * size);
+    return mem;
+}
+
+void* unity_realloc(void* oldMem, size_t size)
+{
+    Guard* guard = (Guard*)oldMem;
+    void* newMem;
+
+    if (oldMem == NULL) return unity_malloc(size);
+
+    guard--;
+    if (isOverrun(oldMem))
+    {
+        release_memory(oldMem);
+        UNITY_TEST_FAIL(Unity.CurrentTestLineNumber, "Buffer overrun detected during realloc()");
+    }
+
+    if (size == 0)
+    {
+        release_memory(oldMem);
+        return NULL;
+    }
+
+    if (guard->size >= size) return oldMem;
+
+#ifdef UNITY_EXCLUDE_STDLIB_MALLOC /* Optimization if memory is expandable */
+    {
+        size_t old_total_size = unity_size_round_up(guard->size + sizeof(end));
+
+        if ((oldMem == unity_heap + heap_index - old_total_size) &&
+            ((heap_index - old_total_size + unity_size_round_up(size + sizeof(end))) <= UNITY_INTERNAL_HEAP_SIZE_BYTES))
+        {
+            release_memory(oldMem);    /* Not thread-safe, like unity_heap generally */
+            return unity_malloc(size); /* No memcpy since data is in place */
+        }
+    }
+#endif
+    newMem = unity_malloc(size);
+    if (newMem == NULL) return NULL; /* Do not release old memory */
+    memcpy(newMem, oldMem, guard->size);
+    release_memory(oldMem);
+    return newMem;
+}