ceedling 1.1.10 → 1.2.1

data/spec/units/bin/mixinator_spec.rb

@@ -98,6 +98,53 @@ describe Mixinator do
         expect(result.first.keys.first).to eq('CEEDLING_MIXIN_1')
       end
     end
+
+    it 'treats a leading zero the same as no leading zero' do
+      env = {'CEEDLING_MIXIN_01' => 'path/to/mixin.yml'}
+      result = @mixinator.fetch_env_filepaths(env)
+      expect(result).to eq([{'CEEDLING_MIXIN_01' => 'path/to/mixin.yml'}])
+    end
+
+    it 'sorts a leading-zero variable numerically alongside ordinary ones' do
+      env = {
+        'CEEDLING_MIXIN_10' => 'path/mixin10.yml',
+        'CEEDLING_MIXIN_01' => 'path/mixin01.yml',
+        'CEEDLING_MIXIN_2'  => 'path/mixin2.yml',
+      }
+      result = @mixinator.fetch_env_filepaths(env)
+      expect(result.map { |e| e.keys.first }).to eq([
+        'CEEDLING_MIXIN_01',
+        'CEEDLING_MIXIN_2',
+        'CEEDLING_MIXIN_10'
+      ])
+    end
+
+    # CEEDLING_MIXIN_1 and CEEDLING_MIXIN_01 are two distinct, simultaneously-settable
+    # env var names that both parse to the same numeric value -- a genuine tie for
+    # sort_by, which Ruby doesn't guarantee resolves the same way on every version/
+    # platform. The full original name is a second tiebreaker precisely so this case
+    # has one fixed, deterministic answer instead of depending on sort stability.
+    it 'resolves two same-numbered spellings (with and without a leading zero) in a fixed order when both are set at once' do
+      env = {
+        'CEEDLING_MIXIN_1'  => 'path/mixin1.yml',
+        'CEEDLING_MIXIN_01' => 'path/mixin01.yml',
+      }
+      result = @mixinator.fetch_env_filepaths(env)
+      expect(result.map { |e| e.keys.first }).to eq([
+        'CEEDLING_MIXIN_01',
+        'CEEDLING_MIXIN_1'
+      ])
+    end
+
+    it 'raises a clear error for a malformed mixin variable name instead of crashing' do
+      env = {'CEEDLING_MIXIN_1_OLD' => 'path/to/mixin.yml'}
+      expect { @mixinator.fetch_env_filepaths(env) }.to raise_error( /CEEDLING_MIXIN_1_OLD/ )
+    end
+
+    it 'raises a clear error for a non-numeric mixin variable suffix' do
+      env = {'CEEDLING_MIXIN_ABC' => 'path/to/mixin.yml'}
+      expect { @mixinator.fetch_env_filepaths(env) }.to raise_error( /CEEDLING_MIXIN_ABC/ )
+    end
   end
 
   # =========================================================================
@@ -212,7 +259,7 @@ describe Mixinator do
     end
 
     it 'returns pre-tagged cmdline entry when only cmdline is provided' do
-      # cmdline entries arrive as pre-tagged hashes from configinator
+      # cmdline entries arrive as pre-tagged hashes from composinator
       result = @mixinator.assemble_mixins(
         config:  [],
         env:     [],
@@ -375,7 +422,6 @@ describe Mixinator do
   # =========================================================================
   describe '#mixin' do
     let(:base_config) { {:project => {:build_root => 'build'}} }
-    let(:builtins)    { {:my_builtin => {:foo => :bar}} }
 
     it 'loads a filepath mixin via yaml_wrapper and merges it into config' do
       mixin_filepath = 'path/to/mixin.yml'
@@ -388,22 +434,21 @@ describe Mixinator do
       ).and_return(true)
 
       @mixinator.mixin(
-        builtins: builtins,
         config:   base_config,
         mixins:   [{'command line' => mixin_filepath}]
       )
     end
 
