ceedling 0.0.1

data/new_project_template/vendor/ceedling/test/system/mocks/test/test_a_file.c

@@ -0,0 +1,41 @@
+#include "unity.h"
+#include "a_file.h"
+#include "mock_stuff.h"
+#include "mock_other_stuff.h"
+
+
+void setUp(void) {}
+void tearDown(void) {}
+
+
+void test_a_function_should_pass_with_values_that_make_sense(void)
+{
+	add_ExpectAndReturn(3, 5, 8);
+	subtract_ExpectAndReturn(8, 2, 6);
+	
+  TEST_ASSERT_EQUAL(6, a_function(3, 5, 2));
+}
+
+void test_a_function_should_pass_because_we_lied_with_our_mocks(void)
+{
+	add_ExpectAndReturn(0, 0, 0);
+	subtract_ExpectAndReturn(0, 0, 100);
+	
+  TEST_ASSERT_EQUAL(100, a_function(0, 0, 0));
+}
+
+void test_a_function_should_fail_because_missing_expectation(void)
+{
+	subtract_ExpectAndReturn(0, 0, 100);
+	
+  TEST_ASSERT_EQUAL(100, a_function(0, 0, 0));
+}
+
+void test_a_function_should_fail_because_wrong_return_value(void)
+{
+	add_ExpectAndReturn(3, 5, 8);
+	subtract_ExpectAndReturn(8, 2, 0);
+	
+  TEST_ASSERT_EQUAL(6, a_function(3, 5, 2));
+}
+

data/new_project_template/vendor/ceedling/test/system/mocks/test/test_no_file.c

@@ -0,0 +1,14 @@
+#include "unity.h"
+#include "a_file.h"
+#include "mock_say_wha.h" // doesn't exist
+
+
+void setUp(void) {}
+void tearDown(void) {}
+
+
+void test_a_function(void)
+{
+  TEST_ASSERT(1);
+}
+

data/new_project_template/vendor/ceedling/test/system/project_mocks.yml

@@ -0,0 +1,43 @@
+---
+# super simple test project for: mock support
+
+:project:
+  :use_exceptions: FALSE
+  :use_mocks: TRUE
+  :use_preprocessor: FALSE
+  :use_auxiliary_dependencie: FALSE
+  :build_root: test/system/mocks/build
+
+  # shut up ceedling because of intentional exceptions;
+  # error report is misleading in test output  
+  :verbosity: 0
+
+:paths:
+  :test:
+    - test/system/mocks/test
+  :source:
+    - test/system/mocks/source
+  :include:
+    - test/system/mocks/include
+
+:cmock:
+  :mock_prefix: mock_
+
+:tools:
+  :test_compiler:
+    :executable: gcc
+    :arguments:
+      - -I"$": COLLECTION_PATHS_TEST_AND_SOURCE_INCLUDE
+      - -D$: COLLECTION_DEFINES_TEST
+      - -c ${1}
+      - -o ${2}
+  :test_linker:
+    :executable: gcc
+    :arguments:
+      - ${1}
+      - -o ${2}
+  # built under gcc, the test is the executable (no simulator)
+  :test_fixture:
+    :executable: ${1}
+ 
+...

data/new_project_template/vendor/ceedling/test/system/project_mocks_test.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../system_test_helper'
+
+
+class TestTasksTest < Test::Unit::TestCase
+
+  def setup
+    @results_path = "#{SYSTEM_TEST_ROOT}/mocks/build/tests/results"
+    
+    ENV['CEEDLING_MAIN_PROJECT_FILE'] = File.join(SYSTEM_TEST_ROOT, 'project_mocks.yml')
+
+    ceedling_execute('directories', 'clobber')
+  end
+
+  def teardown
+  end
+
+
+  should "run a test and verify test results" do
+
+    # tell rake to execute all tests; use '--trace' to see problem if rake run explodes
+    ceedling_execute('test:test_a_file.c', '--trace')
+    
+    results = fetch_test_results(@results_path, 'test_a_file');
+    
+    assert_equal(4, results[:counts][:total])
+    assert_equal(2, results[:counts][:passed])
+    assert_equal(2, results[:counts][:failed])
+  end
+
+  should "blow up if header to be mocked is not found" do
+
+    # tell rake to execute all tests
+    results = ceedling_execute_no_boom('test:test_no_file.c')
+    assert_no_match(/ERROR: Could not find 'say_wha\.h'/i, results, 'execution should have failed because header file was not found')
+  end
+
+
+end

