ceedling 0.27.0 → 0.28.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93c488605f82954ab5f2cccb06ecbfc489133c3b
-  data.tar.gz: 5c97c451a98f9fb5c62522f46814f45aba20e4a6
+  metadata.gz: 71e849e4b01257b6bf46ff3f0c640ac834c75649
+  data.tar.gz: ad0c659fdc9dc461f80fe802876f1ef14901c4ec
 SHA512:
-  metadata.gz: 8cf0b9dbce04687b13d374cfbf214641a72e147093b1c394c67e7e7775c73896c2bc290db3d108174cf8706f0bd378136eefe7540523c7115af2841b89a5695a
-  data.tar.gz: f7575f0950a80118723f6a58fffd361fef164eddb2065ff622641ec1bdb5cbb6aa232149f6821ac495daa7f5086b835fc5c0a1ccd41af14e05271df16ce71fa6
+  metadata.gz: 21ce60fcc40db82d6f48067a5209a8ea9f7d6292005bb099e1143440b430fc3f5f73c4fcd345bf46683cec81ee62322a2dabae519c1ab05c1dc49d7e7ebd21a2
+  data.tar.gz: c7c120c485e554afaae2f4afeefdc6651b7636739d1501f37a919988d81bf38a6facb580bcb19a866bff023ca520ff7dca862a744836d2a845e524ffad6b6b2c

data/assets/project_as_gem.yml

@@ -12,6 +12,9 @@
   :build_root: build
 #  :release_build: TRUE
   :test_file_prefix: test_
+  :which_ceedling: gem
+  :default_tasks:
+    - test:all
 
 #:release_build:
 #  :output: MyApp.out
@@ -57,6 +60,9 @@
     int8:     INT8
     bool:     UINT8
 
+:gcov:
+    :html_report_type: basic
+
 #:tools:
 # Ceedling defaults to using gcc for compiling, linking, etc.
 # As [:tools] is blank, gcc will be used (so long as it's in your system path)

data/assets/project_with_guts.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
@@ -57,6 +60,9 @@
     int8:     INT8
     bool:     UINT8
 
+:gcov:
+    :html_report_type: basic
+
 #:tools:
 # Ceedling defaults to using gcc for compiling, linking, etc.
 # As [:tools] is blank, gcc will be used (so long as it's in your system path)

data/assets/project_with_guts_gcov.yml

