rspec-bash 0.1.1 → 0.2.0

data/lib/rspec/bash/command/stubbed_command.rb

@@ -0,0 +1,64 @@
+require 'digest'
+
+module Rspec
+  module Bash
+    class StubbedCommand
+      attr_reader :command, :arguments
+
+      def initialize(command, call_log_manager, call_conf_manager)
+        @command = command
+        @arguments = []
+        @call_log_manager = call_log_manager
+        @call_conf_manager = call_conf_manager
+      end
+
+      def with_args(*args)
+        @arguments = args
+        self
+      end
+
+      def called?
+        @call_log_manager.called_with_args?(@command, @arguments)
+      end
+
+      def called_with_no_args?
+        @call_log_manager.called_with_no_args?(@command)
+      end
+
+      def called_with_args?(*args)
+        @call_log_manager.called_with_args?(@command, args)
+      end
+
+      def call_count(*args)
+        @call_log_manager.call_count(@command, args)
+      end
+
+      def stdin
+        @call_log_manager.stdin_for_args(@command, @arguments)
+      end
+
+      def returns_exitstatus(exitcode)
+        @call_conf_manager.set_exitcode(@command, exitcode, @arguments)
+        self
+      end
+
+      def outputs(contents, to: :stdout)
+        @call_conf_manager.add_output(@command, contents, to, @arguments)
+        self
+      end
+
+      def call_log
+        @call_log_manager.call_log(@command)
+      end
+
+      def inspect
+        if @arguments.any?
+          "<Stubbed #{@call_configuration.command.inspect} " \
+            "args: #{@arguments.join(' ').inspect}>"
+        else
+          "<Stubbed #{@call_configuration.command.inspect}>"
+        end
+      end
+    end
+  end
+end

data/lib/rspec/bash/server.rb

@@ -0,0 +1,3 @@
+require 'rspec/bash/server/bash_stub_marshaller'
+require 'rspec/bash/server/ruby_stub_marshaller'
+require 'rspec/bash/server/stub_server'

data/lib/rspec/bash/server/bash_stub_marshaller.rb

@@ -0,0 +1,19 @@
+require 'sparsify'
+require 'json'
+
+module Rspec
+  module Bash
+    class BashStubMarshaller
+      def unmarshal(message_to_unmarshal)
+        object_to_unflatten = JSON.parse(message_to_unmarshal)
+        unflattened_object = Sparsify.unsparse(object_to_unflatten)
+        JSON.parse(JSON.dump(unflattened_object), symbolize_names: true)
+      end
+
+      def marshal(object_to_marshal)
+        object_to_dump = Sparsify.sparse(object_to_marshal, sparse_array: true)
+        JSON.pretty_generate(object_to_dump, indent: '', space: '')
+      end
+    end
+  end
+end

data/lib/rspec/bash/server/ruby_stub_marshaller.rb

@@ -0,0 +1,13 @@
+module Rspec
+  module Bash
+    class RubyStubMarshaller
+      def unmarshal(message_to_unmarshal)
+        Marshal.load(message_to_unmarshal)
+      end
+
+      def marshal(object_to_marshal)
+        Marshal.dump(object_to_marshal)
+      end
+    end
+  end
+end

data/lib/rspec/bash/server/stub_server.rb

@@ -0,0 +1,47 @@
+require 'socket'
+
+module Rspec
+  module Bash
+    class StubServer
+      def initialize(call_log_manager, call_conf_manager, stub_marshaller)
+        @call_log_manager = call_log_manager
+        @call_conf_manager = call_conf_manager
+        @stub_marshaller = stub_marshaller
+      end
+
+      def start(tcp_server)
+        Thread.new do
+          accept_loop(tcp_server)
+        end
+      end
+
+      def accept_loop(tcp_server, loop_forever = true)
+        loop do
+          tcp_socket = tcp_server.accept
+          message = process(tcp_socket.read)
+          tcp_socket.write(message)
+          tcp_socket.close
+          break unless loop_forever
+        end
+      end
+
+      def process(client_message)
+        client_call = @stub_marshaller.unmarshal(client_message)
+        server_conf = process_stub_call(client_call)
+        @stub_marshaller.marshal(server_conf)
+      end
+
+      def process_stub_call(stub_call)
+        @call_log_manager.add_log(
+          stub_call[:command],
+          stub_call[:stdin],
+          stub_call[:args]
+        )
+        @call_conf_manager.get_best_call_conf(
+          stub_call[:command],
+          stub_call[:args]
+        )
+      end
+    end
+  end
+end

data/lib/rspec/bash/stubbed_env.rb

@@ -1,97 +1,118 @@
 require 'tmpdir'
 require 'English'
 require 'open3'
+require 'tempfile'
 
 module Rspec
-  # Define stubbed environment to set and assert expectations
   module Bash
-    def create_stubbed_env
-      StubbedEnv.new
+    def create_stubbed_env(stub_type =
+      ENV.fetch('RSPEC_BASH_STUB_TYPE', StubbedEnv::BASH_STUB).to_sym)
+
+      StubbedEnv.new(stub_type)
     end
 
