awesome_spawn 1.2.1 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 495db35a5162aeca5013e1c52777938873956d4d
+  data.tar.gz: aaacd54a4c413f3f69bba0a52b52386041dc1e23
+SHA512:
+  metadata.gz: 4b491f9bdcf6a10961ed3b38e22a66f2906e639b6f0eee2340151bda4c1bba929c46765245d1b6ea38b206a328567bd4d834ce36f5d4de7aa6ec9845c428319e
+  data.tar.gz: c291f6d3861399c95343a9f787db4ac2ccf36415c7dda00934e4d8df44e8bd79fa45639b4d7e63eb88b3c1f5074042534b43aef8ad3051c2c0abff289ef01e0d

data/lib/awesome_spawn.rb

@@ -3,12 +3,19 @@ require "awesome_spawn/command_line_builder"
 require "awesome_spawn/command_result"
 require "awesome_spawn/command_result_error"
 require "awesome_spawn/no_such_file_error"
+require "awesome_spawn/null_logger"
 
 require "open3"
 
 module AwesomeSpawn
   extend self
 
+  attr_writer :logger
+
+  def logger
+    @logger ||= NullLogger.new
+  end
+
   # Execute `command` synchronously via Kernel.spawn and gather the output
   #   stream, error stream, and exit status in a {CommandResult}.
   #
@@ -45,11 +52,10 @@ module AwesomeSpawn
   #
   # @param [String] command The command to run
   # @param [Hash] options The options for running the command.  Also accepts any
-  #   option that can be passed to Kernel.spawn, except `:out` and `:err`.
+  #   option that can be passed to Kernel.spawn, except `:in`, `:out` and `:err`.
   # @option options [Hash,Array] :params The command line parameters. See
   #   {#build_command_line} for how to specify params.
-  # @option options [String] :in_data Data to be passed on stdin.  If this option
-  #   is specified you cannot specify `:in`.
+  # @option options [String] :in_data Data to be passed on stdin.
   #
   # @raise [NoSuchFileError] if the `command` is not found
   # @return [CommandResult] the output stream, error stream, and exit status
@@ -57,20 +63,17 @@ module AwesomeSpawn
   def run(command, options = {})
     raise ArgumentError, "options cannot contain :out" if options.include?(:out)
     raise ArgumentError, "options cannot contain :err" if options.include?(:err)
-    raise ArgumentError, "options cannot contain :in if :in_data is specified" if options.include?(:in) && options.include?(:in_data)
+    raise ArgumentError, "options cannot contain :in" if options.include?(:in)
     options = options.dup
     params  = options.delete(:params)
-    in_data = options.delete(:in_data)
+    if (in_data = options.delete(:in_data))
+      options[:stdin_data] = in_data
+    end
 
     output, error, status = "", "", nil
     command_line = build_command_line(command, params)
 
-    begin
-      output, error, status = launch(command_line, in_data, options)
-    ensure
-      output ||= ""
-      error  ||= ""
-    end
+    output, error, status = launch(command_line, options)
   rescue Errno::ENOENT => err
     raise NoSuchFileError.new(err.message) if NoSuchFileError.detected?(err.message)
     raise
@@ -92,8 +95,10 @@ module AwesomeSpawn
   def run!(command, options = {})
     command_result = run(command, options)
 
-    if command_result.exit_status != 0
+    if command_result.failure?
       message = "#{command} exit code: #{command_result.exit_status}"
+      logger.error("AwesomeSpawn: #{message}")
+      logger.error("AwesomeSpawn: #{command_result.error}")
       raise CommandResultError.new(message, command_result)
     end
 
@@ -107,10 +112,8 @@ module AwesomeSpawn
 
   private
 
-  def launch(command, in_data, spawn_options = {})
-    spawn_options = spawn_options.merge(:stdin_data => in_data) if in_data
+  def launch(command, spawn_options = {})
     output, error, status = Open3.capture3(command, spawn_options)
