ceedling 1.2.1 → 1.2.2

data/spec/units/bin/launchinator_spec.rb

@@ -0,0 +1,171 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+require 'spec_helper'
+require 'tmpdir'
+require 'fileutils'
+require 'ceedling/constants'
+require 'launchinator'
+require 'app_cfg'
+
+describe Launchinator do
+  before(:each) do
+    @selector  = double('installation_selector')
+    @loginator = double('loginator').as_null_object
+    @app_cfg   = CeedlingAppConfig.new( argv: ['test:all', '--verbosity=obnoxious'] )
+    @launcher  = Installation.new( @app_cfg[:launcher_root_path] )
+
+    @launchinator = described_class.new({
+      :installation_selector => @selector,
+      :loginator             => @loginator,
+    })
+
+    allow(Handoff).to receive(:exec)
+  end
+
+  def select(installation)
+    allow(@selector).to receive(:select) do |app_cfg:, **|
+      app_cfg.set_paths( installation.root )
+      installation
+    end
+  end
+
+  describe '#resolve' do
+    it 'selects which Ceedling without handing off' do
+      Dir.mktmpdir do |other|
+        select( Installation.new( other ) )
+
+        expect(@launchinator.resolve( env: {}, app_cfg: @app_cfg )).to eq( Installation.new( other ) )
+        expect(Handoff).to_not have_received(:exec)
+      end
+    end
+
+    it 'passes the configuration and vendor detection through to selection' do
+      select( @launcher )
+      config = {:project => {}}
+
+      @launchinator.resolve( env: {'X' => '1'}, app_cfg: @app_cfg, config: config, detect_vendor: false )
+
+      expect(@selector).to have_received(:select).with( env: {'X' => '1'}, config: config, app_cfg: @app_cfg, detect_vendor: false )
+    end
+  end
+
+  describe '#proceed' do
+    it 'hands off to an already selected installation without selecting again' do
+      Dir.mktmpdir do |other|
+        target = Installation.new( other )
+        FileUtils.mkdir_p( File.dirname( target.bin_path ) )
+        FileUtils.touch( target.bin_path )
+
+        expect(@selector).to_not receive(:select)
+
+        @launchinator.proceed( target: target, app_cfg: @app_cfg )
+
+        expect(Handoff).to have_received(:exec).with( target: target, launcher: @launcher, argv: @app_cfg[:argv], loginator: @loginator )
+      end
+    end
+
+    it 'returns the rakefile of the launcher\'s own installation' do
+      expect(@launchinator.proceed( target: @launcher, app_cfg: @app_cfg )).to eq( @launcher.rakefile_path )
+    end
+  end
+
+  describe '#launch' do
+    it 'continues in-process and returns the rakefile when the launcher\'s own installation is selected' do
+      select( @launcher )
+
+      expect(@launchinator.launch( env: {}, app_cfg: @app_cfg )).to eq( @launcher.rakefile_path )
+      expect(Handoff).to_not have_received(:exec)
+      expect(@loginator).to_not have_received(:log)
+    end
+
+    # GH #1365: another installation once ran inside this launcher's process
+    it 'hands off to another installation with the original command line, after saying so' do
+      Dir.mktmpdir do |other|
+        target = Installation.new( other )
+        FileUtils.mkdir_p( File.dirname( target.bin_path ) )
+        FileUtils.touch( target.bin_path )
+        select( target )
+
+        expect(@loginator).to receive(:log).with(
+          Handoff.handing_off_message( launcher: @launcher, target: target ), Verbosity::COMPLAIN, LogLabels::NOTICE
+        ).ordered
+        expect(Handoff).to receive(:exec).with(
+          target: target, launcher: @launcher, argv: ['test:all', '--verbosity=obnoxious'], loginator: @loginator
+        ).ordered
+
+        @launchinator.launch( env: {}, app_cfg: @app_cfg )
+      end
+    end
+
+    it 'raises rather than hand off to an installation with no launcher' do
+      Dir.mktmpdir do |other|
+        select( Installation.new( other ) )
+
+        expect {
+          @launchinator.launch( env: {}, app_cfg: @app_cfg )
+        }.to raise_error( CeedlingException, /#{Regexp.escape( Installation.new( other ).bin_path )}/ )
+        expect(Handoff).to_not have_received(:exec)
+      end
+    end
+
+    # GH #1365: such a copy only ever ran inside another launcher's process
+    it 'stops with advice to upgrade rather than hand off to a copy vendored without its built-in mixins' do
+      Dir.mktmpdir do |other|
+        target = Installation.new( other )
+        FileUtils.mkdir_p( File.dirname( target.bin_path ) )
+        FileUtils.touch( target.bin_path )
+        File.write( File.join( other, 'bin', 'mixins.rb' ), "BUILTIN_MIXIN_LOAD_PATHS = []\n" )
+        select( target )
+
+        expect {
+          @launchinator.launch( env: {}, app_cfg: @app_cfg )
+        }.to raise_error( CeedlingException, /#{Regexp.escape( target.describe )} cannot run on its own.*ceedling upgrade/m )
+        expect(Handoff).to_not have_received(:exec)
+      end
+    end
+
+    context 'in a process another launcher handed off to' do
+      before(:each) do
+        @app_cfg.set_handoff( {launcher: '/usr/lib/gems/ceedling-1.2.3', target: @launcher.root} )
+      end
+
+      it 'says where it was launched from and continues in-process' do
+        select( @launcher )
+
+        expect(@loginator).to receive(:log).with(
+          Handoff.received_message( @app_cfg[:handoff], own: @launcher ), Verbosity::COMPLAIN, LogLabels::NOTICE
+        )
+
+        expect(@launchinator.launch( env: {}, app_cfg: @app_cfg )).to eq( @launcher.rakefile_path )
+        expect(Handoff).to_not have_received(:exec)
+      end
+
+      it 'never hands off again, even when another installation is selected' do
+        Dir.mktmpdir do |other|
+          select( Installation.new( other ) )
+
+          expect(@launchinator.launch( env: {}, app_cfg: @app_cfg )).to eq( Installation.new( other ).rakefile_path )
+          expect(Handoff).to_not have_received(:exec)
+        end
+      end
+    end
+
+    it 'ignores markers naming another installation as the target' do
+      Dir.mktmpdir do |other|
+        FileUtils.mkdir_p( File.join( other, 'bin' ) )
+        FileUtils.touch( File.join( other, 'bin', 'ceedling' ) )
+        @app_cfg.set_handoff( {launcher: '/gem', target: '/somewhere/else'} )
+        select( Installation.new( other ) )
+
+        @launchinator.launch( env: {}, app_cfg: @app_cfg )
+
+        expect(Handoff).to have_received(:exec)
+      end
+    end
+  end
+end

data/spec/units/bin/path_validator_spec.rb

@@ -94,6 +94,16 @@ describe PathValidator do
     it 'passes nil and empty arguments through unchanged, without raising' do
       expect(@path_validator.standardize_paths( nil, '' )).to eq( [nil, ''] )
     end
+
+    # The path handling audit around GH #1370: a path bin/ takes in reads as lib/ reads one
+    # A destination of only spaces stays the relative name it was, never the filesystem root
+    it 'passes a path of only whitespace through unchanged' do
+      expect(@path_validator.standardize_paths( '   ' )).to eq( ['   '] )
+    end
+
+    it 'reads `~` as the home directory and drops a trailing separator' do
+      expect(@path_validator.standardize_paths( '~/mixins/clang.yml', 'mixins\\' )).to eq( [File.join( Dir.home, 'mixins/clang.yml' ), 'mixins'] )
+    end
   end
 
   describe '#filepath?' do

data/spec/units/bin/versionator_spec.rb

@@ -11,8 +11,7 @@ require 'fileutils'
 
 # versionator.rb's bare `require 'exceptions'`/`require 'constants'` statements only
 # resolve when lib/ceedling/ is directly on the load path -- true in the real
-# bin/ceedling bootstrap but not in this spec harness's load path setup. `require
-# 'version'` similarly needs lib/ on the load path.
+# bin/ceedling bootstrap but not in this spec harness's load path setup.
 here = File.dirname(__FILE__)
 $: << File.join(here, '../../../lib/ceedling')
 $: << File.join(here, '../../../lib')
@@ -35,30 +34,60 @@ describe Versionator do
     HEADER
   end
 
+  # Each fixture root is its own installation with its own lib/version.rb
+  def write_version(root, base)
+    FileUtils.mkdir_p( File.join( root, 'lib' ) )
+    File.write( File.join( root, 'lib', 'version.rb' ), <<~RUBY )
+      module Ceedling
+        module Version
+          BASE = '#{base}'
+          DEV = ''
+          GEM = BASE
+          TAG = GEM
+        end
+      end
+    RUBY
+  end
+
   describe 'Ceedling tag and build string' do
-    it 'sets the Ceedling tag from the Version module' do
+    # GH #1365: the tag once came from whichever installation's constant loaded first
+    it 'sets the Ceedling tag from the installation\'s own lib/version.rb' do
       Dir.mktmpdir do |root|
+        write_version( root, '1.2.0' )
+        stub_const( 'Ceedling::Version::TAG', '9.9.9' )
+
         versionator = described_class.new( root )
 
-        expect(versionator.ceedling_tag).to eq( Ceedling::Version::TAG )
+        expect(versionator.ceedling_tag).to eq( '1.2.0' )
+      end
+    end
+
+    it 'raises a CeedlingException naming the file when the installation has no version' do
+      Dir.mktmpdir do |root|
+        expect {
+          described_class.new( root )
+        }.to raise_error( CeedlingException, /#{Regexp.escape( File.join( File.expand_path( root ), 'lib', 'version.rb' ) )}/ )
       end
     end
 
     it 'builds without a commit SHA suffix when no SHA file is present' do
       Dir.mktmpdir do |root|
+        write_version( root, '1.2.0' )
+
         versionator = described_class.new( root )
 
-        expect(versionator.ceedling_build).to eq( Ceedling::Version::TAG )
+        expect(versionator.ceedling_build).to eq( '1.2.0' )
       end
     end
 
     it 'appends the commit SHA to the build string when the SHA file is present' do
       Dir.mktmpdir do |root|
+        write_version( root, '1.2.0' )
         File.write( File.join( root, GIT_COMMIT_SHA_FILENAME ), "abc1234\n" )
 
         versionator = described_class.new( root )
 
-        expect(versionator.ceedling_build).to eq( "#{Ceedling::Version::TAG}-abc1234" )
+        expect(versionator.ceedling_build).to eq( '1.2.0-abc1234' )
       end
     end
   end
@@ -66,6 +95,7 @@ describe Versionator do
   describe 'framework version gathering' do
     it 'skips framework tags entirely when no vendor path is given' do
       Dir.mktmpdir do |root|
+        write_version( root, '1.2.0' )
         versionator = described_class.new( root )
 
         expect(versionator.unity_tag).to be_nil
@@ -76,6 +106,7 @@ describe Versionator do
 
     it 'parses version tags out of each vendored framework header' do
       Dir.mktmpdir do |root|
+        write_version( root, '1.2.0' )
         Dir.mktmpdir do |vendor|
           write_version_header( vendor, 'unity', File.join('src', 'unity.h'), major: 2, minor: 7, build: 1 )
           write_version_header( vendor, 'cmock', File.join('src', 'cmock.h'), major: 2, minor: 7, build: 0 )
@@ -92,6 +123,7 @@ describe Versionator do
 
     it 'raises a CeedlingException when a framework header cannot be read' do
       Dir.mktmpdir do |root|
+        write_version( root, '1.2.0' )
         Dir.mktmpdir do |vendor|
           # No headers written -- vendor is empty, so every read fails.
           expect {

data/spec/units/build_log_writer_spec.rb

@@ -0,0 +1,57 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+require 'spec_helper'
+require 'tmpdir'
+require 'ceedling/build_log_writer'
+require 'ceedling/filesystem/file_wrapper'
+
+describe BuildLogWriter do
+  let(:file_wrapper) { double('file_wrapper') }
+  let(:writer)       { described_class.new( file_wrapper: file_wrapper ) }
+
+  before(:each) do
+    allow(file_wrapper).to receive(:mkdir_for) { |path| path }
+    allow(file_wrapper).to receive(:write)
+  end
+
+  it "replaces an earlier build's log with this build's first entry" do
+    writer.write( 'logs/test/test/test_foo/test_a.gdb.log', "first\n" )
+
+    expect(file_wrapper).to have_received(:mkdir_for).with( 'logs/test/test/test_foo/test_a.gdb.log' )
+    expect(file_wrapper).to have_received(:write).with( 'logs/test/test/test_foo/test_a.gdb.log', "first\n", 'w' )
+  end
+
+  it 'appends later entries in the same build, after the separator' do
+    writer.write( 'a.log', 'one', separator: "\n" )
+    writer.write( 'a.log', 'two', separator: "\n" )
+
+    expect(file_wrapper).to have_received(:write).with( 'a.log', 'one', 'w' ).ordered
+    expect(file_wrapper).to have_received(:write).with( 'a.log', "\ntwo", 'a' ).ordered
+  end
+
+  it 'replaces each log separately' do
+    writer.write( 'a.log', 'one' )
+    writer.write( 'b.log', 'two' )
+
+    expect(file_wrapper).to have_received(:write).with( 'a.log', 'one', 'w' )
+    expect(file_wrapper).to have_received(:write).with( 'b.log', 'two', 'w' )
+  end
+
+  it 'keeps every entry when build threads write one log at once' do
+    Dir.mktmpdir do |dir|
+      loginator = double( 'loginator', log: nil )
+      real      = described_class.new( file_wrapper: FileWrapper.new( loginator: loginator, verbosinator: double( 'verbosinator', should_output?: false ) ) )
+      log       = File.join( dir, 'test', 'unit', 'test_foo.log' )
+
+      threads = Array.new( 8 ) { |index| Thread.new { real.write( log, "entry #{index}\n" ) } }
+      threads.each( &:join )
+
+      expect( File.readlines( log ).map( &:chomp ) ).to match_array( Array.new( 8 ) { |index| "entry #{index}" } )
+    end
+  end
+end

data/spec/units/config/build_root_policy_spec.rb

@@ -0,0 +1,61 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+require 'spec_helper'
+require 'tmpdir'
+require 'fileutils'
+require 'ceedling/config/build_root_policy'
+
+# The path handling audit around GH #1370: clobber empties the build root's test and release
+# trees, so a build root holding the project's own files is refused however it is spelled
+describe BuildRootPolicy do
+  around(:each) do |example|
+    Dir.mktmpdir do |dir|
+      @ws = File.realpath( dir )
+      FileUtils.mkdir_p( File.join( @ws, 'proj', 'src' ) )
+      Dir.chdir( File.join( @ws, 'proj' ) ) { example.run }
+    end
+  end
+
+  it 'accepts a build root of its own' do
+    expect(BuildRootPolicy.problem( 'build' )).to be_nil
+  end
+
+  # macOS spells /tmp/proj as /private/tmp/proj, and a project reached through any symlink
+  # has two spellings
+  it 'refuses the project directory or a directory above it, but no directory below it, spelled through a symlink', unless: Gem.win_platform? do
+    File.symlink( File.join( @ws, 'proj' ), File.join( @ws, 'link' ) )
+
+    expect(BuildRootPolicy.problem( File.join( @ws, 'link' ) )).to eq( 'is the project directory or holds it' )
+    expect(BuildRootPolicy.problem( File.join( @ws, 'link', 'src' ) )).to be_nil
+  end
+
+  it 'names each :paths and :files entry that adds to a build from within the build root' do
+    config = { paths: { source: ['src/**', 'build/gen/**', '-:build/old'] }, files: { include: ['+:build/gen/table.h'] } }
+
+    expect(BuildRootPolicy.entries_within( 'build', config )).to eq( [[:paths, :source, 'build/gen/**'], [:files, :include, '+:build/gen/table.h']] )
+    expect(BuildRootPolicy.entries_within( 'out', config )).to be_empty
+  end
+
+  it 'names the directories Ceedling and its enabled plugins create' do
+    config = {
+      project_build_root: 'build', project_build_artifacts_root: 'build/artifacts', project_build_tests_root: 'build/test',
+      project_build_release_root: 'build/release', project_build_vendor_root: 'build/vendor',
+      project_build_dependencies_cache_path: 'build/cache', project_log_path: 'build/logs', cmock_mock_path: 'mocks',
+      plugins_enabled: ['gcov', 'report_tests_pretty_stdout']
+    }
+
+    expect(BuildRootPolicy.reserved( config )).to contain_exactly(
+      'build/artifacts', 'build/test', 'build/release', 'build/vendor', 'build/cache', 'build/logs', 'mocks', 'build/gcov', 'build/report_tests_pretty_stdout'
+    )
+  end
+
+  # An empty path would name the project directory itself
+  it 'names no directory for a setting with no path' do
+    expect(BuildRootPolicy.reserved( { project_log_path: '', plugins_enabled: ['gcov'] } )).to be_empty
+  end
+end

data/spec/units/config/configurator_builder_spec.rb

@@ -80,16 +80,14 @@ describe ConfiguratorBuilder do
   class RecordingFileList
     include Enumerable
 
-    attr_reader :patterns, :excluded
+    attr_reader :patterns
 
     def initialize(found = [])
       @found    = found
       @patterns = []
-      @excluded = []
     end
 
     def include(*patterns) = @patterns.concat( patterns )
-    def exclude(*files)    = @excluded.concat( files )
     def resolve()          = self
     def include?(file)     = @found.include?( file )
     def each(&block)       = @found.each( &block )
@@ -202,6 +200,17 @@ describe ConfiguratorBuilder do
           project_release_build_target: 'build/release/app.elf', project_release_build_map: 'build/release/app.map'
         )
       end
+
+      # The path handling audit around GH #1370: an absolute output names the release itself
+      it 'places a target named by an absolute or `~` path where it names, with its map beside it' do
+        output = File.expand_path( '/elsewhere/out/app.elf' )
+        expect(@builder.set_release_target( in_hash.merge( release_build_output: output ) )).to eq(
+          project_release_build_target: output, project_release_build_map: output.ext( '.map' )
+        )
+
+        expect(@builder.set_release_target( in_hash.merge( release_build_output: '~/out/app.elf' ) )[:project_release_build_target])
+          .to eq( File.join( Dir.home, 'out/app.elf' ) )
+      end
     end
 
     describe '#set_build_thread_counts' do
@@ -329,16 +338,38 @@ describe ConfiguratorBuilder do
         expect(revisions).to eq( ['+:a.s'] )
       end
 
-      it 'collects sources, filtering out tests that overlapping paths also matched' do
-        result, = collect( ['src/a.c', 'src/test_a.c'] ) { @builder.collect_source( in_hash, ['src/test_a.c'] ) }
+      it 'collects sources from source paths and revises them by :files ↳ :source' do
+        result, = collect { @builder.collect_source( in_hash, [] ) }
         file_list, revisions = result[:collection_all_source]
 
         expect(file_list.patterns).to eq( ['src/*.c'] )
-        expect(file_list.excluded).to eq( ['src/test_a.c'] )
         expect(revisions).to eq( ['-:src/skip.c'] )
+        expect(@loginator).to_not have_received(:log)
+      end
+
+      # A test reaches the sources through overlapping paths, or a :files revision
+      it 'filters out of the revised sources any test, warning of the overlap' do
+        allow(@file_wrapper).to receive(:instantiate_file_list_literal) { |files| RecordingFileList.new( files ) }
+        result, = collect do
+          allow(@collection_utils).to receive(:revise_filelist).and_return( ['src/a.c', 'src/test_a.c'] )
+          @builder.collect_source( in_hash, ['src/test_a.c'] )
+        end
+
+        expect(result[:collection_all_source].to_a).to eq( ['src/a.c'] )
         expect(@loginator).to have_received(:log).with(/overlap/, Verbosity::COMPLAIN)
       end
 
+      it 'filters any test out of the release input, without warning again' do
+        allow(@file_wrapper).to receive(:instantiate_file_list_literal) { |files| RecordingFileList.new( files ) }
+        result, = collect do
+          allow(@collection_utils).to receive(:revise_filelist).and_return( ['src/a.c', 'test/test_a.c'] )
+          @builder.collect_release_build_input( in_hash.merge( collection_all_tests: ['test/test_a.c'] ) )
+        end
+
+        expect(result[:collection_release_build_input].to_a).to eq( ['src/a.c'] )
+        expect(@loginator).to_not have_received(:log)
+      end
+
       it 'collects headers from test, support, and include paths' do
         result, = collect { @builder.collect_headers( in_hash ) }