data/new_project_template/vendor/ceedling/test/system/project_simple.yml

@@ -0,0 +1,36 @@
+---
+# super simple test project for: basic unity test assert tests
+
+:project:
+  :use_exceptions: FALSE
+  :use_mocks: FALSE
+  :use_preprocessor: FALSE
+  :use_auxiliary_dependencie: FALSE
+  :build_root: test/system/simple/build
+
+:paths:
+  :test:
+    - test/system/simple/test
+  :source:
+    - test/system/simple/source
+  :include:
+    - test/system/simple/include
+
+:tools:
+  :test_compiler:
+    :executable: gcc
+    :arguments:
+      - -I"$": COLLECTION_PATHS_TEST_AND_SOURCE_INCLUDE
+      - -D$: COLLECTION_DEFINES_TEST
+      - -c ${1}
+      - -o ${2}
+  :test_linker:
+    :executable: gcc
+    :arguments:
+      - ${1}
+      - -o ${2}
+  # built under gcc, the test is the executable (no simulator)
+  :test_fixture:
+    :executable: ${1}
+
+...

data/new_project_template/vendor/ceedling/test/system/project_simple_test.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/../system_test_helper'
+
+
+class ProjectSimpleTest < Test::Unit::TestCase
+
+  def setup
+    @results_path = "#{SYSTEM_TEST_ROOT}/simple/build/tests/results"
+    
+    ENV['CEEDLING_MAIN_PROJECT_FILE'] = File.join(SYSTEM_TEST_ROOT, 'project_simple.yml')
+
+    ceedling_execute('directories', 'clobber')
+  end
+
+  def teardown
+  end
+
+
+  should "run all tests and verify test results" do
+
+    # tell rake to execute all tests; use '--trace' to see problem if rake run explodes
+    ceedling_execute('test:all', '--trace')
+    
+    results = fetch_test_results(@results_path, 'test_stuff');
+    
+    assert_equal(7, results[:counts][:total])
+    assert_equal(2, results[:counts][:passed])
+    assert_equal(1, results[:counts][:failed])
+    assert_equal(4, results[:counts][:ignored])
+
+    results = fetch_test_results(@results_path, 'test_other_stuff');
+    
+    assert_equal(4, results[:counts][:total])
+    assert_equal(2, results[:counts][:passed])
+    assert_equal(2, results[:counts][:failed])
+    assert_equal(0, results[:counts][:ignored])
+
+  end
+
+end

data/new_project_template/vendor/ceedling/test/system/rule_mocks_test.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/../system_test_helper'
+
+
+class MocksRuleTest < Test::Unit::TestCase
+
+  def setup
+    @header_file     = "a_file.h"
+    @mock_file       = "mock_a_file.c"
+    @header_filepath = "#{SYSTEM_TEST_ROOT}/mocks/include/#{@header_file}"
+    @mock_filepath   = "#{SYSTEM_TEST_ROOT}/mocks/build/tests/mocks/#{@mock_file}"
+
+    ENV['CEEDLING_MAIN_PROJECT_FILE'] = File.join(SYSTEM_TEST_ROOT, 'project_mocks.yml')
+
+    ceedling_execute('directories', 'clobber')    
+  end
+
+  def teardown
+  end
+
+
+  should "generate a mock from a source header file and regenerate when its dependent source changes" do
+    rake_exec_matcher = /^\*\* Execute.+#{Regexp.escape(@mock_file)}$/
+
+    # verify clobber did its job
+    assert_equal(false, File.exists?(@mock_filepath))
+    
+    # give rake a task to generate a mock file & verify its presence
+    ceedling_execute(@mock_filepath)
+    assert_equal(true, File.exists?(@mock_filepath), 'mock file not created')
+    
+    # verify executing rule again will not regenerate mock
+    output = ceedling_execute_dry_run(@mock_filepath)
+    assert_no_match(rake_exec_matcher, output, 'mock file should not be slated for generation')
+    
+    # wait a spell to update file timestamp, ensuring time change is recognizable
+    sleep(1)
+    FileUtils.touch(@header_filepath)
+
+    # verify executing rule again will regenerate mock
+    output = ceedling_execute_dry_run(@mock_filepath)
+    assert_match(rake_exec_matcher, output, 'mock file should be slated for generation')    
+  end
+
+end

