cocaine 0.5.7 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 183bb99b2dc331acae17ae06bba9497305f62871
-  data.tar.gz: 7588340c94577ccc9cfbdb3061de34c0a0dbe7a7
+  metadata.gz: 4a7f83d9126ee8f5d25a7c78455dd6dff4b883c0
+  data.tar.gz: 062e9535def6a4af7f3c4b54ad4af777970e3d16
 SHA512:
-  metadata.gz: 044ce7602066d9464d844aecd01219d9f6c1a0a37e6cd3ad0a72094edbf6812770c5e98ab2d6b125be3475d4dedc336a4c603a719f3dae1fb6de8a1a01210162
-  data.tar.gz: fc8fa3d67672811b19145d4e1ef14f73d7965a2db6f4202ed2f98b8346b993521bbaf4e55d0aa2fcf18cee15cdc166813f67320b90e515033d4d2c2e5d52d594
+  metadata.gz: 23824efd971fc240abdf4a7892f923e3540dea7c1de8e524a3c45d8154c69c3526b3644920aa0c2dae946fb0c24e93366d59cfdbe44b3566be27a8e5c9eca443
+  data.tar.gz: b62558b1d765fa9da86d9cd2b70b62a9dc80eb6e99edc9582162b836035b128b8198a333baace2b731e6096764985012f24352f1930449bd8d63c2a95784db6e

data/.travis.yml

@@ -3,3 +3,4 @@ rvm:
   - 2.0.0
   - 2.1.5
   - jruby-19mode
+  - rbx-2

data/NEWS.md

@@ -1,3 +1,13 @@
+New for 0.5.7:
+
+* Feature: Allow collection of both STDOUT and STDERR.
+* Improvement: Convert arguments to strings when possible
+
+New for 0.5.6:
+
+* Bug Fix: Java does not need to run commands with `env`
+* Bug Fix: Found out we were rescuing the wrong error
+
 New for 0.5.5:
 
 * Bug Fix: Posix- and ProcessRunner respect paths *and* are thread safe!

data/lib/cocaine.rb

@@ -3,6 +3,8 @@
 require 'rbconfig'
 require 'cocaine/os_detector'
 require 'cocaine/command_line'
+require 'cocaine/command_line/output'
+require 'cocaine/command_line/multi_pipe'
 require 'cocaine/command_line/runners'
 require 'cocaine/exceptions'
 

data/lib/cocaine/command_line.rb

@@ -67,12 +67,11 @@ module Cocaine
     end
 
     def run(interpolations = {})
-      output = ''
       @exit_status = nil
       begin
         full_command = command(interpolations)
         log("#{colored("Command")} :: #{full_command}")
-        output = execute(full_command)
+        @output = execute(full_command)
       rescue Errno::ENOENT => e
         raise Cocaine::CommandNotFoundError, e.message
       ensure
@@ -86,12 +85,24 @@ module Cocaine
       unless @expected_outcodes.include?(@exit_status)
         message = [
           "Command '#{full_command}' returned #{@exit_status}. Expected #{@expected_outcodes.join(", ")}",
-          "Here is the command output:\n",
-          output
+          "Here is the command output: STDOUT:\n", command_output,
+          "\nSTDERR:\n", command_error_output
         ].join("\n")
         raise Cocaine::ExitStatusError, message
       end
-      output
+      command_output
+    end
+
+    def command_output
+      output.output
+    end
+
+    def command_error_output
+      output.error_output
+    end
+
+    def output
+      @output || Output.new
     end
 
     private
@@ -166,11 +177,13 @@ module Cocaine
 
     def shell_quote(string)
       return "" if string.nil?
+      string = string.to_s if string.respond_to? :to_s
+
       if OS.unix?
         if string.empty?
           "''"
         else
-          string.split("'").map{|m| "'#{m}'" }.join("\\'")
+          string.split("'", -1).map{|m| "'#{m}'" }.join("\\'")
         end
       else
         %{"#{string}"}

data/lib/cocaine/command_line/multi_pipe.rb

