rspec-bash 0.0.3 → 0.1.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-bash
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Ben Brewer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-11 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -41,20 +41,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 description: |2
-      Stub and mock Bash commands
-      Verify Bash calls and outputs
+      Test Bash scripts through stubbing and mocking Bash commands
 email:
 - ben@benbrewer.me
 - mike.david.urban@gmail.com
 executables:
 - function_override.sh.erb
 - function_override_wrapper.sh.erb
-- stub
+- stub.rb.erb
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .rubocop.yml
 - .ruby-version
 - .travis.yml
 - CHANGELOG.md
@@ -64,7 +64,7 @@ files:
 - Rakefile
 - bin/function_override.sh.erb
 - bin/function_override_wrapper.sh.erb
-- bin/stub
+- bin/stub.rb.erb
 - lib/rspec/bash.rb
 - lib/rspec/bash/call_configuration.rb
 - lib/rspec/bash/call_log.rb
@@ -73,21 +73,32 @@ files:
 - lib/rspec/bash/matchers/called_with_no_arguments.rb
 - lib/rspec/bash/stubbed_command.rb
 - lib/rspec/bash/stubbed_env.rb
+- lib/rspec/bash/util.rb
+- lib/rspec/bash/util/call_conf_argument_list_matcher.rb
+- lib/rspec/bash/util/call_log_argument_list_matcher.rb
+- return_exitstatus_spec.rb
 - rspec-bash.gemspec
 - spec/classes/call_configuration_spec.rb
 - spec/classes/call_log_spec.rb
+- spec/classes/stub_spec.rb
 - spec/classes/stubbed_command_spec.rb
 - spec/classes/stubbed_env_spec.rb
-- spec/integration/assert_called_spec.rb
-- spec/integration/assert_stdin_spec.rb
-- spec/integration/chain_args_spec.rb
-- spec/integration/change_exitstatus_spec.rb
-- spec/integration/provide_env_vars_spec.rb
-- spec/integration/replace_shell_commands_spec.rb
-- spec/integration/stub_output_spec.rb
-- spec/matchers/be_called_with_arguments_spec.rb
-- spec/matchers/be_called_with_no_arguments_spec.rb
+- spec/classes/util/call_conf_argument_list_matcher_spec.rb
+- spec/classes/util/call_log_argument_list_matcher_spec.rb
+- spec/helper/shared_tmpdir.rb
+- spec/helper/string_file_io.rb
+- spec/integration/call_log/called_with_args_spec.rb
+- spec/integration/call_log/called_with_no_args_spec.rb
+- spec/integration/call_log/stdin_spec.rb
+- spec/integration/matchers/be_called_with_arguments_spec.rb
+- spec/integration/matchers/be_called_with_no_arguments_spec.rb
+- spec/integration/stubbed_command/outputs_spec.rb
+- spec/integration/stubbed_command/returns_exitstatus_spec.rb
+- spec/integration/stubbed_env/execute_with_env_vars_spec.rb
+- spec/integration/stubbed_env/execute_with_path_spec.rb
+- spec/integration/stubbed_env/execute_with_stub_wrapper_spec.rb
 - spec/scripts/function_library.sh
+- spec/spec_helper.rb
 homepage: https://github.com/mdurban/rspec-bash
 licenses:
 - MIT
@@ -115,15 +126,22 @@ summary: Test Bash with RSpec
 test_files:
 - spec/classes/call_configuration_spec.rb
 - spec/classes/call_log_spec.rb
+- spec/classes/stub_spec.rb
 - spec/classes/stubbed_command_spec.rb
 - spec/classes/stubbed_env_spec.rb
