ceedling 0.28.2 → 0.28.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ab20a20fd53b1935cb3c11cffa2f890c18f4f10
-  data.tar.gz: 8d728ca829262063f0422614c248d0eb77ca77a7
+  metadata.gz: a42e9eac6e308f7c966953c1c2d3dc9f1ccfc9bb
+  data.tar.gz: bc07f7ab10c38c3f3ddc106e87610d2cb504f263
 SHA512:
-  metadata.gz: 6aac3b5f1c9bf0179912b4bb8f1ea0889765643d9414afad5706bc45b20110045766b5ea8035809406df5247f8b6ec32ae7ebcc299ad1e2dce37365a50b3525c
-  data.tar.gz: e40627df9e67de61b8f7e0e6e5360bcc4d69f727c1cff93a13fdbaea06f1333184b1fbf56664eeefab381926f68ae66e142f1194660442a619e12a699bf577f0
+  metadata.gz: 1af9dc3072c77add2e69897021dfadb222b7568315c23777233afd1b27cf4fe0dc1bd1b865762676244a79ce785774468d7bf7a18c70e60b47c5d685db9bc2c8
+  data.tar.gz: 10c3c3203587c59f3c93fad88b53f3608c0a52f41d81753c2982167b8c4804524a5f6ac773db311bb3d0eb6c34431b3732fa4551d16eec608ef561343815134e

data/assets/ceedling

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+ruby vendor/ceedling/bin/ceedling $*

data/assets/ceedling.cmd

@@ -0,0 +1 @@
+ruby vendor\ceedling\bin\ceedling %*

data/assets/default_gitignore

@@ -0,0 +1,5 @@
+build/artifacts
+build/gcov
+builld/logs 
+build/temp
+build/test

data/assets/project_with_guts.yml

@@ -87,4 +87,5 @@
   :enabled:
     - stdout_pretty_tests_report
     - module_generator
+    - raw_output_report
 ...

data/assets/project_with_guts_gcov.yml

@@ -12,6 +12,9 @@
   :build_root: build
 #  :release_build: TRUE
   :test_file_prefix: test_
+  :which_ceedling: vendor/ceedling
+  :default_tasks:
+    - test:all
 
 #:release_build:
 #  :output: MyApp.out

data/assets/test_example_file_verbose.c

@@ -0,0 +1,12 @@
+#include "unity.h"
+#include "example_file.h"
+#include <stdio.h>
+
+void setUp(void) {}
+void tearDown(void) {}
+
+void test_add_numbers_adds_numbers(void) {
+  printf("1 + 1 = 2\n");
+  TEST_ASSERT_EQUAL(2, add_numbers(1,1));
+}
+

data/bin/ceedling

@@ -12,6 +12,11 @@ if (!project_found)
   project_found = File.exists?(main_filepath)
 end
 
+def is_windows?
+  return ((RbConfig::CONFIG['host_os'] =~ /mswin|mingw/) ? true : false) if defined?(RbConfig)
+  return ((Config::CONFIG['host_os'] =~ /mswin|mingw/) ? true : false)
+end
+
 unless (project_found)
 #===================================== We Do Not Have A Project ================================================
 
@@ -29,6 +34,9 @@ unless (project_found)
     method_option :no_docs, :type => :boolean, :default => false, :desc => "No docs in vendor directory"
     method_option :nodocs, :type => :boolean, :default => false
     method_option :as_gem, :type => :boolean, :default => false, :desc => "Create the scaffold using Ceedling as a gem instead of filling in the vendor directory. Implies --no-docs."
+    method_option :asgem, :type => :boolean, :default => false
+    method_option :with_ignore, :type => :boolean, :default => false, :desc => "Create a gitignore file for ignoring ceedling generated files."
+    method_option :withignore, :type => :boolean, :default => false
     method_option :no_configs, :type => :boolean, :default => false, :desc => "Don't install starter configuration files."
     method_option :noconfigs, :type => :boolean, :default => false
     def new(name, silent = false)
@@ -47,17 +55,17 @@ unless (project_found)
     no_commands do
       def copy_assets_and_create_structure(name, silent=false, force=false, options = {})
 