-    status &&= status.exitstatus
-    return output, error, status
+    return output || "", error || "", status && status.exitstatus
   end
 end

data/lib/awesome_spawn/null_logger.rb

@@ -0,0 +1,11 @@
+require 'logger'
+
+module AwesomeSpawn
+  class NullLogger < Logger
+    def initialize(*_args)
+    end
+
+    def add(*_args, &_block)
+    end
+  end
+end

data/lib/awesome_spawn/version.rb

@@ -1,3 +1,3 @@
 module AwesomeSpawn
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/spec/awesome_spawn_spec.rb

@@ -6,24 +6,38 @@ describe AwesomeSpawn do
 
   shared_examples_for "run" do
     context "options" do
+      it "params won't be modified" do
+        params      = {:params => {:user => "bob"}}
+        orig_params = params.dup
+        allow(subject).to receive(:launch).with("true --user bob", {}).and_return(["", "", 0])
+        subject.send(run_method, "true", params)
+        expect(orig_params).to eq(params)
+      end
+
       it ":params won't be modified" do
         params      = {:user => "bob"}
         orig_params = params.dup
-        subject.stub(:launch => ["", "", 0])
+        allow(subject).to receive(:launch).with("true --user bob", {}).and_return(["", "", 0])
         subject.send(run_method, "true", :params => params)
         expect(orig_params).to eq(params)
       end
 
-      it ":in_data cannot be passed with :in" do
-        expect { subject.send(run_method, "true", :in_data => "XXXXX", :in => "/dev/null") } .to raise_error(ArgumentError)
+      it ":in is not supported" do
+        expect do
+          subject.send(run_method, "true", :in => "/dev/null")
+        end.to raise_error(ArgumentError, "options cannot contain :in")
       end
 
       it ":out is not supported" do
-        expect { subject.send(run_method, "true", :out => "/dev/null") }.to raise_error(ArgumentError)
+        expect do
+          subject.send(run_method, "true", :out => "/dev/null")
+        end.to raise_error(ArgumentError, "options cannot contain :out")
       end
 
       it ":err is not supported" do
-        expect { subject.send(run_method, "true", :err => "/dev/null") }.to raise_error(ArgumentError)
+        expect do
+          subject.send(run_method, "true", :err => "/dev/null")
+        end.to raise_error(ArgumentError, "options cannot contain :err")
       end
     end
 
@@ -53,7 +67,9 @@ describe AwesomeSpawn do
       end
 
       it "command bad" do
-        expect { subject.send(run_method, "XXXXX --user=bob") }.to raise_error(Errno::ENOENT, "No such file or directory - XXXXX")
+        expect do
+          subject.send(run_method, "XXXXX --user=bob")
+        end.to raise_error(AwesomeSpawn::NoSuchFileError, "No such file or directory - XXXXX")
       end
 
       context "with option" do
@@ -70,6 +86,18 @@ describe AwesomeSpawn do
         end
       end
 
+      context "#exit_status" do
+        it "command ok exit ok" do
+          expect(subject.send(run_method, "echo", :params => %w(x)).command_line).to eq("echo x")
+        end
+
+        it "command ok exit bad" do
+          if run_method == "run"
+            expect(subject.send(run_method, "echo x && false").command_line).to eq("echo x && false")
+          end
+        end
+      end
+
       context "#exit_status" do
         it "command ok exit ok" do
           expect(subject.send(run_method, "true").exit_status).to eq(0)
@@ -88,9 +116,17 @@ describe AwesomeSpawn do
         it "command ok exit bad" do
           expect(subject.send(run_method, "echo 'bad' && false").output).to eq("bad\n") if run_method == "run"
         end
+
+        it "has output even though output redirected to stderr" do
+          expect(subject.send(run_method, "echo \"Hello World\" >&2").output).to eq("")
+        end
       end
 
       context "#error" do