@@ -0,0 +1,50 @@
+module Cocaine
+  class CommandLine
+    class MultiPipe
+      def initialize
+        @stdout_in, @stdout_out = IO.pipe
+        @stderr_in, @stderr_out = IO.pipe
+      end
+
+      def pipe_options
+        { out: @stdout_out, err: @stderr_out }
+      end
+
+      def output
+        Output.new(@stdout_output, @stderr_output)
+      end
+
+      def read_and_then(&block)
+        close_write
+        read
+        block.call
+        close_read
+      end
+
+      private
+
+      def close_write
+        @stdout_out.close
+        @stderr_out.close
+      end
+
+      def read
+        @stdout_output = read_stream(@stdout_in)
+        @stderr_output = read_stream(@stderr_in)
+      end
+
+      def close_read
+        @stdout_in.close
+        @stderr_in.close
+      end
+
+      def read_stream(io)
+        result = ""
+        while partial_result = io.read(8192)
+          result << partial_result
+        end
+        result
+      end
+    end
+  end
+end

data/lib/cocaine/command_line/output.rb

@@ -0,0 +1,12 @@
+class Cocaine::CommandLine::Output
+  def initialize(output = nil, error_output = nil)
+    @output = output
+    @error_output = error_output
+  end
+
+  attr_reader :output, :error_output
+
+  def to_s
+    output.to_s
+  end
+end

data/lib/cocaine/command_line/runners/backticks_runner.rb

@@ -15,7 +15,7 @@ module Cocaine
 
       def call(command, env = {}, options = {})
         with_modified_environment(env) do
-          `#{command}`
+          Output.new(`#{command}`)
         end
       end
 

data/lib/cocaine/command_line/runners/fake_runner.rb

@@ -19,13 +19,12 @@ module Cocaine
 
       def call(command, env = {}, options = {})
         commands << [command, env]
-        ""
+        Output.new("")
       end
 
       def ran?(predicate_command)
-        @commands.any?{|(command, env)| command =~ Regexp.new(predicate_command) }
+        @commands.any?{|(command, _)| command =~ Regexp.new(predicate_command) }
       end
-
     end
   end
 end

data/lib/cocaine/command_line/runners/popen_runner.rb

@@ -14,7 +14,7 @@ module Cocaine
       def call(command, env = {}, options = {})
         with_modified_environment(env) do
           IO.popen(command, "r", options) do |pipe|
-            pipe.read
+            Output.new(pipe.read)
           end
         end
       end

data/lib/cocaine/command_line/runners/posix_runner.rb

@@ -18,17 +18,12 @@ module Cocaine
       end
 
       def call(command, env = {}, options = {})
-        input, output = IO.pipe
-        options[:out] = output
-        pid = spawn(env, command, options)
-        output.close
-        result = ""
-        while partial_result = input.read(8192)
-          result << partial_result
+        pipe = MultiPipe.new
+        pid = spawn(env, command, options.merge(pipe.pipe_options))
+        pipe.read_and_then do
+          waitpid(pid)
         end
-        waitpid(pid)
-        input.close
-        result
+        pipe.output
       end
 
       private

data/lib/cocaine/command_line/runners/process_runner.rb

@@ -16,14 +16,12 @@ module Cocaine
       end
 
       def call(command, env = {}, options = {})
-        input, output = IO.pipe
-        options[:out] = output
-        pid = spawn(env, command, options)
-        output.close
-        result = input.read
-        waitpid(pid)
-        input.close
-        result
+        pipe = MultiPipe.new
+        pid = spawn(env, command, options.merge(pipe.pipe_options))
+        pipe.read_and_then do
+          waitpid(pid)
+        end
+        pipe.output
       end
 
       private

data/lib/cocaine/version.rb

@@ -1,5 +1,5 @@
 # coding: UTF-8
 
 module Cocaine
-  VERSION = "0.5.7".freeze
+  VERSION = "0.5.8".freeze
 end

data/spec/cocaine/command_line/output_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Cocaine::CommandLine::Output do
+  it 'holds an input and error stream' do
+    output = Cocaine::CommandLine::Output.new(:a, :b)
+    expect(output.output).to eq :a
+    expect(output.error_output).to eq :b
+  end
+
+  it 'calls #to_s on the output when you call #to_s on it' do
+    output = Cocaine::CommandLine::Output.new(:a, :b)
+    expect(output.to_s).to eq 'a'
+  end
+end

data/spec/cocaine/command_line/runners/backticks_runner_spec.rb

@@ -4,12 +4,14 @@ describe Cocaine::CommandLine::BackticksRunner do
   if Cocaine::CommandLine::BackticksRunner.supported?
     it_behaves_like 'a command that does not block'
 
