Move working directory to run method, update tests

Author: Kevin Paulisse

lib/octocatalog-diff/util/scriptrunner.rb

@@ -12,17 +12,27 @@ module Util
     class ScriptRunner
       attr_reader :script, :logger
 
+      # 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] (Required) Logger object
+      #   opts[:override_script_path] (Optional) Directory where a similarly-named script MAY exist
       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)
+        @script = find_script(opts.fetch(:default_script), opts[:override_script_path])
       end
 
+      # Execute the script from a given working directory, with additional environment variables
+      # specified in the options hash.
+      #
+      # @param opts [Hash] Options hash
+      #   opts[:working_dir] (Required) Directory where script is to be executed
+      #   opts[<STRING>] (Optional) Environment variable
       def run(opts = {})
+        working_dir = opts.fetch(:working_dir)
+        assert_directory_exists(working_dir)
       end
 
       private

scripts/env/env.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+# This script echoes back the environment. This is used for spec testing
+# and possible debugging.
+
+env | sort

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

@@ -11,22 +11,13 @@
 
     it 'should raise error when script cannot be found' do
       opts = {
-        default_script: 'git-extract/THIS-DOES-NOT-EXIST',
+        default_script: 'env/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',
@@ -41,27 +32,44 @@
 
     it 'should use default script when override is not found' do
       opts = {
-        default_script: 'git-extract/git-extract.sh',
+        default_script: 'env/env.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__))
+      answer = File.expand_path('../../../../scripts/env/env.sh', File.dirname(__FILE__))
       expect(obj.script).to eq(answer)
-      expect(@logger_str.string).to match(/Did not find.+git-extract.sh in override script path/)
+      expect(@logger_str.string).to match(/Did not find.+env.sh in override script path/)
     end
 
     it 'should use default script when override is not provided' do
       opts = {
-        default_script: 'git-extract/git-extract.sh',
+        default_script: 'env/env.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__))
+      answer = File.expand_path('../../../../scripts/env/env.sh', File.dirname(__FILE__))
       expect(obj.script).to eq(answer)
       expect(@logger_str.string).to eq('')
     end
   end
+
+  describe '#run' do
+    before(:each) do
+      @logger, @logger_str = OctocatalogDiff::Spec.setup_logger
+      @described_obj = described_class.new(
+        default_script: 'env/env.sh',
+        logger: @logger
+      )
+    end
+
+    it 'should raise error when working directory cannot be found' do
+      opts = {
+        working_dir: File.join(File.dirname(__FILE__), 'THIS-DOES-NOT-EXIST')
+      }
+      expect { @described_obj.run(opts) }.to raise_error(Errno::ENOENT)
+    end
+  end
 end