Begin scriptrunner class to locate and execute scripts

Author: Kevin Paulisse

lib/octocatalog-diff/util/scriptrunner.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Execute a built-in script (which can also be overridden with a user-supplied script)
+
+require 'fileutils'
+require 'open3'
+require 'shellwords'
+
+module OctocatalogDiff
+  module Util
+    # This is a utility class to execute a built-in script.
+    class ScriptRunner
+      attr_reader :script, :logger
+
+      def initialize(opts = {})
+        default_script = opts.fetch(:default_script)
+        working_dir = opts.fetch(:working_dir)
+        override_script_path = opts[:override_script_path]
+        @logger = opts.fetch(:logger)
+
+        @script = find_script(default_script, override_script_path)
+        assert_directory_exists(working_dir)
+      end
+
+      def run(opts = {})
+      end
+
+      private
+
+      def find_script(default_script, override_script_path)
+        if override_script_path
+          script_test = File.join(override_script_path, File.basename(default_script))
+          if File.file?(script_test)
+            logger.debug "Selecting #{script_test} from override script path"
+            return script_test
+          else
+            logger.debug "Did not find #{script_test} in override script path"
+          end
+        end
+
+        script = File.expand_path("../../../scripts/#{default_script}", File.dirname(__FILE__))
+        return script if File.file?(script)
+
+        raise Errno::ENOENT, "Unable to locate default script '#{default_script}'"
+      end
+
+      def assert_directory_exists(dir)
+        return if File.directory?(dir)
+        raise Errno::ENOENT, "Invalid directory '#{dir}'"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require OctocatalogDiff::Spec.require_path('/util/scriptrunner')
+
+describe OctocatalogDiff::Util::ScriptRunner do
+  describe '#initialize' do
+    before(:each) do
+      @logger, @logger_str = OctocatalogDiff::Spec.setup_logger
+    end
+
+    it 'should raise error when script cannot be found' do
+      opts = {
+        default_script: 'git-extract/THIS-DOES-NOT-EXIST',
+        working_dir: File.dirname(__FILE__),
+        logger: @logger
+      }
+      expect { described_class.new(opts) }.to raise_error(Errno::ENOENT)
+    end
+
+    it 'should raise error when working directory cannot be found' do
+      opts = {
+        default_script: 'git-extract/git-extract.sh',
+        working_dir: File.join(File.dirname(__FILE__), 'THIS-DOES-NOT-EXIST'),
+        logger: @logger
+      }
+      expect { described_class.new(opts) }.to raise_error(Errno::ENOENT)
+    end
+
+    it 'should use override script when it is found' do
+      opts = {
+        default_script: 'asdflkjasf/scriptrunner_spec.rb',
+        working_dir: File.join(File.dirname(__FILE__)),
+        override_script_path: File.join(File.dirname(__FILE__)),
+        logger: @logger
+      }
+      obj = described_class.new(opts)
+      expect(obj.script).to eq(__FILE__)
+    end
+
+    it 'should use default script when override is not found' do
+      opts = {
+        default_script: 'git-extract/git-extract.sh',
+        working_dir: File.join(File.dirname(__FILE__)),
+        override_script_path: File.join(File.dirname(__FILE__)),
+        logger: @logger
+      }
+      obj = described_class.new(opts)
+      answer = File.expand_path('../../../../scripts/git-extract/git-extract.sh', File.dirname(__FILE__))
+      expect(obj.script).to eq(answer)
+    end
+
+    it 'should use default script when override is not provided' do
+      opts = {
+        default_script: 'git-extract/git-extract.sh',
+        working_dir: File.join(File.dirname(__FILE__)),
+        logger: @logger
+      }
+      obj = described_class.new(opts)
+      answer = File.expand_path('../../../../scripts/git-extract/git-extract.sh', File.dirname(__FILE__))
+      expect(obj.script).to eq(answer)
+    end
+  end
+end