data/new_project_template/vendor/ceedling/test/system/rule_runners_test.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/../system_test_helper'
+
+
+class RunnersRuleTest < Test::Unit::TestCase
+
+  def setup
+    @test_file       = 'test_stuff.c'
+    @runner_file     = 'test_stuff_runner.c'
+    @test_filepath   = "#{SYSTEM_TEST_ROOT}/simple/test/#{@test_file}"
+    @runner_filepath = "#{SYSTEM_TEST_ROOT}/simple/build/tests/runners/#{@runner_file}"
+
+    ENV['CEEDLING_MAIN_PROJECT_FILE'] = File.join(SYSTEM_TEST_ROOT, 'project_simple.yml')
+
+    ceedling_execute('directories', 'clobber')    
+  end
+
+  def teardown
+  end
+
+
+  should "generate a test runner from a test source header file and regenerate when its dependent source changes" do
+    rake_exec_matcher = /^\*\* Execute.+#{Regexp.escape(@runner_file)}$/
+    
+    # verify clobber did its job
+    assert_equal(false, File.exists?(@runner_filepath))
+    
+    # give rake a task to generate a test runner file & verify its presence
+    ceedling_execute(@runner_filepath)
+    assert_equal(true, File.exists?(@runner_filepath), 'test runner file not created')
+    
+    # verify executing rule again will not regenerate runner
+    output = ceedling_execute_dry_run(@runner_filepath)
+    assert_no_match(rake_exec_matcher, output, 'test runner file should not be slated for generation')
+    
+    # wait a spell to update file timestamp, ensuring time change is recognizable
+    sleep(1)
+    FileUtils.touch(@test_filepath)
+
+    # verify executing rule again will regenerate runner
+    output = ceedling_execute_dry_run(@runner_filepath)
+    assert_match(rake_exec_matcher, output, 'test runner file should be slated for generation')    
+  end
+
+end

data/new_project_template/vendor/ceedling/test/system/simple/include/other_stuff.h

@@ -0,0 +1,2 @@
+
+int add(int a, int b);

data/new_project_template/vendor/ceedling/test/system/simple/include/stuff.h

@@ -0,0 +1,3 @@
+
+int subtract(int a, int b);
+

data/new_project_template/vendor/ceedling/test/system/simple/source/other_stuff.c

@@ -0,0 +1,6 @@
+#include "other_stuff.h"
+
+int add(int a, int b)
+{
+	return a + b;
+}

data/new_project_template/vendor/ceedling/test/system/simple/source/stuff.c

@@ -0,0 +1,7 @@
+#include "stuff.h"
+
+int subtract(int a, int b)
+{
+	return a - b;
+}
+

data/new_project_template/vendor/ceedling/test/system/simple/test/test_other_stuff.c

@@ -0,0 +1,30 @@
+#include "unity.h"
+#include "other_stuff.h"
+
+
+void setUp(void) {}
+void tearDown(void) {}
+
+// test successes
+
+void test_add_should_succeed_1(void)
+{
+	TEST_ASSERT_EQUAL(100, add(30, 70));
+}
+
+void test_add_should_succeed_2(void)
+{
+	TEST_ASSERT_EQUAL(0, add(-5, 5));
+}
+
+// test failures
+
+void test_fail()
+{
+  TEST_FAIL("Boom.");
+}
+
+void test_add_should_fail(void)
+{
+	TEST_ASSERT_EQUAL(0, add(2, 2));
+}

data/new_project_template/vendor/ceedling/test/system/simple/test/test_stuff.c