-        no_docs    = options[:no_docs]    || options[:nodocs]    || false
-        no_configs = options[:no_configs] || options[:noconfigs] || false
-        as_gem     = options[:as_gem]     || options[:asgem]     || false
+        no_docs     = options[:no_docs]     || options[:nodocs]     || false
+        no_configs  = options[:no_configs]  || options[:noconfigs]  || false
+        as_gem      = options[:as_gem]      || options[:asgem]      || false
+        with_ignore = options[:with_ignore] || options[:withignore] || false
 
         ceedling_path     = File.join(name, 'vendor', 'ceedling')
         source_path       = File.join(name, 'src')
         test_path         = File.join(name, 'test')
         test_support_path = File.join(name, 'test/support')
-        build_path        = File.join(name, 'build')
 
-        [source_path, test_path, test_support_path, build_path].each do |d|
+        [source_path, test_path, test_support_path].each do |d|
           FileUtils.mkdir_p d
         end
 
@@ -87,13 +95,20 @@ unless (project_found)
             end
           end
 
-          folders = %w{plugins lib}
+          folders = if as_gem
+            %w{plugins lib}
+          else
+            %w{plugins lib bin}
+          end
+
+          #copy full folders from ceedling gem into project
           folders.map do |f|
             {:src => f, :dst => File.join(ceedling_path, f)}
           end.each do |f|
             directory(f[:src], f[:dst], :force => force)
           end
 
