Use temporary file not stringio so logs can be collected over forks

Author: kpaulisse

lib/octocatalog-diff/util/parallel.rb

@@ -102,13 +102,16 @@ def self.run_tasks_parallel(result, task_array, logger)
 
         task_array.each_with_index do |task, index|
           # simplecov doesn't see this because it's forked
+          # Kernel.exit! avoids at_exit calls possibly set up by rspec tests
           # :nocov:
           this_pid = fork do
-            logger.reopen if logger.respond_to?(:reopen)
-            task_result = execute_task(task, logger)
-            File.open(File.join(ipc_tempdir, "#{Process.pid}.yaml"), 'w') { |f| f.write Marshal.dump(task_result) }
-            logger.close
-            exit 0
+            begin
+              task_result = execute_task(task, logger)
+              File.open(File.join(ipc_tempdir, "#{Process.pid}.yaml"), 'w') { |f| f.write Marshal.dump(task_result) }
+              Kernel.exit! 0
+            rescue
+              Kernel.exit! 255
+            end
           end
           # :nocov:
 

spec/octocatalog-diff/integration/catalog_only_spec.rb

@@ -42,6 +42,9 @@
     expect(logs).to match(/Compiling catalog for rspec-node.github.net/)
     expect(logs).to match(/Initialized OctocatalogDiff::Catalog::Noop for from-catalog/)
     expect(logs).to match(/Initialized OctocatalogDiff::Catalog::Computed for to-catalog/)
+    expect(logs).to match(/Catalog for test-branch will be built with OctocatalogDiff::Catalog::Computed/)
+    expect(logs).to match(/Success git checkout .+git-repo:test-branch/)
+    expect(logs).to match(/Success build_catalog for test-branch/)
   end
 
   it 'should produce a valid catalog' do

spec/octocatalog-diff/tests/spec_helper.rb

@@ -2,7 +2,6 @@
 require 'logger'
 require 'rspec'
 require 'rspec/retry'
-require 'stringio'
 
 # Enable SimpleCov coverage testing?
 if ENV['COVERAGE']
@@ -33,6 +32,29 @@
 
 module OctocatalogDiff
   class Spec
+    # Set up a logger that is usuable across parent and child forks.
+    class CustomLogger
+      attr_accessor :logger
+
+      def initialize
+        @log_tempdir = Dir.mktmpdir
+        at_exit { FileUtils.remove_entry_secure @log_tempdir if File.directory?(@log_tempdir) }
+
+        @logger = Logger.new File.join(@log_tempdir, 'customlogger.out')
+        @logger.level = Logger::DEBUG
+      end
+
+      def string
+        @content ||= File.read(File.join(@log_tempdir, 'customlogger.out'))
+      end
+    end
+
+    # Create a logger object so that its result can be inspected
+    def self.setup_logger
+      logger_obj = OctocatalogDiff::Spec::CustomLogger.new
+      [logger_obj.logger, logger_obj]
+    end
+
     # Wrapper around puppet binstub
     PUPPET_BINARY = File.expand_path('../../../script/puppet', File.dirname(__FILE__)).freeze
     raise "Puppet binary (#{PUPPET_BINARY}) is missing" unless File.file?(PUPPET_BINARY)
@@ -205,14 +227,6 @@ def self.clean_up_tmpdir(*dir_in)
       end
     end
 
-    # Create a logger object so that its result can be inspected
-    def self.setup_logger
-      strio = StringIO.new
-      logger = Logger.new strio
-      logger.level = Logger::DEBUG
-      [logger, strio]
-    end
-
     # To help test a diff against an answer without considering the file and line locations,
     # remove the file and line locations. This takes the JSON result from catalog-diff and returns
     # a cleaned-up array of diffs.