@@ -0,0 +1,51 @@
+#include "unity.h"
+#include "stuff.h"
+
+
+void setUp(void) {}
+void tearDown(void) {}
+
+
+// test ignores & variations on test declarations
+
+void test_a_single_thing(void)
+{
+  TEST_IGNORE_MESSAGE("pay no attention to the test behind the curtain");
+}
+
+ void  test_another_thing ( void )
+{
+  TEST_IGNORE_MESSAGE("pay no attention to the test behind the curtain");
+}
+
+void test_some_non_void_param_stuff()
+{
+  TEST_IGNORE_MESSAGE("pay no attention to the test behind the curtain");
+}
+
+void
+test_some_multiline_test_case_action
+(void)
+{
+  TEST_IGNORE_MESSAGE("pay no attention to the test behind the curtain");
+}
+
+// test successes
+
+void test_subtract_should_succeed_1(void)
+{
+	TEST_ASSERT_EQUAL(10, subtract(31, 21));
+}
+
+void test_subtract_should_succeed_2(void)
+{
+	TEST_ASSERT_EQUAL(0, subtract(12, 12));
+}
+
+// test failures
+
+void test_subtract_should_fail(void)
+{
+	TEST_ASSERT_EQUAL(100, subtract(210, 109));
+}
+

data/new_project_template/vendor/ceedling/test/system_test_helper.rb

@@ -0,0 +1,73 @@
+require File.expand_path(File.dirname(__FILE__)) + "/../config/test_environment"
+require 'test_helper'
+require 'fileutils'
+require 'yaml'
+
+
+class Test::Unit::TestCase
+  extend Behaviors
+  
+  def ceedling_execute(*args_and_tasks)
+    return execute('rake', ["-f #{File.join(LIB_ROOT, 'rakefile.rb')}"] + args_and_tasks)
+  end
+
+  # do not raise if rake execution of ceedling bombs & do not display any output
+  def ceedling_execute_no_boom(*args_and_tasks)
+    return execute('rake', ["-f #{File.join(LIB_ROOT, 'rakefile.rb')}"] + args_and_tasks, false, false, false)
+  end
+
+  # execute rake in dry run mode -- checking dependencies and invoke states but not actually taking action
+  def ceedling_execute_dry_run(*args_and_tasks)
+    return ceedling_execute(['-n'] + args_and_tasks)
+  end
+  
+  def fetch_test_results(results_path, test_name)
+    filepath = ''
+    
+    pass_path = File.join(results_path, "#{test_name}.pass")
+    fail_path = File.join(results_path, "#{test_name}.fail")
+
+    if (File.exists?(pass_path))
+      filepath = pass_path
+    elsif (File.exists?(fail_path))
+      filepath = fail_path
+    else
+      raise "Could not find test results for '#{test_name}' in #{results_path}"
+    end
+    
+    return YAML.load(File.read(filepath))
+  end
+  
+  private
+  
+  def report(message)
+    puts message
+    $stdout.flush
+  end
+  
+  def report_err(message)
+    $stderr.puts(message)
+    $stderr.flush
+  end
+  
+  def execute(cmd, args=[], verbose_cmd=false, verbose_error=true, should_raise=true)
+    cmd_str = "#{cmd} #{args.join(' ')}"
+    
+    # execute command and redirect stderr to stdout;
+    # the redirect grabs all response output centrally & 
+    #  lets us gobble up errors if we need to parse them for test execution
+    response = `#{cmd_str} 2>&1`
+
+    report(cmd_str) if verbose_cmd
+    report(response) if verbose_cmd
+    report('') if verbose_cmd
+
+    if ($?.exitstatus != 0)
+      report_err(response) if verbose_error
+      report_err('') if verbose_error
+      raise "Command '#{cmd_str}' failed. (Returned #{$?.exitstatus})" if should_raise
+    end
+    return response
+  end
+end
+

data/new_project_template/vendor/ceedling/test/test_helper.rb

