ceedling 0.13.0.rc1 → 0.13.0

data/examples/temp_sensor/project.yml

@@ -57,10 +57,9 @@
 # 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
 
-# some platforms need the default test_linker to explicitly link the math lib (uncomment if this is you)
-# :tools_test_linker:
-#   :arguments:
-#     - -lm
+:tools_test_linker:
+  :arguments:
+    - -lm
 
 :plugins:
   :load_paths:

data/lib/ceedling.rb

@@ -1,5 +1,10 @@
 require 'rake'
 
+ERR_MSG = <<EOF
+I expected to see a project.yml file in the current directoy. Please create one
+by hand or by using the 'ceedling' shell command.
+EOF
+
 def ceedling_dir
   File.join(
     File.dirname(__FILE__),
@@ -12,7 +17,11 @@ def builtin_ceedling_plugins_path
     'plugins')
 end
 
-load File.join(
-  ceedling_dir,
-  'lib',
-  'rakefile.rb')
+ceeling_lib_rakefile = File.join( ceedling_dir,
+                                 'lib',
+                                 'rakefile.rb')
+if File.exists? "./project.yml"
+  load ceeling_lib_rakefile
+else
+  $stderr.puts ERR_MSG
+end

data/lib/ceedling/version.rb

@@ -2,15 +2,15 @@
 module Ceedling
   module Version
     # @private
-    GEM = "0.13.0.rc1"
+    GEM = "0.13.0"
 
     # @private
-    CEEDLING = "0.10.226"
+    CEEDLING = GEM
     # @private
     CEXCEPTION = "1.2.17"
     # @private
     CMOCK = "2.0.215"
     # @private
-    UNITY = "2.0.136"
+    UNITY = "2.1.0"
   end
 end

data/lib/project_file_loader.rb

@@ -24,7 +24,7 @@ class ProjectFileLoader
       @user_project_filepath = user_filepath
     elsif (@file_wrapper.exist?(DEFAULT_CEEDLING_USER_PROJECT_FILE))
       @user_project_filepath = DEFAULT_CEEDLING_USER_PROJECT_FILE
-    end        
+    end
     
     # next check for main project file by looking for environment variable and then default location on disk;
     # blow up if we don't find this guy -- like, he's so totally important

data/lib/rakefile.rb

@@ -19,6 +19,7 @@ require 'diy'
 require 'constructor'
 
 require 'constants'
+require 'target_loader'
 
 
 # construct all our objects
@@ -27,7 +28,19 @@ require 'constants'
 
 # one-stop shopping for all our setup and such after construction
 @ceedling[:setupinator].ceedling = @ceedling
-@ceedling[:setupinator].do_setup( @ceedling[:setupinator].load_project_files )
+
+project_config =
+  begin
+    cfg = @ceedling[:setupinator].load_project_files
+    TargetLoader.inspect(cfg, ENV['TARGET'])
+  rescue TargetLoader::NoTargets
+    cfg
+  rescue TargetLoader::RequestReload
+    @ceedling[:setupinator].load_project_files
+  end
+
+@ceedling[:setupinator].do_setup( project_config )
+
 
 # tell all our plugins we're about to do something
 @ceedling[:plugin_manager].pre_build

data/lib/target_loader.rb

@@ -0,0 +1,38 @@
+module TargetLoader
+  class NoTargets    < Exception; end
+  class NoDirectory  < Exception; end
+  class NoDefault    < Exception; end
+  class NoSuchTarget < Exception; end
+
+  class RequestReload < Exception; end
+
+  def self.inspect(config, target_name=nil)
+    unless config[:targets]
+      raise NoTargets
+    end
+
+    targets = config[:targets]
+    unless targets[:targets_directory]
+      raise NoDirectory("No targets directory specified.")
+    end
+    unless targets[:default_target]
+      raise NoDefault("No default target specified.")
+    end
+
+    target_path = lambda {|name| File.join(targets[:targets_directory], name + ".yml")}
+
+    target = if target_name
+               target_path.call(target_name)
+             else
+               target_path.call(targets[:default_target])
+             end
+
+    unless File.exists? target
+      raise NoSuchTarget.new("No such target: #{target}")
+    end
+
+    ENV['CEEDLING_MAIN_PROJECT_FILE'] = target
+
+    raise RequestReload
+  end
+end

data/plugins/bullseye/{bullseye.rb → lib/bullseye.rb}

@@ -16,22 +16,21 @@ BULLSEYE_IGNORE_SOURCES    = ['unity', 'cmock', 'cexception']
 
 class Bullseye < Plugin
 
-  attr_reader :config
-
   def setup
