rspec-bash 0.2.1 → 0.3.0

data/spec/classes/wrapper/ruby_stub_script_spec.rb

@@ -133,20 +133,20 @@ describe 'RubyStubFunction' do
     before do
       stdout_configuration = {
         args: [],
-        outputs: [
-          {
+        outputs: {
+          stderr: {
             target: :stderr,
             content: "stderr\n"
           },
-          {
+          stdout: {
             target: :stdout,
             content: "stdout\n"
           },
-          {
+          'tofile' => {
             target: 'tofile',
             content: "tofile\n"
           }
-        ],
+        },
         exitcode: 8
       }
       allow(stub_socket).to receive(:read).and_return(Marshal.dump(stdout_configuration))

data/spec/integration/edge_cases/stub_internals_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+include Rspec::Bash
+
+# rubocop:disable Metrics/AbcSize
+# rubocop:disable Metrics/MethodLength
+def expect_normal_operation
+  it 'should not blow up the test framework' do
+    expect(first_command).to be_called_with_arguments('hello')
+  end
+
+  it 'should return given stdout' do
+    expect(stdout).to eql 'stdout'
+  end
+
+  it 'should return given stderr' do
+    expect(stderr.chomp).to eql 'stderr'
+  end
+
+  it 'should return the given exit code' do
+    expect(exitcode).to eql 1
+  end
+
+  it 'treat calls like any other stub' do
+    expect(second_command).to be_called_with_no_arguments
+  end
+end
+# rubocop:enable Metrics/AbcSize
+# rubocop:enable Metrics/AbcSize
+
+describe 'integration for overrides of key stub internals' do
+  let(:stubbed_env) { create_stubbed_env }
+  let!(:first_command) do
+    stubbed_env.stub_command('first_command')
+               .outputs('stdout', to: :stdout)
+               .outputs('stderr', to: :stderr)
+               .returns_exitstatus(1)
+  end
+
+  context 'bash' do
+    let!(:second_command) { stubbed_env.stub_command('bash') }
+
+    execute_script 'bash; first_command hello'
+
+    expect_normal_operation
+  end
+
+  context 'ruby' do
+    let!(:second_command) { stubbed_env.stub_command('ruby') }
+
+    execute_script 'ruby; first_command hello'
+
+    expect_normal_operation
+  end
+
+  context '/usr/bin/env' do
+    let!(:second_command) { stubbed_env.stub_command('/usr/bin/env') }
+
+    execute_script '/usr/bin/env; first_command hello'
+
+    expect_normal_operation
+  end
+
+  context 'source' do
+    let!(:second_command) { stubbed_env.stub_command('source') }
+
+    execute_script 'source; first_command hello'
+
+    expect_normal_operation
+  end
+
+  context 'grep' do
+    let!(:second_command) { stubbed_env.stub_command('grep') }
+
+    execute_script 'grep; first_command hello'
+
+    expect_normal_operation
+  end
+
+  context 'exit' do
+    let!(:second_command) { stubbed_env.stub_command('exit') }
+
+    execute_script 'exit; first_command hello'
+
+    expect_normal_operation
+  end
+
+  context 'readonly' do
+    let!(:second_command) { stubbed_env.stub_command('readonly') }
+
+    execute_script <<-multiline_script
+      function first_command {
+        echo 'overridden'
+      }
+
+      readonly
+      first_command hello
+    multiline_script
+
+    expect_normal_operation
+  end
+end

data/spec/integration/stubbed_command/outputs_spec.rb

@@ -1,18 +1,6 @@
 require 'spec_helper'
 include Rspec::Bash
 
-def execute_script(script)
-  let!(:execute_results) do
-    stdout, stderr, status = stubbed_env.execute_inline(
-      script
-    )
-    [stdout, stderr, status]
-  end
-  let(:stdout) { execute_results[0] }
-  let(:stderr) { execute_results[1] }
-  let(:exitcode) { execute_results[2].exitstatus }
-end
-
 describe 'StubbedCommand' do
   let(:stubbed_env) { create_stubbed_env }
   let!(:command) { stubbed_env.stub_command('stubbed_command') }
@@ -179,7 +167,7 @@ describe 'StubbedCommand' do
     end
 
     describe 'target file path' do
-      let(:temp_file) { Tempfile.new('for-testing') }
+      let(:temp_file) { Tempfile.new('for testing') }
 
       context 'when given no arguments to match' do
         before do
@@ -277,6 +265,51 @@ describe 'StubbedCommand' do
           FileUtils.remove_entry_secure dynamic_file
         end
       end
+
+      describe 'when given a filename that matches the stdout target' do
+        let(:stdout_file) { Pathname.new('stdout') }
+
+        before do
+          command
+            .outputs('i am supposed to go to a file', to: 'stdout')
+        end
+
+        execute_script('stubbed_command poglet piglet')
+
+        it 'outputs the expected content to the file' do
+          expect(stdout_file.read).to eql 'i am supposed to go to a file'
+        end
+
+        after(:each) do
+          FileUtils.remove_entry_secure stdout_file
+        end
+      end
+    end
+
+    describe 'any target' do
+      context 'when given a non-string output' do
+        before do
+          command.outputs(['an array'], to: :stdout)
+        end
+
+        execute_script('stubbed_command first_argument second_argument')
+
+        it 'outputs the expected output to stdout' do
+          expect(stdout).to eql '["an array"]'
+        end
+      end
+      context 'when given multiple outputs settings' do
+        before do
+          command.outputs('first output', to: :stdout)
+          command.outputs('second output', to: :stdout)
+        end
+
+        execute_script('stubbed_command first_argument second_argument')
+
+        it 'outputs only the results from the second call to outputs' do
+          expect(stdout).to eql 'second output'
+        end
+      end
     end
   end
 end

data/spec/integration/stubbed_command/returns_exitstatus_spec.rb

@@ -1,18 +1,6 @@
 require 'spec_helper'
 include Rspec::Bash
 
-def execute_script(script)
-  let!(:execute_results) do
-    stdout, stderr, status = stubbed_env.execute_inline(
-      script
-    )
-    [stdout, stderr, status]
-  end
-  let(:stdout) { execute_results[0] }
-  let(:stderr) { execute_results[1] }
-  let(:exitcode) { execute_results[2].exitstatus }
-end
-
 describe 'StubbedCommand' do
   let(:stubbed_env) { create_stubbed_env }
   let!(:command) { stubbed_env.stub_command('stubbed_command') }

data/spec/integration/stubbed_env/override_spec.rb

@@ -1,31 +1,6 @@
 require 'spec_helper'
 include Rspec::Bash
 
-def execute_script(script)
-  let!(:execute_results) do
-    stdout, stderr, status = stubbed_env.execute_inline(
-      script
-    )
-    [stdout, stderr, status]
-  end
-  let(:stdout) { execute_results[0] }
-  let(:stderr) { execute_results[1] }
-  let(:exitcode) { execute_results[2].exitstatus }
-end
-
-def execute_function(script, function)
-  let!(:execute_results) do
-    stdout, stderr, status = stubbed_env.execute_function(
-      script,
-      function
-    )
-    [stdout, stderr, status]
-  end
-  let(:stdout) { execute_results[0] }
-  let(:stderr) { execute_results[1] }
-  let(:exitcode) { execute_results[2].exitstatus }
-end
-
 describe('StubbedEnv override tests') do
   subject { create_stubbed_env }
   let(:stubbed_env) { subject }

data/spec/integration/wrapper/bash_stub_script_spec.rb

@@ -2,23 +2,27 @@ require 'spec_helper'
 include Rspec::Bash
 
 def execute_script(script)
-  let(:temp_file) { Tempfile.new('for-testing') }
+  let(:temp_file) { Tempfile.new('for testing') }
 
-  capture_standard_streams script
+  capture_execute_results script
 
   after do
     FileUtils.remove_entry_secure temp_file if script.include? '<temp file>'
   end
 end
 
-def capture_standard_streams(script)
+def capture_execute_results(script)
   let!(:execute_results) do
     script.gsub!(/<temp file>/, temp_file.path) if script.include? '<temp file>'
     stubbed_env.execute_function(BashStubScript.path, script)
   end
+  capture_standard_streams
+end
 
+def capture_standard_streams
   let(:stdout) { execute_results[0] }
   let(:stderr) { execute_results[1] }
+  let(:exit_code) { execute_results[2].exitstatus }
 end
 
 describe 'BashStub' do
@@ -166,24 +170,20 @@ describe 'BashStub' do
           Sparsify.sparse(
             {
               exitcode: 10_000,
-              outputs: [
-                {
-                  target: 'stdout',
+              outputs: {
+                stdout: {
+                  target: :stdout,
                   content: "stdout\nstdout,stdout"
                 },
-                {
-                  target: 'stdout',
-                  content: 1
-                },
-                {
-                  target: 'stderr',
+                stderr: {
+                  target: :stderr,
                   content: "stderr\" stderr\nstderr"
                 },
-                {
+                'tofile' => {
                   target: 'tofile',
                   content: "tofile\ntofile:\", tofile"
                 }
-              ]
+              }
             }, sparse_array: true
           ), indent: '', space: ''
         )
@@ -205,12 +205,20 @@ describe 'BashStub' do
         expect(stdout.chomp).to eql "stdout\\nstdout,stdout\nstderr\\\" stderr\\nstderr" \
         "\ntofile\\ntofile:\\\", tofile"
       end
+
+      it 'extracts a multiple value field with a dynamic key' do
+        stdout, _stderr = stubbed_env.execute_function(
+          BashStubScript.path,
+          "extract-string-properties '#{call_conf}' 'outputs\\..*\\.target'"
+        )
+        expect(stdout.chomp).to eql "stdout\nstderr\ntofile"
+      end
     end
   end
 
   context '.print-output' do
-    context 'given a stdout target and its associated content' do
-      execute_script("print-output 'stdout' '\\nstdout \\\\nstdout\nstdout\\n'")
+    context 'given a stdout type and target and its associated content' do
+      execute_script("print-output 'stdout' 'stdout' '\\nstdout \\\\nstdout\nstdout\\n'")
 
       it 'prints the output to stdout' do
         expect(stdout).to eql "\nstdout \\nstdout\nstdout\n"
@@ -221,8 +229,8 @@ describe 'BashStub' do
       end
     end
 
-    context 'given a stderr target and its associated content' do
-      execute_script("print-output 'stderr' '\\nstderr \\\\nstderr\nstderr\\n'")
+    context 'given a stderr type and target and its associated content' do
+      execute_script("print-output 'stderr' 'stderr' '\\nstderr \\\\nstderr\nstderr\\n'")
 
       it 'prints the output to stderr' do
         expect(stderr).to eql "\nstderr \\nstderr\nstderr\n"
@@ -233,8 +241,8 @@ describe 'BashStub' do
       end
     end
 
-    context 'given a file target (anything but stderr or stdout)' do
-      execute_script("print-output '<temp file>' '\\ntofile \\\\ntofile\ntofile\\n'")
+    context 'given a file type and target (anything but stderr or stdout)' do
+      execute_script("print-output 'file' '<temp file>' '\\ntofile \\\\ntofile\ntofile\\n'")
 
       it 'prints the output to the file' do
         expect(temp_file.read).to eql "\ntofile \\ntofile\ntofile\n"
@@ -244,6 +252,21 @@ describe 'BashStub' do
         expect(stderr.chomp).to eql ''
       end
 
+      it 'does not print the output to stdout' do
+        expect(stdout.chomp).to eql ''
+      end
+    end
+    context 'given a file type and target that is an empty string' do
+      execute_script("print-output 'file' '' '\\ntofile \\\\ntofile\ntofile\\n'")
+
+      it 'does not exit with a non-zero exit code' do
+        expect(exit_code).to eql 0
+      end
+
+      it 'does not print the output to stderr' do
+        expect(stderr.chomp).to eql ''
+      end
+
       it 'does not print the output to stdout' do
         expect(stdout.chomp).to eql ''
       end
@@ -332,6 +355,9 @@ describe 'BashStub' do
         @extract_string_properties
           .with_args('call conf', 'outputs\..*\.target')
           .outputs("stdout\nstderr\ntofile\n")
+        @extract_string_properties
+          .with_args('call conf', 'outputs\..*\.type')
+          .outputs("stdout\nstderr\nfile\n")
         @extract_string_properties
           .with_args('call conf', 'outputs\..*\.content')
           .outputs("\\nstd out\\n\n\\nstd err\\n\n\\nto file\\n\n")
@@ -371,13 +397,13 @@ describe 'BashStub' do
       end
       it 'prints the extracted outputs (with newlines still escaped)' do
         expect(@print_output).to be_called_with_arguments(
-          'stdout', '\nstd out\n'
+          'stdout', 'stdout', '\nstd out\n'
         )
         expect(@print_output).to be_called_with_arguments(
-          'stderr', '\nstd err\n'
+          'stderr', 'stderr', '\nstd err\n'
         )
         expect(@print_output).to be_called_with_arguments(
-          'tofile', '\nto file\n'
+          'file', 'tofile', '\nto file\n'
         )
       end
       it 'exits with the extracted exit code' do

data/spec/spec_helper.rb

@@ -14,3 +14,28 @@ require 'helper/shared_tmpdir'
 RSpec.configure do |c|
   c.include Rspec::Bash
 end
+
+def execute_script(script)
+  let!(:execute_results) do
+    stdout, stderr, status = stubbed_env.execute_inline(
+      script
+    )
+    [stdout, stderr, status]
+  end
+  let(:stdout) { execute_results[0] }
+  let(:stderr) { execute_results[1] }
+  let(:exitcode) { execute_results[2].exitstatus }
+end
+
+def execute_function(script, function)
+  let!(:execute_results) do
+    stdout, stderr, status = stubbed_env.execute_function(
+      script,
+      function
+    )
+    [stdout, stderr, status]
+  end
+  let(:stdout) { execute_results[0] }
+  let(:stderr) { execute_results[1] }
+  let(:exitcode) { execute_results[2].exitstatus }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-bash
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Ben Brewer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-23 00:00:00.000000000 Z
+date: 2018-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sparsify
@@ -122,6 +122,7 @@ files:
 - spec/integration/call_log/called_with_no_args_spec.rb
 - spec/integration/call_log/stdin_spec.rb
 - spec/integration/edge_cases/long_command_spec.rb
+- spec/integration/edge_cases/stub_internals_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
@@ -178,6 +179,7 @@ test_files:
 - spec/integration/call_log/called_with_no_args_spec.rb
 - spec/integration/call_log/stdin_spec.rb
 - spec/integration/edge_cases/long_command_spec.rb
+- spec/integration/edge_cases/stub_internals_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