-    it 'looks up a builtin mixin by name and merges its content into config' do
-      expect(@merginator).to receive(:merge).with(
-        hash_including(mixin: {:foo => :bar})
-      ).and_return(true)
-
-      @mixinator.mixin(
-        builtins: builtins,
-        config:   base_config,
-        mixins:   [{'command line' => 'my_builtin'}]
-      )
+    it 'raises when a mixin entry resolves to neither inline YAML nor a filepath' do
+      # lookup_mixins() only ever hands back inline YAML or a real filepath for
+      # validated input -- reaching neither here means something upstream let
+      # an unresolved bare name through.
+      expect {
+        @mixinator.mixin(
+          config: base_config,
+          mixins: [{'command line' => 'unresolved_name'}]
+        )
+      }.to raise_error( /unresolved_name/ )
     end
 
     it 'logs a WARNING when a loaded mixin contains a :mixins section' do
@@ -420,7 +465,6 @@ describe Mixinator do
       )
 
       @mixinator.mixin(
-        builtins: builtins,
         config:   base_config,
         mixins:   [{'command line' => mixin_filepath}]
       )
@@ -441,7 +485,6 @@ describe Mixinator do
       end
 
       @mixinator.mixin(
-        builtins: builtins,
         config:   base_config,
         mixins:   [{'command line' => mixin_filepath}]
       )
@@ -460,7 +503,6 @@ describe Mixinator do
 
       expect {
         @mixinator.mixin(
-          builtins: builtins,
           config:   base_config,
           mixins:   [{'command line' => mixin_filepath}]
         )
@@ -472,7 +514,6 @@ describe Mixinator do
 
       expect {
         @mixinator.mixin(
-          builtins: builtins,
           config:   {},
           mixins:   [{'command line' => 'path/to/mixin.yml'}]
         )
@@ -490,7 +531,6 @@ describe Mixinator do
       expect(@loginator).to receive(:log).at_least(:twice)
 
       @mixinator.mixin(
-        builtins: builtins,
         config:   base_config,
         mixins:   [{'command line' => mixin_filepath}]
       )
@@ -511,7 +551,6 @@ describe Mixinator do
       )
 
       @mixinator.mixin(
-        builtins: builtins,
         config:   base_config,
         mixins:   [{'command line' => mixin_filepath}]
       )
@@ -530,7 +569,6 @@ describe Mixinator do
       ).and_return(true)
 
       @mixinator.mixin(
-        builtins: builtins,
         config:   base_config,
         mixins:   [{'command line (inline)' => yaml_string}]
       )
@@ -541,7 +579,6 @@ describe Mixinator do
       allow(@yaml_wrapper).to receive(:load_string).and_return({:defines => {:release => ['MY_SYM']}})
 
       @mixinator.mixin(
-        builtins: builtins,
         config:   base_config,
         mixins:   [{'command line (inline)' => yaml_string, :_input => yaml_string}]
       )
@@ -571,7 +608,6 @@ describe Mixinator do
       )
 
       @mixinator.mixin(
-        builtins: builtins,
         config:   base_config,
         mixins:   [{'command line (inline)' => yaml_string}]
       )

data/spec/units/bin/path_validator_spec.rb

