ceedling 1.2.1 → 1.2.2

data/spec/integration/path_intake_scenarios_spec.rb

@@ -0,0 +1,101 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+# How configuration takes in the paths a project file names, before any build: where each
+# lands, and which a build can't use safely. Each example names the gap it probes (the path
+# handling audit around GH #1370). Where the right behavior is a policy still to be chosen,
+# the example states the one it assumes.
+
+require 'spec_helper'
+require 'configurator_integration_helper'
+
+describe 'Path intake (integration)' do
+  include ConfiguratorIntegrationHelpers
+
+  def yaml(project: {}, paths: {}, extra: '')
+    project_lines = { build_root: 'build' }.merge( project ).map { |key, value| "  :#{key}: #{value.inspect}" }.join( "\n" )
+    path_lines = { test: ['test/**'], source: ['src/**'], include: ['src/**'] }.merge( paths ).map { |key, value| "  :#{key}: #{value.inspect}" }.join( "\n" )
+    return ":project:\n#{project_lines}\n  :use_test_preprocessor: :none\n:paths:\n#{path_lines}\n#{extra}"
+  end
+
+  # Clobber empties the build root's test and release trees, so a build root holding the
+  # whole project is refused. An empty build root is left to the unit specs: it names the
+  # filesystem root, where a configuration that got past it would create directories.
+  { '.' => 'the project directory', '..' => 'a directory above the project' }.each do |root, what|
+    it "G16: refuses a build root that is #{what}" do
+      in_temp_project( minimal_project_files ) do
+        expect { configure( yaml( project: { build_root: root } ) ) }.to raise_error( CeedlingException )
+        expect(logged.join( "\n" )).to match( /build_root.*'#{Regexp.escape( root )}'/ )
+      end
+    end
+  end
+
+  it 'G16: accepts a build root beside the project\'s own directories' do
+    in_temp_project( minimal_project_files ) do
+      expect { configure( yaml( project: { build_root: 'out/build' } ) ) }.to_not raise_error
+    end
+  end
+
+  it 'G16: accepts a build root holding sources, warning of the entry' do
+    in_temp_project( minimal_project_files ) do
+      expect { configure( yaml( project: { build_root: 'src' } ) ) }.to_not raise_error
+      expect(logged.join( "\n" )).to match( %r{:paths ↳ :source => 'src/\*\*' lies in the build root 'src'} )
+    end
+  end
+
+  # A `-:` entry names what a build leaves out, and nothing there to leave out is no error.
+  # Below the build root, where nothing exists before a first build, it is not worth a word.
+  it 'G24: accepts a `-:` path below the build root that names nothing, silently' do
+    in_temp_project( minimal_project_files ) do
+      configure( yaml( paths: { include: ['src/**', '-:build/gen'] } ) )
+
+      expect(logged.join( "\n" )).to_not match( %r{build/gen} )
+    end
+  end
+
+  it 'G24: accepts a `-:` path elsewhere that names nothing, warning of it' do
+    in_temp_project( minimal_project_files ) do
+      configure( yaml( paths: { include: ['src/**', '-:src/gone'] } ) )
+
+      expect(logged.join( "\n" )).to match( %r{'-:src/gone' leaves out nothing} )
+    end
+  end
+
+  it "G18: includes a Unity helper written with backslashes in every mock by its own filename" do
+    files = minimal_project_files.merge( 'test/support/helper.h' => "\n" )
+    in_temp_project( files ) do
+      config = configure( yaml( extra: ":cmock:\n  :unity_helper_path: 'test\\support\\helper.h'\n" ) )[:configurator]
+
+      expect(config.cmock_includes).to include( 'helper.h' )
+    end
+  end
+
+  # Assumes an absolute release output names the release itself
+  it 'G19: places a release named by an absolute :output where it names' do
+    in_temp_project( minimal_project_files ) do |dir|
+      output = File.join( File.realpath( dir ), 'out', 'app.elf' )
+      config = configure( yaml( project: { release_build: true }, extra: ":release_build:\n  :output: #{output}\n" ) )[:configurator]
+
+      expect(config.project_release_build_target).to eq( output )
+    end
+  end
+
+  # Assumes `~` means the home directory, as it does in a shell
+  it 'G21: reads a `~` path as below the home directory' do
+    in_temp_project( minimal_project_files.merge( 'home/inc/extra.h' => "\n" ) ) do |dir|
+      home = ENV['HOME']
+      begin
+        ENV['HOME'] = File.join( File.realpath( dir ), 'home' )
+        config = configure( yaml( paths: { include: ['src/**', '~/inc'] } ) )[:configurator]
+
+        expect(config.collection_all_headers.map { |header| File.basename( header ) }).to include( 'extra.h' )
+      ensure
+        ENV['HOME'] = home
+      end
+    end
+  end
+end

