ceedling 0.29.0 → 0.29.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7af7d95453c0e7c09164e299afb08c59bd1004ebfb279e8857df5d117e0e7de
-  data.tar.gz: 4f10c322dc7526a2296dcb725b726de50d353e303ddc16d3b47a62cf80c1a1b5
+  metadata.gz: 57518fcd5eccaf61d4bf5b6953233e73bd09043d749c0c17e14bde86a448908c
+  data.tar.gz: ebb08f8cb40fc19ac1808fb5d5670e6323beaf8415681a97c9e0dc0ab37265b6
 SHA512:
-  metadata.gz: 18f1c30727ed97eb04c84116d50e698a5a9907beaf0448264595593cc2d790ff26ebe1c94265792c7373b4270f9276676929c669616b80098797d417f11d424e
-  data.tar.gz: 02f2ac736750915514646d5818de1e5a37e66e2610d14e7649f66b00e12ac41de79f2708380d4669e6aaa3518885251ef2864c68a2572ac9ff79b87e8891a268
+  metadata.gz: 5fc75ecfbd7c086f807fade3847511fc4208102a14ed4d3dd5a7be3302388bf6ac1be38eedcb87ff6c74654979bb9c30750c442a6ee20969209c156b6faabb7c
+  data.tar.gz: c00944a53e45f50e1cf7daca6400f428dce69456c7db3d29092e3641ff577c3aaefc23c347ad5174f88d2766276d3599d11494424c6fe491cd87a72971668e4c

data/assets/project_as_gem.yml

@@ -85,11 +85,8 @@
 :libraries:
   :placement: :end
   :flag: "${1}"  # or "-L ${1}" for example
-  :common: &common_libraries []
-  :test:
-    - *common_libraries
-  :release:
-    - *common_libraries
+  :test: []
+  :release: []
 
 :plugins:
   :load_paths:

data/assets/project_with_guts.yml

@@ -85,11 +85,8 @@
 :libraries:
   :placement: :end
   :flag: "${1}"  # or "-L ${1}" for example
-  :common: &common_libraries []
-  :test:
-    - *common_libraries
-  :release:
-    - *common_libraries
+  :test: []
+  :release: []
 
 :plugins:
   :load_paths:

data/assets/project_with_guts_gcov.yml

@@ -85,11 +85,8 @@
 :libraries:
   :placement: :end
   :flag: "${1}"  # or "-L ${1}" for example
-  :common: &common_libraries []
-  :test:
-    - *common_libraries
-  :release:
-    - *common_libraries
+  :test: []
+  :release: []
 
 :plugins:
   :load_paths:

data/bin/ceedling

@@ -49,16 +49,16 @@ unless (project_found)
     end
 
     desc "upgrade PROJECT_NAME", "upgrade ceedling for a project (not req'd if gem used)"
-    method_option :docs, :type => :boolean, :default => false, :desc => "Add docs in project vendor directory"
-    method_option :local, :type => :boolean, :default => false, :desc => "Create a copy of Ceedling in the project vendor directory"
-    method_option :no_configs, :type => :boolean, :default => false, :desc => "Don't install starter configuration files"
-    method_option :noconfigs, :type => :boolean, :default => false
-
-    #deprecated:
-    method_option :no_docs, :type => :boolean, :default => false
-    method_option :nodocs, :type => :boolean, :default => false
     def upgrade(name, silent = false)
-      copy_assets_and_create_structure(name, silent, true, options || {:upgrade => true})
+      as_local = true
+      begin
+        require "yaml"
+        as_local = (YAML.load_file(File.join(name, "project.yml"))[:project][:which_ceedling] != 'gem')
+      rescue
+        raise "ERROR: Could not find valid project file '#{yaml_path}'"
+      end
+      found_docs = File.exists?( File.join(name, "docs", "CeedlingPacket.md") )
+      copy_assets_and_create_structure(name, silent, true, {:upgrade => true, :no_configs => true, :local => as_local, :docs => found_docs})
     end
 
     no_commands do
@@ -207,9 +207,9 @@ unless (project_found)
     desc "version", "return the version of the tools installed"
     def version()
       require 'ceedling/version.rb'
-      puts "  Ceedling::   #{Ceedling::Version::CEEDLING}"
-      puts "  CMock::      #{Ceedling::Version::CMOCK}"
-      puts "  Unity::      #{Ceedling::Version::UNITY}"
+      puts "    Ceedling:: #{Ceedling::Version::CEEDLING}"
+      puts "       CMock:: #{Ceedling::Version::CMOCK}"
+      puts "       Unity:: #{Ceedling::Version::UNITY}"
       puts "  CException:: #{Ceedling::Version::CEXCEPTION}"
     end
   end
@@ -287,6 +287,8 @@ else
         options[:list_tasks] = true
       when /^-T$/
         options[:list_tasks] = true