-    # A shell environment that can manipulate behaviour
-    # of executables
     class StubbedEnv
-      attr_reader :dir
+      RUBY_STUB = :ruby_stub
+      BASH_STUB = :bash_stub
 
-      def initialize
-        @dir = Dir.mktmpdir
-        at_exit { cleanup }
+      def initialize(stub_type)
+        start_stub_server(stub_type)
       end
 
-      def cleanup
-        FileUtils.remove_entry_secure @dir if Pathname.new(@dir).exist?
+      def start_stub_server(stub_type)
+        tcp_server = create_tcp_server
+        stub_server = create_stub_server(stub_type)
+        stub_server.start(tcp_server)
       end
 
       def stub_command(command)
-        write_function_override_file_for_command command
-        StubbedCommand.new command, @dir
+        check_if_command_is_allowed(command)
+        add_override_for_command(command)
+        create_stubbed_command(command)
       end
 
       def execute(command, env_vars = {})
-        full_command = get_wrapped_execution_with_function_overrides(
-          <<-multiline_script
-            source #{command}
-          multiline_script
-        )
-
-        Open3.capture3(env_vars, full_command)
+        script_runner = "source #{command}"
+        script_wrapper = wrap_script(script_runner)
+        execute_script(env_vars, script_wrapper)
       end
 
       def execute_function(script, command, env_vars = {})
-        full_command = get_wrapped_execution_with_function_overrides(
-          <<-multiline_script
-            source #{script}
-            #{command}
-          multiline_script
-        )
-
-        Open3.capture3(env_vars, full_command)
+        script_runner = "source #{script}\n#{command}"
+        script_wrapper = wrap_script(script_runner)
+        execute_script(env_vars, script_wrapper)
       end
 
       def execute_inline(command_string, env_vars = {})
-        temp_command_path = Dir::Tmpname.make_tmpname("#{@dir}/inline-", nil)
-        File.write(temp_command_path, command_string)
-        execute(temp_command_path, env_vars)
+        temp_command_file = Tempfile.new('inline-')
+        temp_command_path = temp_command_file.path
+        write_file(temp_command_path, command_string)
+        stdout, stderr, status = execute(temp_command_path, env_vars)
+        delete_file(temp_command_path)
+        [stdout, stderr, status]
       end
 
       private
 
-      def write_function_override_file_for_command(command)
-        function_command_binding_for_template = command
-        function_command_path_binding_for_template = File.join(@dir, command)
+      STUB_MARSHALLER_MAPPINGS = {
+        RUBY_STUB => RubyStubMarshaller,
+        BASH_STUB => BashStubMarshaller
+      }.freeze
+      STUB_SCRIPT_MAPPINGS = {
+        RUBY_STUB => RubyStubScript,
+        BASH_STUB => BashStubScript
+      }.freeze
+      DISALLOWED_COMMANDS = %w(/usr/bin/env bash readonly function).freeze
+
+      def create_tcp_server
+        tcp_server = TCPServer.new('localhost', 0)
+        @stub_server_port = tcp_server.addr[1]
+        tcp_server
+      end
 
-        function_override_file_path = File.join(@dir, "#{command}_overrides.sh")
-        function_override_file_template = ERB.new(
-          File.new(function_override_template_path).read, nil, '%'
-        )
-        function_override_file_content = function_override_file_template.result(binding)
+      def create_stub_server(stub_type)
+        stub_marshaller = STUB_MARSHALLER_MAPPINGS[stub_type].new
+        stub_script_class = STUB_SCRIPT_MAPPINGS[stub_type]
+        @stub_wrapper = BashWrapper.new(@stub_server_port)
+        @stub_function = StubFunction.new(@stub_server_port, stub_script_class)
+        @call_log_manager = CallLogManager.new
+        @call_conf_manager = CallConfigurationManager.new
+        StubServer.new(@call_log_manager, @call_conf_manager, stub_marshaller)
+      end
 
-        File.write(function_override_file_path, function_override_file_content)
+      def create_stubbed_command(command)
+        StubbedCommand.new(
+          command,
+          @call_log_manager,
+          @call_conf_manager
+        )
       end
 
-      def get_wrapped_execution_with_function_overrides(execution_snippet)
-        execution_binding_for_template = execution_snippet
-        function_override_path_binding_for_template = "#{@dir}/*_overrides.sh"
-        wrapped_error_path_binding_for_template = "#{@dir}/errors"
+      def execute_script(env_vars, script)
+        Open3.capture3(env_vars, script)
+      end
 
-        function_override_wrapper_template = ERB.new(
-          File.new(function_override_wrapper_template_path).read, nil, '%'
-        )
+      def wrap_script(script)
+        @stub_wrapper.wrap_script(script)
+      end
 
-        function_override_wrapper_template.result(binding)
+      def delete_file(file_path)
+        File.delete(file_path)
       end
 