+        it "has error even though no error" do
+          expect(subject.send(run_method, "echo", :params => ["Hello World"]).error).to eq("")
+        end
+
         it "command ok exit ok" do
           expect(subject.send(run_method, "echo \"Hello World\" >&2").error).to eq("Hello World\n")
         end
@@ -102,6 +138,16 @@ describe AwesomeSpawn do
     end
   end
 
+  context ".build_command_line" do
+    it "should handle single parameter" do
+      expect(subject.build_command_line("cmd")).to eq("cmd")
+    end
+
+    it "should handle multi parameter" do
+      expect(subject.build_command_line("cmd", :status => true)).to eq("cmd --status true")
+    end
+  end
+
   context ".run" do
     include_examples "run" do
       let(:run_method) {"run"}

data/spec/command_line_builder_spec.rb

@@ -16,6 +16,14 @@ describe AwesomeSpawn::CommandLineBuilder do
       expect(subject.build("true", nil)).to eq "true"
     end
 
+    it "with empty" do
+      expect(subject.build("true", "")).to eq "true"
+    end
+
+    it "with empty" do
+      expect(subject.build("true", [])).to eq "true"
+    end
+
     it "with Pathname command" do
       actual = subject.build(Pathname.new("/usr/bin/ruby"))
       expect(actual).to eq "/usr/bin/ruby"
@@ -197,6 +205,10 @@ describe AwesomeSpawn::CommandLineBuilder do
         assert_params([["--abc", ["def", "ghi"]]], "--abc def ghi")
       end
 
+      it "with value as Array and extra nils" do
+        assert_params([["--abc", [nil, "def", nil, "ghi", nil]]], "--abc def ghi")
+      end
+
       it "with value as flattened Array" do
         assert_params([["--abc", "def", "ghi"]], "--abc def ghi")
       end
@@ -250,6 +262,11 @@ describe AwesomeSpawn::CommandLineBuilder do
         assert_params(params, expected)
       end
 
+      it "as mixed Array" do
+        params = ["log", "feature", "-E", :oneline, :grep, "abc"]
+        assert_params(params, expected)
+      end
+
       it "as mixed Array with nested Hashes" do
         params = ["log", "feature", "-E", :oneline, {:grep => "abc"}]
         assert_params(params, expected)

data/spec/command_result_error_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe AwesomeSpawn::CommandResultError do
+  context "basic false command" do
+    before { enable_spawning }
+    subject do
+      begin
+        AwesomeSpawn.run!("false")
+      rescue => e
+        return e
+      end
+    end
+
+    it { expect(subject.message).to eq("false exit code: 1") }
+    it { expect(subject.result).to be_a_failure }
+  end
+end

data/spec/command_result_spec.rb

@@ -1,23 +1,38 @@
 require 'spec_helper'
 
 describe AwesomeSpawn::CommandResult do
-  context "#inspect" do
-    it "will not display sensitive information" do
-      str = described_class.new("aaa", "bbb", "ccc", 0).inspect
+  context "succeeding object" do
+    subject { described_class.new("aaa", "bbb", "ccc", 0) }
 