+      when /^--tasks$/
+        options[:list_tasks] = true
       when /^project:(\w+)/
         ENV['CEEDLING_USER_PROJECT_FILE'] = "#{$1}.yml"
       else

data/ceedling.sublime-project

@@ -1,25 +1,28 @@
 {
-    "folders":
-    [
-        {
-            "folder_exclude_patterns":
-            [
-                "backup",
-                "build"
-            ],
-            "file_exclude_patterns":
-            [
-                ".*",
-                "*.sublime*"
-            ],
-            "path": ".."
-        }
-    ],
-    "settings":
-    {
-        "tab_size": 4,
-        "translate_tabs_to_spaces": true,
-        "use_tab_stops": false,
-        "word_wrap": false
-    }
+	"folders":
+	[
+		{
+			"file_exclude_patterns":
+			[
+				".*",
+				"*.sublime*"
+			],
+			"folder_exclude_patterns":
+			[
+				"backup",
+				"build"
+			],
+			"path": "C:\\projects"
+		},
+		{
+			"path": "C:\\Ruby25-x64\\lib\\ruby\\gems\\2.5.0\\gems\\ceedling-0.29.0"
+		}
+	],
+	"settings":
+	{
+		"tab_size": 4,
+		"translate_tabs_to_spaces": true,
+		"use_tab_stops": false,
+		"word_wrap": false
+	}
 }

data/docs/CeedlingPacket.md

@@ -259,7 +259,7 @@ Ceedling (more on this later).
 * `ceedling environment`:
 
   List all configured environment variable names and string values. This
-  task is helpful in verifying the evaluatio of any Ruby expressions in
+  task is helpful in verifying the evaluation of any Ruby expressions in
   the [:environment] section of your config file.`: Note: Ceedling may
   set some convenience environment variables by default.
 
@@ -1414,6 +1414,21 @@ Example [:flags] YAML blurb
         - --baz
 ```
 
+**import**: allow to load other config files
+
+In some cases it is nice to have config files (project.yml, options files) which can
+load other config files, for commonly re-used definitions (target processor,
+common code modules, etc).
+These can be recursively nested, the included files can include other files.
+
+Example [:import] YAML blurb
+
+```yaml
+:import:
+  - path/to/config.yml
+  - path/to/another/config.yml
+```
+
 Ceedling sets values for a subset of CMock settings. All CMock
 options are available to be set, but only those options set by
 Ceedling in an automated fashion are documented below. See CMock
@@ -1876,7 +1891,7 @@ Notes:
 * `COLLECTION_DEFINES_RELEASE_AND_VENDOR`:
 
   All symbols specified in [:defines][:release] plus symbols defined by
-[:cexception][:defines] if exceptions are ena bled
+[:cexception][:defines] if exceptions are enabled
 
 
 Notes:

data/docs/CeedlingUpgrade.md

@@ -0,0 +1,83 @@
+# Upgrading Ceedling
+
+You'd like to stay in sync with the latest Ceedling... and who wouldn't? Depending on 
+how you've made use of Ceedling, that may vary slightly. No matter what, though, our first
+step is to update Ceedling itself.
+
+## Step 1: Update Ceedling Itself
+
+```
+gem update ceedling
+```
+
+That should do it... unless you don't have a valid connection to the internet. In that case,
+you might have to download the gem from rubygems.org and then install it manually:
+
+```
+gem update ceedling --local=ceedling-filename.zip
+```
+
+## Step 2: Udpate Projects Using Ceedling
+
+When you set up your project(s), it was either configured to use the gem directly, or it was
+configured to install itself locally (often into a vendor directory).
+
+For projects that are of the first type, congratulations, you're finished. The project will
+automatically use the new ceedling. There MAY be things that need to be tweaked if features have
+moved significantly. (And we apologize if that's your situation... as we get to version 1, we're
+going to have a stronger focus on backwards compatibility). If your project isn't working perfectly, 
+skip down to Step 3.
+
+If the project was installed to have a copy of ceedling locally, you have a choice. You may 
+choose to continue to run THIS project on the old version of Ceedling. Often this is the
+preferred method for legacy projects which only get occasional focus. Why go through the effort 
+of updating for new tools if it's serving its purpose and you're unlikely to actually use the new
+features?
+
+The other choice, of course, is to update it. To do so, we open a command prompt and address ceedling 
+from *outside* the project. For example, let's say we have the following structure:
+
+ - projects
+    - myproject
+        - project.yml
+        - src
+        - tgt
+        - vendor
+
+In this case, we'd want to be in the `projects` directory. At that point, we can ask Ceedling to
+update our project.
+
+```
+ceedling upgrade myproject
+```
+
+Ceedling will automatically look for your project yaml file and do its best to determine what needs
+to be updated. If installed locally, this will mean copying the latest copy of Unity, CMock, and
+Ceedling. It will also involve copying documentation, if you had that installed.
+
+## Step 3: Solving Problems
+
+We wish every project would update seamlessly... unfortunately there is a lot of customization that
+goes into each project, and Ceedling often isn't aware of all of these. To make matter worse, Ceedling
+has been in pre-release for awhile, meaning it occasionally has significant changes that may break
+current installations. We've tried to capture the common ones here:
+
+### rakefile
+
+Ceedling is built in a utility called Rake. In the past, rake was the method that the user actually
+interacted with Ceedling. That's no longer the case. Using a modern version of Ceedling means that
+you issue commands like `ceedling test:all` instead of `rake test:all`. If you have a continuous 
+integration server or other calling service, it may need to be updated to comply.
+
+Similarly, older versions of Ceedling actually placed a rakefile in the project directory, allowing 
+the project to customize its own flow. For the most part this went unused and better ways were later
+introduced. At this point, the `rakefile` is more trouble than its worth and often should just be 
+removed. 
+
+### plugins
+
+If you have custom plugins installed to your project, the plugin architecture has gone through some 
+revisions and it may or may not be compatible at this time. Again, this is a problem which should
+not exist soon.
+
+

