ceedling 0.27.0 → 0.28.1

data/plugins/gcov/lib/gcov_constants.rb

@@ -0,0 +1,16 @@
+
+GCOV_ROOT_NAME         = 'gcov'.freeze
+GCOV_TASK_ROOT         = GCOV_ROOT_NAME + ':'
+GCOV_SYM               = GCOV_ROOT_NAME.to_sym
+
+GCOV_BUILD_PATH        = File.join(PROJECT_BUILD_ROOT, GCOV_ROOT_NAME)
+GCOV_BUILD_OUTPUT_PATH = File.join(GCOV_BUILD_PATH, "out")
+GCOV_RESULTS_PATH      = File.join(GCOV_BUILD_PATH, "results")
+GCOV_DEPENDENCIES_PATH = File.join(GCOV_BUILD_PATH, "dependencies")
+GCOV_ARTIFACTS_PATH    = File.join(PROJECT_BUILD_ARTIFACTS_ROOT, GCOV_ROOT_NAME)
+
+GCOV_ARTIFACTS_FILE    = File.join(GCOV_ARTIFACTS_PATH, "GcovCoverageResults.html")
+
+GCOV_IGNORE_SOURCES    = %w(unity cmock cexception).freeze
+
+

data/spec/build_invoker_utils_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'ceedling/build_invoker_utils'
+require 'ceedling/constants'
+require 'ceedling/streaminator'
+require 'ceedling/configurator'
+
+describe BuildInvokerUtils do
+  before(:each) do
+    # this will always be mocked
+    @configurator = Configurator.new({:configurator_setup => nil, :configurator_builder => nil,
+                                      :configurator_plugins => nil, :cmock_builder => nil,
+                                      :yaml_wrapper => nil, :system_wrapper => nil})
+    @streaminator = Streaminator.new({:streaminator_helper => nil, :verbosinator => nil,
+                                      :loginator => nil, :stream_wrapper => nil})
+
+    # this is what is being tested
+    @bi_utils = described_class.new({:configurator => @configurator, :streaminator => @streaminator})
+ 
+    # these keep the actual test cleaner
+    @exception_msg = 'Don\'t know how to build task \'xyz\''
+    @basic_msg =  "ERROR: Rake could not find file referenced in source or test: 'xyz'. Possible stale dependency."
+    @deep_dep_msg = "Try fixing #include statements or adding missing file. Then run '#{REFRESH_TASK_ROOT}#{TEST_SYM.to_s}' task and try again."
+    @exception = RuntimeError.new(@exception_msg)
+  end
+  
+  describe '#process_exception' do
+
+    it 'passes given error if message does not contain handled messagr' do
+      expect{@bi_utils.process_exception(ArgumentError.new('oops...'), TEST_SYM)}.to raise_error(ArgumentError)
+    end
+
+    it 'prints to stderr for test with test_build flag set true' do
+      allow(@streaminator).to receive(:stderr_puts).with(@basic_msg)
+      allow(@configurator).to receive(:project_use_deep_dependencies).and_return(false)
+      expect{@bi_utils.process_exception(@exception, TEST_SYM, true)}.to raise_error(RuntimeError)
+    end
+
+    it 'prints to stderr for test with test_build flag set false' do
+      allow(@streaminator).to receive(:stderr_puts).with(@basic_msg.sub(' or test', ''))
+      allow(@configurator).to receive(:project_use_deep_dependencies).and_return(false)
+      expect{@bi_utils.process_exception(@exception, TEST_SYM, false)}.to raise_error(RuntimeError)
+    end
+
+    it 'prints to stderr with extra message when deep dependencies is true' do
+      allow(@streaminator).to receive(:stderr_puts).with(@basic_msg.sub(' or test', ''))
+      allow(@configurator).to receive(:project_use_deep_dependencies).and_return(true)
+      allow(@streaminator).to receive(:stderr_puts).with(@deep_dep_msg)
+      
+      expect{@bi_utils.process_exception(@exception, TEST_SYM, false)}.to raise_error(RuntimeError)
+    end
+
+
+  end
+end

