ceedling 1.1.10 → 1.2.0

data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb

@@ -7,12 +7,15 @@
 
 require 'spec_helper'
 require 'stringio'
+require 'include_guard_helper'
 require 'ceedling/preprocess/preprocessinator_file_assembler'
 require 'ceedling/preprocess/preprocessinator_reconstructor'
 require 'ceedling/parsing_parcels'
 require 'ceedling/encodinator'
 
 RSpec.describe PreprocessinatorFileAssembler do
+  include IncludeGuardHelper
+
 
   # Use real ParsingParcels for _filter_conditionals and collect_file_contents_fallback tests
   let(:real_parsing_parcels) { ParsingParcels.new }
@@ -25,6 +28,9 @@ RSpec.describe PreprocessinatorFileAssembler do
     @tool_executor  = double('tool_executor')
     @file_path_utils = double('file_path_utils')
     @file_wrapper   = double('file_wrapper')
+    # Whoever writes a preprocessed file creates its directory, since the path may mirror
+    # a source's own namespace below the test's flat preprocess directories.
+    allow(@file_wrapper).to receive(:mkdir)
     @loginator      = double('loginator')
     @reportinator   = double('reportinator')
 
@@ -47,9 +53,12 @@ RSpec.describe PreprocessinatorFileAssembler do
     )
   end
 
-  # Helper: stub file_wrapper.open to yield StringIO of content
+  # Helper: stub file_wrapper.open (or, for a real-mode 'r' read -- every one of
+  # which in this file reads a file this same build just produced via gcc --
+  # open_with_retry) to yield StringIO of content.
   def stub_file_open(filepath, content, mode='rb')
-    allow(@file_wrapper).to receive(:open).with(filepath, mode).and_yield(StringIO.new(content))
+    method = (mode == 'r') ? :open_with_retry : :open
+    allow(@file_wrapper).to receive(method).with(filepath, mode).and_yield(StringIO.new(content))
   end
 
 
@@ -354,6 +363,69 @@ RSpec.describe PreprocessinatorFileAssembler do
 
 
   # ===========================================================================