-    @result_list = []  
-  
-    @config = {
+    @result_list = []
+    @environment = [ {:covfile => File.join( BULLSEYE_ARTIFACTS_PATH, 'test.cov' )} ]
+    @plugin_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+    @coverage_template_all = @ceedling[:file_wrapper].read(File.join(@plugin_root, 'assets/template.erb'))
+  end
+
+  def config
+    {
       :project_test_build_output_path     => BULLSEYE_BUILD_OUTPUT_PATH,
       :project_test_results_path          => BULLSEYE_RESULTS_PATH,
       :project_test_dependencies_path     => BULLSEYE_DEPENDENCIES_PATH,
       :defines_test                       => DEFINES_TEST + ['CODE_COVERAGE'],
       :collection_defines_test_and_vendor => COLLECTION_DEFINES_TEST_AND_VENDOR + ['CODE_COVERAGE']
-      }
-    
-    @environment = [ {:covfile => File.join( BULLSEYE_ARTIFACTS_PATH, 'test.cov' )} ]
-      
-    @coverage_template_all = @ceedling[:file_wrapper].read( File.join( PLUGINS_BULLSEYE_PATH, 'template.erb') )
+    }
   end
 
   def generate_coverage_object_file(source, object)

data/spec/spec_system_helper.rb

@@ -0,0 +1,192 @@
+require 'fileutils'
+require 'tmpdir'
+require 'yaml'
+
+def test_asset_path(asset_file_name)
+  File.join(File.dirname(__FILE__), '..', 'assets', asset_file_name)
+end
+
+def convert_slashes(path)
+  if RUBY_PLATFORM.downcase.match(/mingw|win32/)
+    path.gsub("/","\\")
+  else
+    path
+  end
+end
+
+class GemDirLayout
+  attr_reader :gem_dir_base_name
+
+  def initialize(install_dir)
+    @gem_dir_base_name = "gems"
+    @d = File.join install_dir, @gem_dir_base_name
+    FileUtils.mkdir_p @d
+  end
+
+  def install_dir; convert_slashes(@d)  end
+  def bin;         File.join(@d, 'bin') end
+  def lib;         File.join(@d, 'lib') end
+end
+
+class SystemContext
+  class VerificationFailed < Exception; end
+  class InvalidBackupEnv < Exception; end
+
+  attr_reader :dir, :gem
+
+  def initialize
+    @dir = Dir.mktmpdir
+    @gem = GemDirLayout.new(@dir)
+  end
+
+  def done!
+    FileUtils.rm_rf(@dir)
+  end
+
+  def deploy_gem
+    git_repo = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+    bundler_gem_file_data = [ %Q{source "http://rubygems.org/"},
+                              %Q{gem "rake"},
+                              %Q{gem "ceedling", :path => '#{git_repo.to_s}'}
+                            ].join("\n")
+
+    File.open(File.join(@dir, "Gemfile"), "w+") do |f|
+      f.write(bundler_gem_file_data)
+    end
+
+    Dir.chdir @dir do
+      with_constrained_env do
+        `bundle install --path #{@gem.install_dir}`
+        checks = [ "bundle exec ruby -S ceedling 2>&1"]
+        checks.each do |c|
+          `#{c}`
+          raise VerificationFailed.new(c) unless $?.success?
+        end
+      end
+    end
+  end
+
+  # Does a few things:
+  #   - Configures the environment.
+  #   - Runs the command from the temporary context directory.
+  #   - Restores everything to where it was when finished.
+  def context_exec(cmd, *args)
+    with_context do
+      `#{args.unshift(cmd).join(" ")}`
+    end
+  end
+
+  def with_context
+    Dir.chdir @dir do |current_dir|
+      with_constrained_env do
+        ENV['RUBYLIB'] = @gem.lib
+        ENV['RUBYPATH'] = @gem.bin
+
+        yield
+      end
+    end
+  end
+
+  def backup_env
+    # Force a deep clone. Hacktacular, but works.
+    @_env = YAML.load(ENV.to_hash.to_yaml)
+  end
+
+  def reduce_env(destroy_keys=[])
+    ENV.keys.each {|k| ENV.delete(k) if destroy_keys.include?(k) }
+  end
+
+  def constrain_env
+    destroy_keys = %w{BUNDLE_GEMFILE BUNDLE_BIN_PATH RUBYOPT}
+    reduce_env(destroy_keys)
+  end
+
+  def restore_env
+    if @_env
+      @_env.each_pair {|k,v| ENV[k] = v}
+    else
+      raise InvalidBackupEnv.new
+    end
+  end
+
+  def with_constrained_env
+    begin
+      backup_env
+      constrain_env
+      yield
+    ensure
+      restore_env
+    end
+  end
+end
+
+module CeedlingTestCases
+  def can_create_projects
+    @c.with_context do
+      Dir.chdir @proj_name do
+        File.exists?("project.yml").should be_true
+        File.exists?("rakefile.rb").should be_true
+        File.exists?("src").should be_true
+        File.exists?("test").should be_true
+      end
+    end
+  end
+
+  def contains_a_vendor_directory
+    @c.with_context do
+      Dir.chdir @proj_name do
+        File.exists?("vendor/ceedling").should be_true
+      end
+    end
+  end
+
+  def does_not_contain_a_vendor_directory
+    @c.with_context do
+      Dir.chdir @proj_name do
+        File.exists?("vendor/ceedling").should be_false
+      end
+    end
+  end
+
+  def contains_documentation
+    @c.with_context do
+      Dir.chdir @proj_name do
+        Dir["vendor/ceedling/docs/*.pdf"].length.should == 4
+      end
+    end
+  end
+
+  def does_not_contain_documentation
+    @c.with_context do
+      Dir.chdir @proj_name do
+        File.exists?("vendor/ceedling/docs").should be_false
+        Dir["vendor/ceedling/**/*.pdf"].length.should == 0
+      end
+    end
+  end
+
+  def can_test_projects
+    @c.with_context do
+      Dir.chdir @proj_name do
+        FileUtils.cp test_asset_path("example_file.h"), 'src'
+        FileUtils.cp test_asset_path("example_file.c"), 'src'
+        FileUtils.cp test_asset_path("test_example_file.c"), 'test'
+
+        output = `bundle exec ruby -S rake test:all 2>&1`
+        output.should match(/TESTED:\s+2/)
+        output.should match(/PASSED:\s+1/)
+        output.should match(/IGNORED:\s+0/)
+      end
+    end
+  end
+
+  def can_use_the_module_plugin
+    @c.with_context do
+      Dir.chdir @proj_name do
+        `bundle exec ruby -S rake module:create[ponies] 2>&1`
+        output = `bundle exec ruby -S rake test:all 2>&1`
+        output.should match(/IGNORED:\s+1/)
+      end
+    end
+  end
+end

