ceedling 0.13.0 → 0.15.0

data/plugins/xml_tests_report/xml_tests_report.rb

@@ -1,5 +1,5 @@
-require 'plugin'
-require 'constants'
+require 'ceedling/plugin'
+require 'ceedling/constants'
 
 class XmlTestsReport < Plugin
 
@@ -57,7 +57,7 @@ class XmlTestsReport < Plugin
         result[:collection].each do |item|
           filename = File.join( result[:source][:path], result[:source][:file] )
         
-          stream.puts "\t\t<FailedTest id=\"#{@test_counter}\">"
+          stream.puts "\t\t<FailedTest id=\"#{@test_counter}\"/>"
           stream.puts "\t\t\t<Name>#{filename}::#{item[:test]}</Name>"
   				stream.puts "\t\t\t<FailureType>Assertion</FailureType>"
           stream.puts "\t\t\t<Location>"
@@ -107,4 +107,4 @@ class XmlTestsReport < Plugin
     stream.puts "</TestRun>"
   end
   
-end
+end

data/release/version.info

@@ -1 +1 @@
-0.10
+0.15

data/spec/ceedling_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+require 'ceedling'
+
+describe 'Ceedling' do
+  context 'location' do
+    it 'should return the location of the ceedling gem directory' do
+      # create test state/variables
+      ceedling_path = File.join(File.dirname(__FILE__), '..').gsub('spec','lib')
+      # mocks/stubs/expected calls
+      # execute method
+      location = Ceedling.location
+      # validate results
+      location.should == ceedling_path
+    end
+  end
+
+  context 'load_path' do
+    it 'should return the location of the plugins directory' do
+      # create test state/variables
+      load_path = File.join(File.dirname(__FILE__), '..').gsub('spec','lib')
+      load_path = File.join( load_path, 'plugins' )
+      # mocks/stubs/expected calls
+      # execute method
+      location = Ceedling.load_path
+      # validate results
+      location.should == load_path
+    end
+  end
+
+  context 'rakefile' do
+    it 'should return the location of the ceedling rakefile' do
+      # create test state/variables
+      rakefile_path = File.join(File.dirname(__FILE__), '..').gsub('spec','lib')
+      rakefile_path = File.join( rakefile_path, 'lib', 'ceedling', 'rakefile.rb' )
+      # mocks/stubs/expected calls
+      # execute method
+      location = Ceedling.rakefile
+      # validate results
+      location.should == rakefile_path
+    end
+  end
+
+  context 'load_project' do
+    it 'should load the project with the default yaml file' do
+      # create test state/variables
+      ENV.delete('CEEDLING_MAIN_PROJECT_FILE')
+      rakefile_path = File.join(File.dirname(__FILE__), '..').gsub('spec','lib')
+      rakefile_path = File.join( rakefile_path, 'lib', 'ceedling', 'rakefile.rb' )
+      # mocks/stubs/expected calls
+      Ceedling.should_receive(:load).with(rakefile_path)
+      # execute method
+      Ceedling.load_project
+      # validate results
+      ENV['CEEDLING_MAIN_PROJECT_FILE'].should == './project.yml'
+    end
+
+    it 'should load the project with the specified yaml file' do
+      # create test state/variables
+      ENV.delete('CEEDLING_MAIN_PROJECT_FILE')
+      rakefile_path = File.join(File.dirname(__FILE__), '..').gsub('spec','lib')
+      rakefile_path = File.join( rakefile_path, 'lib', 'ceedling', 'rakefile.rb' )
+      # mocks/stubs/expected calls
+      Ceedling.should_receive(:load).with(rakefile_path)
+      # execute method
+      Ceedling.load_project(config: './foo.yml')
+      # validate results
+      ENV['CEEDLING_MAIN_PROJECT_FILE'].should == './foo.yml'
+    end
+
+    it 'should load the project with the yaml file specified by the existing environment variable' do
+      # create test state/variables
+      ENV['CEEDLING_MAIN_PROJECT_FILE'] = './bar.yml'
+      rakefile_path = File.join(File.dirname(__FILE__), '..').gsub('spec','lib')
+      rakefile_path = File.join( rakefile_path, 'lib', 'ceedling', 'rakefile.rb' )
+      # mocks/stubs/expected calls
+      Ceedling.should_receive(:load).with(rakefile_path)
+      # execute method
+      Ceedling.load_project
+      # validate results
+      ENV['CEEDLING_MAIN_PROJECT_FILE'].should == './bar.yml'
+    end
+
+    it 'should load the project with the specified plugins enabled' do
+      # create test state/variables
+      DEFAULT_CEEDLING_CONFIG[:plugins][:enabled].clear()
+      DEFAULT_CEEDLING_CONFIG[:plugins][:load_paths].clear()
+      spec_double = double('spec-double')
+      rakefile_path = File.join(File.dirname(__FILE__), '..').gsub('spec','lib')
+      rakefile_path = File.join( rakefile_path, 'lib', 'ceedling', 'rakefile.rb' )
+      # mocks/stubs/expected calls
+      Gem::Specification.should_receive(:find_by_name).with('ceedling-foo').and_return(spec_double)
+      spec_double.should_receive(:gem_dir).and_return('dummy/path')
+      Ceedling.should_receive(:require).with('ceedling/defaults')
+      Ceedling.should_receive(:load).with(rakefile_path)
+      # execute method
+      Ceedling.load_project( config:  './foo.yml',
+                             plugins: ['foo'])
+      # validate results
+      ENV['CEEDLING_MAIN_PROJECT_FILE'].should == './foo.yml'
+    end
+
+    it 'should set the project root if the root key is provided' do
+      # create test state/variables
+      Object.send(:remove_const, :PROJECT_ROOT)
+      DEFAULT_CEEDLING_CONFIG[:plugins][:enabled].clear()
+      DEFAULT_CEEDLING_CONFIG[:plugins][:load_paths].clear()
+      rakefile_path = File.join(File.dirname(__FILE__), '..').gsub('spec','lib')
+      rakefile_path = File.join( rakefile_path, 'lib', 'ceedling', 'rakefile.rb' )
+      # mocks/stubs/expected calls
+      Ceedling.should_receive(:load).with(rakefile_path)
+      # execute method
+      Ceedling.load_project( config:  './foo.yml',
+                             root:    './')
+      # validate results
+      ENV['CEEDLING_MAIN_PROJECT_FILE'].should == './foo.yml'
+      PROJECT_ROOT.should == './'
+    end
+  end
+
+  context 'register_plugin' do
+    it 'should register a plugin' do
+      # create test state/variables
+      DEFAULT_CEEDLING_CONFIG[:plugins][:enabled].clear()
+      DEFAULT_CEEDLING_CONFIG[:plugins][:load_paths].clear()
+      spec_double = double('spec-double')
+      # mocks/stubs/expected calls
+      Gem::Specification.should_receive(:find_by_name).with('ceedling-foo').and_return(spec_double)
+      spec_double.should_receive(:gem_dir).and_return('dummy/path')
+      Ceedling.should_receive(:require).with('ceedling/defaults')
+      # execute method
+      Ceedling.register_plugin('foo')
+      # validate results
+      DEFAULT_CEEDLING_CONFIG[:plugins][:enabled].should    == ["foo"]
+      DEFAULT_CEEDLING_CONFIG[:plugins][:load_paths].should == ["dummy/path"]
+    end
+
+    it 'should register a plugin with an alternative prefix' do
+      # create test state/variables
+      DEFAULT_CEEDLING_CONFIG[:plugins][:enabled].clear()
+      DEFAULT_CEEDLING_CONFIG[:plugins][:load_paths].clear()
+      spec_double = double('spec-double')
+      # mocks/stubs/expected calls
+      Gem::Specification.should_receive(:find_by_name).with('prefix-foo').and_return(spec_double)
+      spec_double.should_receive(:gem_dir).and_return('dummy/path')
+      Ceedling.should_receive(:require).with('ceedling/defaults')
+      # execute method
+      Ceedling.register_plugin('foo','prefix-')
+      # validate results
+      DEFAULT_CEEDLING_CONFIG[:plugins][:enabled].should    == ["foo"]
+      DEFAULT_CEEDLING_CONFIG[:plugins][:load_paths].should == ["dummy/path"]
+    end
+  end
+end
+