@@ -0,0 +1,88 @@
+---
+
+# Notes:
+# Sample project C code is not presently written to produce a release artifact.
+# As such, release build options are disabled.
+# This sample, therefore, only demonstrates running a collection of unit tests.
+
+:project:
+  :use_exceptions: FALSE
+  :use_test_preprocessor: TRUE
+  :use_auxiliary_dependencies: TRUE
+  :build_root: build
+#  :release_build: TRUE
+  :test_file_prefix: test_
+
+#:release_build:
+#  :output: MyApp.out
+#  :use_assembly: FALSE
+
+:environment:
+
+:extension:
+  :executable: .out
+
+:paths:
+  :test:
+    - +:test/**
+    - -:test/support
+  :source:
+    - src/**
+  :support:
+    - test/support
+
+:defines:
+  # in order to add common defines:
+  #  1) remove the trailing [] from the :common: section
+  #  2) add entries to the :common: section (e.g. :test: has TEST defined)
+  :commmon: &common_defines []
+  :test:
+    - *common_defines
+    - TEST
+  :test_preprocess:
+    - *common_defines
+    - TEST
+
+:cmock:
+  :mock_prefix: mock_
+  :when_no_prototypes: :warn
+  :enforce_strict_ordering: TRUE
+  :plugins:
+    - :ignore
+    - :callback
+  :treat_as:
+    uint8:    HEX8
+    uint16:   HEX16
+    uint32:   UINT32
+    int8:     INT8
+    bool:     UINT8
+
+:gcov:
+    :html_report_type: basic
+
+#:tools:
+# Ceedling defaults to using gcc for compiling, linking, etc.
+# As [:tools] is blank, gcc will be used (so long as it's in your system path)
+# See documentation to configure a given toolchain for use
+
+# LIBRARIES
+# These libraries are automatically injected into the build process. Those specified as
+# common will be used in all types of builds. Otherwise, libraries can be injected in just
+# tests or releases. These options are MERGED with the options in supplemental yaml files.
+:libraries:
+  :placement: :end
+  :flag: "${1}"  # or "-L ${1}" for example
+  :common: &common_libraries []
+  :test:
+    - *common_libraries
+  :release:
+    - *common_libraries
+
+:plugins:
+  :load_paths:
+    - vendor/ceedling/plugins
+  :enabled:
+    - stdout_pretty_tests_report
+    - module_generator
+    - gcov
+...

data/assets/test_example_file_boom.c

@@ -0,0 +1,13 @@
+#include "unity.h"
+#include "example_file.h"
+
+void setUp(void) {}
+void tearDown(void) {}
+
+void test_add_numbers_adds_numbers(void) {
+  TEST_ASSERT_EQUAL(2, add_numbers(1,1) //Removed semicolon & parenthesis to make a compile error.
+}
+
+void test_add_numbers_will_fail(void) {
+  TEST_ASSERT_EQUAL(2, add_numbers(2,2));
+}

data/assets/test_example_file_success.c

@@ -0,0 +1,14 @@
+#include "unity.h"
+#include "example_file.h"
+
+void setUp(void) {}
+void tearDown(void) {}
+
+void test_add_numbers_adds_numbers(void) {
+  TEST_ASSERT_EQUAL(2, add_numbers(1,1));
+}
+
+void test_add_numbers_will_fail_but_is_ignored_for_now(void) {
+  TEST_IGNORE();
+  TEST_ASSERT_EQUAL(2, add_numbers(2,2));
+}

data/bin/ceedling

@@ -11,9 +11,8 @@ if (!project_found)
   main_filepath = "project.yml"
   project_found = File.exists?(main_filepath)
 end
-rakefile_found = (File.exists? "rakefile.rb")
 
-unless (project_found && rakefile_found)
+unless (project_found)
 #===================================== We Do Not Have A Project ================================================
 
   puts "Welcome to Ceedling!"
@@ -27,20 +26,31 @@ unless (project_found && rakefile_found)
     include Thor::Actions
 
     desc "new PROJECT_NAME", "create a new ceedling project"
-    method_option :nodocs, :type => :boolean, :default => false, :desc => "No docs in vendor directory"
+    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 :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)
-      copy_assets_and_create_structure(name, silent, false, options[:nodocs], options[:as_gem])
+      copy_assets_and_create_structure(name, silent, false, options)
     end
 
     desc "upgrade PROJECT_NAME", "upgrade ceedling for a project (not req'd if gem used)"
-    method_option :nodocs, :type => :boolean, :default => false, :desc => "No docs in vendor directory"
+    method_option :no_docs, :type => :boolean, :default => false, :desc => "No docs in vendor directory"
+    method_option :nodocs, :type => :boolean, :default => false
+    method_option :no_configs, :type => :boolean, :default => true, :desc => "Don't install starter configuration files."
+    method_option :noconfigs, :type => :boolean, :default => false
     def upgrade(name, silent = false)
-      copy_assets_and_create_structure(name, silent, true, options[:nodocs])
+      copy_assets_and_create_structure(name, silent, true, options)
     end
 
     no_commands do
-      def copy_assets_and_create_structure(name, silent=false, force=false, no_docs=false, as_gem=false)
+      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
+
         ceedling_path     = File.join(name, 'vendor', 'ceedling')
         source_path       = File.join(name, 'src')
         test_path         = File.join(name, 'test')
@@ -91,7 +101,6 @@ unless (project_found && rakefile_found)
             {:src => 'vendor/cmock/lib/',           :dst => 'vendor/cmock/lib'},
             {:src => 'vendor/cmock/release/',       :dst => 'vendor/cmock/release'},
             {:src => 'vendor/cmock/src/',           :dst => 'vendor/cmock/src'},
-            {:src => 'vendor/constructor/lib/',     :dst => 'vendor/constructor/lib'},
             {:src => 'vendor/deep_merge/lib/',      :dst => 'vendor/deep_merge/lib'},
             {:src => 'vendor/diy/lib',              :dst => 'vendor/diy/lib'},
             {:src => 'vendor/unity/auto/',          :dst => 'vendor/unity/auto'},
@@ -104,12 +113,12 @@ unless (project_found && rakefile_found)
           end
         end
 
-        if as_gem
-          copy_file(File.join('assets', 'project_as_gem.yml'), File.join(name, 'project.yml'), :force => force)
-          copy_file(File.join('assets', 'rakefile_as_gem.rb'), File.join(name, 'rakefile.rb'), :force => force)
-        else
-          copy_file(File.join('assets', 'project_with_guts.yml'), File.join(name, 'project.yml'), :force => force)
-          copy_file(File.join('assets', 'rakefile_with_guts.rb'), File.join(name, 'rakefile.rb'), :force => force)
+        unless (no_configs)
+          if as_gem
+            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)
+          end
         end
 
         unless silent
@@ -138,20 +147,17 @@ unless (project_found && rakefile_found)
 
       dest_src      = File.join(dest,'src')
       dest_test     = File.join(dest,'test')
-      dest_rakefile = File.join(dest,'rakefile.rb')
       dest_project  = File.join(dest,'project.yml')
 
       directory "examples/#{proj_name}/src",         dest_src
       directory "examples/#{proj_name}/test",        dest_test
-      remove_file dest_rakefile
       remove_file dest_project
-      copy_file "examples/#{proj_name}/rakefile.rb", dest_rakefile
       copy_file "examples/#{proj_name}/project.yml", dest_project
 
       puts "\n"
       puts "Example project '#{proj_name}' created!"
       puts " - Tool documentation is located in vendor/ceedling/docs"
-      puts " - Execute 'rake -T' to view available test & build tasks"
+      puts " - Execute 'ceedling help' to view available test & build tasks"
       puts ''
     end
 
@@ -178,66 +184,9 @@ unless (project_found && rakefile_found)
 
 #===================================== We Have A Project Already ================================================
 else
-  begin
-    require 'pty'
-
-    #if available, we use PTY because it will live-stream our data instead of buffering it all up
-    def spawn_command(cmd, &block)
-      begin
-        PTY.spawn(cmd) do |stdout, stdin, pid|
-          begin
-            block.call(stdout)
-          rescue Errno::EIO
-          end
-        end
-      rescue Exception => e
-        STDERR.puts e.inspect unless (e == PTY::ChildExited)
-      end
-    end
-
-  rescue LoadError
-
-    begin
-
-      require 'popen4'
-
-      #if pty wasn't available, we'll use POPEN instead
-      def spawn_command(cmd, &block)
-        POpen4.popen4(cmd) do |stdout, stderr, stdin|
-          begin
-            block.call(stdout)
-          rescue Errno::EIO
-          end
-        end
-      end
-
-    rescue LoadError
-
-      #if neither of these libraries were available, we can just shell out to the command and collect results
-      def spawn_command(cmd, &block)
-        results = `#{cmd}`
-        if ($?.exitstatus != 0)
-          block.call( StringIO.new("ERROR: Aborted with Exit Code #{$?.exitstatus.to_s}") )
-        else
-          block.call( StringIO.new(results) )
-        end
-      end
-    end
-
-  end
-
   require 'yaml'
   require 'rbconfig'
 
-  #determine the width of the screen
-  cols = 80
-  begin
-    require 'curses'
-    Curses.init_screen()
-    cols = Curses.cols
-  rescue LoadError
-  end
-
   #determine platform
   platform = begin
     case(RbConfig::CONFIG['host_os'])
@@ -254,12 +203,13 @@ else
 
   #create our default meta-runner option set
   options = {
-    :pretend_we_are_gtest => false,
-    :args => "",
     :pretest => nil,
-    :outfile => nil,
     :add_path => [],
     :path_connector => (platform == :mswin) ? ";" : ":",
+    :graceful_fail => false,
+    :which_ceedling => (Dir.exists?("vendor/ceedling") ? "vendor/ceedling" : 'gem'),
+    :default_tasks => [ 'test:all' ],
+    :list_tasks => false
   }
 
   #guess that we need a special script file first if it exists
@@ -271,15 +221,16 @@ else
 
   #merge in project settings if they can be found here
   yaml_options = YAML.load_file(main_filepath)
-  options[:pretend_we_are_gtest] = (yaml_options[:plugins][:enabled].include? :stdout_gtestlike_tests_report) if (yaml_options[:plugins] && yaml_options[:plugins][:enabled])
   if (yaml_options[:paths])
     options[:add_path] = yaml_options[:paths][:tools] || []
   else
     options[:add_path] = []
   end
+  options[:graceful_fail]  = yaml_options[:graceful_fail] if yaml_options[:graceful_fail]
+  options[:which_ceedling] = yaml_options[:project][:which_ceedling] if (yaml_options[:project] && yaml_options[:project][:which_ceedling])
+  options[:default_tasks]  = yaml_options[:default_tasks] if yaml_options[:default_tasks]
 
   #sort through command line options
-  options[:args]
   ARGV.each do |v|
     case(v)
       when /^(?:new|examples?|templates?)$/
@@ -288,16 +239,12 @@ else
              "      but it looks like you're already in a project. If you really \n" +
              "      want to do this, try moving to an empty folder.\n\n"
         abort
-      when /^--gtest/
-        options[:pretend_we_are_gtest] = true
-      when /^--debug/
-        options[:outfile] = "debug.txt"
       when /^help$/
-        options[:args] += "-T "
+        options[:list_tasks] = true
       when /^project:(\w+)/
         ENV['CEEDLING_USER_PROJECT_FILE'] = "#{$1}.yml"
       else
-        options[:args] += v + " "
+        #nothing
     end
   end
 
@@ -311,37 +258,34 @@ else
     ENV["PATH"] = path
   end
 
-  if (options[:outfile])
-    f = File.open(options[:outfile],'w')
-    f << ARGV.inspect << "\n\n"
-    f << options.inspect << "\n\n"
-  end
-
-  #run rake and capture all the output
-  options[:cmd] = if (options[:pretest].nil? || options[:pretest].empty?)
-    "rake #{options[:args]}"
+  # Load Ceedling (either through the rakefile OR directly)
+  if (File.exists?("rakefile.rb"))
+    load 'rakefile.rb'
   else
-    "#{options[:pretest]} && rake #{options[:args]}"
-  end
-  spawn_command(options[:cmd]) do |stdout|
-    stdout.each do |line|
-      if (!options[:pretend_we_are_gtest] || (line.match(/^\[.*\]/)) || (line.match(/\d+ FAILED TESTS/)))
-        f.puts(line) if (options[:outfile])
-        if (options[:args].strip == "-T")
-          line.gsub!(/(?<!\w)rake(?!\w)/,'ceedling')
-          if (line.length > cols)
-            endings = line.match(/[\r\n]+/)[0]
-            line.gsub!(endings,'')
-            line = line.slice(0, cols-3) + '...' + endings
-          end
-        end
-        puts(line)
-      end
+    if (options[:which_ceedling] == 'gem')
+      require 'ceedling'
+    else
+      load "#{options[:which_ceedling]}/lib/ceedling.rb"
     end
+    Ceedling.load_project
   end
 
-  f.close if options[:outfile]
+  Rake.application.standard_exception_handling do
+    if options[:list_tasks]
+      # Display helpful task list when requested. This required us to dig into Rake internals a bit
+      Rake.application.define_singleton_method(:name=) {|n| @name = n}
+      Rake.application.name = 'ceedling'
+      Rake.application.options.show_tasks = :tasks
+      Rake.application.options.show_task_pattern = /^(?!.*build).*$/
+      Rake.application.display_tasks_and_comments()
+    else
+      task :default => options[:default_tasks]
+
+      # Run our Tasks!
+      Rake.application.collect_command_line_tasks(ARGV)
+      Rake.application.top_level
+    end
+  end
   true
-
 #===================================================================================================================
 end

data/ceedling.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "thor", ">= 0.14.5"
   s.add_dependency "rake", ">= 0.8.7"
-  # s.add_dependency "curses", ">= 1.0.0"
+  s.add_runtime_dependency "constructor", ">= 1.0.4"
 
   # Files needed from submodules
   s.files         = []