+          #copy necessary subcomponents from ceedling gem into project
           sub_components = [
             {:src => 'vendor/c_exception/lib/',     :dst => 'vendor/c_exception/lib'},
             {:src => 'vendor/c_exception/release/', :dst => 'vendor/c_exception/release'},
@@ -118,9 +133,18 @@ unless (project_found)
             copy_file(File.join('assets', 'project_as_gem.yml'), File.join(name, 'project.yml'), :force => force)
           else
             copy_file(File.join('assets', 'project_with_guts.yml'), File.join(name, 'project.yml'), :force => force)
+            if is_windows?
+              copy_file(File.join('assets', 'ceedling.cmd'), File.join(name, 'ceedling.cmd'), :force => force)
+            else
+              copy_file(File.join('assets', 'ceedling'), File.join(name, 'ceedling'), :force => force)
+            end
           end
         end
 
+        if (with_ignore)
+          copy_file(File.join('assets', 'default_gitignore'), File.join(name, '.gitignore'), :force => force)
+        end
+
         unless silent
           puts "\n"
           puts "Project '#{name}' #{force ? "upgraded" : "created"}!"

data/docs/CeedlingPacket.md

@@ -202,6 +202,11 @@ General notes:
    and Rakefiles, consult the [Rake tutorial, examples, and
    user guide](http://rubyrake.org/).
 
+4. When using Ceedling in Windows environments, a test file name may 
+   not include the sequences “patch” or “setup”. The Windows Installer 
+   Detection Technology (part of UAC), requires administrator 
+   privileges to execute file names with these strings.
+
 
 
 Now What? How Do I Make It GO?
@@ -323,6 +328,7 @@ Ceedling (more on this later).
   ceedling release:assemble:foo.s
 
 * `ceedling module:create[Filename]`:
+* `ceedling module:create[<Path:>Filename]`:
 
   It's often helpful to create a file automatically. What's better than
   that? Creating a source file, a header file, and a corresponding test
@@ -331,6 +337,10 @@ Ceedling (more on this later).
   There are also patterns which can be specified to automatically generate
   a bunch of files. Try `ceedling module:create[Poodles,mch]` for example!
 
+  The module generator has several options you can configure.
+  F.e. Generating the source/header/test file in a subdirectory (by adding <Path> when calling module:create).
+  For more info, refer to the [Module Generator](https://github.com/ThrowTheSwitch/Ceedling/blob/master/docs/CeedlingPacket.md#module-generator) section.
+
 * `ceedling logging <tasks...>`:
 
   Enable logging to <build path>/logs. Must come before test and release
@@ -797,6 +807,17 @@ project: global project settings
 
   **Default**: FALSE
 
+* `generate_deep_dependencies`:
+
+  When `use_deep_dependencies` is set to TRUE, Ceedling will run a separate
+  build step to generate the deep dependencies. If you are using gcc as your
+  primary compiler, or another compiler that can generate makefile rules as
+  a side effect of compilation, then you can set this to FALSE to avoid the
+  extra build step but still use the deep dependencies data when deciding
+  which source files to rebuild.
+
+  **Default**: TRUE
+
 * `test_file_prefix`:
 
   Ceedling collects test files by convention from within the test file
@@ -1453,10 +1474,26 @@ by overriding the value in the Ceedling YAML configuration file.
   List of conditional compilation symbols used to configure Unity's
   features in its source and header files. See Unity documentation to
   understand available options. No symbols must be set unless the
-  defaults are inappropriate for your specific environment.
+  defaults are inappropriate for your specific environment. Most Unity 
+  defines can be easily configured through the YAML file.
 
   **Default**: [] (empty)
 
+Example [:unity] YAML blurbs
+```yaml
+:unity: #itty bitty processor & toolchain with limited test execution options
+  :defines:
+    - UNITY_INT_WIDTH=16           #16 bit processor without support for 32 bit instructions
+    - UNITY_EXCLUDE_FLOAT          #no floating point unit
+
+:unity: #great big gorilla processor that grunts and scratches
+  :defines:
+    - UNITY_SUPPORT_64                    #big memory, big counters, big registers
+    - UNITY_LINE_TYPE=\"unsigned int\"    #apparently we're using really long test files,
+    - UNITY_COUNTER_TYPE=\"unsigned int\" #and we've got a ton of test cases in those test files
+    - UNITY_FLOAT_TYPE=\"double\"         #you betcha
+```
+
 
 Notes on Unity configuration:
 
@@ -1476,29 +1513,34 @@ Notes on Unity configuration:
   routine that transmits a character via RS232 or USB. Once you have
   that routine, you can replace `putchar()` calls in Unity by overriding
   the function-like macro `UNITY_OUTPUT_CHAR`. Consult your toolchain
-  and shell documentation.
-
+  and shell documentation. Eventhough this can also be defined in the YAML file
+  most shell environments do not handle parentheses as command line arguments 
+  very well. To still be able to add this functionality all necessary 
+  options can be defined in the `unity_config.h`. Unity needs to be told to look for 
+  the `unity_config.h` in the YAML file, though. 
 
 Example [:unity] YAML blurbs
-
 ```yaml
-:unity: #itty bitty processor & toolchain with limited test execution options
+:unity:
   :defines:
-    - UNITY_INT_WIDTH=16           #16 bit processor without support for 32 bit instructions
-    - UNITY_EXCLUDE_FLOAT          #no floating point unit
-        #let's say environment & tools provide no way to run tests on desktop so we gotta go on target
-        #replace putchar() with write_usart() via command line specified macro (gcc style)
-        #note escaped quotes for our hypothetical shell that doesn't like parens in arguments
-        #transformed into -D"UNITY_OUTPUT_CHAR(a)=write_usart(a)" at command line by [:tools] entry
-    - "\"UNITY_OUTPUT_CHAR(a)=write_usart(a)\""
+  	- UNITY_INCLUDE_CONFIG_H
+```
 
-:unity: #great big gorilla processor that grunts and scratches
-  :defines:
-    - UNITY_SUPPORT_64                    #big memory, big counters, big registers
-    - UNITY_LINE_TYPE=\"unsigned int\"    #apparently we're using really long test files,
-    - UNITY_COUNTER_TYPE=\"unsigned int\" #and we've got a ton of test cases in those test files
-    - UNITY_FLOAT_TYPE=\"double\"         #you betcha
+Example unity_config.h
 ```
+#ifndef UNITY_CONFIG_H
+#define UNITY_CONFIG_H
+
+#include "uart_output.h" //Helper library for your custom environment
+
+#define UNITY_INT_WIDTH 16
+#define UNITY_OUTPUT_START() uart_init(F_CPU, BAUD) //Helperfunction to init UART
+#define UNITY_OUTPUT_CHAR(a) uart_putchar(a) //Helperfunction to forward char via UART
+#define UNITY_OUTPUT_COMPLETE() uart_complete() //Helperfunction to inform that test has ended
+
+#endif
+```
+
 
 **tools**: a means for representing command line tools for use under
 Ceedling's automation framework
@@ -1513,14 +1555,14 @@ tools.
 * `test_compiler`:
 
   Compiler for test & source-under-test code
-  ${1}: input source ${2}: output object ${3}: optional output list ${4}: optional per-file flags
+  ${1}: input source ${2}: output object ${3}: optional output list ${4}: optional output dependencies file
 
   **Default**: gcc
 
 * `test_linker`:
 
   Linker to generate test fixture executables
-  ${1}: input objects ${2}: output binary ${3}: optional output map ${4}: optional per-binary flags
+  ${1}: input objects ${2}: output binary ${3}: optional output map ${4}: optional library list
 
   **Default**: gcc
 
@@ -1555,7 +1597,7 @@ tools.
 * `release_compiler`:
 
   Compiler for release source code
-  ${1}: input source ${2}: output object ${3}: optional output list ${4}: optional per-file flags
+  ${1}: input source ${2}: output object ${3}: optional output list ${4}: optional output dependencies file
 
   **Default**: gcc
 
@@ -1569,7 +1611,7 @@ tools.
 * `release_linker`:
 
   Linker for release source code
-  ${1}: input objects ${2}: output binary ${3}: optional output map ${4}: optional per-binary flags
+  ${1}: input objects ${2}: output binary ${3}: optional output map ${4}: optional library list
 
   **Default**: gcc
 
@@ -1911,6 +1953,77 @@ Example [:plugins] YAML blurb
   root>/artifacts` directory (e.g. test/ for test tasks, `release/` for a
   release build, or even `bullseye/` for bullseye runs).
 
+Module Generator
+========================
+Ceedling includes a plugin called module_generator that will create a source, header and test file for you.
+There are several possibilities to configure this plugin through your project.yml to suit your project's needs.
+
+Directory Structure
+-------------------------------------------
+
+The default configuration for directory/project structure is:
+```yaml
+:module_generator:
+  :project_root: ./
+  :source_root: src/
+  :test_root: test/
+```
+You can change these variables in your project.yml file to comply with your project's directory structure.
+
+If you call `ceedling module:create`, it will create three files:
+1. A source file in the source_root
+2. A header file in the source_root
+3. A test file in the test_root
+
+If you want your header file to be in another location,
+you can specify the ':inc_root:" in your project.yml file:
+```yaml
+:module_generator:
+  :inc_root: inc/
+```
+The module_generator will then create the header file in your defined ':inc_root:'.
+By default, ':inc_root:' is not defined so the module_generator will use the source_root.
+
+Sometimes, your project can't be divided into a single src, inc, and test folder. You have several directories
+with sources/..., something like this for example:
+<project_root>
+ - myDriver
+   - src
+   - inc
+   - test
+ - myOtherDriver
+   - src
+   - inc
+   - test
+ - ...
+
+Don't worry, you don't have to manually create the source/header/test files.
+The module_generator can accept a path to create a source_root/inc_root/test_root folder with your files:
+`ceedling module:create[<module_root_path>:<module_name>]`
+
+F.e., applied to the above project structure:
+`ceedling module:create[myOtherDriver:driver]`
+This will make the module_generator run in the subdirectory 'myOtherDriver' and generate the module files
+for you in that directory. So, this command will generate the following files:
+1. A source file 'driver.c' in <project_root>/myOtherDriver/<source_root>
+2. A header file 'driver.h' in <project_root>/myOtherDriver/<source_root> (or <inc_root> if specified)
+3. A test file 'test_driver.c' in <project_root>/myOtherDriver/<test_root>
+
+Naming
+-------------------------------------------
+By default, the module_generator will generate your files in lowercase.
+`ceedling module:create[mydriver]` and `ceedling module:create[myDriver]`(note the uppercase) will generate the same files:
+1. mydriver.c
+2. mydriver.h
+3. test_mydriver.c
+
+You can configure the module_generator to use a differect naming mechanism through the project.yml:
+```yaml
+:module_generator:
+  :naming: "camel"
+```
+There are other possibilities as well (bumpy, camel, snake, caps).
+Refer to the unity module generator for more info (the unity module generator is used under the hood by module_generator).
 
 Advanced Topics (Coming)
 ========================
@@ -1945,4 +2058,3 @@ Creating Custom Plugins
 -----------------------
 
 Oh boy. This is going to take some explaining.
-

data/examples/blinky/rakefile.rb

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

data/lib/ceedling/configurator.rb

@@ -173,12 +173,15 @@ class Configurator
       FilePathUtils::standardize(path)
     end
 
+    config[:plugins][:load_paths] << FilePathUtils::standardize(Ceedling.load_path)
+    config[:plugins][:load_paths].uniq!
+
     paths_hash = @configurator_plugins.add_load_paths(config)
 
-    @rake_plugins   = @configurator_plugins.find_rake_plugins(config)
-    @script_plugins = @configurator_plugins.find_script_plugins(config)
-    config_plugins  = @configurator_plugins.find_config_plugins(config)
-    plugin_defaults = @configurator_plugins.find_plugin_defaults(config)
+    @rake_plugins   = @configurator_plugins.find_rake_plugins(config, paths_hash)
+    @script_plugins = @configurator_plugins.find_script_plugins(config, paths_hash)
+    config_plugins  = @configurator_plugins.find_config_plugins(config, paths_hash)
+    plugin_defaults = @configurator_plugins.find_plugin_defaults(config, paths_hash)
 
     config_plugins.each do |plugin|
       config.deep_merge!( @yaml_wrapper.load(plugin) )
@@ -328,7 +331,6 @@ class Configurator
 
   def insert_rake_plugins(plugins)
     plugins.each do |plugin|
-      # TODO needs a duplicate guard
       @project_config_hash[:project_rakefile_component_files] << plugin
     end
   end

data/lib/ceedling/configurator_builder.rb

@@ -89,12 +89,14 @@ class ConfiguratorBuilder
       [:project_build_tests_root,      project_build_tests_root,     true ],
       [:project_build_release_root,    project_build_release_root,   in_hash[:project_release_build] ],
 
-      [:project_test_artifacts_path,     File.join(project_build_artifacts_root, TESTS_BASE_PATH), true ],
-      [:project_test_runners_path,       File.join(project_build_tests_root, 'runners'),           true ],
-      [:project_test_results_path,       File.join(project_build_tests_root, 'results'),           true ],
-      [:project_test_build_output_path,  File.join(project_build_tests_root, 'out'),               true ],
-      [:project_test_build_cache_path,   File.join(project_build_tests_root, 'cache'),             true ],
-      [:project_test_dependencies_path,  File.join(project_build_tests_root, 'dependencies'),      true ],
+      [:project_test_artifacts_path,            File.join(project_build_artifacts_root, TESTS_BASE_PATH), true ],
+      [:project_test_runners_path,              File.join(project_build_tests_root, 'runners'),           true ],
+      [:project_test_results_path,              File.join(project_build_tests_root, 'results'),           true ],
+      [:project_test_build_output_path,         File.join(project_build_tests_root, 'out'),               true ],
+      [:project_test_build_output_asm_path,     File.join(project_build_tests_root, 'out', 'asm'),        true ],
+      [:project_test_build_output_c_path,       File.join(project_build_tests_root, 'out', 'c'),          true ],
+      [:project_test_build_cache_path,          File.join(project_build_tests_root, 'cache'),             true ],
+      [:project_test_dependencies_path,         File.join(project_build_tests_root, 'dependencies'),      true ],
 
       [:project_release_artifacts_path,         File.join(project_build_artifacts_root, RELEASE_BASE_PATH), in_hash[:project_release_build] ],
       [:project_release_build_cache_path,       File.join(project_build_release_root, 'cache'),             in_hash[:project_release_build] ],
@@ -270,7 +272,7 @@ class ConfiguratorBuilder
   def collect_assembly(in_hash)
     all_assembly = @file_wrapper.instantiate_file_list
 
-    return {:collection_all_assembly => all_assembly} if (not in_hash[:release_build_use_assembly])
+    return {:collection_all_assembly => all_assembly} if ((not in_hash[:release_build_use_assembly]) && (not in_hash[:test_build_use_assembly]))
 
     in_hash[:collection_paths_source].each do |path|
       all_assembly.include( File.join(path, "*#{in_hash[:extension_assembly]}") )
@@ -361,6 +363,7 @@ class ConfiguratorBuilder
         all_input.include( path )
       else
         all_input.include( File.join(path, "*#{in_hash[:extension_source]}") )
+        all_input.include( File.join(path, "*#{in_hash[:extension_assembly]}") ) if (defined?(TEST_BUILD_USE_ASSEMBLY) && TEST_BUILD_USE_ASSEMBLY)
       end
     end