-- spec/integration/assert_called_spec.rb
-- spec/integration/assert_stdin_spec.rb
-- spec/integration/chain_args_spec.rb
-- spec/integration/change_exitstatus_spec.rb
-- spec/integration/provide_env_vars_spec.rb
-- spec/integration/replace_shell_commands_spec.rb
-- spec/integration/stub_output_spec.rb
-- spec/matchers/be_called_with_arguments_spec.rb
-- spec/matchers/be_called_with_no_arguments_spec.rb
+- spec/classes/util/call_conf_argument_list_matcher_spec.rb
+- spec/classes/util/call_log_argument_list_matcher_spec.rb
+- spec/helper/shared_tmpdir.rb
+- spec/helper/string_file_io.rb
+- spec/integration/call_log/called_with_args_spec.rb
+- spec/integration/call_log/called_with_no_args_spec.rb
+- spec/integration/call_log/stdin_spec.rb
+- spec/integration/matchers/be_called_with_arguments_spec.rb
+- spec/integration/matchers/be_called_with_no_arguments_spec.rb
+- spec/integration/stubbed_command/outputs_spec.rb
+- spec/integration/stubbed_command/returns_exitstatus_spec.rb
+- spec/integration/stubbed_env/execute_with_env_vars_spec.rb
+- spec/integration/stubbed_env/execute_with_path_spec.rb
+- spec/integration/stubbed_env/execute_with_stub_wrapper_spec.rb
 - spec/scripts/function_library.sh
+- spec/spec_helper.rb

data/bin/stub

@@ -1,62 +0,0 @@
-#!/usr/bin/env ruby
-require 'pathname'
-require 'yaml'
-
-command = File.basename(__FILE__)
-folder = File.dirname(__FILE__)
-
-call_logs = Pathname.new(folder).join("#{command}_calls.yml")
-call_logs.open('a') do |f|
-  f.puts '- args:'
-  ARGV.each { |arg| f.puts "  - #{arg.inspect}" }
-  f.puts "  stdin: #{$stdin.read.inspect}" unless STDIN.tty?
-end
-
-def interpolate_filename(elements)
-  return elements if elements.is_a? String
-  return nil unless elements.is_a? Array
-
-  elements.map do |element|
-    case element
-    when String then element
-    when Symbol then interpolate_argument(element)
-    end
-  end.join
-end
-
-def interpolate_argument(name)
-  return unless (data = /^arg(\d+)$/.match(name.to_s))
-  ARGV[data[1].to_i - 1]
-end
-
-call_configurations = Pathname.new(folder).join("#{command}_stub.yml")
-if call_configurations.exist?
-  config = YAML.load call_configurations.read
-
-  matching_calls = []
-  config.each do |call_config|
-    if !call_config[:args].empty?
-      next unless (call_config[:args].eql? ARGV)
-    end
-    matching_calls << {
-      config: call_config,
-      specific: call_config[:args].length
-    }
-  end
-  exit 0 if matching_calls.empty?
-
-  call_config = matching_calls.sort do |a, b|
-    b[:specific] <=> a[:specific]
-  end.first[:config]
-  (call_config[:outputs] || []).each do |data|
-    $stdout.print data[:content] if data[:target] == :stdout
-    $stderr.print data[:content] if data[:target] == :stderr
-
-    output_filename = interpolate_filename(data[:target])
-    next unless output_filename
-    Pathname.new(output_filename).open('w') do |f|
-      f.print data[:content]
-    end
-  end
-  exit call_config[:statuscode] || 0
-end

data/spec/integration/assert_called_spec.rb