data/spec/integration/path_scenarios_spec.rb

@@ -0,0 +1,322 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+# Path handling across project layouts and the spellings a project file may use for one
+# place: through configuration, collection, build-path mapping, and the lookups that invert
+# it. Every build file must land inside the build root, distinct inputs must stay distinct,
+# and every spelling of one layout must place files alike.
+#
+# Each example names the gap it probes (GH #1370 and the path handling audit around it).
+
+require 'spec_helper'
+require 'path_scenario_harness'
+
+describe 'Path scenarios (integration)' do
+  include PathScenarioHarness
+
+  TEST_C = "#include \"unity.h\"\nvoid setUp(void) {}\nvoid tearDown(void) {}\nvoid test_it(void) {}\n"
+
+  def c(name)
+    "int #{name}(void) { return 0; }\n"
+  end
+
+  def h(name)
+    "int #{name}(void);\n"
+  end
+
+  # --- Baseline -------------------------------------------------------------------------
+
+  it 'baseline: mirrors same-named files below one plain root, inside the build root' do
+    files = {
+      'app/src/a/util.c' => c( 'a' ), 'app/src/b/util.c' => c( 'b' ),
+      'app/src/a/util.h' => h( 'a' ), 'app/src/b/util.h' => h( 'b' ),
+      'app/test/test_u.c' => TEST_C
+    }
+    in_workspace( files ) do |ws, app|
+      scene = scenario( scenario_yaml( ws: ws, app: app, paths: { test: ['test/**'], source: ['src/**'], include: ['src/**'] } ) )
+      placed = placements( scene )
+
+      placed.each_value { |paths| expect_inside_build( paths ) }
+      expect_distinct( placed[:test_objects], 'test objects' )
+      expect_distinct( placed[:release_objects], 'release objects' )
+      expect_distinct( placed[:preprocessed], 'preprocessed headers' )
+    end
+  end
+
+  # --- G1 (#1370): a `..` root beside a header outside the project ------------------------
+
+  # The report's vendor SDK sat at its drive's root, far above the project, so its headers'
+  # paths climb past the `..` root. A sibling one level up is truly below `..` and mirrors.
+  context 'G1 (#1370): a `..` root beside an include path far outside the project' do
+    def files
+      {
+        'app/src/main.c' => c( 'main' ), 'app/src/main.h' => h( 'main' ),
+        'app/test/test_m.c' => TEST_C,
+        'vendor/inc/cmsis.h' => h( 'cmsis' )
+      }
+    end
+
+    [
+      ['an absolute vendor path far outside', '%{far}/inc'],
+      ['a sibling vendor path', '../vendor/inc']
+    ].each do |label, vendor|
+      it "places a mock of the vendor header inside the build root, with #{label}" do
+        in_workspace( files, far: { 'inc/sdk.h' => h( 'sdk' ) } ) do |ws, app|
+          scene = scenario( scenario_yaml( ws: ws, app: app, paths: { test: ['test/**'], source: ['src/**'], include: ['../**', vendor] } ) )
+          placed = placements( scene )
+
+          expect_inside_build( placed[:mocks] )
+          expect_inside_build( placed[:preprocessed] )
+          expect_inside_build( placed[:test_objects] )
+        end
+      end
+    end
+  end
+
+  # --- G2: equivalent spellings of one root ------------------------------------------------
+
+  context 'G2: one layout under each spelling of its roots' do
+    def files
+      {
+        'app/src/a/util.c' => c( 'a' ), 'app/src/b/util.c' => c( 'b' ),
+        'app/src/a/util.h' => h( 'a' ), 'app/src/b/util.h' => h( 'b' ),
+        'app/test/test_u.c' => TEST_C
+      }
+    end
+
+    def placed_with(spelling, ws, app)
+      spell = PathScenarioHarness::ROOT_SPELLINGS[spelling]
+      roots = ->(root) { [spell.call( root, ws: ws, app: app )] }
+      scene = scenario( scenario_yaml( ws: ws, app: app, paths: { test: roots.( 'test/**' ), source: roots.( 'src/**' ), include: roots.( 'src/**' ) } ) )
+      return [scene, relative_placements( scene )]
+    end
+
+    (PathScenarioHarness::ROOT_SPELLINGS.keys - [:plain]).each do |spelling|
+      it "places every build file as the plain spelling does, with #{spelling} roots" do
+        in_workspace( files, symlink: spelling == :symlink ) do |ws, app|
+          _, plain = placed_with( :plain, ws, app )
+          scene, spelled = placed_with( spelling, ws, app )
+
+          expect_one_spelling_each( scene[:configurator] )
+          expect(spelled).to eq( plain )
+        end
+      end
+    end
+  end
+
+  # --- G3 and G13: exclusions ---------------------------------------------------------------
+
+  context 'G3 and G13: a `-:` exclusion' do
+    def files
+      {
+        'app/src/sub/x.c' => c( 'x1' ), 'app/src/exp/sub/x.c' => c( 'x2' ), 'app/src/exp/deep/y.c' => c( 'y' ),
+        'app/src/main.h' => h( 'main' ), 'app/test/test_m.c' => TEST_C
+      }
+    end
+
+    it 'G13: excludes the whole subtree it names' do
+      in_workspace( files ) do |ws, app|
+        scene = scenario( scenario_yaml( ws: ws, app: app, paths: { test: ['test/**'], source: ['+:src/**', '-:src/exp'], include: ['src/**'] } ) )
+
+        expect(scene[:configurator].collection_all_source).to match_array( %w[src/sub/x.c] )
+      end
+    end
+
+    # A file the exclusion fails to drop (G13) must not mirror below the exclusion itself
+    it 'G3: is never a root that kept files mirror below' do
+      in_workspace( files ) do |ws, app|
+        scene = scenario( scenario_yaml( ws: ws, app: app, paths: { test: ['test/**'], source: ['+:src/**', '-:src/exp'], include: ['src/**'] } ) )
+        placed = placements( scene )
+
+        expect_distinct( placed[:release_objects], 'release objects' )
+      end
+    end
+  end
+
+  # --- G4: header-to-source correlation ---------------------------------------------------
+
+  context 'G4: a header found beside its source by convention' do
+    def files
+      {
+        'app/include/drv/x.h' => h( 'x' ), 'app/src/drv/x.c' => c( 'x' ),
+        'app/components/foo/include/foo.h' => h( 'foo' ), 'app/components/foo/src/foo.c' => c( 'foo' ),
+        'app/test/test_x.c' => TEST_C
+      }
+    end
+
+    {
+      'a plain include root'     => ['include/**'],
+      'a `./` include root'      => ['./include/**'],
+      'an absolute include root' => ['%{app}/include/**']
+    }.each do |label, include|
+      it "finds the source of a header below #{label}" do
+        in_workspace( files ) do |ws, app|
+          scene = scenario( scenario_yaml( ws: ws, app: app, paths: { test: ['test/**'], source: ['src/**'], include: include } ) )
+
+          expect(scene[:finder].find_build_input_file( filepath: 'include/drv/x.h', complain: :ignore, context: :test )).to eq( 'src/drv/x.c' )
+        end
+      end
+    end
+
+    it 'finds the source of a header below a glob-middle include root' do
+      in_workspace( files ) do |ws, app|
+        scene = scenario( scenario_yaml( ws: ws, app: app, paths: { test: ['test/**'], source: ['components/*/src'], include: ['components/*/include'] } ) )
+
+        expect(scene[:finder].find_build_input_file( filepath: 'components/foo/include/foo.h', complain: :ignore, context: :test )).to eq( 'components/foo/src/foo.c' )
+      end
+    end
+  end
+
+  # --- G5 and G6: collisions --------------------------------------------------------------
+
+  context 'G5: the same relative path below two roots' do
+    it 'gives each source its own release object' do
+      files = { 'app/src/foo.c' => c( 'a' ), 'app/lib/foo.c' => c( 'b' ), 'app/src/foo.h' => h( 'a' ), 'app/test/test_f.c' => TEST_C }
+      in_workspace( files ) do |ws, app|
+        scene = scenario( scenario_yaml( ws: ws, app: app, paths: { test: ['test/**'], source: ['src/**', 'lib/**'], include: ['src/**'] } ) )
+
+        expect_distinct( placements( scene )[:release_objects], 'release objects' )
+      end
+    end
+  end
+
+  context 'G6: nested roots' do
+    it 'gives a file in the inner root and one in the outer root their own objects' do
+      files = { 'app/src/util.c' => c( 'a' ), 'app/src/legacy/util.c' => c( 'b' ), 'app/src/util.h' => h( 'a' ), 'app/test/test_u.c' => TEST_C }
+      in_workspace( files ) do |ws, app|
+        scene = scenario( scenario_yaml( ws: ws, app: app, paths: { test: ['test/**'], source: ['src/**', 'src/legacy/**'], include: ['src/**'] } ) )
+        placed = placements( scene )
+
+        expect_distinct( placed[:test_objects], 'test objects' )
+        expect_distinct( placed[:release_objects], 'release objects' )
+      end
+    end
+  end
+
+  # --- G8: outside every root -------------------------------------------------------------
+
+  context 'G8: sources reached only through :files' do
+    it 'gives same-named files outside every root their own objects' do
+      files = { 'app/src/main.c' => c( 'main' ), 'app/src/main.h' => h( 'main' ), 'app/a/util.c' => c( 'a' ), 'app/b/util.c' => c( 'b' ), 'app/test/test_m.c' => TEST_C }
+      in_workspace( files ) do |ws, app|
+        scene = scenario( scenario_yaml( ws: ws, app: app, paths: { test: ['test/**'], source: ['src/**'], include: ['src/**'] }, files: { source: ['a/util.c', 'b/util.c'] } ) )
+
+        expect_distinct( placements( scene )[:release_objects], 'release objects' )
+      end
+    end
+  end
+
+  # --- Sources outside the project --------------------------------------------------------
+
+  context 'sources and headers in a sibling directory' do
+    it 'places their build files inside the build root, each its own' do
+      files = {
+        'shared/src/a/util.c' => c( 'a' ), 'shared/src/b/util.c' => c( 'b' ),
+        'shared/src/a/util.h' => h( 'a' ), 'shared/src/b/util.h' => h( 'b' ),
+        'app/test/test_u.c' => TEST_C
+      }
+      in_workspace( files ) do |ws, app|
+        scene = scenario( scenario_yaml( ws: ws, app: app, paths: { test: ['test/**'], source: ['../shared/src/**'], include: ['../shared/src/**'] } ) )
+        placed = placements( scene )
+
+        placed.each_value { |paths| expect_inside_build( paths ) }
+        expect_distinct( placed[:release_objects], 'release objects' )
+      end
+    end
+  end
+
+  # --- G15: a root above the build root --------------------------------------------------
+
+  context 'G15: a root that holds the build root' do
+    it 'collects nothing from an existing build directory' do
+      files = {
+        'app/src/main.c' => c( 'main' ), 'app/src/main.h' => h( 'main' ), 'app/test/test_m.c' => TEST_C,
+        'app/build/test/mocks/test/test_m/mock_main.h' => h( 'mock' ), 'app/build/test/runners/test/test_m/test_m_runner.c' => c( 'r' )
+      }
+      in_workspace( files ) do |ws, app|
+        scene = scenario( scenario_yaml( ws: ws, app: app, paths: { test: ['test/**'], source: ['src/**'], include: ['../**'] } ) )
+
+        expect_collections_outside_build( scene[:configurator] )
+      end
+    end
+
+    # A release compiles every collected source, so generated mocks and runners broke it
+    it 'collects nothing from an existing build directory through a `:files` glob' do
+      files = {
+        'app/src/main.c' => c( 'main' ), 'app/src/main.h' => h( 'main' ), 'app/test/test_m.c' => TEST_C,
+        'app/build/test/mocks/test/test_m/mock_main.c' => c( 'mock' ), 'app/build/vendor/unity/src/unity.c' => c( 'unity' )
+      }
+      in_workspace( files ) do |ws, app|
+        yaml  = scenario_yaml( ws: ws, app: app, paths: { test: ['test/**'], source: ['src/**'], include: ['src/**'] }, files: { source: ['+:**/*.c'] } )
+        scene = scenario( yaml )
+
+        expect_collections_outside_build( scene[:configurator] )
+        expect(scene[:configurator].collection_release_build_input.to_a.grep( %r{\Abuild/} )).to be_empty
+        expect(scene[:configurator].collection_existing_test_build_input.to_a.grep( %r{\Abuild/test/} )).to be_empty
+      end
+    end
+
+    # Generated code may sit in the build root, beside the directories Ceedling creates there
+    it 'collects generated code an entry names in the build root, but nothing Ceedling created there' do
+      files = {
+        'app/src/main.c' => c( 'main' ), 'app/src/main.h' => h( 'main' ), 'app/test/test_m.c' => TEST_C,
+        'app/build/gen/table.c' => c( 'table' ), 'app/build/gen/table.h' => h( 'table' ),
+        'app/build/test/mocks/test/test_m/mock_main.c' => c( 'mock' ), 'app/build/test/mocks/test/test_m/mock_main.h' => h( 'mock' )
+      }
+      in_workspace( files ) do |ws, app|
+        paths = { test: ['test/**'], source: ['src/**', 'build/**'], include: ['src/**', 'build/gen'] }
+        yaml  = scenario_yaml( ws: ws, app: app, paths: paths, files: { source: ['+:build/**/*.c'] } )
+        scene = scenario( yaml )
+
+        expect(scene[:configurator].collection_all_source.to_a).to contain_exactly( 'src/main.c', 'build/gen/table.c' )
+        expect(scene[:configurator].collection_all_headers.to_a).to include( 'build/gen/table.h' )
+        expect(scene[:configurator].collection_all_headers.to_a.grep( %r{\Abuild/test/} )).to be_empty
+      end
+    end
+  end
+
+  # --- Test files kept out of the sources and the release --------------------------------
+
+  context 'test files among the sources' do
+    # A release compiles every source it collects, and a test file holds a second main()
+    it 'collects no test file into the sources or the release through a `:files` glob' do
+      files = { 'app/src/main.c' => c( 'main' ), 'app/src/main.h' => h( 'main' ), 'app/test/test_m.c' => TEST_C }
+      in_workspace( files ) do |ws, app|
+        yaml  = scenario_yaml( ws: ws, app: app, paths: { test: ['test/**'], source: ['src/**'], include: ['src/**'] }, files: { source: ['+:**/*.c'] } )
+        scene = scenario( yaml )
+
+        expect(scene[:configurator].collection_all_tests.to_a).to eq( ['test/test_m.c'] )
+        expect(scene[:configurator].collection_all_source.to_a).to eq( ['src/main.c'] )
+        expect(scene[:configurator].collection_release_build_input.to_a).to eq( ['src/main.c'] )
+      end
+    end
+
+    # A test root beside the sources reaches the release through :paths as well
+    it 'collects no test file into the release from a source root that holds the tests' do
+      files = { 'app/src/main.c' => c( 'main' ), 'app/src/main.h' => h( 'main' ), 'app/src/test/test_m.c' => TEST_C }
+      in_workspace( files ) do |ws, app|
+        scene = scenario( scenario_yaml( ws: ws, app: app, paths: { test: ['src/test/**'], source: ['src/**'], include: ['src/**'] } ) )
+
+        expect(scene[:configurator].collection_release_build_input.to_a).to eq( ['src/main.c'] )
+      end
+    end
+
+  end
+
+  # --- G12: the working directory reached through a symlink -------------------------------
+
+  context 'G12: absolute roots spelled through a symlink to the project' do
+    it 'collects each file once' do
+      files = { 'app/src/main.c' => c( 'main' ), 'app/src/main.h' => h( 'main' ), 'app/test/test_m.c' => TEST_C }
+      in_workspace( files, symlink: true ) do |ws, app|
+        scene = scenario( scenario_yaml( ws: ws, app: app, paths: { test: ['test/**'], source: ['src/**', '%{ws}/link/src/**'], include: ['src/**'] } ) )
+
+        expect_one_spelling_each( scene[:configurator] )
+      end
+    end
+  end
+end