-    it 'runs the command given' do
-      subject.call("echo hello").should == "hello\n"
+    it 'runs the command given and captures the output in an Output' do
+      output = subject.call("echo hello")
+      expect(output).to have_output "hello\n"
     end
 
     it 'modifies the environment and runs the command given' do
-      subject.call("echo $yes", {"yes" => "no"}).should == "no\n"
+      output = subject.call("echo $yes", {"yes" => "no"})
+      expect(output).to have_output "no\n"
     end
 
     it 'sets the exitstatus when a command completes' do

data/spec/cocaine/command_line/runners/popen_runner_spec.rb

@@ -4,12 +4,14 @@ describe Cocaine::CommandLine::PopenRunner do
   if Cocaine::CommandLine::PopenRunner.supported?
     it_behaves_like 'a command that does not block'
 
-    it 'runs the command given' do
-      subject.call("echo hello").should == "hello\n"
+    it 'runs the command given and captures the output in an Output' do
+      output = subject.call("echo hello")
+      expect(output).to have_output "hello\n"
     end
 
     it 'modifies the environment and runs the command given' do
-      subject.call("echo $yes", {"yes" => "no"}).should == "no\n"
+      output = subject.call("echo $yes", {"yes" => "no"})
+      expect(output).to have_output "no\n"
     end
 
     it 'sets the exitstatus when a command completes' do

data/spec/cocaine/command_line/runners/posix_runner_spec.rb

@@ -4,12 +4,19 @@ describe Cocaine::CommandLine::PosixRunner do
   if Cocaine::CommandLine::PosixRunner.supported?
     it_behaves_like 'a command that does not block'
 
-    it 'runs the command given' do
-      subject.call("echo hello").should == "hello\n"
+    it 'runs the command given and captures the output' do
+      output = subject.call("echo hello")
+      expect(output).to have_output "hello\n"
+    end
+
+    it 'runs the command given and captures the error output' do
+      output = subject.call("echo hello 1>&2")
+      expect(output).to have_error_output "hello\n"
     end
 
     it 'modifies the environment and runs the command given' do
-      subject.call("echo $yes", {"yes" => "no"}).should == "no\n"
+      output = subject.call("echo $yes", {"yes" => "no"})
+      expect(output).to have_output "no\n"
     end
 
     it 'sets the exitstatus when a command completes' do
@@ -18,5 +25,16 @@ describe Cocaine::CommandLine::PosixRunner do
       subject.call("ruby -e 'exit 5'")
       $?.exitstatus.should == 5
     end
+
+    it "runs the command it's given and allows access to stderr afterwards" do
+      cmd = Cocaine::CommandLine.new(
+        "ruby",
+        "-e '$stdout.puts %{hello}; $stderr.puts %{goodbye}'",
+        :swallow_stderr => false
+      )
+      cmd.run
+      expect(cmd.command_output).to eq "hello\n"
+      expect(cmd.command_error_output).to eq "goodbye\n"
+    end
   end
 end

data/spec/cocaine/command_line/runners/process_runner_spec.rb

@@ -4,12 +4,19 @@ describe Cocaine::CommandLine::ProcessRunner do
   if Cocaine::CommandLine::ProcessRunner.supported?
     it_behaves_like "a command that does not block"
 
-    it 'runs the command given' do
-      subject.call("echo hello").should == "hello\n"
+    it 'runs the command given and captures the output' do
+      output = subject.call("echo hello")
+      expect(output).to have_output "hello\n"
+    end
+
+    it 'runs the command given and captures the error output' do
+      output = subject.call("echo hello 1>&2")
+      expect(output).to have_error_output "hello\n"
     end
 
     it 'modifies the environment and runs the command given' do
-      subject.call("echo $yes", {"yes" => "no"}).should == "no\n"
+      output = subject.call("echo $yes", {"yes" => "no"})
+      expect(output).to have_output "no\n"
     end
 
     it 'sets the exitstatus when a command completes' do
@@ -18,5 +25,16 @@ describe Cocaine::CommandLine::ProcessRunner do
       subject.call("ruby -e 'exit 5'")
       $?.exitstatus.should == 5
     end