@@ -1,48 +0,0 @@
-require 'English'
-require 'rspec/bash'
-
-describe 'Assert called' do
-  include Rspec::Bash
-  let(:stubbed_env) { create_stubbed_env }
-  let!(:first_command) { stubbed_env.stub_command('first_command') }
-
-  let(:script) do
-    <<-SCRIPT
-      first_command "foo bar"
-    SCRIPT
-  end
-  let(:script_path) { Pathname.new '/tmp/test_script.sh' }
-
-  before do
-    script_path.open('w') { |f| f.puts script }
-    script_path.chmod 0777
-
-    stubbed_env.execute script_path.to_s
-  end
-
-  after do
-    script_path.delete
-  end
-
-  describe 'assert called' do
-    it 'returns called status' do
-      expect(first_command).to be_called
-    end
-
-    context 'assert with args' do
-      it 'returns called status' do
-        expect(first_command).to be_called_with_arguments('foo bar')
-        expect(first_command).to be_called_with_arguments(anything)
-        expect(first_command).not_to be_called_with_arguments('foot')
-      end
-    end
-
-    describe 'assertion message' do
-      it 'provides a helpful message' do
-        expect(first_command.inspect).to eql '<Stubbed "first_command">'
-        expect(first_command.with_args('foo bar').inspect).to \
-          eql '<Stubbed "first_command" args: "foo bar">'
-      end
-    end
-  end
-end

data/spec/integration/assert_stdin_spec.rb

@@ -1,39 +0,0 @@
-require 'English'
-require 'rspec/bash'
-
-describe 'Assert stdin' do
-  include Rspec::Bash
-  let(:stubbed_env) { create_stubbed_env }
-  let!(:command1_stub) { stubbed_env.stub_command('command1') }
-
-  let(:script) do
-    <<-SCRIPT
-      echo "foo bar" | command1
-      echo "baz" | command1 'hello'
-    SCRIPT
-  end
-  let(:script_path) { Pathname.new '/tmp/test_script.sh' }
-
-  before do
-    script_path.open('w') { |f| f.puts script }
-    script_path.chmod 0777
-    
-    stubbed_env.execute script_path.to_s
-  end
-
-  after do
-    script_path.delete
-  end
-
-  describe '#stdin' do
-    it 'returns the stdin' do
-      expect(command1_stub.stdin).to match 'foo bar'
-    end
-
-    context 'with arguments' do
-      it 'returns the stdin' do
-        expect(command1_stub.with_args('hello').stdin).to match 'baz'
-      end
-    end
-  end
-end

data/spec/integration/chain_args_spec.rb

@@ -1,65 +0,0 @@
-require 'English'
-require 'rspec/bash'
-
-describe 'Assert called' do
-  context 'checking command is called with argument sequence' do
-    include Rspec::Bash
-    let(:stubbed_env) { create_stubbed_env }
-    let!(:bundle) {
-      stubbed_env.stub_command('bundle')
-    }
-
-    let(:script) do
-      <<-SCRIPT
-        bundle exec rake foo:bar
-      SCRIPT
-    end
-    let(:script_path) { Pathname.new '/tmp/test_script.sh' }
-
-    before do
-      script_path.open('w') { |f| f.puts script }
-      script_path.chmod 0777
-
-      stubbed_env.execute script_path.to_s
-    end
-
-    after do
-      script_path.delete
-    end
-
-    it 'is called with correct argument sequence' do
-      expect(bundle).to be_called_with_arguments('exec', 'rake', 'foo:bar')
-      expect(bundle).to be_called_with_arguments('exec', anything, 'foo:bar')
-      expect(bundle).not_to be_called_with_arguments('exec', 'rake', 'foo')
-    end
-  end
-  context 'checking command is called with no arguments' do
-    include Rspec::Bash
-    let(:stubbed_env) { create_stubbed_env }
-    let!(:ls) {
-      stubbed_env.stub_command('ls')
-    }
-
-    let(:script) do
-      <<-SCRIPT
-       ls
-      SCRIPT
-    end
-    let(:script_path) { Pathname.new '/tmp/no_arg_test_script.sh' }
-
-    before do
-      script_path.open('w') { |f| f.puts script }
-      script_path.chmod 0777
-
-      stubbed_env.execute script_path.to_s
-    end
-
-    after do
-      script_path.delete
-    end
-
-    it 'is called with no arguments' do
-      expect(ls).to be_called_with_no_arguments
-    end
-  end
-end