@@ -0,0 +1,93 @@
+
+#gem install test-unit -v 1.2.3
+ruby_version = RUBY_VERSION.split('.')
+if (ruby_version[1].to_i == 9) and (ruby_version[2].to_i > 1)
+  require 'gems'
+  gem 'test-unit'
+end
+require 'test/unit'
+require 'behaviors'
+
+
+TESTS_ROOT            = File.expand_path(File.dirname(__FILE__))
+SYSTEM_TEST_ROOT      = TESTS_ROOT + '/system'
+INTEGRATION_TEST_ROOT = TESTS_ROOT + '/integration'
+LIB_ROOT              = File.expand_path(File.dirname(__FILE__) + '/../lib')
+CEEDLING_ROOT         = 'test_ceedling_root/'
+CEEDLING_LIB          = 'test_ceedling_lib/'
+CEEDLING_VENDOR       = 'test_ceedling_vendor/'
+CEEDLING_RELEASE      = 'test_ceedling_release/'
+
+$config_options = {
+  :project_build_root => 'project/build',
+  :project_test_build_output_path => 'project/build/tests/output',
+  :project_test_results_path => 'project/build/tests/results',
+  :project_source_include_dirs => [],
+  :project_test_file_prefix => 'test_',
+  :project_test_preprocess_files_path => 'project/build/tests/preprocess/files',
+  :project_test_preprocess_includes_path => 'project/build/tests/preprocess/includes',
+  :project_test_dependencies_path => 'project/build/tests/dependencies',
+  :test_runner_file_suffix => '_runner',
+  :cmock_mock_prefix => 'mock_',
+  :extension_source  => '.c',
+  :extension_header  => '.h',
+  :extension_object  => '.o',
+  :extension_executable  => '.out',
+  :extension_testpass  => '.pass',
+  :extension_dependencies => '.d',
+  :collection_all_tests => [],
+  :collection_all_include_paths => [],
+  :defines_test => [],
+  }    
+
+PROJECT_BUILD_ROOT = $config_options[:project_build_root]
+PROJECT_TEST_BUILD_OUTPUT_PATH = $config_options[:project_test_build_output_path]
+PROJECT_TEST_RESULTS_PATH = $config_options[:project_test_results_path]
+PROJECT_SOURCE_INCLUDE_PATHS = $config_options[:project_source_include_dirs]
+PROJECT_TEST_FILE_PREFIX = $config_options[:project_test_file_prefix]
+PROJECT_TEST_PREPROCESS_FILES_PATH = $config_options[:project_test_preprocess_files_path]
+PROJECT_TEST_PREPROCESS_INCLUDES_PATH = $config_options[:project_test_preprocess_includes_path]
+PROJECT_TEST_DEPENDENCIES_PATH = $config_options[:project_test_dependencies_path]
+TEST_RUNNER_FILE_SUFFIX = $config_options[:test_runner_file_suffix]
+CMOCK_MOCK_PREFIX = $config_options[:cmock_mock_prefix]  
+EXTENSION_SOURCE  = $config_options[:extension_source]
+EXTENSION_HEADER  = $config_options[:extension_header]
+EXTENSION_OBJECT  = $config_options[:extension_object]
+EXTENSION_EXECUTABLE  = $config_options[:extension_executable]
+EXTENSION_TESTPASS  = $config_options[:extension_testpass]
+EXTENSION_DEPENDENCIES  = $config_options[:extension_dependencies]
+COLLECTION_ALL_TESTS  = $config_options[:collection_all_tests]
+COLLECTION_ALL_INCLUDE_PATHS = $config_options[:collection_all_include_paths]
+DEFINES_TEST = $config_options[:defines_test]
+
+
+class String
+  def left_margin(margin=0)
+    non_whitespace_column = 0
+    new_lines = []
+    
+    # find first line with non-whitespace and count left columns of whitespace
+    self.each_line do |line|
+      if (line =~ /^\s*\S/)
+        non_whitespace_column = $&.length - 1
+        break
+      end
+    end
+    
+    # iterate through each line, chopping off leftmost whitespace columns and add back the desired whitespace margin
+    self.each_line do |line|
+      columns = []
+      margin.times{columns << ' '}
+      # handle special case of line being narrower than width to be lopped off
+      if (non_whitespace_column < line.length)
+        new_lines << "#{columns.join}#{line[non_whitespace_column..-1]}"
+      else
+        new_lines << "\n"
+      end
+    end
+    
+    return new_lines.join
+  end
+end
+
+