Let scriptrunner support an existing tempdir

Author: kpaulisse

lib/octocatalog-diff/util/scriptrunner.rb

@@ -13,18 +13,20 @@ class ScriptRunner
       # For an exception running the script
       class ScriptException < RuntimeError; end
 
-      attr_reader :script, :script_src, :logger, :stdout, :stderr, :exitcode
+      attr_reader :script, :script_src, :logger, :stdout, :stderr, :exitcode, :existing_tempdir
 
       # Create the object - the object is a configured script, which can be executed multiple
       # times with different environment varibles.
       #
       # @param opts [Hash] Options hash
       #   opts[:default_script] (Required) Path to script, relative to `scripts` directory
       #   opts[:logger] (Optional) Logger object
+      #   opts[:existing_tempdir] (Optional) An existing temporary directory (helpful when parallelizing)
       #   opts[:override_script_path] (Optional) Directory where a similarly-named script MAY exist
       def initialize(opts = {})
         @logger = opts[:logger]
         @script_src = find_script(opts.fetch(:default_script), opts[:override_script_path])
+        @existing_tempdir = opts[:existing_tempdir]
         @script = temp_script(@script_src)
         @stdout = nil
         @stderr = nil
@@ -91,14 +93,20 @@ def log(priority, message, logger = @logger)
       # @return [String] Path to tempfile containing script
       def temp_script(script)
         raise Errno::ENOENT, "Script '#{script}' not found" unless File.file?(script)
-        temp_dir = Dir.mktmpdir('ocd-scriptrunner-')
-        at_exit do
-          begin
-            FileUtils.remove_entry_secure temp_dir
-          rescue Errno::ENOENT # rubocop:disable Lint/HandleExceptions
-            # OK if the directory doesn't exist since we're trying to remove it anyway
+        temp_dir = if existing_tempdir
+          Dir.mktmpdir('ocd-scriptrunner-', existing_tempdir)
+        else
+          temp_dir_local = Dir.mktmpdir('ocd-scriptrunner-')
+          at_exit do
+            begin
+              FileUtils.remove_entry_secure temp_dir_local
+            rescue Errno::ENOENT # rubocop:disable Lint/HandleExceptions
+              # OK if the directory doesn't exist since we're trying to remove it anyway
+            end
           end
+          temp_dir_local
         end
+
         temp_file = File.join(temp_dir, File.basename(script))
         File.open(temp_file, 'w') { |f| f.write(File.read(script)) }
         FileUtils.chmod 0o755, temp_file

spec/octocatalog-diff/tests/util/scriptrunner_spec.rb

@@ -57,6 +57,43 @@
     end
   end
 
+  describe '#temp_script' do
+    context 'when running under --parallel' do
+      before(:each) do
+        @base_tempdir = Dir.mktmpdir('ocd-tempdir')
+      end
+
+      after(:each) do
+        OctocatalogDiff::Spec.clean_up_tmpdir(@base_tempdir)
+      end
+
+      it 'should create a temporary directory within the existing tempdir' do
+        opts = {
+          default_script: 'env/env.sh',
+          existing_tempdir: @base_tempdir
+        }
+        subject = described_class.new(opts)
+        script = subject.send(:temp_script, subject.script_src)
+
+        regex = Regexp.new('\\A' + Regexp.escape(@base_tempdir) + '/ocd-scriptrunner[^/]+/env.sh\\z')
+        expect(script).to match(regex)
+      end
+    end
+
+    context 'when not running under --parallel' do
+      it 'should create a new temporary directory and clean it up at_exit' do
+        opts = {
+          default_script: 'env/env.sh'
+        }
+        subject = described_class.new(opts)
+        script = subject.send(:temp_script, subject.script_src)
+
+        regex = Regexp.new('/ocd-scriptrunner[^/]+/env.sh\\z')
+        expect(script).to match(regex)
+      end
+    end
+  end
+
   describe '#run' do
     before(:each) do
       @logger, @logger_str = OctocatalogDiff::Spec.setup_logger