-      def function_override_template_path
-        project_root.join('bin', 'function_override.sh.erb')
+      def write_file(file_path, contents)
+        File.write(file_path, contents)
       end
 
-      def function_override_wrapper_template_path
-        project_root.join('bin', 'function_override_wrapper.sh.erb')
+      def check_if_command_is_allowed(command)
+        error_message = "Not able to stub command #{command}. Reserved for use by test wrapper."
+
+        raise(error_message) if DISALLOWED_COMMANDS.include? command
       end
 
-      def project_root
-        Pathname.new(File.dirname(File.expand_path(__FILE__))).join('..', '..', '..')
+      def add_override_for_command(command)
+        function_override = @stub_function.script(command).chomp
+        @stub_wrapper.add_override(function_override)
       end
     end
   end

data/lib/rspec/bash/util/call_conf_argument_list_matcher.rb

@@ -13,19 +13,19 @@ module Rspec
           @expected_call_conf_list = call_conf_list
         end
 
-        def args_match?(*call_arguments)
-          !get_call_conf_matches(*call_arguments).empty?
+        def args_match?(call_arguments)
+          !get_call_conf_matches(call_arguments).empty?
         end
 
-        def get_best_call_conf(*call_arguments)
-          get_call_conf_matches(*call_arguments).sort_by do |call_conf|
+        def get_best_call_conf(call_arguments)
+          get_call_conf_matches(call_arguments).sort_by do |call_conf|
             [
               call_conf[:args].length
             ]
           end.last || {}
         end
 
-        def get_call_conf_matches(*call_arguments)
+        def get_call_conf_matches(call_arguments)
           @expected_call_conf_list.select do |expected_call_conf|
             @expected_args = remap_argument_matchers(expected_call_conf[:args])
             parent_args_match?(*call_arguments)

data/lib/rspec/bash/util/call_log_argument_list_matcher.rb

@@ -9,7 +9,7 @@ module Rspec
         alias parent_args_match? args_match?
         alias parent_initialize initialize
 
-        def initialize(*expected_args)
+        def initialize(expected_args = [any_args])
           expected_args = expected_args.empty? ? [any_args] : expected_args
           parent_initialize(*expected_args)
         end

data/lib/rspec/bash/wrapper.rb

@@ -0,0 +1,4 @@
+require 'rspec/bash/wrapper/bash_stub_script'
+require 'rspec/bash/wrapper/ruby_stub_script'
+require 'rspec/bash/wrapper/bash_wrapper'
+require 'rspec/bash/wrapper/stub_function'

data/lib/rspec/bash/wrapper/bash_stub_script.rb

@@ -0,0 +1,15 @@
+module Rspec
+  module Bash
+    class BashStubScript
+      def self.path
+        File.join(project_root, 'bin', 'bash_stub.sh')
+      end
+
+      def self.project_root
+        File.expand_path(
+          File.join(File.dirname(File.expand_path(__FILE__)), '..', '..', '..', '..')
+        )
+      end
+    end
+  end
+end

data/lib/rspec/bash/wrapper/bash_wrapper.rb

@@ -0,0 +1,54 @@
+module Rspec
+  module Bash
+    class BashWrapper
+      def initialize(port)
+        @port = port
+        @override_list = []
+        at_exit { cleanup }
+      end
+
+      def wrap_script(script)
+        wrapper_template = ERB.new(File.new(wrapper_input_path).read, nil, '%')
+        File.open(wrapper_output_path, 'w') do |file|
+          file.write(wrapper_template.result(binding))
+        end
+        File.chmod(0755, wrapper_output_path)
+
+        wrapper_output_path
+      end
+
+      def wrapper_input_path
+        File.join(project_root, 'bin', 'bash_wrapper.sh.erb')
+      end
+
+      def wrapper_output_path
+        File.join(Dir.tmpdir, "wrapper-#{@port}.sh")
+      end
+
+      def stderr_output_path
+        File.join(Dir.tmpdir, "stderr-#{@port}.tmp")
+      end
+
+      def cleanup
+        remove_file_system_path wrapper_output_path
+        remove_file_system_path stderr_output_path
+      end
+
+      def remove_file_system_path(path)
+        FileUtils.remove_entry_secure(path) if Pathname.new(path).exist?
+      end
+
+      def add_override(override)
+        @override_list << override
+      end
+
+      private
+
+      def project_root
+        File.expand_path(
+          File.join(File.dirname(File.expand_path(__FILE__)), '..', '..', '..', '..')
+        )
+      end
+    end
+  end
+end

data/lib/rspec/bash/wrapper/ruby_stub_script.rb

@@ -0,0 +1,15 @@
+module Rspec
+  module Bash
+    class RubyStubScript
+      def self.path
+        File.join(project_root, 'bin', 'ruby_stub.rb')
+      end
+
+      def self.project_root
+        File.expand_path(
+          File.join(File.dirname(File.expand_path(__FILE__)), '..', '..', '..', '..')
+        )
+      end
+    end
+  end
+end