data/spec/par_map_spec.rb

@@ -1,4 +1,4 @@
-require "par_map"
+require 'ceedling/par_map'
 
 def short_task_should(n) 
   done_count = 0

data/spec/preprocessinator_extractor_spec.rb

@@ -1,39 +1,38 @@
 # derived from test_graveyard/unit/preprocessinator_extractor_test.rb
 
 require 'spec_helper'
+require 'ceedling/preprocessinator_extractor'
 
 describe PreprocessinatorExtractor do
-  describe "#extract_base_file_from_preprocessed_expansion" do
+  context "#extract_base_file_from_preprocessed_expansion" do
     it "should extract text from the original file and keep #pragma statements" do
       file_path = "path/to/WANT.c"
-      input_str = <<-EOS
-        # 1 "some/file/we/do/not/care/about.c" 5
-        #pragma shit
-        some_text_we_do_not_want();
-        # 1 "some/file/we/DO/WANT.c" 99999
-        some_text_we_do_not_want();
-        #pragma want
-        some_awesome_text_we_want_so_hard();
-        holy_crepes_more_awesome_text();
-        # oh darn
-        # 1 "some/useless/file.c" 9
-        a set of junk
-        more junk
-        # 1 "holy/shoot/yes/WANT.c" 10
-        some_additional_awesome_want_text();
-      EOS
-      input_str = input_str.left_margin.rstrip
+      input_str = [
+        '# 1 "some/file/we/do/not/care/about.c" 5',
+        '#pragma shit',
+        'some_text_we_do_not_want();',
+        '# 1 "some/file/we/DO/WANT.c" 99999',
+        'some_text_we_do_not_want();',
+        '#pragma want',
+        'some_awesome_text_we_want_so_hard();',
+        'holy_crepes_more_awesome_text();',
+        '# oh darn',
+        '# 1 "some/useless/file.c" 9',
+        'a set of junk',
+        'more junk',
+        '# 1 "holy/shoot/yes/WANT.c" 10',
+        'some_additional_awesome_want_text();',
+      ]
 