@@ -0,0 +1,112 @@
+# =========================================================================
+#   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 'path_validator'
+require 'ceedling/constants'
+
+describe PathValidator do
+  before(:each) do
+    @file_wrapper = double('file_wrapper')
+    @loginator    = double('loginator').as_null_object
+
+    @path_validator = described_class.new({
+      :file_wrapper => @file_wrapper,
+      :loginator    => @loginator,
+    })
+  end
+
+  describe '#validate' do
+    it 'passes when every path exists as a filepath' do
+      allow(@file_wrapper).to receive(:exist?).and_return( true )
+
+      expect(@path_validator.validate( paths: ['a.yml', 'b.yml'], source: 'Test' )).to eq( true )
+    end
+
+    it 'fails and logs when a path is empty' do
+      expect(@loginator).to receive(:log).with( /contains an empty path/, Verbosity::ERRORS )
+
+      expect(@path_validator.validate( paths: [''], source: 'Test' )).to eq( false )
+    end
+
+    it 'fails and logs when a filepath does not exist' do
+      allow(@file_wrapper).to receive(:exist?).and_return( false )
+      expect(@loginator).to receive(:log).with( /does not exist in the filesystem/, Verbosity::ERRORS )
+
+      expect(@path_validator.validate( paths: ['missing.yml'], source: 'Test' )).to eq( false )
+    end
+
+    it 'fails and logs when a directory does not exist' do
+      allow(@file_wrapper).to receive(:directory?).and_return( false )
+      expect(@loginator).to receive(:log).with( /does not exist as a directory/, Verbosity::ERRORS )
+
+      expect(@path_validator.validate( paths: ['missing/'], source: 'Test', type: :directory )).to eq( false )
+    end
+
+    it 'checks every path rather than stopping at the first failure' do
+      allow(@file_wrapper).to receive(:exist?).and_return( false )
+      expect(@loginator).to receive(:log).twice
+
+      expect(@path_validator.validate( paths: ['a.yml', 'b.yml'], source: 'Test' )).to eq( false )
+    end
+  end
+
+  describe '#standardize_paths' do
+    it 'returns backslashes converted to forward slashes, as a new value' do
+      path = 'some\\windows\\path.yml'
+
+      result = @path_validator.standardize_paths( path )
+
+      expect(result).to eq( ['some/windows/path.yml'] )
+    end
+
+    it 'does not mutate the argument given' do
+      path = 'some\\windows\\path.yml'
+      original_object_id = path.object_id
+
+      @path_validator.standardize_paths( path )
+
+      expect(path).to eq( 'some\\windows\\path.yml' )
+      expect(path.object_id).to eq( original_object_id )
+    end
+
+    it 'returns every argument given, standardized, in the same order' do
+      a = 'one\\two'
+      b = 'three\\four'
+
+      result = @path_validator.standardize_paths( a, b )
+
+      expect(result).to eq( ['one/two', 'three/four'] )
+    end
+
+    it 'returns already-forward-slash paths unchanged' do
+      path = 'already/unix/style.yml'
+
+      result = @path_validator.standardize_paths( path )
+
+      expect(result).to eq( ['already/unix/style.yml'] )
+    end
+
+    it 'passes nil and empty arguments through unchanged, without raising' do
+      expect(@path_validator.standardize_paths( nil, '' )).to eq( [nil, ''] )
+    end
+  end
+
+  describe '#filepath?' do
+    it 'is true for a value with a file extension' do
+      expect(@path_validator.filepath?( 'clang.yml' )).to eq( true )
+    end
+
+    it 'is true for a value containing a path separator, even without an extension' do
+      expect(@path_validator.filepath?( File.join('mixins', 'clang') )).to eq( true )
+    end
+
+    it 'is false for a bare name with neither an extension nor a separator' do
+      expect(@path_validator.filepath?( 'clang' )).to eq( false )
+    end
+  end
+end

data/spec/units/bin/projectinator_spec.rb