data/spec/integration/change_exitstatus_spec.rb

@@ -1,53 +0,0 @@
-require 'English'
-require 'rspec/bash'
-
-describe 'Change exitstatus' do
-  include Rspec::Bash
-  let(:stubbed_env) { create_stubbed_env }
-  let!(:command1_stub) { stubbed_env.stub_command('command1') }
-  let(:script) do
-    <<-SCRIPT
-      command1 "foo bar"
-    SCRIPT
-  end
-  let(:script_path) { Pathname.new '/tmp/test_script.sh' }
-
-  before do
-    script_path.open('w') { |f| f.puts script }
-    script_path.chmod 0777
-  end
-
-  after do
-    script_path.delete
-  end
-
-  describe 'default exitstatus' do
-    it 'is 0' do
-      output, error, status = stubbed_env.execute script_path.to_s
-      expect(status.exitstatus).to eq 0
-    end
-  end
-
-  describe 'changing exitstatus' do
-    before do
-      command1_stub.returns_exitstatus(4)
-    end
-
-    it 'returns the stubbed exitstatus' do
-      output, error, status = stubbed_env.execute script_path.to_s
-      expect(status.exitstatus).to eq 4
-    end
-
-    context 'with specific args only' do
-      before do
-        command1_stub.with_args('foo bar').returns_exitstatus(2)
-        command1_stub.with_args('bar').returns_exitstatus(6)
-      end
-
-      it 'returns the stubbed exitstatus' do
-        output, error, status = stubbed_env.execute script_path.to_s
-        expect(status.exitstatus).to eq 2
-      end
-    end
-  end
-end

data/spec/integration/provide_env_vars_spec.rb

@@ -1,31 +0,0 @@
-require 'English'
-require 'rspec/bash'
-
-describe 'Provide environment vars' do
-  include Rspec::Bash
-  let(:script) do
-    <<-SCRIPT
-      echo $SOME_ENV_VAR
-    SCRIPT
-  end
-  let(:script_path) { Pathname.new '/tmp/test_script.sh' }
-
-  before do
-    script_path.open('w') { |f| f.puts script }
-    script_path.chmod 0777
-  end
-
-  after do
-    script_path.delete
-  end
-
-  let(:stubbed_env) { create_stubbed_env }
-
-  it 'exits with an error' do
-    o, _e, _s = stubbed_env.execute(
-      script_path,
-      'SOME_ENV_VAR' => 'SekretCredential'
-    )
-    expect(o).to eql "SekretCredential\n"
-  end
-end

data/spec/integration/replace_shell_commands_spec.rb

@@ -1,48 +0,0 @@
-require 'English'
-require 'rspec/bash'
-
-describe 'Replace shell commands' do
-  include Rspec::Bash
-  let(:script) do
-    <<-SCRIPT
-      command1 "foo bar"
-    SCRIPT
-  end
-  let(:script_path) { Pathname.new '/tmp/test_script.sh' }
-
-  before do
-    script_path.open('w') { |f| f.puts script }
-    script_path.chmod 0777
-  end
-
-  after do
-    script_path.delete
-  end
-
-  describe 'running a file with non-existing commands' do
-    it 'exits with an error' do
-      `#{script_path} 2>&1`
-      expect($CHILD_STATUS.exitstatus).not_to eq 0
-    end
-
-    context 'with stubbed environment' do
-      let(:stubbed_env) { create_stubbed_env }
-
-      it 'exits with an error' do
-        stubbed_env.execute "#{script_path} 2>&1"
-        expect($CHILD_STATUS.exitstatus).not_to eq 0
-      end
-
-      context 'with a stubbed command' do
-        before do
-          stubbed_env.stub_command('command1')
-        end
-
-        it 'exits with status code 0' do
-          _o, _e, s = stubbed_env.execute "#{script_path} 2>&1"
-          expect(s.exitstatus).to eq 0
-        end
-      end
-    end
-  end
-end