-      expect_str = <<-EOS
-        some_text_we_do_not_want();
-        #pragma want
-        some_awesome_text_we_want_so_hard();
-        holy_crepes_more_awesome_text();
-        some_additional_awesome_want_text();
-      EOS
-      expect_str = expect_str.left_margin.rstrip.split("\n")
+      expect_str = [
+        'some_text_we_do_not_want();',
+        '#pragma want',
+        'some_awesome_text_we_want_so_hard();',
+        'holy_crepes_more_awesome_text();',
+        'some_additional_awesome_want_text();',
+      ]
 
-      stub(File).readlines(file_path) { input_str.split("\n") }
+      File.should_receive(:readlines).with(file_path).and_return( input_str )
 
       subject.extract_base_file_from_preprocessed_expansion(file_path).should == expect_str
     end

data/spec/preprocessinator_includes_handler_spec.rb

@@ -0,0 +1,175 @@
+require 'spec_helper'
+require 'ceedling/preprocessinator_includes_handler'
+
+describe PreprocessinatorIncludesHandler do
+  before :each do
+    @configurator    = double('configurator')
+    @tool_executor   = double('tool_executor')
+    @task_invoker    = double('task_invoker')
+    @file_path_utils = double('file_path_utils')
+    @yaml_wrapper    = double('yaml_wrapper')
+    @file_wrapper    = double('file_wrapper')
+  end
+
+  subject do
+    PreprocessinatorIncludesHandler.new(
+      :configurator    => @configurator,
+      :tool_executor   => @tool_executor,
+      :task_invoker    => @task_invoker,
+      :file_path_utils => @file_path_utils,
+      :yaml_wrapper    => @yaml_wrapper,
+      :file_wrapper    => @file_wrapper,
+    )
+  end
+
+  context 'invoke_shallow_includes_list' do
+    it 'should invoke the rake task which will build included files' do
+      # create test state/variables
+      # mocks/stubs/expected calls
+      inc_list_double = double('inc-list-double')
+      @file_path_utils.should_receive(:form_preprocessed_includes_list_filepath).with('some_source_file.c').and_return(inc_list_double)
+      @task_invoker.should_receive(:invoke_test_shallow_include_lists).with( [inc_list_double] )
+      # execute method
+      subject.invoke_shallow_includes_list('some_source_file.c')
+      # validate results
+    end
+  end
+
+  context 'form_shallow_dependencies_rule' do
+    it 'should return an annotated dependency rule generated by the preprocessor' do
+      # create test state/variables
+      # mocks/stubs/expected calls
+      @file_path_utils.should_receive(:form_temp_path).with('some_source_file.c','_').and_return('_some_source_file.c')
+      contents_double = double('contents-double')
+      @file_wrapper.should_receive(:read).with('some_source_file.c').and_return(contents_double)
+      contents_double.should_receive(:gsub!).with(/^\s*#include\s+[\"<]\s*(\S+)\s*[\">]/, "#include \"\\1\"\n#include \"@@@@\\1\"")
+      @file_wrapper.should_receive(:write).with('_some_source_file.c', contents_double)
+      @configurator.should_receive(:tools_test_includes_preprocessor).and_return('cpp')
+      command_double = double('command-double')
+      @tool_executor.should_receive(:build_command_line).with('cpp', '_some_source_file.c').and_return(command_double)
+      command_double.should_receive(:[]).with(:line).and_return('cpp')
+      command_double.should_receive(:[]).with(:options).and_return(['arg1','arg2'])
+      output_double = double('output-double')
+      @tool_executor.should_receive(:exec).with('cpp',['arg1','arg2']).and_return(output_double)
+      output_double.should_receive(:[]).with(:output).and_return('make-rule')
+      # execute method
+      results = subject.form_shallow_dependencies_rule('some_source_file.c')
+      # validate results
+      results.should == 'make-rule'
+    end
+  end
+
+  context 'extract_shallow_includes' do
+    it 'should return the list of direct dependencies for the given test file' do
+      # create test state/variables
+      # mocks/stubs/expected calls
+      @configurator.should_receive(:extension_header).and_return('.h')
+      # execute method
+      results = subject.extract_shallow_includes(%q{
+        _test_DUMMY.o: Build/temp/_test_DUMMY.c \
+          source/some_header1.h \
+          source/some_lib/some_header2.h \
+          source/some_other_lib/some_header2.h \
+          @@@@some_header1.h \
+          @@@@some_lib/some_header2.h
+          @@@@some_other_lib/some_header2.h
+      })
+      # validate results
+      results.should == ['some_header1.h',
+                         'some_lib/some_header2.h',
+                         'some_other_lib/some_header2.h']
+    end
+
+  it 'should return the list of direct dependencies for the given test file' do
+      # create test state/variables
+      # mocks/stubs/expected calls
+      @configurator.should_receive(:extension_header).and_return('.h')
+      # execute method
+      results = subject.extract_shallow_includes(%q{
+        _test_DUMMY.o: Build/temp/_test_DUMMY.c \
+          source/some_header1.h \
+          source/some_lib/some_header2.h \
+          source/some_other_lib/some_header2.h \
+          @@@@some_header1.h \
+          @@@@some_lib/some_header2.h
+          @@@@some_other_lib/some_header2.h
+      })
+      # validate results
+      results.should == ['some_header1.h',
+                         'some_lib/some_header2.h',
+                         'some_other_lib/some_header2.h']
+    end
+
+    it 'should correctly handle path separators' do
+      # create test state/variables
+      # mocks/stubs/expected calls
+      @configurator.should_receive(:extension_header).and_return('.h')
+      # execute method
+      results = subject.extract_shallow_includes(%q{
+        _test_DUMMY.o: Build/temp/_test_DUMMY.c \
+          source\some_header1.h \
+          source\some_lib\some_header2.h \
+          source\some_lib1\some_lib\some_header2.h \
+          source\some_other_lib\some_header2.h \
+          @@@@some_header1.h \
+          @@@@some_lib/some_header2.h
+          @@@@some_lib1/some_lib/some_header2.h
+          @@@@some_other_lib/some_header2.h
+      })
+      # validate results
+      results.should == ['some_header1.h',
+                         'some_lib/some_header2.h',
+                         'some_lib1/some_lib/some_header2.h',
+                         'some_other_lib/some_header2.h']
+    end
+
+    it 'exclude annotated headers with no matching "real" header' do
+      # create test state/variables
+      # mocks/stubs/expected calls
+      @configurator.should_receive(:extension_header).and_return('.h')
+      # execute method
+      results = subject.extract_shallow_includes(%q{
+        _test_DUMMY.o: Build/temp/_test_DUMMY.c \
+          source/some_header1.h \
+          @@@@some_header1.h \
+          @@@@some_lib/some_header2.h
+      })
+      # validate results
+      results.should == ['some_header1.h']
+    end
+
+    it 'should correctly filter secondary dependencies' do
+      # create test state/variables
+      # mocks/stubs/expected calls
+      @configurator.should_receive(:extension_header).and_return('.h')
+      # execute method
+      results = subject.extract_shallow_includes(%q{
+        _test_DUMMY.o: Build/temp/_test_DUMMY.c \
+          source\some_header1.h \
+          source\some_lib\some_header2.h \
+          source\some_lib1\some_lib\some_header2.h \
+          source\some_other_lib\some_header2.h \
+          source\some_other_lib\another.h \
+          @@@@some_header1.h \
+          @@@@some_lib/some_header2.h \
+          @@@@lib/some_header2.h \
+          @@@@some_other_lib/some_header2.h
+      })
+      # validate results
+      results.should == ['some_header1.h',
+                         'some_lib/some_header2.h',
+                         'some_other_lib/some_header2.h']
+    end
+  end
+
+  context 'invoke_shallow_includes_list' do
+    it 'should invoke the rake task which will build included files' do
+      # create test state/variables
+      # mocks/stubs/expected calls
+      @yaml_wrapper.should_receive(:dump).with('some_source_file.c', [])
+      # execute method
+      subject.write_shallow_includes_list('some_source_file.c', [])
+      # validate results
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,9 +1,9 @@
 require 'require_all'
 require 'constructor'
 
-RSpec.configure do |configuration|
-  configuration.mock_with :rr
-end
+#RSpec.configure do |configuration|
+#  configuration.mock_with :rr
+#end
 
 here = File.dirname(__FILE__)
 
@@ -20,27 +20,8 @@ support_dir = File.join(File.dirname(__FILE__), 'support')
 # # ceedling_files = File.join(File.dirname(__FILE__), '../lib/**/*.rb')
 # # require_all Dir.glob(ceedling_files)
 
-require 'preprocessinator_extractor'
-require 'configurator_builder'
-require 'configurator'
-
-class String
-  def left_margin(indentation_level = 0)
-    indent = " " * indentation_level
-
-    data_start_at_col = self.lines.map do |l|
-      white_space = l.match(/(^\s*)\S/)
-
-      if white_space
-        white_space[1].length
-      end
-    end.compact.min
-
-    self.lines.map do |l|
-      rel = l[data_start_at_col..-1]
-      if rel
-        indent + rel
-      end
-    end.compact.join
-  end
-end
+require 'ceedling/preprocessinator_extractor'
+require 'ceedling/configurator_builder'
+require 'ceedling/configurator'
+
+