data/lib/ceedling/build_invoker_utils.rb

@@ -9,7 +9,7 @@ class BuildInvokerUtils
   ##
   # Processes exceptions and tries to display a useful message for the user.
   #
-  # ==== Attriboops...utes
+  # ==== Attributes
   #
   # * _exception_:  The exception given by a rescue statement.
   # * _context_:    A symbol representing where in the build the exception

data/lib/ceedling/cacheinator_helper.rb

@@ -4,8 +4,8 @@ class CacheinatorHelper
   constructor :file_wrapper, :yaml_wrapper
   
   def diff_cached_config?(cached_filepath, hash)
-    return true if ( not @file_wrapper.exist?(cached_filepath) )
-    return true if ( (@file_wrapper.exist?(cached_filepath)) and (!(@yaml_wrapper.load(cached_filepath) == hash)) )
+    return false if ( not @file_wrapper.exist?(cached_filepath) )
+    return true if (@yaml_wrapper.load(cached_filepath) != hash)
     return false
   end
 

data/lib/ceedling/dependinator.rb

@@ -91,8 +91,8 @@ class Dependinator
   end
 
 
-  def setup_test_executable_dependencies(test, objects)
-    @rake_wrapper.create_file_task( @file_path_utils.form_test_executable_filepath(test), objects )
+  def enhance_test_executable_dependencies(test, objects)
+    @rake_wrapper[ @file_path_utils.form_test_executable_filepath(test) ].enhance( objects )
   end
 
 end

data/lib/ceedling/generator_test_results.rb

@@ -37,6 +37,10 @@ class GeneratorTestResults
         elements = extract_line_elements(line, results[:source][:file])
         results[:successes] << elements[0]
         results[:stdout] << elements[1] if (!elements[1].nil?)
+      when /(:PASS \(.* ms\)$)/
+        elements = extract_line_elements(line, results[:source][:file])
+        results[:successes] << elements[0]
+        results[:stdout] << elements[1] if (!elements[1].nil?)
       when /(:FAIL)/
         elements = extract_line_elements(line, results[:source][:file])
         results[:failures] << elements[0]
@@ -73,6 +77,7 @@ class GeneratorTestResults
     # handle anything preceding filename in line as extra output to be collected
     stdout = nil
     stdout_regex = /(.+)#{Regexp.escape(filename)}.+/i
+    unity_test_time = 0 
 
     if (line =~ stdout_regex)
       stdout = $1.clone
@@ -82,8 +87,14 @@ class GeneratorTestResults
     # collect up test results minus and extra output
     elements = (line.strip.split(':'))[1..-1]
 
-    return {:test => elements[1], :line => elements[0].to_i, :message => (elements[3..-1].join(':')).strip}, stdout if elements.size >= 3
-    return {:test => '???', :line => -1, :message => nil} #fallback safe option. TODO better handling
+    # find timestamp if available
+    if (elements[2] =~  / \((.*) ms\)/)
+      unity_test_time = $1.to_f / 1000
+      elements[2].sub!(/ \((.*) ms\)/, '') 
+    end
+
+    return {:test => elements[1], :line => elements[0].to_i, :message => (elements[3..-1].join(':')).strip, :unity_test_time => unity_test_time}, stdout if elements.size >= 3
+    return {:test => '???', :line => -1, :message => nil, :unity_test_time => unity_test_time} #fallback safe option. TODO better handling
   end
 
 end

data/lib/ceedling/tasks_base.rake

@@ -4,28 +4,10 @@ require 'ceedling/version'
 
 desc "Display build environment version info."
 task :version do