+
+    it "runs the command it's given and allows access to stderr afterwards" do
+      cmd = Cocaine::CommandLine.new(
+        "ruby",
+        "-e '$stdout.puts %{hello}; $stderr.puts %{goodbye}'",
+        :swallow_stderr => false
+      )
+      cmd.run
+      expect(cmd.command_output).to eq "hello\n"
+      expect(cmd.command_error_output).to eq "goodbye\n"
+    end
   end
 end

data/spec/cocaine/command_line_spec.rb

@@ -95,8 +95,8 @@ describe Cocaine::CommandLine do
     cmd = Cocaine::CommandLine.new("convert",
                                    ":one :two",
                                    :swallow_stderr => false)
-    command_string = cmd.command(:one => "`rm -rf`.jpg", :two => "ha'ha.png")
-    command_string.should == "convert '`rm -rf`.jpg' 'ha'\\''ha.png'"
+    command_string = cmd.command(:one => "`rm -rf`.jpg", :two => "ha'ha.png'")
+    command_string.should == "convert '`rm -rf`.jpg' 'ha'\\''ha.png'\\'''"
   end
 
   it 'cannot recursively introduce a place where user-supplied commands can run' do
@@ -126,6 +126,12 @@ describe Cocaine::CommandLine do
     cmd.command.should == "convert 'a.jpg' xc:black 'b.jpg'"
   end
 
