Change puppet version determinator to use scriptrunner

Author: Kevin Paulisse

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

@@ -43,10 +43,12 @@ def self.check_out_git_archive(options = {})
         script = OctocatalogDiff::Util::ScriptRunner.new(sr_opts)
 
         sr_run_opts = {
-          :working_dir => dir,
+          :working_dir             => dir,
+          :pass_env_vars           => options[:pass_env_vars],
           'OCD_GIT_EXTRACT_BRANCH' => branch,
           'OCD_GIT_EXTRACT_TARGET' => path
         }
+
         begin
           script.run(sr_run_opts)
           logger.debug("Success git archive #{dir}:#{branch}")

lib/octocatalog-diff/util/puppetversion.rb

@@ -2,9 +2,9 @@
 
 # Helper to determine the version of Puppet
 
-require 'fileutils'
-require 'open3'
-require 'shellwords'
+require 'logger'
+require 'stringio'
+require_relative 'scriptrunner'
 
 module OctocatalogDiff
   module Util
@@ -17,19 +17,24 @@ class PuppetVersion
       def self.puppet_version(puppet, options = {})
         raise ArgumentError, 'Puppet binary was not supplied' if puppet.nil?
         raise Errno::ENOENT, "Puppet binary #{puppet} doesn't exist" unless File.file?(puppet)
-        cmdline = [Shellwords.escape(puppet), '--version'].join(' ')
 
-        # This is the environment provided to the puppet command.
-        env = {
-          'HOME' => ENV['HOME'],
-          'PATH' => ENV['PATH'],
-          'PWD' => File.dirname(puppet)
+        sr_opts = {
+          logger: Logger.new(StringIO.new),
+          default_script: 'puppet-version/puppet-version.sh',
+          override_script_path: options[:override_script_path]
         }
-        pass_env_vars = options.fetch(:pass_env_vars, [])
-        pass_env_vars.each { |var| env[var] ||= ENV[var] }
-        out, err, _status = Open3.capture3(env, cmdline, unsetenv_others: true, chdir: env['PWD'])
-        return Regexp.last_match(1) if out =~ /^([\d\.]+)\s*$/
-        raise "Unable to determine Puppet version: #{out} #{err}"
+
+        script = OctocatalogDiff::Util::ScriptRunner.new(sr_opts)
+
+        sr_run_opts = {
+          :working_dir        => File.dirname(puppet),
+          :pass_env_vars      => options[:pass_env_vars],
+          'OCD_PUPPET_BINARY' => puppet
+        }
+
+        output = script.run(sr_run_opts)
+        return Regexp.last_match(1) if output =~ /^([\d\.]+)\s*$/
+        raise "Unable to determine Puppet version: #{script.output}"
       end
     end
   end

lib/octocatalog-diff/util/scriptrunner.rb

@@ -38,17 +38,18 @@ def initialize(opts = {})
       # @param opts [Hash] Options hash
       #   opts[:working_dir] (Required) Directory where script is to be executed
       #   opts[:argv] (Optional Array) Command line arguments
+      #   opts[:pass_env_vars] (Optional Array) Environment variables to pass (default: HOME, PATH)
       #   opts[<STRING>] (Optional) Environment variable
       def run(opts = {})
         working_dir = opts.fetch(:working_dir)
         assert_directory_exists(working_dir)
 
         argv = opts.fetch(:argv, [])
 
+        pass_env_vars = opts[:pass_env_vars] || %w(HOME PATH)
         env = opts.select { |k, _v| k.is_a?(String) }
-        env['HOME'] ||= ENV['HOME']
+        pass_env_vars.each { |var| env[var] ||= ENV[var] }
         env['PWD'] = working_dir
-        env['PATH'] ||= ENV['PATH']
 
         cmdline = [script, argv].flatten.compact.map { |x| Shellwords.escape(x) }.join(' ')
         @logger.debug "Execute: #{cmdline}"

scripts/puppet-version/puppet-version.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Script to determine the Puppet version.
+
+if [ -z "$OCD_PUPPET_BINARY" ]; then
+  echo "Error: PUPPET_BINARY must be set"
+  exit 255
+fi
+
+"$OCD_PUPPET_BINARY" --version

spec/octocatalog-diff/tests/catalog/computed_spec.rb

@@ -294,7 +294,7 @@
             branch: '.'
           }
           expect { OctocatalogDiff::Catalog::Computed.new(opts).build }
-            .to raise_error(RuntimeError, /Unable to determine Puppet version/)
+            .to raise_error(OctocatalogDiff::Util::ScriptRunner::ScriptException, /something failed horribly/)
         end
       end
     end