Fingertips-executioner 0.1.0 → 0.2.0

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 1
+:minor: 2
 :patch: 0
 :major: 0

data/lib/executioner.rb

@@ -16,7 +16,7 @@ module Executioner
   end
   
   def execute(command, options={})
-    options[:switch_stdout_and_stderr] = false if options[:switch_stdout_and_stderr].nil?
+    command = "#{options[:env].map { |k,v| "#{k}='#{v}'" }.join(' ')} #{command}" if options[:env]
     
     Executioner.logger.debug("Executing: `#{command}'") if Executioner.logger
     
@@ -56,8 +56,8 @@ module Executioner
   
   module ClassMethods
     def executable(executable, options={})
-      options[:switch_stdout_and_stderr] = false if options[:switch_stdout_and_stderr].nil?
-      options[:use_queue]                = false if options[:use_queue].nil?
+      options[:switch_stdout_and_stderr] ||= false
+      options[:use_queue]                ||= false
       
       executable = executable.to_s if executable.is_a? Symbol
       use_queue = options.delete(:use_queue)
@@ -76,13 +76,13 @@ module Executioner
         if use_queue
           body = "queue(\"#{executable_path} \#{args}\")"
         else
-          body = "execute(\"#{executable_path} \#{args}\", #{options.inspect})"
+          body = "execute(\"#{executable_path} \#{args}\", #{options.inspect}.merge(options))"
         end
       else
         body = "raise Executioner::ExecutableNotFoundError, \"Unable to find the executable '#{executable}' in: #{Executioner::SEARCH_PATHS.join(', ')}\""
       end
       
-      class_eval "def #{executable.gsub(/-/, '_')}(args); #{body}; end", __FILE__, __LINE__
+      class_eval "def #{executable.gsub(/-/, '_')}(args, options = {}); #{body}; end", __FILE__, __LINE__
     end
     
     def find_executable(executable, advance_from = nil)

data/test/executioner_test.rb

@@ -6,18 +6,64 @@ class AClassThatUsesSubshells
   executable :doesnotexistforsure
   executable 'executable-with-dash'
   executable :with_path, :path => '/path/to/executable'
+  executable :with_env,  :path => '/path/to/executable', :env => { :foo => 'bar' }
+  
+  public :execute
 end
 
-describe "Executioner, the module" do
-  it "should assign an optional logger" do
+describe "Executioner, when executing" do
+  before do
+    @object = AClassThatUsesSubshells.new
+  end
+  
+  it "should open a pipe with the given command" do
+    Open3.expects(:popen3).with('/the/command')
+    @object.execute('/the/command')
+  end
+  
+  it "should return the output received from stdout" do
+    stub_popen3 'stdout output', ''
+    @object.execute('/the/command').should == 'stdout output'
+  end
+  
+  it "should return the output received from stderr if they should be reversed" do
+    stub_popen3 '', 'stderr output'
+    @object.execute('/the/command', :switch_stdout_and_stderr => true).should == 'stderr output'
+  end
+  
+  it "should raise a Executioner::ProcessError if stdout is empty and stderr is not" do
+    stub_popen3 '', 'stderr output'
+    lambda { @object.execute('foo') }.should.raise Executioner::ProcessError
+  end
+  
+  it "should raise a Executioner::ProcessError if stderr is empty and stdout is not and the streams are reversed" do
+    stub_popen3 'stdout output', ''
+    lambda { @object.execute('foo', :switch_stdout_and_stderr => true) }.should.raise Executioner::ProcessError
+  end
+  
+  it "should prepend the given env variables" do
+    Open3.expects(:popen3).with("foo='bar' /the/command")
+    @object.execute('/the/command', :env => { :foo => :bar })
+  end
+  
+  it "should log the command that's going to be executed if a logger is available" do
     begin
-      logger = Object.new
+      logger = mock('Logger')
       Executioner.logger = logger
-      Executioner.logger.should.be logger
+      
+      logger.expects(:debug).with("Executing: `foo'")
+      stub_popen3
+      @object.execute('foo')
     ensure
       Executioner.logger = nil
     end
   end
+  
+  private
+  
+  def stub_popen3(stdout = '', stderr = '')
+    Open3.stubs(:popen3).yields(*['stdin', stdout, stderr].map { |s| StringIO.new(s) })
+  end
 end
 
 describe "Executioner, instance methods" do
@@ -76,7 +122,7 @@ describe "Executioner, class methods" do
   end
   
   it "should define an instance method which calls #execute with the correct path to the executable" do
-    @object.expects(:execute).with('/bin/sh with some args', {:switch_stdout_and_stderr => false})
+    @object.expects(:execute).with('/bin/sh with some args', { :switch_stdout_and_stderr => false })
     @object.sh 'with some args'
   end
   
@@ -85,13 +131,13 @@ describe "Executioner, class methods" do
   end
   
   it "should be possible to switch stdin and stderr" do
-    AClassThatUsesSubshells.class_eval { executable(:sh, {:switch_stdout_and_stderr => true}) }
-    @object.expects(:execute).with('/bin/sh with some args', {:switch_stdout_and_stderr => true})
+    AClassThatUsesSubshells.class_eval { executable(:sh, { :switch_stdout_and_stderr => true }) }
+    @object.expects(:execute).with('/bin/sh with some args', { :switch_stdout_and_stderr => true })
     @object.sh 'with some args'
   end
   
   it "should be possible to use the queue by default" do
-    AClassThatUsesSubshells.class_eval { executable(:sh, {:use_queue => true}) }
+    AClassThatUsesSubshells.class_eval { executable(:sh, { :use_queue => true }) }
     @object.expects(:execute).with('/bin/sh arg1 && /bin/sh arg2', {})
     @object.sh 'arg1'
     @object.sh 'arg2'
@@ -103,6 +149,16 @@ describe "Executioner, class methods" do
     @object.with_path 'arg1'
   end
   
+  it "should be possible to specify the env that's to be prepended to the command" do
+    @object.expects(:execute).with { |command, options| options[:env] == { :foo => 'bar' } }
+    @object.with_env 'arg1'
+  end
+  
+  it "should merge options onto the default options" do
+    @object.expects(:execute).with { |command, options| options[:env] == { :foo => 'foo' } }
+    @object.with_env 'arg1', :env => { :foo => 'foo' }
+  end
+  
   it "should be possible to find an executable" do
     File.stubs(:exist?).with('/bin/sh').returns(true)
     Executioner::ClassMethods.find_executable('sh').should == '/bin/sh'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Fingertips-executioner
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Eloy Duran