data/spec/file_finder_helper_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'ceedling/file_finder_helper'
+require 'ceedling/constants'
+require 'ceedling/streaminator'
+
+FILE_LIST = ['some/dir/a.c', 'some/dir/a.h', \
+             'another/place/b.c','another/place/b.h',\
+             'here/c.cpp', 'here/c.hpp',\
+             'copy/c.cpp', 'copy/c.hpp'].freeze
+
+describe FileFinderHelper do
+  before(:each) do
+    # this will always be mocked
+    @streaminator = Streaminator.new({:streaminator_helper => nil, :verbosinator => nil, :loginator => nil, :stream_wrapper => nil})
+
+    @ff_helper = described_class.new({:streaminator => @streaminator})
+  end
+  
+  
+  describe '#find_file_in_collection' do
+    it 'returns the full path of the matching file' do
+      expect(@ff_helper.find_file_in_collection('a.c', FILE_LIST, :ignore)).to eq(FILE_LIST[0])
+      expect(@ff_helper.find_file_in_collection('b.h', FILE_LIST, :ignore)).to eq(FILE_LIST[3])
+    end
+
+    xit 'handles duplicate files' do
+    end
+
+    context 'file not found' do
+      it 'returns nil' do
+        expect(@ff_helper.find_file_in_collection('unknown/d.c', FILE_LIST, :ignore)).to be_nil
+      end
+
+      it 'outputs nothing if complain is ignore' do
+        @ff_helper.find_file_in_collection('unknown/d.c', FILE_LIST, :ignore)
+      end
+
+      it 'outputs a complaint if complain is warn' do
+        msg = 'WARNING: Found no file \'d.c\' in search paths.'
+        expect(@streaminator).to receive(:stderr_puts).with(msg, Verbosity::COMPLAIN)
+        @ff_helper.find_file_in_collection('d.c', FILE_LIST, :warn)
+      end
+
+      it 'outputs and raises an error if  complain is error' do
+        msg = 'ERROR: Found no file \'d.c\' in search paths.'
+        allow(@streaminator).to receive(:stderr_puts).with(msg, Verbosity::ERRORS) do
+          expect{@ff_helper.find_file_in_collection('d.c', FILE_LIST, :warn)}.to raise_error
+        end
+      end
+    end
+
+  end
+end