-      expect(str).to_not include("aaa")
-      expect(str).to_not include("bbb")
-      expect(str).to_not include("ccc")
+    it "should set attributes" do
+      expect(subject.command_line).to eq("aaa")
+      expect(subject.output).to eq("bbb")
+      expect(subject.error).to eq("ccc")
+      expect(subject.exit_status).to eq(0)
+      expect(subject.inspect).to match(/^#<AwesomeSpawn::CommandResult:[0-9a-fx]+ @exit_status=0>$/)
     end
 
-    it "will know if a command succeeded" do
-      expect(described_class.new("c", "o", "e", 0)).to be_a_success
-      expect(described_class.new("c", "o", "e", 0)).not_to be_a_failure
+    it "should not display sensitive information" do
+      expect(subject.inspect).to_not include("aaa")
+      expect(subject.inspect).to_not include("bbb")
+      expect(subject.inspect).to_not include("ccc")
     end
 
-    it "will know if a command failed" do
-      expect(described_class.new("c", "o", "e", 1)).to be_a_failure
-      expect(described_class.new("c", "o", "e", 1)).not_to be_a_success
-    end
+    it { expect(subject).to be_a_success }
+    it { expect(subject).not_to be_a_failure }
+  end
+
+  context "failing object" do
+    subject { described_class.new("aaa", "bbb", "ccc", 1) }
+
+    it { expect(subject).not_to be_a_success }
+    it { expect(subject).to be_a_failure }
+  end
+
+  context "another failing object" do
+    subject { described_class.new("aaa", "bbb", "ccc", 100) }
+
+    it { expect(subject).not_to be_a_success }
+    it { expect(subject).to be_a_failure }
   end
 end

data/spec/no_such_file_error_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe AwesomeSpawn::NoSuchFileError do
+  before do
+    enable_spawning
+  end
+
+  context "single word command" do
+    subject { caught_exception_for("falsey") }
+    it { expect(subject.message).to eq("No such file or directory - falsey") }
+    it { expect(subject.to_s).to eq("No such file or directory - falsey") }
+    it { expect(subject).to be_a(described_class) }
+  end
+
+  context "multi word command" do
+    subject { caught_exception_for("  flat   --arg 1 --arg 2") }
+    it { expect(subject.message).to eq("No such file or directory - flat") }
+    it { expect(subject.to_s).to eq("No such file or directory - flat") }
+    it { expect(subject).to be_a(described_class) }
+  end
+
+  def caught_exception_for(command)
+    AwesomeSpawn.run!(command)
+  rescue => e
+    return e
+  end
+end

data/spec/spec_helper.rb

@@ -5,7 +5,6 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 
@@ -19,11 +18,12 @@ RSpec.configure do |config|
 end
 
 def disable_spawning
-  Open3.stub(:capture3).and_raise("Spawning is not permitted in specs.  Please change your spec to use expectations/stubs.")
+  allow(Open3).to receive(:capture3)
+    .and_raise("Spawning is not permitted in specs.  Please change your spec to use expectations/stubs.")
 end
 
 def enable_spawning
-  Open3.stub(:capture3).and_call_original
+  allow(Open3).to receive(:capture3).and_call_original
 end
 
 begin

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: awesome_spawn
 version: !ruby/object:Gem::Version
-  version: 1.2.1
-  prerelease: 
+  version: 1.3.0
 platform: ruby
 authors:
 - Jason Frey
@@ -12,12 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2015-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -25,7 +23,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -33,49 +30,43 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: AwesomeSpawn is a module that provides some useful features over Ruby's
@@ -94,43 +85,47 @@ files:
 - lib/awesome_spawn/command_result.rb
 - lib/awesome_spawn/command_result_error.rb
 - lib/awesome_spawn/no_such_file_error.rb
+- lib/awesome_spawn/null_logger.rb
 - lib/awesome_spawn/version.rb
 - .yardopts
 - README.md
 - LICENSE.txt
 - spec/awesome_spawn_spec.rb
 - spec/command_line_builder_spec.rb
+- spec/command_result_error_spec.rb
 - spec/command_result_spec.rb
+- spec/no_such_file_error_spec.rb
 - spec/spec_helper.rb
 - .rspec
 homepage: https://github.com/ManageIQ/awesome_spawn
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: AwesomeSpawn is a module that provides some useful features over Ruby's Kernel.spawn.
 test_files:
 - spec/awesome_spawn_spec.rb
 - spec/command_line_builder_spec.rb
+- spec/command_result_error_spec.rb
 - spec/command_result_spec.rb
+- spec/no_such_file_error_spec.rb
 - spec/spec_helper.rb
 - .rspec