@@ -0,0 +1,223 @@
+# =========================================================================
+#   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 'projectinator'
+require 'ceedling/constants'
+require 'ceedling/exceptions'
+
+# Covers Projectinator's namesake responsibility -- discovering and loading the
+# project file itself. Its former :mixins section handling now lives on
+# MixinResolvinator (see mixin_resolvinator_spec.rb).
+describe Projectinator do
+  before(:each) do
+    @loginator = double('loginator')
+    allow(@loginator).to receive(:lazy)
+    allow(@loginator).to receive(:log)
+
+    @file_wrapper = double('file_wrapper')
+    allow(@file_wrapper).to receive(:exist?).and_return(false)
+
+    @path_validator = double('path_validator')
+    allow(@path_validator).to receive(:standardize_paths) do |*paths|
+      paths.map {|p| (p.nil? || p.empty?) ? p : p.tr("\\", '/') }
+    end
+
+    @yaml_wrapper = double('yaml_wrapper')
+
+    @projectinator = described_class.new({
+      :file_wrapper      => @file_wrapper,
+      :path_validator    => @path_validator,
+      :yaml_wrapper      => @yaml_wrapper,
+      :loginator         => @loginator,
+    })
+  end
+
+  # =========================================================================
+  describe '#load' do
+    it 'loads from an explicit filepath argument at highest priority' do
+      # A leading `/` is already absolute on POSIX but means "root of the
+      # current drive" on Windows, so File.expand_path prepends a drive
+      # letter there -- compute the real expanded value instead of assuming
+      # the input string is left unchanged.
+      expanded = File.expand_path('/abs/custom.yml')
+      allow(@yaml_wrapper).to receive(:load).with(expanded).and_return({:project => {}})
+
+      filepath, config = @projectinator.load( filepath: '/abs/custom.yml', env: {'CEEDLING_PROJECT_FILE' => 'ignored.yml'} )
+
+      expect(filepath).to eq(expanded)
+      expect(config[:project]).to eq({})
+    end
+
+    it 'records cmdline-argument history with the original (non-expanded) path' do
+      allow(@yaml_wrapper).to receive(:load).and_return({})
+
+      _, config = @projectinator.load( filepath: 'custom.yml' )
+      # File.expand_path resolves relative to the real working directory, so
+      # only assert on the structure, not the exact absolute path.
+      entry = config[:history][:config].first
+      expect(entry[:type]).to eq(:file)
+      expect(entry[:mechanism]).to eq(:project)
+      expect(entry[:path]).to eq('custom.yml')
+    end
+
+    it 'falls back to the environment variable when no filepath argument is given' do
+      # Same platform-dependent File.expand_path behavior as the cmdline
+      # argument case above.
+      expanded = File.expand_path('/abs/env_project.yml')
+      allow(@yaml_wrapper).to receive(:load).with(expanded).and_return({:project => {}})
+
+      filepath, config = @projectinator.load( env: {'CEEDLING_PROJECT_FILE' => '/abs/env_project.yml'} )
+
+      expect(filepath).to eq(expanded)
+      expect(config[:history][:config].first[:mechanism]).to eq(:project)
+    end
+
+    it 'falls back to the default project.yml in the working directory when available' do
+      allow(@file_wrapper).to receive(:exist?).with('./project.yml').and_return(true)
+      allow(@yaml_wrapper).to receive(:load).with(File.expand_path('./project.yml')).and_return({:project => {}})
+
+      filepath, config = @projectinator.load
+
+      expect(filepath).to eq(File.expand_path('./project.yml'))
+      expect(config[:history][:config].first[:mechanism]).to eq(:project)
+    end
+
+    it 'raises when no filepath, env var, or default project.yml is available' do
+      expect {
+        @projectinator.load
+      }.to raise_error( /No project filepath provided/ )
+    end
+
+    # #1250 -- ceedling.yml as an alternative default project filename, self-documenting
+    # in a way the generic project.yml isn't. Default discovery only (no --project/-p,
+    # no CEEDLING_PROJECT_FILE) -- an explicit filepath or env var always wins outright,
+    # as already covered above.
+    it 'falls back to ceedling.yml in the working directory when project.yml is absent' do
+      allow(@file_wrapper).to receive(:exist?).with('./project.yml').and_return(false)
+      allow(@file_wrapper).to receive(:exist?).with('./ceedling.yml').and_return(true)
+      allow(@yaml_wrapper).to receive(:load).with(File.expand_path('./ceedling.yml')).and_return({:project => {}})
+
+      filepath, config = @projectinator.load
+
+      expect(filepath).to eq(File.expand_path('./ceedling.yml'))
+      expect(config[:history][:config].first[:mechanism]).to eq(:project)
+    end
+
+    it 'raises a CeedlingException naming both files when project.yml and ceedling.yml both exist, under default discovery' do
+      allow(@file_wrapper).to receive(:exist?).with('./project.yml').and_return(true)
+      allow(@file_wrapper).to receive(:exist?).with('./ceedling.yml').and_return(true)
+
+      expect {
+        @projectinator.load
+      }.to raise_error( CeedlingException, a_string_matching(/project\.yml/).and(a_string_matching(/ceedling\.yml/)) )
+    end
+
+    it 'does not raise the ambiguity error when only ceedling.yml exists' do
+      allow(@file_wrapper).to receive(:exist?).with('./project.yml').and_return(false)
+      allow(@file_wrapper).to receive(:exist?).with('./ceedling.yml').and_return(true)
+      allow(@yaml_wrapper).to receive(:load).and_return({:project => {}})
+
+      expect { @projectinator.load }.to_not raise_error
+    end
+
+    it 'ignores ceedling.yml (no ambiguity error) when an explicit filepath argument is given, even if both default files exist' do
+      allow(@file_wrapper).to receive(:exist?).and_return(true)
+      allow(@yaml_wrapper).to receive(:load).and_return({:project => {}})
+
+      expect { @projectinator.load( filepath: 'custom.yml' ) }.to_not raise_error
+    end
+
+    it 'treats a blank YAML file as an empty config hash rather than nil' do
+      allow(@yaml_wrapper).to receive(:load).and_return(nil)
+
+      _, config = @projectinator.load( filepath: 'blank.yml' )
+
+      expect(config).to eq({:history => config[:history]})
+    end
+
+    it 'wraps a not-found YAML load failure with a clearer message' do
+      allow(@yaml_wrapper).to receive(:load).and_raise(
+        YamlLoadException.new( reason: :not_found, source: 'missing.yml', original_error: nil, message: 'original message' )
+      )
+
+      expect {
+        @projectinator.load( filepath: 'missing.yml' )
+      }.to raise_error( YamlLoadException, /Could not find project filepath/ )
+    end
+
+    it 'wraps a non-not-found YAML load failure, preserving the original message' do
+      allow(@yaml_wrapper).to receive(:load).and_raise(
+        YamlLoadException.new( reason: :syntax, source: 'broken.yml', original_error: nil, message: 'line 3: bad indentation' )
+      )
+
+      expect {
+        @projectinator.load( filepath: 'broken.yml' )
+      }.to raise_error( YamlLoadException, /line 3: bad indentation/ )
+    end
+
+    it 'logs a loading message when not silent' do
+      allow(@yaml_wrapper).to receive(:load).and_return({})
+
+      expect(@loginator).to receive(:lazy)
+
+      @projectinator.load( filepath: 'project.yml', silent: false )
+    end
+
+    it 'does not log when silent' do
+      allow(@yaml_wrapper).to receive(:load).and_return({})
+
+      expect(@loginator).to_not receive(:lazy)
+
+      @projectinator.load( filepath: 'project.yml', silent: true )
+    end
+  end
+
+  # =========================================================================
+  describe '#config_available?' do
+    it 'returns true when a project file can be loaded' do
+      allow(@yaml_wrapper).to receive(:load).and_return({})
+
+      expect(@projectinator.config_available?( filepath: 'project.yml' )).to eq(true)
+    end
+
+    it 'returns false when no project file can be found' do
+      expect(@projectinator.config_available?).to eq(false)
+    end
+
+    it 'returns false when the found project file fails to load' do
+      allow(@yaml_wrapper).to receive(:load).and_raise(
+        YamlLoadException.new( reason: :syntax, source: 'broken.yml', original_error: nil, message: 'bad yaml' )
+      )
+
+      expect(@projectinator.config_available?( filepath: 'broken.yml' )).to eq(false)
+    end
+  end
+
+  # =========================================================================
+  # Every :extension entry may be a single extension or a list
+  describe '#lookup_yaml_extensions' do
+    it 'returns the default extension when no :extension section is present' do
+      expect(@projectinator.lookup_yaml_extensions( config: {} )).to eq(['.yml'])
+    end
+
+    it 'returns the default extension when :extension is present but :yaml is not' do
+      config = {:extension => {:header => '.h'}}
+      expect(@projectinator.lookup_yaml_extensions( config: config )).to eq(['.yml'])
+    end
+
+    it 'returns a configured single :extension ↳ :yaml value as a list' do
+      config = {:extension => {:yaml => '.yaml'}}
+      expect(@projectinator.lookup_yaml_extensions( config: config )).to eq(['.yaml'])
+    end
+
+    it 'returns a configured list of :extension ↳ :yaml values' do
+      config = {:extension => {:yaml => ['.yml', '.yaml']}}
+      expect(@projectinator.lookup_yaml_extensions( config: config )).to eq(['.yml', '.yaml'])
+    end
+  end
+end

