ceedling 1.2.0 → 1.2.2

data/spec/units/config/configurator_paths_validator_spec.rb

@@ -0,0 +1,292 @@
+# =========================================================================
+#   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 'config_yaml_helper'
+require 'ceedling/config/configurator_paths_validator'
+require 'ceedling/config/config_walkinator'
+require 'ceedling/reportinator'
+
+# Unit coverage for ConfiguratorPathsValidator through a doubled file layer. What these
+# validations make of a real project tree is proven in
+# spec/integration/configurator_validation_spec.rb.
+describe ConfiguratorPathsValidator do
+  include ConfigYamlHelper
+
+  before(:each) do
+    @file_wrapper = double('file_wrapper')
+    @loginator    = double('loginator', log: nil)
+
+    @validator = described_class.new(
+      {
+        config_walkinator: ConfigWalkinator.new,
+        file_wrapper:      @file_wrapper,
+        loginator:         @loginator,
+        reportinator:      Reportinator.new
+      }
+    )
+  end
+
+  def existing(*paths)
+    allow(@file_wrapper).to receive(:exist?) { |path| paths.include?( path ) }
+  end
+
+  def directories(*paths)
+    allow(@file_wrapper).to receive(:directory?) { |path| paths.include?( path ) }
+  end
+
+  describe '#validate_path_list' do
+    let(:config) { config_from_yaml( ":paths:\n  :test:\n    - +:test/**\n    - -:test/ignore\n    - '**/generated'\n" ) }
+
+    it 'checks each path stripped of its aggregation decorator and glob' do
+      existing('test', 'test/ignore')
+      expect(@validator.validate_path_list( config, :paths, :test )).to be true
+    end
+
+    it 'skips a path that begins with a glob' do
+      existing('test', 'test/ignore')
+      @validator.validate_path_list( config, :paths, :test )
+      expect(@file_wrapper).to_not have_received(:exist?).with('')
+    end
+
+    it 'logs each path that does not exist' do
+      existing()
+      expect(@validator.validate_path_list( config, :paths, :test )).to be false
+      expect(@loginator).to have_received(:log).with("Config path :paths ↳ :test => 'test' does not exist in the filesystem.", Verbosity::ERRORS)
+    end
+
+    # The path handling audit around GH #1370: a `-:` entry may name nothing to leave out
+    it 'leaves a `-:` path to the entries validation' do
+      existing('test')
+      expect(@validator.validate_path_list( config, :paths, :test )).to be true
+    end
+
+    it 'fails a missing entry' do
+      expect(@validator.validate_path_list( config, :paths, :source )).to be false
+    end
+  end
+
+  # An entry naming no path, or wrapping its path in quotes, is rejected before any
+  # filesystem check. Both usually come from quoting only the path after a +: or -:
+  # decoration, so each rejection carries a hint about quoting.
+  shared_examples 'an entry that names no usable path' do |walk|
+    {
+      'a bare subtractive decoration' => "    - '-:'\n",
+      'a bare additive decoration'    => "    - '+:'\n",
+      'an empty string'               => "    - ''\n",
+      'whitespace alone'              => "    - '   '\n",
+      'a YAML null'                   => "    -\n",
+    }.each_pair do |label, yaml|
+      it "rejects #{label} as naming no path, with a quoting hint" do
+        expect(validate( yaml )).to be false
+        expect(@loginator).to have_received(:log).with(/#{Regexp.escape(walk)} => '.*' names no path/, Verbosity::ERRORS)
+        expect(@loginator).to have_received(:log).with(/Quote the whole entry/, Verbosity::ERRORS)
+      end
+    end
+
+    # YAML reads an unquoted decoration with nothing after it as a one-key mapping
+    it 'rejects an entry YAML read as something other than a path, with a quoting hint' do
+      expect(validate( "    - -:\n" )).to be false
+      expect(@loginator).to have_received(:log).with(/#{Regexp.escape(walk)} => '.*' is not a path \(YAML read it as a Hash\)/, Verbosity::ERRORS)
+      expect(@loginator).to have_received(:log).with(/Quote the whole entry/, Verbosity::ERRORS)
+    end
+
+    it 'rejects a path wrapped in quotes after its decoration, with a quoting hint' do
+      expect(validate( "    - '-:\"src/a.c\"'\n" )).to be false
+      expect(@loginator).to have_received(:log).with(/#{Regexp.escape(walk)} => '-:"src\/a.c"' wraps its path in quotes/, Verbosity::ERRORS)
+      expect(@loginator).to have_received(:log).with(/Quote the whole entry/, Verbosity::ERRORS)
+    end
+  end
+
+  describe '#validate_paths_entries' do
+    def validate(yaml_list)
+      @validator.validate_paths_entries( config_from_yaml( ":paths:\n  :source:\n#{yaml_list}" ), :source )
+    end
+
+    it 'accepts a glob that yields directories' do
+      existing; directories('src', 'src/a')
+      allow(@file_wrapper).to receive(:directory_listing).with('src/**/**').and_return(['src', 'src/a', 'src/a/x.c'])
+
+      expect(validate( "    - src/**\n" )).to be true
+    end
+
+    it 'warns about and skips a path naming a file' do
+      existing('src/main.c'); directories
+
+      expect(validate( "    - src/main.c\n" )).to be true
+      expect(@loginator).to have_received(:log).with(/'src\/main.c' is a filepath and will be ignored/, Verbosity::COMPLAIN)
+    end
+
+    it 'accepts a subdirectory glob of a directory that has no subdirectories' do
+      existing; directories
+      allow(@file_wrapper).to receive(:directory_listing).and_return([])
+
+      expect(validate( "    - src/*\n" )).to be true
+    end
+
+    it 'logs a path that yields no directories' do
+      existing; directories
+      allow(@file_wrapper).to receive(:directory_listing).and_return([])
+
+      expect(validate( "    - +:src/missing\n" )).to be false
+      expect(@loginator).to have_received(:log).with(/'src\/missing' yielded no directories/, Verbosity::ERRORS)
+    end
+
+    # The path handling audit around GH #1370: a `-:` entry names what a build leaves out
+    it 'accepts a `-:` path that names nothing, warning of it' do
+      existing; directories
+      allow(@file_wrapper).to receive(:directory_listing).and_return([])
+
+      expect(validate( "    - -:src/missing\n" )).to be true
+      expect(@loginator).to have_received(:log).with(/'-:src\/missing' leaves out nothing; no directory matches it/, Verbosity::COMPLAIN)
+    end
+
+    it 'warns of a `-:` subdirectories glob whose directory does not exist' do
+      existing; directories
+      allow(@file_wrapper).to receive(:directory_listing).and_return([])
+
+      expect(validate( "    - -:src/typo/**\n" )).to be true
+      expect(@loginator).to have_received(:log).with(/'-:src\/typo\/\*\*' leaves out nothing; no directory matches it/, Verbosity::COMPLAIN)
+    end
+
+    it 'warns of a `-:` glob that matches nothing below a directory that exists' do
+      existing( 'src' ); directories( 'src' )
+      allow(@file_wrapper).to receive(:directory_listing).and_return([])
+
+      expect(validate( "    - -:src/nomatch*\n" )).to be true
+      expect(@loginator).to have_received(:log).with(/'-:src\/nomatch\*' leaves out nothing/, Verbosity::COMPLAIN)
+    end
+
+    it 'accepts a `-:` subdirectories glob of an existing directory without a word' do
+      existing( 'src/legacy' ); directories( 'src/legacy' )
+      allow(@file_wrapper).to receive(:directory_listing).and_return([])
+
+      expect(validate( "    - -:src/legacy/**\n" )).to be true
+      expect(@loginator).to_not have_received(:log)
+    end
+
+    it 'accepts a `-:` path below the build root that names nothing, without a word' do
+      existing; directories
+      allow(@file_wrapper).to receive(:directory_listing).and_return([])
+
+      config = config_from_yaml( ":project:\n  :build_root: build\n:paths:\n  :source:\n    - -:build/gen\n" )
+      expect(@validator.validate_paths_entries( config, :source )).to be true
+      expect(@loginator).to_not have_received(:log)
+    end
+
+    it 'escapes literal brackets before globbing' do
+      existing; directories('src/[legacy]')
+      allow(@file_wrapper).to receive(:directory_listing).with('src/\[legacy\]').and_return(['src/[legacy]'])
+
+      expect(validate( "    - 'src/[legacy]'\n" )).to be true
+    end
+
+    it 'fails a missing entry' do
+      expect(@validator.validate_paths_entries( { paths: {} }, :source )).to be false
+    end
+
+    it_behaves_like 'an entry that names no usable path', ':paths ↳ :source'
+  end
+
+  describe '#validate_files_entries' do
+    def validate(yaml_list)
+      @validator.validate_files_entries( config_from_yaml( ":files:\n  :source:\n#{yaml_list}" ), :source )
+    end
+
+    it 'accepts a glob that yields files' do
+      existing; directories
+      allow(@file_wrapper).to receive(:instantiate_file_list).with('src/*.c').and_return(['src/a.c'])
+
+      expect(validate( "    - +:src/*.c\n" )).to be true
+    end
+
+    it 'warns about and skips a path naming a directory' do
+      existing('src'); directories('src')
+
+      expect(validate( "    - src\n" )).to be true
+      expect(@loginator).to have_received(:log).with(/'src' is a directory path and will be ignored/, Verbosity::COMPLAIN)
+    end
+
+    it 'logs a glob that yields no files' do
+      existing; directories
+      allow(@file_wrapper).to receive(:instantiate_file_list).and_return([])
+
+      expect(validate( "    - src/*.x\n" )).to be false
+      expect(@loginator).to have_received(:log).with(/'src\/\*.x' yielded no files/, Verbosity::ERRORS)
+    end
+
+    it 'accepts a `-:` glob that names no files, warning of it' do
+      existing; directories
+      allow(@file_wrapper).to receive(:instantiate_file_list).and_return([])
+
+      expect(validate( "    - -:src/*.x\n" )).to be true
+      expect(@loginator).to have_received(:log).with(/'-:src\/\*.x' leaves out nothing; no file matches it/, Verbosity::COMPLAIN)
+    end
+
+    it 'escapes literal brackets before globbing' do
+      existing; directories
+      allow(@file_wrapper).to receive(:instantiate_file_list).with('src/\[legacy\]/*.c').and_return(['src/[legacy]/a.c'])
+
+      expect(validate( "    - 'src/[legacy]/*.c'\n" )).to be true
+    end
+
+    it 'fails a missing entry' do
+      expect(@validator.validate_files_entries( { files: {} }, :source )).to be false
+    end
+
+    it_behaves_like 'an entry that names no usable path', ':files ↳ :source'
+  end
+
+  # The path handling audit around GH #1370: clobber empties the build root's test and
+  # release trees
+  describe '#validate_build_root' do
+    def validate(build_root, paths: "  :source:\n    - src/**\n", files: '')
+      yaml = ":project:\n  :build_root: '#{build_root}'\n:paths:\n#{paths}"
+      yaml += ":files:\n#{files}" unless files.empty?
+      @validator.validate_build_root( config_from_yaml( yaml ) )
+    end
+
+    it 'accepts a build root of its own' do
+      expect(validate( 'build' )).to be true
+    end
+
+    {
+      ''      => 'names no directory',
+      '.'     => 'is the project directory or holds it',
+      '..'    => 'is the project directory or holds it',
+      '/'     => 'is the project directory or holds it'
+    }.each do |root, problem|
+      it "refuses a build root of '#{root}', which #{problem}" do
+        expect(validate( root )).to be false
+        expect(@loginator).to have_received(:log).with( ":project ↳ :build_root => '#{root}' #{problem}. Give the build its own directory, such as 'build'.", Verbosity::ERRORS )
+      end
+    end
+
+    it 'accepts a build root holding :paths and :files entries that add to a build, warning of each' do
+      expect(validate( 'gen', paths: "  :source:\n    - src/**\n    - gen/**\n", files: "  :source:\n    - gen/out/a.c\n" )).to be true
+      expect(@loginator).to have_received(:log).with( ":paths ↳ :source => 'gen/**' lies in the build root 'gen'. Ceedling leaves out the directories it creates there.", Verbosity::COMPLAIN )
+      expect(@loginator).to have_received(:log).with( ":files ↳ :source => 'gen/out/a.c' lies in the build root 'gen'. Ceedling leaves out the directories it creates there.", Verbosity::COMPLAIN )
+    end
+
+    it 'accepts a build root holding only what `-:` entries name' do
+      expect(validate( 'build', paths: "  :source:\n    - src/**\n    - -:build/gen\n" )).to be true
+    end
+  end
+
+  describe '#validate_filepath_simple' do
+    it 'accepts an existing path' do
+      existing('helper.h')
+      expect(@validator.validate_filepath_simple( 'helper.h', :cmock, :unity_helper_path )).to be true
+    end
+
+    it 'logs a missing path with the configuration walk it came from' do
+      existing
+      expect(@validator.validate_filepath_simple( 'helper.h', :cmock, :unity_helper_path )).to be false
+      expect(@loginator).to have_received(:log).with("Config path 'helper.h' associated with :cmock ↳ :unity_helper_path does not exist in the filesystem.", Verbosity::ERRORS)
+    end
+  end
+end

data/spec/units/config/configurator_setup_spec.rb

@@ -20,6 +20,7 @@ describe ConfiguratorSetup do
   before(:each) do
     @configurator_builder   = double('ConfiguratorBuilder')
     @configurator_validator = double('ConfiguratorValidator')
+    @paths_validator        = double('ConfiguratorPathsValidator')
     @loginator              = double('Loginator')
     @reportinator           = Reportinator.new
     @file_wrapper           = double('FileWrapper')
@@ -30,6 +31,7 @@ describe ConfiguratorSetup do
       {
         configurator_builder:   @configurator_builder,
         configurator_validator: @configurator_validator,
+        configurator_paths_validator: @paths_validator,
         loginator:              @loginator,
         reportinator:           @reportinator,
         file_wrapper:           @file_wrapper,
@@ -177,136 +179,96 @@ describe ConfiguratorSetup do
     end
   end
 
-  # Issue #1292: a vendor destination (build/vendor/unity/src, etc.) occasionally turns
-  # up as the wrong file/directory type, crashing the copy that populates it. These
-  # examples cover the two fixes: unconditional copying (never skipped just because the
-  # destination looks already populated -- an errant edit there must be overwritten, not
-  # left standing) and self-healing a wrong-typed destination before that copy runs.
-  context "#heal_vendor_path" do
-    it "does nothing when neither the destination nor the marker file exist yet" do
-      allow(@file_wrapper).to receive(:exist?).and_return(false)
-
-      @setup.heal_vendor_path('/build/vendor/unity/src', 'unity.c')
-
-      expect(@file_wrapper).to_not receive(:rm_rf)
-    end
-
-    it "does nothing when the destination is a directory and the marker is a plain file inside it" do
-      allow(@file_wrapper).to receive(:exist?).with('/build/vendor/unity/src').and_return(true)
-      allow(@file_wrapper).to receive(:directory?).with('/build/vendor/unity/src').and_return(true)
-      allow(@file_wrapper).to receive(:exist?).with('/build/vendor/unity/src/unity.c').and_return(true)
-      allow(@file_wrapper).to receive(:directory?).with('/build/vendor/unity/src/unity.c').and_return(false)
-
-      @setup.heal_vendor_path('/build/vendor/unity/src', 'unity.c')
-
-      expect(@file_wrapper).to_not receive(:rm_rf)
-    end
-
-    it "removes and logs a NOTICE when the destination itself is the wrong type (a file, not a directory)" do
-      allow(@file_wrapper).to receive(:exist?).with('/build/vendor/unity/src').and_return(true)
-      allow(@file_wrapper).to receive(:directory?).with('/build/vendor/unity/src').and_return(false)
-      expect(@file_wrapper).to receive(:rm_rf).with('/build/vendor/unity/src')
-      expect(@loginator).to receive(:log)
-        .with(a_string_including('/build/vendor/unity/src'), Verbosity::COMPLAIN, LogLabels::NOTICE)
-
-      @setup.heal_vendor_path('/build/vendor/unity/src', 'unity.c')
-    end
-
-    it "removes and logs a NOTICE when the marker file inside an otherwise-fine destination is the wrong type (Issue #1292's own reported shape: unity.c itself became a directory)" do
-      allow(@file_wrapper).to receive(:exist?).with('/build/vendor/unity/src').and_return(true)
-      allow(@file_wrapper).to receive(:directory?).with('/build/vendor/unity/src').and_return(true)
-      allow(@file_wrapper).to receive(:exist?).with('/build/vendor/unity/src/unity.c').and_return(true)
-      allow(@file_wrapper).to receive(:directory?).with('/build/vendor/unity/src/unity.c').and_return(true)
-      expect(@file_wrapper).to receive(:rm_rf).with('/build/vendor/unity/src')
-      expect(@loginator).to receive(:log)
-        .with(a_string_including('/build/vendor/unity/src'), Verbosity::COMPLAIN, LogLabels::NOTICE)
-
-      @setup.heal_vendor_path('/build/vendor/unity/src', 'unity.c')
-    end
-  end
-
+  # Only a build populates build/vendor, so a command that only reads the project, such as
+  # files:test or dumpconfig, leaves a concurrent build's files alone (GH #1361)
   context "#vendor_frameworks_and_support_files" do
     def flattened_config
       {
-        unity_vendor_path:                  '/gem/vendor/unity',
+        unity_vendor_path:                  '/gem/vendor',
         project_build_vendor_unity_path:    '/build/vendor/unity/src',
-        cmock_vendor_path:                  '/gem/vendor/cmock',
+        cmock_vendor_path:                  '/gem/vendor',
         project_build_vendor_cmock_path:    '/build/vendor/cmock/src',
-        cexception_vendor_path:             '/gem/vendor/c_exception',
+        cexception_vendor_path:             '/gem/vendor',
         project_build_vendor_cexception_path: '/build/vendor/c_exception/lib',
+        project_build_vendor_ceedling_path: '/build/vendor/ceedling',
+        project_build_tests_root:           '/build/test',
         project_use_mocks:                  true,
         project_use_exceptions:             true,
-        project_use_backtrace:              false,
-        project_use_partials:               false,
+        project_use_backtrace:              :gdb,
+        project_use_partials:               true,
       }
     end
 
     before(:each) do
       allow(@file_wrapper).to receive(:exist?).and_return(false)
       allow(@file_wrapper).to receive(:rm_rf)
-      allow(@file_wrapper).to receive(:cp_r_with_retry)
+      allow(@file_wrapper).to receive(:mkdir)
+      allow(@file_wrapper).to receive(:sync_tree)
+      allow(@file_wrapper).to receive(:sync_file)
     end
 
-    it "copies the gdb backtrace script and the Partials header when those features are in use" do
-      allow(@file_wrapper).to receive(:mkdir)
-      allow(@file_wrapper).to receive(:cp_r)
-      config = flattened_config.merge(
-        project_use_backtrace: :gdb, project_build_tests_root: '/build/test',
-        project_use_partials: true, project_build_vendor_ceedling_path: '/build/vendor/ceedling'
-      )
+    def vendor(config = flattened_config, test_build: false, release_build: false)
+      @setup.vendor_frameworks_and_support_files( '/gem/lib', config, test_build: test_build, release_build: release_build )
+    end
 
-      @setup.vendor_frameworks_and_support_files('/gem/lib', config)
+    def synced_trees
+      synced = []
+      allow(@file_wrapper).to receive(:sync_tree) { |source, destination| synced << [source, destination] }
+      yield
+      return synced
+    end
 
+    it "brings Unity, CMock, CException, the gdb backtrace script and the Partials header up to date for a test build" do
+      synced = synced_trees { vendor( test_build: true ) }
+
+      expect(synced).to eq( [
+        ['/gem/vendor/unity/src', '/build/vendor/unity/src'],
+        ['/gem/vendor/cmock/src', '/build/vendor/cmock/src'],
+        ['/gem/vendor/c_exception/lib', '/build/vendor/c_exception/lib']
+      ] )
       expect(@file_wrapper).to have_received(:mkdir).with('/build/test')
-      expect(@file_wrapper).to have_received(:cp_r).with(File.join('/gem/lib', BACKTRACE_GDB_SCRIPT_FILE), '/build/test')
-      expect(@file_wrapper).to have_received(:cp_r).with('/gem/lib/ceedling.h', '/build/vendor/ceedling')
+      expect(@file_wrapper).to have_received(:sync_file).with(File.join('/gem/lib', BACKTRACE_GDB_SCRIPT_FILE), '/build/test')
+      expect(@file_wrapper).to have_received(:sync_file).with('/gem/lib/ceedling.h', '/build/vendor/ceedling')
     end
 
-    it "always copies Unity, CMock, and CException, regardless of whether the destination looks already populated" do
-      # A prior run's destination "looking populated and uncorrupted" is exactly the
-      # state a skip-check would trust -- simulate it directly (dest is a real
-      # directory, its marker file is a real file, nothing corrupted) to prove there
-      # is no such skip.
-      allow(@file_wrapper).to receive(:exist?).and_return(true)
-      allow(@file_wrapper).to receive(:directory?) do |path|
-        !path.end_with?('.c') # marker files (unity.c, cmock.c, CException.c) are plain files; their parent dirs are directories
-      end
+    it "leaves out CMock, CException, the backtrace script and the Partials header when a test build doesn't use them" do
+      config = flattened_config.merge( project_use_mocks: false, project_use_exceptions: false, project_use_backtrace: :simple, project_use_partials: false )
 
-      @setup.vendor_frameworks_and_support_files('/gem/lib', flattened_config)
+      synced = synced_trees { vendor( config, test_build: true ) }
 
-      expect(@file_wrapper).to have_received(:cp_r_with_retry)
-        .with(a_string_including('/gem/vendor/unity'), '/build/vendor/unity/src')
-      expect(@file_wrapper).to have_received(:cp_r_with_retry)
-        .with(a_string_including('/gem/vendor/cmock'), '/build/vendor/cmock/src')
-      expect(@file_wrapper).to have_received(:cp_r_with_retry)
-        .with(a_string_including('/gem/vendor/c_exception'), '/build/vendor/c_exception/lib')
+      expect(synced).to eq( [['/gem/vendor/unity/src', '/build/vendor/unity/src']] )
+      expect(@file_wrapper).to_not have_received(:sync_file)
     end
 
-    it "skips CMock and CException copying when the project doesn't use them" do
-      config = flattened_config.merge(project_use_mocks: false, project_use_exceptions: false)
+    it "brings only CException up to date for a release build" do
+      synced = synced_trees { vendor( release_build: true ) }
+
+      expect(synced).to eq( [['/gem/vendor/c_exception/lib', '/build/vendor/c_exception/lib']] )
+      expect(@file_wrapper).to_not have_received(:sync_file)
+    end
 
-      @setup.vendor_frameworks_and_support_files('/gem/lib', config)
+    it "copies nothing for a release build without exceptions" do
+      vendor( flattened_config.merge( project_use_exceptions: false ), release_build: true )
 
-      expect(@file_wrapper).to have_received(:cp_r_with_retry)
-        .with(a_string_including('/gem/vendor/unity'), '/build/vendor/unity/src')
-      expect(@file_wrapper).to_not have_received(:cp_r_with_retry)
-        .with(a_string_including('/gem/vendor/cmock'), anything)
-      expect(@file_wrapper).to_not have_received(:cp_r_with_retry)
-        .with(a_string_including('/gem/vendor/c_exception'), anything)
+      expect(@file_wrapper).to_not have_received(:sync_tree)
+      expect(@file_wrapper).to_not have_received(:sync_file)
     end
 
-    it "heals a corrupted (wrong-typed) vendor destination before copying" do
-      allow(@file_wrapper).to receive(:exist?).with('/build/vendor/unity/src').and_return(true)
-      allow(@file_wrapper).to receive(:directory?).with('/build/vendor/unity/src').and_return(false)
-      allow(@loginator).to receive(:log)
+    it "copies each framework once when a command builds both tests and a release" do
+      synced = synced_trees { vendor( test_build: true, release_build: true ) }
+
+      expect(synced.map( &:last )).to eq( ['/build/vendor/unity/src', '/build/vendor/cmock/src', '/build/vendor/c_exception/lib'] )
+    end
 
-      @setup.vendor_frameworks_and_support_files('/gem/lib', flattened_config)
+    it "touches nothing beneath build/vendor for a command that builds nothing" do
+      vendor
 
-      expect(@file_wrapper).to have_received(:rm_rf).with('/build/vendor/unity/src')
+      expect(@file_wrapper).to_not have_received(:sync_tree)
+      expect(@file_wrapper).to_not have_received(:sync_file)
+      expect(@file_wrapper).to_not have_received(:rm_rf)
     end
   end
 
-  # The validations below log each problem they find and report overall validity
   context "configuration validation" do
     before(:each) do
       allow(@loginator).to receive(:log)
@@ -352,19 +314,19 @@ describe ConfiguratorSetup do
       end
 
       it "checks helper paths, plugin load paths, and every :paths and :files entry" do
-        allow(@configurator_validator).to receive_messages(
+        allow(@paths_validator).to receive_messages(
           validate_filepath_simple: true, validate_path_list: true, validate_paths_entries: true, validate_files_entries: true
         )
 
         expect(@setup.validate_paths( config )).to be true
-        expect(@configurator_validator).to have_received(:validate_filepath_simple).with('helper.h', :cmock, :unity_helper_path)
-        expect(@configurator_validator).to have_received(:validate_filepath_simple).with('plugins', :plugins, :load_paths)
-        expect(@configurator_validator).to have_received(:validate_paths_entries).with(config, :source)
-        expect(@configurator_validator).to have_received(:validate_files_entries).with(config, :support)
+        expect(@paths_validator).to have_received(:validate_filepath_simple).with('helper.h', :cmock, :unity_helper_path)
+        expect(@paths_validator).to have_received(:validate_filepath_simple).with('plugins', :plugins, :load_paths)
+        expect(@paths_validator).to have_received(:validate_paths_entries).with(config, :source)
+        expect(@paths_validator).to have_received(:validate_files_entries).with(config, :support)
       end
 
       it "fails when any check fails" do
-        allow(@configurator_validator).to receive_messages(
+        allow(@paths_validator).to receive_messages(
           validate_filepath_simple: true, validate_path_list: true, validate_paths_entries: true, validate_files_entries: false
         )
 
@@ -733,7 +695,7 @@ describe ConfiguratorSetup do
   context "#build_project_collections" do
     it "merges every path and file collection" do
       collections = [
-        :expand_all_path_globs, :collect_vendor_paths, :collect_source_and_include_paths, :collect_source_include_vendor_paths,
+        :expand_all_path_globs, :collect_mirror_roots, :collect_vendor_paths, :collect_source_and_include_paths, :collect_source_include_vendor_paths,
         :collect_test_support_source_include_paths, :collect_test_support_source_include_vendor_paths, :collect_assembly,
         :collect_headers, :collect_release_build_input, :collect_existing_test_build_input,
         :collect_release_artifact_extra_link_objects, :collect_test_fixture_extra_link_objects, :collect_vendor_framework_sources

data/spec/units/config/configurator_spec.rb

@@ -606,20 +606,42 @@ describe Configurator do
       expect( @configurator.get_cmock_config[:plugins] ).to eq( ['ignore', :ignore, 'expect_any_args'] )
     end
 
-    it "normalizes plugins, helper paths, includes, and the mock prefix define when mocks are on" do
+    it "normalizes plugins and the mock prefix define when mocks are on" do
       config = cmock_config(true)
 
       @configurator.populate_cmock_config( config )
 
       expect( @configurator.get_cmock_config ).to include(
-        plugins:           [:ignore, :expect_any_args],
-        unity_helper_path: ['support/unity_helper.h'],
-        includes:          ['unity_helper.h'],
-        defines:           ['CMOCK_MOCK_PREFIX=mock_']
+        plugins: [:ignore, :expect_any_args],
+        defines: ['CMOCK_MOCK_PREFIX=mock_']
       )
     end
   end
 
+  # The path handling audit around GH #1370: a helper's filename is taken from its path
+  # as standardized, so this runs after path standardizing
+  describe "#populate_cmock_helpers" do
+    def helper_config(use_mocks, helper)
+      { project: { use_mocks: use_mocks }, cmock: { unity_helper_path: helper, includes: ['unity_helper.h'] } }
+    end
+
+    it "lists a single helper path and includes each helper in every mock, once, by its filename" do
+      config = helper_config( true, 'support/unity_helper.h' )
+
+      @configurator.populate_cmock_helpers( config )
+
+      expect( config[:cmock] ).to include( unity_helper_path: ['support/unity_helper.h'], includes: ['unity_helper.h'] )
+    end
+
+    it "leaves the helpers alone when mocks are off" do
+      config = helper_config( false, 'support/unity_helper.h' )
+
+      @configurator.populate_cmock_helpers( config )
+
+      expect( config[:cmock][:unity_helper_path] ).to eq( 'support/unity_helper.h' )
+    end
+  end
+
   describe "#populate_exceptions_config" do
     it "enables exceptions when CMock uses its CException plugin" do
       config = { project: { use_exceptions: false }, cmock: { plugins: [:cexception] }, cexception: {} }
@@ -902,13 +924,22 @@ describe Configurator do
       flattened = { flat_a: 1, flat_environment: [ { cc: 'gcc' } ] }
       expect( @configurator_setup ).to have_received(:build_project_config).with( 'lib', 'logs', flattened ).ordered
       expect( @configurator_setup ).to have_received(:build_directory_structure).with( flattened ).ordered
-      expect( @configurator_setup ).to have_received(:vendor_frameworks_and_support_files).with( 'lib', flattened ).ordered
+      expect( @configurator_setup ).to have_received(:vendor_frameworks_and_support_files).with( 'lib', flattened, test_build: false, release_build: false ).ordered
       expect( @configurator_setup ).to have_received(:build_project_collections).with( flattened ).ordered
       expect( @configurator_setup ).to have_received(:build_constants_and_accessors).with( flattened, anything ).ordered
       expect( @configurator_setup ).to have_received(:build_constants_and_accessors).with( { environment: [ { cc: 'gcc' } ] }, anything ).ordered
       expect( @configurator.project_config_hash ).to eq( flattened )
     end
 
+    it "copies the vendor files the requested build tasks need" do
+      @configurator.test_build_tasks = true
+      @configurator.release_build_tasks = true
+
+      @configurator.build( 'lib', 'logs', { a: 1 } )
+
+      expect( @configurator_setup ).to have_received(:vendor_frameworks_and_support_files).with( 'lib', { flat_a: 1 }, test_build: true, release_build: true )
+    end
+
     it "redefines an existing element and its constant" do
       @configurator.build( 'lib', 'logs', { a: 1 } )