data/spec/system/deployment_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_system_helper'
+
+describe "Ceedling" do
+  include CeedlingTestCases
+
+  before :all do
+    @c = SystemContext.new
+    @c.deploy_gem
+  end
+
+  after :all do
+    @c.done!
+  end
+
+  before { @proj_name = "fake_project" }
+  after { @c.with_context { FileUtils.rm_rf @proj_name } }
+
+  describe "deployed in a project's `vendor` directory." do
+    before do
+      @c.with_context do
+        `bundle exec ruby -S ceedling new #{@proj_name} 2>&1`
+      end
+    end
+
+    it { can_create_projects }
+    it { contains_a_vendor_directory }
+    it { contains_documentation }
+    it { can_test_projects }
+    it { can_use_the_module_plugin }
+  end
+
+  describe "deployed in a project's `vendor` directory without docs." do
+    before do
+      @c.with_context do
+        `bundle exec ruby -S ceedling new --nodocs #{@proj_name} 2>&1`
+      end
+    end
+
+    it { can_create_projects }
+    it { contains_a_vendor_directory }
+    it { does_not_contain_documentation }
+    it { can_test_projects }
+    it { can_use_the_module_plugin }
+  end
+
+  describe "deployed as a gem" do
+    before do
+      @c.with_context do
+        `bundle exec ruby -S ceedling new --as-gem #{@proj_name} 2>&1`
+      end
+    end
+
+    it { can_create_projects }
+    it { does_not_contain_a_vendor_directory }
+    it { can_test_projects }
+    it { can_use_the_module_plugin }
+  end
+
+  describe "command: `ceedling examples`" do
+    before do
+      @c.with_context do
+        @output = `bundle exec ruby -S ceedling examples 2>&1`
+      end
+    end
+
+    it "should list out all the examples" do
+      @output.should match(/blinky/)
+      @output.should match(/temp_sensor/)
+      @output.lines.to_a.length.should == 3
+    end
+  end
+
+  describe "command: `ceedling example [example]`" do
+    describe "temp_sensor" do
+      before do
+        @c.with_context do
+          output = `bundle exec ruby -S ceedling example temp_sensor 2>&1`
+          output.should match(/created!/)
+        end
+      end
+
+      it "should be testable" do
+        @c.with_context do
+          Dir.chdir "temp_sensor" do
+            @output = `bundle exec ruby -S rake test:all`
+            @output.should match(/TESTED:\s+47/)
+            @output.should match(/PASSED:\s+47/)
+          end
+        end
+      end
+    end
+
+    # # blinky depends on avr-gcc. If you happen to have this installed, go
+    # # ahead and uncomment this test and run it. This will fail on CI, so I'm
+    # # removing it for now.
+    #
+    # describe "blinky" do
+    #   before do
+    #     @c.with_context do
+    #       output = `bundle exec ruby -S ceedling example blinky 2>&1`
+    #       output.should match(/created!/)
+    #     end
+    #   end
+    #
+    #   it "should be testable" do
+    #     @c.with_context do
+    #       Dir.chdir "blinky" do
+    #         @output = `bundle exec ruby -S rake test:all`
+    #         @output.should match(/TESTED:\s+7/)
+    #         @output.should match(/PASSED:\s+7/)
+    #       end
+    #     end
+    #   end
+    # end
+  end
+end