data/spec/gcov/gcov_deployment_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_system_helper'
+require 'gcov/gcov_test_cases_spec'
+
+describe "Ceedling" do
+  describe "Gcov" do
+    include CeedlingTestCases
+    include GcovTestCases
+    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 "basic operations" do
+      before do
+        @c.with_context do
+          `bundle exec ruby -S ceedling new #{@proj_name} 2>&1`
+        end
+      end
+
+      it { can_test_projects_with_gcov_with_success }
+      it { can_test_projects_with_gcov_with_fail }
+      it { can_test_projects_with_gcov_with_compile_error }
+      it { can_fetch_project_help_for_gcov }
+      it { can_create_html_report }
+    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`
+            expect(output).to match(/created!/)
+          end
+        end
+
+        it "should be testable" do
+          @c.with_context do
+            Dir.chdir "temp_sensor" do
+              @output = `bundle exec ruby -S ceedling gcov:all`
+              expect(@output).to match(/TESTED:\s+47/)
+              expect(@output).to match(/PASSED:\s+47/)
+
+              expect(@output).to match(/AdcConductor\.c Lines executed:/i)
+              expect(@output).to match(/AdcHardware\.c Lines executed:/i)
+              expect(@output).to match(/AdcModel\.c Lines executed:/i)
+              expect(@output).to match(/Executor\.c Lines executed:/i)
+              expect(@output).to match(/Main\.c Lines executed:/i)
+              expect(@output).to match(/Model\.c Lines executed:/i)
+              # there are more, but this is a good place to stop.
+
+              @output = `bundle exec ruby -S ceedling utils:gcov`
+              expect(@output).to match(/For now, just creating basic\./)
+              expect(@output).to match(/Creating a basic html report of gcov results in build\/artifacts\/gcov\/GcovCoverageResults\.html\.\.\./)
+              expect(File.exists?('build/artifacts/gcov/GcovCoverageResults.html')).to eq true
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/gcov/gcov_test_cases_spec.rb

@@ -0,0 +1,91 @@
+require 'fileutils'
+require 'tmpdir'
+require 'yaml'
+require 'spec_system_helper'
+require 'pp'
+
+
+module GcovTestCases
+
+  def can_test_projects_with_gcov_with_success
+    @c.with_context do
+      Dir.chdir @proj_name do
+        FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
+        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_success.c"), 'test/'
+
+        output = `bundle exec ruby -S ceedling gcov:all`
+        expect($?.exitstatus).to match(0) # Since a test either pass or are ignored, we return success here
+        expect(output).to match(/TESTED:\s+\d/)
+        expect(output).to match(/PASSED:\s+\d/)
+        expect(output).to match(/FAILED:\s+\d/)
+        expect(output).to match(/IGNORED:\s+\d/)
+      end
+    end
+  end
+
+  def can_test_projects_with_gcov_with_fail
+    @c.with_context do
+      Dir.chdir @proj_name do
+        FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
+        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 ceedling gcov:all`
+        expect($?.exitstatus).to match(1) # Since a test fails, we return error here
+        expect(output).to match(/TESTED:\s+\d/)
+        expect(output).to match(/PASSED:\s+\d/)
+        expect(output).to match(/FAILED:\s+\d/)
+        expect(output).to match(/IGNORED:\s+\d/)
+      end
+    end
+  end
+
+  def can_test_projects_with_gcov_with_compile_error
+    @c.with_context do
+      Dir.chdir @proj_name do
+        FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
+        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_boom.c"), 'test/'
+
+        output = `bundle exec ruby -S ceedling test:all`
+        expect($?.exitstatus).to match(1) # Since a test explodes, we return error here
+        expect(output).to match(/ERROR: Ceedling Failed/)
+      end
+    end
+  end
+
+  def can_fetch_project_help_for_gcov
+    @c.with_context do
+      Dir.chdir @proj_name do
+        FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
+        output = `bundle exec ruby -S ceedling help`
+        expect($?.exitstatus).to match(0)
+        expect(output).to match(/ceedling gcov:\*/i)
+        expect(output).to match(/ceedling gcov:all/i)
+        expect(output).to match(/ceedling gcov:delta/i)
+        expect(output).to match(/ceedling utils:gcov/i)
+      end
+    end
+  end
+
+  def can_create_html_report
+    @c.with_context do
+      Dir.chdir @proj_name do
+        FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
+        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_success.c"), 'test/'
+
+        output = `bundle exec ruby -S ceedling gcov:all`
+        output = `bundle exec ruby -S ceedling utils:gcov`
+        expect(output).to match(/Creating a basic html report of gcov results in build\/artifacts\/gcov\/GcovCoverageResults\.html\.\.\./)
+        expect(File.exists?('build/artifacts/gcov/GcovCoverageResults.html')).to eq true
+
+      end
+    end
+  end
+end