data/spec/integration/quote_include_isolator_spec.rb

@@ -24,7 +24,7 @@ require 'spec_integration_helper'
 require 'fileutils'
 require 'tmpdir'
 require 'open3'
-require 'ceedling/file_wrapper'
+require 'ceedling/filesystem/file_wrapper'
 require 'ceedling/quote_include_isolator'
 require 'ceedling/constants'
 

data/spec/integration/report_build_warnings_log_spec.rb

@@ -16,7 +16,7 @@ require 'open3'
 require 'json'
 require 'ceedling/constants'
 require 'ceedling/plugins/plugin'
-require 'ceedling/file_wrapper'
+require 'ceedling/filesystem/file_wrapper'
 
 $LOAD_PATH.unshift( File.expand_path( '../../plugins/report_build_warnings_log/lib', __dir__ ) )
 

data/spec/integration/report_tests_log_factory_spec.rb

@@ -16,7 +16,7 @@ require 'spec_helper'
 require 'json'
 require 'tmpdir'
 require 'rexml/document'
-require 'ceedling/file_wrapper'
+require 'ceedling/filesystem/file_wrapper'
 require 'ceedling/config/config_walkinator'
 
 $: << File.expand_path('../../../plugins/report_tests_log_factory/lib', __FILE__)

data/spec/integration/test_executable_manifest_spec.rb

@@ -14,7 +14,7 @@ require 'spec_integration_helper'
 require 'open3'
 require 'tmpdir'
 require 'ceedling/constants'
-require 'ceedling/file_wrapper'
+require 'ceedling/filesystem/file_wrapper'
 require 'ceedling/generators/generator'
 require 'ceedling/system_wrapper'
 require 'fileutils'

data/spec/integration/test_includes_extractinator_spec.rb

@@ -140,7 +140,8 @@ describe 'Test file #include extraction (integration)' do
 
         extract_in_mode( tree, 'test_reader.c' ) do |harness, testable|
           expect(harness.mocks( 'test/test_reader.c' )).to eq( ['mock_widget.h'] )
-          expect(testable.mock_search_paths).to eq( ['build/mocks/test_reader/drivers'] )
+          # The macro's #include resolves as `drivers/mock_widget.h`, reached from the mock root
+          expect(testable.mock_search_paths).to eq( ['build/mocks/test_reader/drivers', 'build/mocks/test_reader'] )
         end
       end