-  puts "  Ceedling:: #{Ceedling::Version::CEEDLING}"
-
-  [
-      ['CException', File.join( CEEDLING_VENDOR, CEXCEPTION_ROOT_PATH)],
-      ['     CMock', File.join( CEEDLING_VENDOR, CMOCK_ROOT_PATH)],
-      ['     Unity', File.join( CEEDLING_VENDOR, UNITY_ROOT_PATH)],
-  ].each do |tool|
-    name      = tool[0]
-    base_path = tool[1]
-
-    version_string = begin
-      @ceedling[:file_wrapper].read( File.join(base_path, 'release', 'version.info') ).strip
-    rescue
-      "UNKNOWN"
-    end
-    build_string = begin
-      @ceedling[:file_wrapper].read( File.join(base_path, 'release', 'build.info') ).strip
-    rescue
-      "UNKNOWN"
-    end
-    puts "#{name}:: #{version_string.empty? ? '#.#.' : (version_string + '.')}#{build_string.empty? ? '?' : build_string}"
-  end
+  puts "   Ceedling:: #{Ceedling::Version::CEEDLING}"
+  puts "      Unity:: #{Ceedling::Version::UNITY}"
+  puts "      CMock:: #{Ceedling::Version::CMOCK}"
+  puts " CException:: #{Ceedling::Version::CEXCEPTION}"
 end
 
 desc "Set verbose output (silent:[#{Verbosity::SILENT}] - obnoxious:[#{Verbosity::OBNOXIOUS}])."
@@ -65,6 +47,12 @@ task :sanity_checks, :level do |t, args|
   @ceedling[:configurator].sanity_checks = check_level
 end
 
+# non advertised catch for calling upgrade in the wrong place
+task :upgrade do
+  puts "WARNING: You're currently IN your project directory. Take a step out and try"
+  puts "again if you'd like to perform an upgrade."
+end
+
 # list expanded environment variables
 if (not ENVIRONMENT.empty?)
 desc "List all configured environment variables."
@@ -88,7 +76,7 @@ namespace :options do
     option = File.basename(option_path, '.yml')
 
     desc "Merge #{option} project options."
-    task option.downcase.to_sym do
+    task option.to_sym do
       hash = @ceedling[:project_config_manager].merge_options( @ceedling[:setupinator].config_hash, option_path )
       @ceedling[:setupinator].do_setup( hash )
       if @ceedling[:configurator].project_release_build
@@ -97,6 +85,12 @@ namespace :options do
     end
   end
 
+  # This is to give nice errors when typing options
+  rule /^options:.*/ do |t, args|
+    filename = t.to_s.split(':')[-1] + '.yml'
+    filelist = COLLECTION_PROJECT_OPTIONS.map{|s| File.basename(s) }
+    @ceedling[:file_finder].find_file_from_list(filename, filelist, :error)
+  end
 end
 
 

data/lib/ceedling/tasks_filesystem.rake

@@ -45,16 +45,25 @@ task(:clobber => [:clean]) do
   @ceedling[:streaminator].stdout_puts("\nClobbering all generated files...\n(For large projects, this task may take a long time to complete)\n\n")
   begin
     CLOBBER.each { |fn| REMOVE_FILE_PROC.call(fn) }
+    @ceedling[:rake_wrapper][:directories].invoke
+    @ceedling[:dependinator].touch_force_rebuild_files
   rescue
   end
 end
 
-
+# create a directory task for each of the paths, so we know how to build them
 PROJECT_BUILD_PATHS.each { |path| directory(path) }
 
-# create directories that hold build output and generated files & touching rebuild dependency sources
-task(:directories => PROJECT_BUILD_PATHS) { @ceedling[:dependinator].touch_force_rebuild_files }
+# create a single directory task which verifies all the others get built
+task :directories => PROJECT_BUILD_PATHS
 
+# when the force file doesn't exist, it probably means we clobbered or are on a fresh
+# install. In either case, stuff was deleted, so assume we want to rebuild it all
+file @ceedling[:configurator].project_test_force_rebuild_filepath do
+  unless File.exists?(@ceedling[:configurator].project_test_force_rebuild_filepath)
+    @ceedling[:dependinator].touch_force_rebuild_files
+  end
+end
 
 # list paths discovered at load time
 namespace :paths do

data/lib/ceedling/tasks_tests.rake

@@ -8,7 +8,7 @@ namespace TEST_SYM do
 
   desc "Run all unit tests (also just 'test' works)."
   task :all => [:directories] do
-    @ceedling[:test_invoker].setup_and_invoke(COLLECTION_ALL_TESTS)
+    @ceedling[:test_invoker].setup_and_invoke(COLLECTION_ALL_TESTS, TEST_SYM, {:force_run => false})
   end
 
   desc "Run single test ([*] real test or source file name, no path)."