data/spec/generator_test_results_sanity_checker_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+require 'ceedling/generator_test_results_sanity_checker'
+require 'ceedling/constants'
+require 'ceedling/streaminator'
+require 'ceedling/configurator'
+
+describe GeneratorTestResultsSanityChecker do
+  before(:each) do
+    # this will always be mocked
+    @configurator = Configurator.new({:configurator_setup => nil, :configurator_builder => nil, :configurator_plugins => nil, :cmock_builder => nil, :yaml_wrapper => nil, :system_wrapper => nil})
+    @streaminator = Streaminator.new({:streaminator_helper => nil, :verbosinator => nil, :loginator => nil, :stream_wrapper => nil})
+
+    @sanity_checker = described_class.new({:configurator => @configurator, :streaminator => @streaminator})
+  
+    @results = {}
+    @results[:ignores] = ['', '', '']
+    @results[:failures] = ['', '', '']
+    @results[:successes] = ['', '', '']
+    @results[:source] = {:file => "test_file.c"}
+    @results[:counts] = {:ignored => @results[:ignores].size, :failed => @results[:failures].size, :total => 9}
+  end
+  
+  
+  describe '#verify' do
+    it 'returns immediately if sanity_checker set to NONE' do
+      @configurator.sanity_checks = TestResultsSanityChecks::NONE
+      expect(@sanity_checker.verify(nil, 255)).to be_nil
+    end
+
+    it 'rasies error if results are nil' do
+      @configurator.sanity_checks = TestResultsSanityChecks::NORMAL
+      expect{@sanity_checker.verify(nil, 3)}.to raise_error(RuntimeError)
+    end
+
+    it 'rasies error if results are empty' do
+      @configurator.sanity_checks = TestResultsSanityChecks::NORMAL
+      expect{@sanity_checker.verify({}, 3)}.to raise_error(RuntimeError)
+    end
+
+    it 'returns nil if basic checks are good' do
+      @configurator.sanity_checks = TestResultsSanityChecks::NORMAL
+      expect(@sanity_checker.verify(@results, 3)).to be_nil
+    end
+
+    it 'rasies error if basic check fails for ignore' do
+      @configurator.sanity_checks = TestResultsSanityChecks::NORMAL
+      @results[:counts][:ignored] = 0
+      allow(@configurator).to receive(:extension_executable).and_return('')
+      allow(@streaminator).to receive(:stderr_puts)
+      expect{@sanity_checker.verify(@results, 3)}.to raise_error(RuntimeError)
+    end
+
+    it 'rasies error if basic check fails for failed' do
+      @configurator.sanity_checks = TestResultsSanityChecks::NORMAL
+      @results[:counts][:failed] = 0
+      allow(@configurator).to receive(:extension_executable).and_return('')
+      allow(@streaminator).to receive(:stderr_puts)
+      expect{@sanity_checker.verify(@results, 3)}.to raise_error(RuntimeError)
+    end
+
+    it 'rasies error if basic check fails for total' do
+      @configurator.sanity_checks = TestResultsSanityChecks::NORMAL
+      @results[:counts][:total] = 0
+      allow(@configurator).to receive(:extension_executable).and_return('')
+      allow(@streaminator).to receive(:stderr_puts)
+      expect{@sanity_checker.verify(@results, 3)}.to raise_error(RuntimeError)
+    end
+
+    it 'rasies error if thorough check fails for error code not 255 not equal' do
+      @configurator.sanity_checks = TestResultsSanityChecks::THOROUGH
+      allow(@configurator).to receive(:extension_executable).and_return('')
+      allow(@streaminator).to receive(:stderr_puts)
+      expect{@sanity_checker.verify(@results, 2)}.to raise_error(RuntimeError)
+    end
+
+    it 'rasies error if thorough check fails for error code 255 less than 255' do
+      @configurator.sanity_checks = TestResultsSanityChecks::THOROUGH
+      allow(@configurator).to receive(:extension_executable).and_return('')
+      allow(@streaminator).to receive(:stderr_puts)
+      expect{@sanity_checker.verify(@results, 255)}.to raise_error(RuntimeError)
+    end
+
+    it 'returns nil if thorough checks are good' do
+      @configurator.sanity_checks = TestResultsSanityChecks::THOROUGH
+      expect(@sanity_checker.verify(@results, 3)).to be_nil
+    end
+  end
+end

