Change git extract code to use scriptrunner

Author: Kevin Paulisse

lib/octocatalog-diff/catalog-util/git.rb

@@ -4,9 +4,9 @@
 require 'open3'
 require 'rugged'
 require 'shellwords'
-require 'tempfile'
 
 require_relative '../errors'
+require_relative '../util/scriptrunner'
 
 module OctocatalogDiff
   module CatalogUtil
@@ -34,31 +34,23 @@ def self.check_out_git_archive(options = {})
         end
 
         # Create and execute checkout script
-        script = create_git_checkout_script(branch, path)
-        logger.debug("Begin git archive #{dir}:#{branch} -> #{path}")
-        output, status = Open3.capture2e(script, chdir: dir)
-        unless status.exitstatus.zero?
-          raise OctocatalogDiff::Errors::GitCheckoutError, "Git archive #{branch}->#{path} failed: #{output}"
-        end
-        logger.debug("Success git archive #{dir}:#{branch}")
-      end
+        sr_opts = {
+          logger: logger,
+          default_script: 'git-extract/git-extract.sh'
+        }
+        script = OctocatalogDiff::Util::ScriptRunner.new(sr_opts)
 
-      # Create the temporary file used to interact with the git command line.
-      # To get the options working correctly (-o pipefail in particular) this needs to run under
-      # bash. It's just creating a script, rather than figuring out all the shell escapes...
-      # @param branch [String] Branch name
-      # @param path [String] Target directory
-      # @return [String] Name of script
-      def self.create_git_checkout_script(branch, path)
-        tmp_script = Tempfile.new(['git-checkout', '.sh'])
-        tmp_script.write "#!/bin/bash\n"
-        tmp_script.write "set -euf -o pipefail\n"
-        tmp_script.write "git archive --format=tar #{Shellwords.escape(branch)} | \\\n"
-        tmp_script.write "  ( cd #{Shellwords.escape(path)} && tar -xf - )\n"
-        tmp_script.close
-        FileUtils.chmod 0o755, tmp_script.path
-        at_exit { FileUtils.rm_f tmp_script.path if File.exist?(tmp_script.path) }
-        tmp_script.path
+        sr_run_opts = {
+          :working_dir => dir,
+          'OCD_GIT_EXTRACT_BRANCH' => branch,
+          'OCD_GIT_EXTRACT_TARGET' => path
+        }
+        begin
+          script.run(sr_run_opts)
+          logger.debug("Success git archive #{dir}:#{branch}")
+        rescue OctocatalogDiff::Util::ScriptRunner::ScriptException
+          raise OctocatalogDiff::Errors::GitCheckoutError, "Git archive #{branch}->#{path} failed: #{script.output}"
+        end
       end
 
       # Determine the SHA of origin/master (or any other branch really) in the git repo

lib/octocatalog-diff/util/scriptrunner.rb

@@ -59,7 +59,19 @@ def run(opts = {})
         @stderr.split(/\n/).select { |line| line =~ /\S/ }.each { |line| @logger.debug "STDERR: #{line}" }
         @logger.debug "Exit status: #{@exitcode}"
         return @stdout if @exitcode.zero?
-        raise ScriptException, [@stdout.split(/\n/), @stderr.split(/\n/)].compact.join("\n")
+        raise ScriptException, output
+      end
+
+      # All output from the latest execution of the command.
+      # @return [String] Combined output of STDOUT and STDERR
+      def output
+        return if @exitcode.nil?
+        [
+          'STDOUT:',
+          @stdout.split(/\n/).map { |line| "  #{line}" },
+          'STDERR:',
+          @stderr.split(/\n/).map { |line| "  #{line}" }
+        ].flatten.compact.join("\n")
       end
 
       private

scripts/git-extract/git-extract.sh

@@ -2,3 +2,16 @@
 
 # This script is called from lib/octocatalog-diff/catalog-util/git.rb and is used to
 # archive and extract a certain branch of a git repository into a target directory.
+
+if [ -z "$OCD_GIT_EXTRACT_BRANCH" ]; then
+  echo "Error: Must declare OCD_GIT_EXTRACT_BRANCH"
+  exit 255
+fi
+
+if [ -z "$OCD_GIT_EXTRACT_TARGET" ]; then
+  echo "Error: Must declare OCD_GIT_EXTRACT_TARGET"
+  exit 255
+fi
+
+set -euf -o pipefail
+git archive --format=tar "$OCD_GIT_EXTRACT_BRANCH" | ( cd "$OCD_GIT_EXTRACT_TARGET" && tar -xf - )