+  it 'handles symbols in user supplied values' do
+    cmd = Cocaine::CommandLine.new("echo", ":foo")
+    command_string = cmd.command(:foo => :bar)
+    command_string.should == "echo 'bar'"
+  end
+
   it "can redirect stderr to the bit bucket if requested" do
     cmd = Cocaine::CommandLine.new("convert",
                                    "a.jpg b.png",
@@ -143,12 +149,15 @@ describe Cocaine::CommandLine do
     cmd.command.should == "convert a.jpg b.png 2>NUL"
   end
 
-  it "runs the command it's given and return the output" do
-    cmd = Cocaine::CommandLine.new("convert", "a.jpg b.png", :swallow_stderr => false)
-    cmd.stubs(:execute).with("convert a.jpg b.png").returns(:correct_value)
-    with_exitstatus_returning(0) do
-      cmd.run.should == :correct_value
-    end
+  it "runs the command it's given and returns the output" do
+    cmd = Cocaine::CommandLine.new("echo", "hello", :swallow_stderr => false)
+    expect(cmd.run).to eq "hello\n"
+  end
+
+  it "runs the command it's given and allows access to stdout afterwards" do
+    cmd = Cocaine::CommandLine.new("echo", "hello", :swallow_stderr => false)
+    cmd.run
+    expect(cmd.command_output).to eq "hello\n"
   end
 
   it "colorizes the output to a tty" do

data/spec/cocaine/errors_spec.rb

@@ -1,47 +1,40 @@
 require 'spec_helper'
 
 describe "When an error happens" do
-  it "raises a CommandLineError if the result code from the command isn't expected" do
-    cmd = Cocaine::CommandLine.new("convert", "a.jpg b.png", :swallow_stderr => false)
-    cmd.stubs(:execute).with("convert a.jpg b.png").returns(:correct_value)
+  it "raises a CommandLineError if the result code command isn't expected" do
+    cmd = Cocaine::CommandLine.new("echo", "hello")
+    cmd.stubs(:execute)
     with_exitstatus_returning(1) do
-      lambda do
-        cmd.run
-      end.should raise_error(Cocaine::CommandLineError)
+      lambda { cmd.run }.should raise_error(Cocaine::CommandLineError)
     end
   end
 
   it "does not raise if the result code is expected, even if nonzero" do
-    cmd = Cocaine::CommandLine.new("convert",
-                                   "a.jpg b.png",
-                                   :expected_outcodes => [0, 1],
-                                   :swallow_stderr => false)
-    cmd.stubs(:execute).with("convert a.jpg b.png").returns(:correct_value)
+    cmd = Cocaine::CommandLine.new("echo", "hello", expected_outcodes: [0, 1])
+    cmd.stubs(:execute)
     with_exitstatus_returning(1) do
-      lambda do
-        cmd.run
-      end.should_not raise_error
+      lambda { cmd.run }.should_not raise_error
     end
   end
 
   it "adds command output to exception message if the result code is nonzero" do
-    cmd = Cocaine::CommandLine.new("convert",
-                                   "a.jpg b.png",
-                                   :swallow_stderr => false)
+    cmd = Cocaine::CommandLine.new("echo", "hello")
     error_output = "Error 315"
-    cmd.stubs(:execute).with("convert a.jpg b.png").returns(error_output)
+    cmd.
+      stubs(:execute).
+      returns(Cocaine::CommandLine::Output.new("", error_output))
     with_exitstatus_returning(1) do
       begin
         cmd.run
       rescue Cocaine::ExitStatusError => e
-        e.message.should =~ /#{error_output}/
+        e.message.should =~ /STDERR:\s+#{error_output}/
       end
     end
   end
 
-  it 'passes error message to the exception when command fails with Errno::ENOENT' do
+  it 'passes the error message to the exception when command is not found' do
     cmd = Cocaine::CommandLine.new('test', '')
-    cmd.stubs(:execute).with('test').raises(Errno::ENOENT.new("not found"))
+    cmd.stubs(:execute).raises(Errno::ENOENT.new("not found"))
     begin
       cmd.run
     rescue Cocaine::CommandNotFoundError => e
@@ -58,7 +51,7 @@ describe "When an error happens" do
     cmd.exit_status.should == 1
   end
 
-  it "does not blow up if running the command errored before the actual execution" do
+  it "does not blow up if running the command errored before execution" do
     assuming_no_processes_have_been_run
     command = Cocaine::CommandLine.new("echo", ":hello_world")
     command.stubs(:command).raises("An Error")

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ require 'timeout'
 require 'tempfile'
 require 'pry'
 require 'thread'
+require 'pathname'
 
 begin; require 'active_support/logger'; rescue LoadError; end
 begin; require 'active_support/buffered_logger'; rescue LoadError; end

data/spec/support/have_output.rb

@@ -0,0 +1,11 @@
+RSpec::Matchers.define :have_output do |expected|
+  match do |actual|
+    actual.output == expected
+  end
+end
+
+RSpec::Matchers.define :have_error_output do |expected|
+  match do |actual|
+    actual.error_output == expected
+  end
+end

data/spec/support/nonblocking_examples.rb

@@ -6,7 +6,7 @@ shared_examples_for "a command that does not block" do
     Timeout.timeout(5) do
       output = subject.call("cat '#{garbage_file.path}'")
       $?.exitstatus.should == 0
-      output.length.should == 10 * 1024 * 1024
+      output.output.length.should == 10 * 1024 * 1024
     end
 
     garbage_file.close

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocaine
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.5.8
 platform: ruby
 authors:
 - Jon Yurek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -137,6 +137,8 @@ files:
 - cocaine.gemspec
 - lib/cocaine.rb
 - lib/cocaine/command_line.rb
+- lib/cocaine/command_line/multi_pipe.rb
+- lib/cocaine/command_line/output.rb
 - lib/cocaine/command_line/runners.rb
 - lib/cocaine/command_line/runners/backticks_runner.rb
 - lib/cocaine/command_line/runners/fake_runner.rb
@@ -146,6 +148,7 @@ files:
 - lib/cocaine/exceptions.rb
 - lib/cocaine/os_detector.rb
 - lib/cocaine/version.rb
+- spec/cocaine/command_line/output_spec.rb
 - spec/cocaine/command_line/runners/backticks_runner_spec.rb
 - spec/cocaine/command_line/runners/fake_runner_spec.rb
 - spec/cocaine/command_line/runners/popen_runner_spec.rb
@@ -157,6 +160,7 @@ files:
 - spec/cocaine/runners_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_logger.rb
+- spec/support/have_output.rb
 - spec/support/nonblocking_examples.rb
 - spec/support/stub_os.rb
 - spec/support/unsetting_exitstatus.rb
@@ -181,11 +185,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A small library for doing (command) lines
 test_files:
+- spec/cocaine/command_line/output_spec.rb
 - spec/cocaine/command_line/runners/backticks_runner_spec.rb
 - spec/cocaine/command_line/runners/fake_runner_spec.rb
 - spec/cocaine/command_line/runners/popen_runner_spec.rb
@@ -197,6 +202,7 @@ test_files:
 - spec/cocaine/runners_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_logger.rb
+- spec/support/have_output.rb
 - spec/support/nonblocking_examples.rb
 - spec/support/stub_os.rb
 - spec/support/unsetting_exitstatus.rb