data/spec/units/bin/rake_patches_spec.rb

@@ -0,0 +1,52 @@
+# =========================================================================
+#   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 'rake_patches'
+
+# Rake::ColonTaskNameFileTaskPatch only ever matters on Windows (see the comment
+# block in rake_patches.rb for why), but Errno::EINVAL can be stubbed from any
+# platform -- no real Windows machine is needed to exercise the rescue itself.
+describe Rake::ColonTaskNameFileTaskPatch do
+  around(:each) do |example|
+    # Rake.application is process-global; save/restore it so this spec's throwaway
+    # application doesn't leak into any other spec that happens to run in the
+    # same process.
+    original_application = Rake.application
+    Rake.application = Rake::Application.new
+
+    example.run
+
+    Rake.application = original_application
+  end
+
+  def file_task(name)
+    Rake::FileTask.define_task(name)
+  end
+
+  describe '#needed?' do
+    it 'treats Errno::EINVAL the same as Rake would treat a missing file' do
+      allow(File).to receive(:mtime).and_raise( Errno::EINVAL )
+
+      expect(file_task('release:compile:foo.c').needed?).to eq( true )
+    end
+
+    it 'leaves ordinary Errno::ENOENT handling (already rescued by Rake) unaffected' do
+      allow(File).to receive(:mtime).and_raise( Errno::ENOENT )
+
+      expect(file_task('release:compile:foo.c').needed?).to eq( true )
+    end
+  end
+
+  describe '#timestamp' do
+    it 'treats Errno::EINVAL the same as Rake would treat a missing file' do
+      allow(File).to receive(:mtime).and_raise( Errno::EINVAL )
+
+      expect(file_task('release:compile:foo.c').timestamp).to eq( Rake::LATE )
+    end
+  end
+end