data/spec/generator_test_results_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+require 'ceedling/generator_test_results_sanity_checker'
+require 'ceedling/generator_test_results'
+require 'ceedling/yaml_wrapper'
+require 'ceedling/constants'
+require 'ceedling/streaminator'
+require 'ceedling/configurator'
+
+NORMAL_OUTPUT =
+  "Verbose output one\n" +
+  "Verbous output two\n" +
+  "test_example.c:257:test_one:PASS\n" +
+  "test_example.c:269:test_two:PASS\n" +
+  "\n" +
+  "-----------------------\n" +
+  "2 Tests 0 Failures 0 Ignored \n" +
+  "OK\n".freeze
+
+IGNORE_OUTPUT =
+  "Verbose output one\n" +
+  "Verbous output two\n" +
+  "test_example.c:257:test_one:IGNORE\n" +
+  "test_example.c:269:test_two:IGNORE\n" +
+  "\n" +
+  "-----------------------\n" +
+  "2 Tests 0 Failures 2 Ignored \n" +
+  "OK\n".freeze
+
+
+FAIL_OUTPUT =
+  "Verbose output one\n" +
+  "Verbous output two\n" +
+  "test_example.c:257:test_one:FAIL\n" +
+  "test_example.c:269:test_two:FAIL\n" +
+  "\n" +
+  "-----------------------\n" +
+  "2 Tests 2 Failures 0 Ignored \n" +
+  "OK\n".freeze
+
+
+MANGLED_OUTPUT =
+  "Verbose output one\n" +
+  "test_example.c:257:test_one:PASS\n" +
+  "test_example.c:269:test_tVerbous output two\n" +
+  "wo:PASS\n" +
+  "\n" +
+  "-----------------------\n" +
+  "2 Tests 0 Failures 0 Ignored \n" +
+  "OK\n".freeze
+
+TEST_OUT_FILE = 'out.pass'
+TEST_OUT_FILE_FAIL = 'out.fail'
+
+
+describe GeneratorTestResults do
+  before(:each) do
+    # these will always be mocked
+    @configurator = Configurator.new({:configurator_setup => nil, :configurator_builder => nil, :configurator_plugins => nil, :cmock_builder => nil, :yaml_wrapper => nil, :system_wrapper => nil})
+    @streaminator = Streaminator.new({:streaminator_helper => nil, :verbosinator => nil, :loginator => nil, :stream_wrapper => nil})
+    
+    # these will always be used as is.
+    @yaml_wrapper = YamlWrapper.new
+    @sanity_checker = GeneratorTestResultsSanityChecker.new({:configurator => @configurator, :streaminator => @streaminator})
+    
+    @generate_test_results = described_class.new({:configurator => @configurator, :generator_test_results_sanity_checker => @sanity_checker, :yaml_wrapper => @yaml_wrapper})
+  end
+
+  after(:each) do
+    if File.exists?(TEST_OUT_FILE)
+      File.delete(TEST_OUT_FILE)
+    end
+  end
+  
+  describe '#process_and_write_results' do
+    it 'handles an empty input' do
+      @generate_test_results.process_and_write_results({:output => ''}, TEST_OUT_FILE, 'some/place/test_example.c')
+      expect(IO.read(TEST_OUT_FILE)).to eq(IO.read('spec/support/test_example_empty.pass'))
+    end
+
+    it 'handles a normal test output' do
+      @generate_test_results.process_and_write_results({:output => NORMAL_OUTPUT}, TEST_OUT_FILE, 'some/place/test_example.c')
+      expect(IO.read(TEST_OUT_FILE)).to eq(IO.read('spec/support/test_example.pass'))
+    end
+
+    it 'handles a normal test output with ignores' do
+      @generate_test_results.process_and_write_results({:output => IGNORE_OUTPUT}, TEST_OUT_FILE, 'some/place/test_example.c')
+      expect(IO.read(TEST_OUT_FILE)).to eq(IO.read('spec/support/test_example_ignore.pass'))
+    end
+
+    it 'handles a normal test output with failures' do
+      allow(@configurator).to receive(:extension_testfail).and_return('.fail')
+      @generate_test_results.process_and_write_results({:output => FAIL_OUTPUT}, TEST_OUT_FILE, 'some/place/test_example.c')
+      expect(IO.read(TEST_OUT_FILE_FAIL)).to eq(IO.read('spec/support/test_example.fail'))
+    end
+
+    it 'handles a mangled test output as gracefully as it can' do
+      @generate_test_results.process_and_write_results({:output => MANGLED_OUTPUT}, TEST_OUT_FILE, 'some/place/test_example.c')
+      expect(IO.read(TEST_OUT_FILE)).to eq(IO.read('spec/support/test_example_mangled.pass'))
+    end
+
+  end
+end