+  # A reconstructed header falls back to a synthetic guard whenever its original carried
+  # none to reuse. Two headers sharing a basename in one test must not land on the same
+  # guard, or whichever the compiler reads second is emptied of its declarations.
+  describe 'synthetic include guard' do
+    def assemble(path)
+      written = StringIO.new
+      allow(@file_wrapper).to receive(:open).and_yield( written )
+
+      subject.assemble_preprocessed_header_file(
+        filepath: path,
+        preprocessed_filepath: "/build/#{path}",
+        contents: [], extras: [], includes: []
+      )
+
+      written.string[/#ifndef (\S+)/, 1]
+    end
+
+    it 'distinguishes two headers sharing a basename' do
+      expect( assemble('drivers/uart/config.h') ).to_not eq( assemble('drivers/spi/config.h') )
+    end
+
+    it 'reuses the original header-s own guard when there is one to reuse' do
+      written = StringIO.new
+      allow(@file_wrapper).to receive(:open).and_yield( written )
+
+      subject.assemble_preprocessed_header_file(
+        filepath: 'drivers/uart/config.h',
+        preprocessed_filepath: '/build/drivers/uart/config.h',
+        contents: [], extras: [], includes: [], include_guard: 'ORIGINAL_GUARD_H'
+      )
+
+      expect( written.string ).to include('#ifndef ORIGINAL_GUARD_H')
+    end
+  end
+
+  # A preprocessed artifact's path mirrors its source's own namespace, so the directory may
+  # not exist yet. Whoever writes the file creates it.
+  describe 'output directory creation' do
+    it 'creates the directory before writing a preprocessed header file' do
+      allow(@file_wrapper).to receive(:open)
+
+      expect(@file_wrapper).to receive(:mkdir).with('/build/files/drivers/uart')
+
+      subject.assemble_preprocessed_header_file(
+        filepath: 'config.h',
+        preprocessed_filepath: '/build/files/drivers/uart/config.h',
+        contents: [], extras: [], includes: []
+      )
+    end
+
+    it 'creates the directory before writing a preprocessed code file' do
+      allow(@file_wrapper).to receive(:open)
+
+      expect(@file_wrapper).to receive(:mkdir).with('/build/files/drivers/spi')
+
+      subject.assemble_preprocessed_code_file(
+        filename: 'config.c',
+        preprocessed_filepath: '/build/files/drivers/spi/config.c',
+        contents: [], extras: [], includes: []
+      )
+    end
+  end
+
   describe '#assemble_preprocessed_header_file' do
   # ===========================================================================
 
@@ -372,7 +444,7 @@ RSpec.describe PreprocessinatorFileAssembler do
       output = stub_file_write(preprocessed_filepath)
 
       subject.assemble_preprocessed_header_file(
-        filename:              'module.h',
+        filepath:              'module.h',
         preprocessed_filepath: preprocessed_filepath,
         contents:              ['void foo(void);'],
         extras:                [],
@@ -389,22 +461,22 @@ RSpec.describe PreprocessinatorFileAssembler do
       output = stub_file_write(preprocessed_filepath)
 
       subject.assemble_preprocessed_header_file(
-        filename:              'module.h',
+        filepath:              'module.h',
         preprocessed_filepath: preprocessed_filepath,
         contents:              ['void foo(void);'],
         extras:                [],
         includes:              []
       )
 
-      expect(output.string).to include("#ifndef __CEEDLING_GENERATED_MODULE_H__\n")
-      expect(output.string).to include("#define __CEEDLING_GENERATED_MODULE_H__\n")
+      expect(mask_include_guard_hashes(output.string)).to include("#ifndef GEN<HASH>_MODULE_H_CEEDLING\n")
+      expect(mask_include_guard_hashes(output.string)).to include("#define GEN<HASH>_MODULE_H_CEEDLING\n")
     end
 
     it 'writes provided includes and contents between the guard lines' do
       output = stub_file_write(preprocessed_filepath)
 
       subject.assemble_preprocessed_header_file(
-        filename:              'module.h',
+        filepath:              'module.h',
         preprocessed_filepath: preprocessed_filepath,
         contents:              ['void foo(void);'],
         extras:                [],
@@ -420,7 +492,7 @@ RSpec.describe PreprocessinatorFileAssembler do
       stub_file_write(preprocessed_filepath)
 
       subject.assemble_preprocessed_header_file(
-        filename:              'module.h',
+        filepath:              'module.h',
         preprocessed_filepath: preprocessed_filepath,
         contents:              [],
         extras:                [],
@@ -435,7 +507,7 @@ RSpec.describe PreprocessinatorFileAssembler do
       content_line_with_crlf = "void foo(void) {\r\n  return;\r\n}"
 
       subject.assemble_preprocessed_header_file(
-        filename:              'module.h',
+        filepath:              'module.h',
         preprocessed_filepath: preprocessed_filepath,
         contents:              [content_line_with_crlf],
         extras:                [],
@@ -445,6 +517,35 @@ RSpec.describe PreprocessinatorFileAssembler do
       expect(output.string).to include(content_line_with_crlf)
     end
 
+    it 'writes a String extra as a single line' do
+      output = stub_file_write(preprocessed_filepath)
+
+      subject.assemble_preprocessed_header_file(
+        filepath:              'module.h',
+        preprocessed_filepath: preprocessed_filepath,
+        contents:              [],
+        extras:                ['#define FOO 1'],
+        includes:              []
+      )
+
+      expect(output.string).to include("#define FOO 1\n")
+    end
+
+    it 'writes each line of an Array extra' do
+      output = stub_file_write(preprocessed_filepath)
+
+      subject.assemble_preprocessed_header_file(
+        filepath:              'module.h',
+        preprocessed_filepath: preprocessed_filepath,
+        contents:              [],
+        extras:                [ ['#define FOO(x) \\', '  (x + 1)'] ],
+        includes:              []
+      )
+
+      expect(output.string).to include("#define FOO(x) \\\n")
+      expect(output.string).to include("  (x + 1)\n")
+    end
+
   end
 
 
@@ -507,6 +608,188 @@ RSpec.describe PreprocessinatorFileAssembler do
       expect(output.string).to include(content_line_with_crlf)
     end
 
+    it 'writes a String extra as a single line' do
+      output = stub_file_write(preprocessed_filepath)
+
+      subject.assemble_preprocessed_code_file(
+        filename:              'module.c',
+        preprocessed_filepath: preprocessed_filepath,
+        contents:              [],
+        extras:                ['TEST_SOURCE_FILE("other.c")'],
+        includes:              []
+      )
+
+      expect(output.string).to include("TEST_SOURCE_FILE(\"other.c\")\n")
+    end
+
+    it 'writes each line of an Array extra' do
+      output = stub_file_write(preprocessed_filepath)
+
+      subject.assemble_preprocessed_code_file(
+        filename:              'module.c',
+        preprocessed_filepath: preprocessed_filepath,
+        contents:              [],
+        extras:                [ ['TEST_CASE(1, 2)', 'TEST_CASE(3, 4)'] ],
+        includes:              []
+      )
+
+      expect(output.string).to include("TEST_CASE(1, 2)\n")
+      expect(output.string).to include("TEST_CASE(3, 4)\n")
+    end
+
+  end
+
+
+  # ===========================================================================
+  describe '#collect_file_contents_from_directives_only_preprocessing' do
+  # ===========================================================================
+
+    it 'extracts file content from the raw directives-only preprocessor output' do
+      source_filepath = 'test/test_widget.c'
+      allow(@file_path_utils).to receive(:form_preprocessed_file_raw_directives_only_filepath)
+        .with(source_filepath, 'test_widget')
+        .and_return('/build/directives_only/raw_test_widget.c')
+
+      file_contents = [
+        "# 1 \"#{source_filepath}\" 99999",
+        'void test_ShouldDoSomething(void) {}'
+      ].join("\n")
+      stub_file_open('/build/directives_only/raw_test_widget.c', file_contents, 'r')
+
+      result = subject.collect_file_contents_from_directives_only_preprocessing(
+        source_filepath: source_filepath, test: 'test_widget'
+      )
+
+      expect(result).to eq(['void test_ShouldDoSomething(void) {}'])
+    end
+
+  end
+
+
+  # ===========================================================================
+  describe '#collect_file_contents_from_full_expansion' do
+  # ===========================================================================
+
+    it 'extracts file content from the full-expansion preprocessor output' do
+      source_filepath = 'src/module.c'
+      allow(@file_path_utils).to receive(:form_preprocessed_file_full_expansion_filepath)
+        .with(source_filepath, 'test_module')
+        .and_return('/build/full_expansion/module.c')
+
+      file_contents = [
+        "# 1 \"#{source_filepath}\" 99999",
+        'void Module_Init(void) {}'
+      ].join("\n")
+      stub_file_open('/build/full_expansion/module.c', file_contents, 'r')
+
+      result = subject.collect_file_contents_from_full_expansion(
+        source_filepath: source_filepath, test: 'test_module'
+      )
+
+      expect(result).to eq(['void Module_Init(void) {}'])
+    end
+
+  end
+
+
+  # ===========================================================================
+  describe '#collect_macros_and_pragmas_fallback' do
+  # ===========================================================================
+
+    let(:source_filepath) { '/src/module.h' }
+
+    it 'extracts pragmas and macro definitions, excluding the include guard\'s own #define' do
+      allow(@file_wrapper).to receive(:read).with(source_filepath, 2048).and_return(
+        "#ifndef MODULE_H\n#define MODULE_H\n"
+      )
+      content = <<~C
+        #ifndef MODULE_H
+        #define MODULE_H
+        #pragma pack(1)
+        #define MAX_SIZE 10
+        void foo(void);
+        #endif
+      C
+      stub_file_open(source_filepath, content, 'rb')
+
+      result = subject.collect_macros_and_pragmas_fallback(source_filepath: source_filepath)
+
+      expect(result).to include('#pragma pack(1)')
+      expect(result).to include('#define MAX_SIZE 10')
+      expect(result).not_to include('#define MODULE_H')
+    end
+
+    it 'filters out macros inside an inactive conditional block' do
+      allow(@file_wrapper).to receive(:read).with(source_filepath, 2048).and_return('')
+      content = <<~C
+        #ifdef FEATURE_X
+        #define FEATURE_MACRO 1
+        #endif
+        #define ALWAYS_MACRO 2
+      C
+      stub_file_open(source_filepath, content, 'rb')
+
+      result = subject.collect_macros_and_pragmas_fallback(source_filepath: source_filepath, defines: [])
+
+      expect(result).not_to include('#define FEATURE_MACRO 1')
+      expect(result).to include('#define ALWAYS_MACRO 2')
+    end
+
+  end
+
+
+  # ===========================================================================
+  describe '#collect_test_file_contents' do
+  # ===========================================================================
+
+    let(:filepath) { 'test/test_widget.c' }
+
+    before do
+      allow(@file_path_utils).to receive(:form_preprocessed_file_full_expansion_filepath).and_return('/build/full_expansion/test_widget.c')
+      allow(@configurator).to receive(:tools_test_file_full_preprocessor).and_return({})
+      allow(@tool_executor).to receive(:build_command_line).and_return({})
+      allow(@tool_executor).to receive(:exec)
+
+      full_expansion = [
+        "# 1 \"#{filepath}\" 99999",
+        'void test_ShouldDoSomething(void) {}'
+      ].join("\n")
+      stub_file_open('/build/full_expansion/test_widget.c', full_expansion, 'r')
+    end
+
+    it 'extracts contents from the full expansion and test directives via the fallback text scan when fallback: true' do
+      original_content = <<~C
+        TEST_SOURCE_FILE("other.c")
+        void test_ShouldDoSomething(void) {}
+      C
+      stub_file_open(filepath, original_content, 'rb')
+
+      contents, test_directives = subject.collect_test_file_contents(
+        test: 'test_widget', filepath: filepath, directives_only_filepath: '/build/directives_only/test_widget.c',
+        fallback: true, flags: [], defines: [], include_paths: []
+      )
+
+      expect(contents).to include('void test_ShouldDoSomething(void) {}')
+      expect(test_directives).to include('TEST_SOURCE_FILE("other.c")')
+    end
+
+    it 'extracts test directives from the directives-only output when fallback: false' do
+      directives_only_content = [
+        "# 1 \"#{filepath}\" 99999",
+        'TEST_SOURCE_FILE("other.c")',
+        'void test_ShouldDoSomething(void) {}'
+      ].join("\n")
+      stub_file_open('/build/directives_only/test_widget.c', directives_only_content, 'r')
+
+      contents, test_directives = subject.collect_test_file_contents(
+        test: 'test_widget', filepath: filepath, directives_only_filepath: '/build/directives_only/test_widget.c',
+        fallback: false, flags: [], defines: [], include_paths: []
+      )
+
+      expect(contents).to include('void test_ShouldDoSomething(void) {}')
+      expect(test_directives).to include('TEST_SOURCE_FILE("other.c")')
+    end
+
   end
 
 end