data/spec/units/bin/recursive_merger_spec.rb

@@ -159,6 +159,28 @@ describe RecursiveMerger do
     end
   end
 
+  # =========================================================================
+  describe '.merge! — single value merged into list (:tools :name :arguments exception)' do
+    it 'appends a single mixin :arguments value instead of prepending it' do
+      # A mixin author writing `:arguments: -O0` (a scalar) instead of the
+      # expected `:arguments: [-O0]` must still get the left-to-right
+      # override guarantee -- appended after config's -O2, not before it.
+      config = {tools: {test_compiler: {arguments: ['-O2']}}}
+      mixin  = {tools: {test_compiler: {arguments: '-O0'}}}
+      expect(merge(config, mixin)).to eq(
+        {tools: {test_compiler: {arguments: ['-O2', '-O0']}}}
+      )
+    end
+
+    it 'still prepends a single mixin value at a non-:arguments list key' do
+      config = {tools: {test_compiler: {other: ['a']}}}
+      mixin  = {tools: {test_compiler: {other: 'b'}}}
+      expect(merge(config, mixin)).to eq(
+        {tools: {test_compiler: {other: ['b', 'a']}}}
+      )
+    end
+  end
+
   # =========================================================================
   describe '.merge! — single mixin value merged into config list' do
     it 'prepends mixin single string value into config list' do