12 files changed, 507 insertions, 0 deletions
diff --git a/deps/Unity/examples/example_3/helper/UnityHelper.c b/deps/Unity/examples/example_3/helper/UnityHelper.c
new file mode 100644
index 0000000..9cf42c6
--- /dev/null
+++ b/deps/Unity/examples/example_3/helper/UnityHelper.c
@@ -0,0 +1,10 @@
+#include "unity.h"
+#include "UnityHelper.h"
+#include <stdio.h>
+#include <string.h>
+
+void AssertEqualExampleStruct(const EXAMPLE_STRUCT_T expected, const EXAMPLE_STRUCT_T actual, const unsigned short line)
+{
+    UNITY_TEST_ASSERT_EQUAL_INT(expected.x, actual.x, line, "Example Struct Failed For Field x");
+    UNITY_TEST_ASSERT_EQUAL_INT(expected.y, actual.y, line, "Example Struct Failed For Field y");
+}
diff --git a/deps/Unity/examples/example_3/helper/UnityHelper.h b/deps/Unity/examples/example_3/helper/UnityHelper.h
new file mode 100644
index 0000000..1516111
--- /dev/null
+++ b/deps/Unity/examples/example_3/helper/UnityHelper.h
@@ -0,0 +1,12 @@
+#ifndef _TESTHELPER_H
+#define _TESTHELPER_H
+
+#include "Types.h"
+
+void AssertEqualExampleStruct(const EXAMPLE_STRUCT_T expected, const EXAMPLE_STRUCT_T actual, const unsigned short line);
+
+#define UNITY_TEST_ASSERT_EQUAL_EXAMPLE_STRUCT_T(expected, actual, line, message) AssertEqualExampleStruct(expected, actual, line);
+
+#define TEST_ASSERT_EQUAL_EXAMPLE_STRUCT_T(expected, actual) UNITY_TEST_ASSERT_EQUAL_EXAMPLE_STRUCT_T(expected, actual, __LINE__, NULL);
+
+#endif // _TESTHELPER_H
diff --git a/deps/Unity/examples/example_3/rakefile.rb b/deps/Unity/examples/example_3/rakefile.rb
new file mode 100644
index 0000000..c095af3
--- /dev/null
+++ b/deps/Unity/examples/example_3/rakefile.rb
@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/clean'
+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 = 'target_gcc_32.yml'.freeze
+configure_toolchain(DEFAULT_CONFIG_FILE)
+
+task unit: [:prepare_for_tests] do
+  run_tests unit_test_files
+end
+
+desc 'Generate test summary'
+task :summary do
+  report_summary
+end
+
+desc 'Build and test Unity'
+task all: %i[clean unit summary]
+task default: %i[clobber all]
+task ci: [:default]
+task cruise: [:default]
+
+desc 'Load configuration'
+task :config, :config_file do |_t, args|
+  configure_toolchain(args[:config_file])
+end
diff --git a/deps/Unity/examples/example_3/rakefile_helper.rb b/deps/Unity/examples/example_3/rakefile_helper.rb
new file mode 100644
index 0000000..cbc4549
--- /dev/null
+++ b/deps/Unity/examples/example_3/rakefile_helper.rb
@@ -0,0 +1,254 @@
+# ==========================================
+#   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 'fileutils'
+require_relative '../../auto/unity_test_summary'
+require_relative '../../auto/generate_test_runner'
+require_relative '../../auto/colour_reporter'
+require_relative '../../auto/yaml_helper'
+C_EXTENSION = '.c'.freeze
+
+def load_configuration(config_file)
+  $cfg_file = config_file
+  $cfg = YamlHelper.load_file($cfg_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$/
+  load_configuration(config_file)
+  configure_clean
+end
+
+def unit_test_files
+  path = "#{$cfg['compiler']['unit_tests_path']}Test*#{C_EXTENSION}"
+  path.tr!('\\', '/')
+  FileList.new(path)
+end
+
+def local_include_dirs
+  include_dirs = $cfg['compiler']['includes']['items'].dup
+  include_dirs.delete_if { |dir| dir.is_a?(Array) }
+  include_dirs
+end
+
+def extract_headers(filename)
+  includes = []
+  lines = File.readlines(filename)
+  lines.each do |line|
+    m = line.match(/^\s*#include\s+"\s*(.+\.[hH])\s*"/)
+    includes << m[1] unless m.nil?
+  end
+  includes
+end
+
+def find_source_file(header, paths)
+  paths.each do |dir|
+    src_file = dir + header.ext(C_EXTENSION)
+    return src_file if File.exist?(src_file)
+  end
+  nil
+end
+
+def tackit(strings)
+  if strings.is_a?(Array)
+    "\"#{strings.join}\""
+  else
+    strings
+  end
+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
+              squash($cfg['compiler']['defines']['prefix'], $cfg['compiler']['defines']['items'])
+            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
+  cmd_str  = "#{compiler[:command]}#{compiler[:defines]}#{compiler[:options]}#{compiler[:includes]} #{file} " \
+             "#{$cfg['compiler']['object_files']['prefix']}#{$cfg['compiler']['object_files']['destination']}"
+  obj_file = "#{File.basename(file, C_EXTENSION)}#{$cfg['compiler']['object_files']['extension']}"
+  execute(cmd_str + obj_file)
+  obj_file
+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]}"
+  cmd_str += " #{(obj_list.map { |obj| "#{$cfg['linker']['object_files']['path']}#{obj}" }).join(' ')}"
+  cmd_str += " #{$cfg['linker']['bin_files']['prefix']} "
+  cmd_str += $cfg['linker']['bin_files']['destination']
+  cmd_str += 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, raise_on_fail = true)
+  report command_string
+  output = `#{command_string}`.chomp
+  report(output) if verbose && !output.nil? && !output.empty?
+
+  if !$?.nil? && !$?.exitstatus.zero? && raise_on_fail
+    raise "Command failed. (Returned #{$?.exitstatus})"
+  end
+
+  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
+  fail_out 'FAIL: There were failures' if summary.failures > 0
+end
+
+def run_tests(test_files)
+  report 'Running 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'] << 'TEST'
+
+  include_dirs = local_include_dirs
+
+  # Build and execute each unit test
+  test_files.each do |test|
+    obj_list = []
+
+    # Detect dependencies and build required required modules
+    extract_headers(test).each do |header|
+      # Compile corresponding source file if it exists
+      src_file = find_source_file(header, include_dirs)
+      obj_list << compile(src_file, test_defines) unless src_file.nil?
+    end
+
+    # Build the test runner (generate if configured to do so)
+    test_base = File.basename(test, C_EXTENSION)
+    runner_name = "#{test_base}_Runner.c"
+    if $cfg['compiler']['runner_path'].nil?
+      runner_path = $cfg['compiler']['build_path'] + runner_name
+      test_gen = UnityTestRunnerGenerator.new($cfg_file)
+      test_gen.run(test, runner_path)
+    else
+      runner_path = $cfg['compiler']['runner_path'] + runner_name
+    end
+
+    obj_list << compile(runner_path, test_defines)
+
+    # Build the test module
+    obj_list << compile(test, test_defines)
+
+    # Link the test executable
+    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
+              else
+                "#{simulator[:command]} #{simulator[:pre_support]} #{executable} #{simulator[:post_support]}"
+              end
+    output = execute(cmd_str, true, false)
+    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
+end
+
+def build_application(main)
+  report 'Building application...'
+
+  obj_list = []
+  load_configuration($cfg_file)
+  main_path = $cfg['compiler']['source_path'] + main + C_EXTENSION
+
+  # Detect dependencies and build required required modules
+  include_dirs = get_local_include_dirs
+  extract_headers(main_path).each do |header|
+    src_file = find_source_file(header, include_dirs)
+    obj_list << compile(src_file) unless src_file.nil?
+  end
+
+  # Build the main source file
+  main_base = File.basename(main_path, C_EXTENSION)
+  obj_list << compile(main_path)
+
+  # Create the executable
+  link_it(main_base, obj_list)
+end
+
+def fail_out(msg)
+  puts msg
+  puts 'Not returning exit code so continuous integration can pass'
+  #    exit(-1) # Only removed to pass example_3, which has failing tests on purpose.
+  #               Still fail if the build fails for any other reason.
+end
diff --git a/deps/Unity/examples/example_3/readme.txt b/deps/Unity/examples/example_3/readme.txt
new file mode 100644
index 0000000..7371fea
--- /dev/null
+++ b/deps/Unity/examples/example_3/readme.txt
@@ -0,0 +1,13 @@
+Example 3
+=========
+
+This example project gives an example of some passing, ignored, and failing tests.
+It's simple and meant for you to look over and get an idea for what all of this stuff does.
+
+You can build and test using rake. The rake version will let you test with gcc or a couple
+versions of IAR.  You can tweak the yaml files to get those versions running.
+
+Ruby is required if you're using the rake version (obviously).  This version shows off most of
+Unity's advanced features (automatically creating test runners, fancy summaries, etc.)
+Without ruby, you have to maintain your own test runners.  Do that for a while and you'll learn
+why you really want to start using the Ruby tools.
diff --git a/deps/Unity/examples/example_3/src/ProductionCode.c b/deps/Unity/examples/example_3/src/ProductionCode.c
new file mode 100644
index 0000000..3bafe20
--- /dev/null
+++ b/deps/Unity/examples/example_3/src/ProductionCode.c
@@ -0,0 +1,24 @@
+
+#include "ProductionCode.h"
+
+int Counter = 0;
+int NumbersToFind[9] = { 0, 34, 55, 66, 32, 11, 1, 77, 888 }; //some obnoxious array to search that is 1-based indexing instead of 0.
+
+// This function is supposed to search through NumbersToFind and find a particular number.  
+// If it finds it, the index is returned.  Otherwise 0 is returned which sorta makes sense since 
+// NumbersToFind is indexed from 1.  Unfortunately it's broken 
+// (and should therefore be caught by our tests)
+int FindFunction_WhichIsBroken(int NumberToFind)
+{
+    int i = 0;
+    while (i < 8) //Notice I should have been in braces
+        i++;
+        if (NumbersToFind[i] == NumberToFind) //Yikes!  I'm getting run after the loop finishes instead of during it!
+            return i;
+    return 0;
+}
+
+int FunctionWhichReturnsLocalVariable(void)
+{
+    return Counter;
+}
diff --git a/deps/Unity/examples/example_3/src/ProductionCode.h b/deps/Unity/examples/example_3/src/ProductionCode.h
new file mode 100644
index 0000000..250ca0d
--- /dev/null
+++ b/deps/Unity/examples/example_3/src/ProductionCode.h
@@ -0,0 +1,3 @@
+
+int FindFunction_WhichIsBroken(int NumberToFind);
+int FunctionWhichReturnsLocalVariable(void);
diff --git a/deps/Unity/examples/example_3/src/ProductionCode2.c b/deps/Unity/examples/example_3/src/ProductionCode2.c
new file mode 100644
index 0000000..77c969f
--- /dev/null
+++ b/deps/Unity/examples/example_3/src/ProductionCode2.c
@@ -0,0 +1,11 @@
+
+#include "ProductionCode2.h"
+
+char* ThisFunctionHasNotBeenTested(int Poor, char* LittleFunction)
+{
+  (void)Poor;
+  (void)LittleFunction;
+  //Since There Are No Tests Yet, This Function Could Be Empty For All We Know.
+  // Which isn't terribly useful... but at least we put in a TEST_IGNORE so we won't forget
+  return (char*)0;
+}
diff --git a/deps/Unity/examples/example_3/src/ProductionCode2.h b/deps/Unity/examples/example_3/src/ProductionCode2.h
new file mode 100644
index 0000000..34ae980
--- /dev/null
+++ b/deps/Unity/examples/example_3/src/ProductionCode2.h
@@ -0,0 +1,2 @@
+
+char* ThisFunctionHasNotBeenTested(int Poor, char* LittleFunction);
diff --git a/deps/Unity/examples/example_3/target_gcc_32.yml b/deps/Unity/examples/example_3/target_gcc_32.yml
new file mode 100644
index 0000000..d7568ab
--- /dev/null
+++ b/deps/Unity/examples/example_3/target_gcc_32.yml
@@ -0,0 +1,47 @@
+# Copied from ~Unity/targets/gcc_32.yml
+unity_root:  &unity_root '../..'
+unity_source: &unity_source '../../src/'
+compiler:
+  path: gcc
+  source_path:     &source_path 'src/'
+  unit_tests_path: &unit_tests_path 'test/'
+  build_path:      &build_path 'build/'
+  options:
+    - '-c'
+    - '-m32'
+    - '-Wall'
+    - '-Wno-address'
+    - '-std=c99'
+    - '-pedantic'
+  includes:
+    prefix: '-I'
+    items:
+      - *source_path
+      - *unity_source
+      - *unit_tests_path
+  defines:
+    prefix: '-D'
+    items:
+      - UNITY_INCLUDE_DOUBLE
+      - UNITY_SUPPORT_TEST_CASES
+  object_files:
+    prefix: '-o'
+    extension: '.o'
+    destination: *build_path
+linker:
+  path: gcc
+  options:
+    - -lm
+    - '-m32'
+  includes:
+    prefix: '-I'
+  object_files:
+    path: *build_path
+    extension: '.o'
+  bin_files:
+    prefix: '-o'
+    extension: '.exe'
+    destination: *build_path
+colour: true
+:unity:
+  :plugins: []
diff --git a/deps/Unity/examples/example_3/test/TestProductionCode.c b/deps/Unity/examples/example_3/test/TestProductionCode.c
new file mode 100644
index 0000000..28a5581
--- /dev/null
+++ b/deps/Unity/examples/example_3/test/TestProductionCode.c
@@ -0,0 +1,62 @@
+
+#include "ProductionCode.h"
+#include "unity.h"
+
+//sometimes you may want to get at local data in a module.
+//for example: If you plan to pass by reference, this could be useful
+//however, it should often be avoided
+extern int Counter; 
+
+void setUp(void)
+{
+  //This is run before EACH TEST
+  Counter = 0x5a5a;
+}
+
+void tearDown(void)
+{
+}
+
+void test_FindFunction_WhichIsBroken_ShouldReturnZeroIfItemIsNotInList_WhichWorksEvenInOurBrokenCode(void)
+{
+  //All of these should pass
+  TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(78));
+  TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(1));
+  TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(33));
+  TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(999));
+  TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(-1));
+}
+
+void test_FindFunction_WhichIsBroken_ShouldReturnTheIndexForItemsInList_WhichWillFailBecauseOurFunctionUnderTestIsBroken(void)
+{
+  // You should see this line fail in your test summary
+  TEST_ASSERT_EQUAL(1, FindFunction_WhichIsBroken(34));
+  
+  // Notice the rest of these didn't get a chance to run because the line above failed.  
+  // Unit tests abort each test function on the first sign of trouble. 
+  // Then NEXT test function runs as normal.
+  TEST_ASSERT_EQUAL(8, FindFunction_WhichIsBroken(8888));
+}
+
+void test_FunctionWhichReturnsLocalVariable_ShouldReturnTheCurrentCounterValue(void)
+{
+    //This should be true because setUp set this up for us before this test
+    TEST_ASSERT_EQUAL_HEX(0x5a5a, FunctionWhichReturnsLocalVariable());
+    
+    //This should be true because we can still change our answer
+    Counter = 0x1234;
+    TEST_ASSERT_EQUAL_HEX(0x1234, FunctionWhichReturnsLocalVariable());
+}
+
+void test_FunctionWhichReturnsLocalVariable_ShouldReturnTheCurrentCounterValueAgain(void)
+{
+    //This should be true again because setup was rerun before this test (and after we changed it to 0x1234)
+    TEST_ASSERT_EQUAL_HEX(0x5a5a, FunctionWhichReturnsLocalVariable());
+}
+
+void test_FunctionWhichReturnsLocalVariable_ShouldReturnCurrentCounter_ButFailsBecauseThisTestIsActuallyFlawed(void)
+{
+    //Sometimes you get the test wrong.  When that happens, you get a failure too... and a quick look should tell
+    // you what actually happened...which in this case was a failure to setup the initial condition.
+    TEST_ASSERT_EQUAL_HEX(0x1234, FunctionWhichReturnsLocalVariable());
+}
diff --git a/deps/Unity/examples/example_3/test/TestProductionCode2.c b/deps/Unity/examples/example_3/test/TestProductionCode2.c
new file mode 100644
index 0000000..e2119cc
--- /dev/null
+++ b/deps/Unity/examples/example_3/test/TestProductionCode2.c
@@ -0,0 +1,31 @@
+
+#include "ProductionCode2.h"
+#include "unity.h"
+
+/* These should be ignored because they are commented out in various ways:
+#include "whatever.h" 
+*/
+//#include "somethingelse.h"
+
+void setUp(void)
+{
+}
+
+void tearDown(void)
+{
+}
+
+void test_IgnoredTest(void)
+{
+    TEST_IGNORE_MESSAGE("This Test Was Ignored On Purpose");
+}
+
+void test_AnotherIgnoredTest(void)
+{
+    TEST_IGNORE_MESSAGE("These Can Be Useful For Leaving Yourself Notes On What You Need To Do Yet");
+}
+
+void test_ThisFunctionHasNotBeenTested_NeedsToBeImplemented(void)
+{
+    TEST_IGNORE(); //Like This
+}