kommando 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96fe9669f6508544674dd94b73b3b8c9cf34ae8f
-  data.tar.gz: 9a58c3f6946f95ac9edf60d55a2cdf47e15fdd40
+  metadata.gz: ea4177fe69b2dda93641ad54157d9c917cbcd322
+  data.tar.gz: a2c071b228bc3c5b48749d42a5fd5af0be41e2b1
 SHA512:
-  metadata.gz: 50c8bd2ffb7986a0ee4c3abf75ef39b650e035e506d475930d6ec81da4a06fa90378cf9f9ecd4bd9c7a42a6c27962ec0ab8df24b0a0450de260bd2cd8aa1b7dc
-  data.tar.gz: a52c9187140f7964d8f0f6e6dba3191f78dc95b6984d07d056b3268a3beb08926d770eccb27d7b0e9e4fdec37373b17257f5c5346f09a974947159cf08bc7531
+  metadata.gz: d52dc37e74ee347302f53a8f320898eb2470afe68588cd67988544142286928b0bf8f880e3a21302c2a7c41f61faf80e53a512caaad0fd244f2af93e98aa0362
+  data.tar.gz: 2aaff338413e4dedbe9ecd44e3c5507e24a24e8274e38de22ff2ba82ddc967a6b230fa1a833723ba5fac0fa5eec3d59bebe5ff7a19663f8b31b0e5afb6c0fed7

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 0.0.16
+Error callback, optional retry running.
+
+- FEAT: Retry a certain ThreadError case with `Kommando.run "uptime", {retry: {times: 3}}`
+- FEAT: Optionally perform sleep before the retry with `Kommando.run "uptime", {retry: {times: 3, sleep: 2}}`
+- FEAT: Callback names are validated.
+- FEAT: Callback `k.when :error block` on all known and unknown error states.
+- EXAMPLES: `when.rb` updated
+
 ## 0.0.15
 Exit and timeout callbacks, output shorthand.
 

data/examples/when.rb

@@ -29,4 +29,66 @@ raise "got_start not set" unless got_start
 raise "got_start_when_given_as_symbol not set" unless got_start_when_given_as_symbol
 raise "got_exit not set" unless got_exit
 
+k = Kommando.new "not_existing_command_with non_existing_args"
+
+got_error = false
+k.when :error do
+  puts ":error"
+  got_error = true
+end
+
+begin
+  k.run
+rescue
+end
+
+raise "got_error not set" unless got_error
+
+
+k = Kommando.new "thread_not_available_situation_for_example_in_heroku", {
+  retry: {
+    times: 3
+  }
+}
+
+k.define_singleton_method :make_pty_testable do
+  raise ThreadError, "can't create Thread: Resource temporarily unavailable"
+end
+
+got_retry_times = 0
+got_error_times = 0
+k.when :retry do
+  got_retry_times += 1
+end
+k.when :error do
+  got_error_times += 1
+end
+
+begin
+  k.run
+rescue
+end
+
+raise "got_retry_times not 3 (is #{got_retry_times})" unless got_retry_times == 3
+raise "got_error_times not 1" unless got_error_times == 1
+
+
+k = Kommando.new "thread_not_available_situation_for_example_in_heroku", {
+  retry: {
+    times: 1,
+    sleep: 0.5
+  }
+}
+
+k.define_singleton_method :make_pty_testable do
+  raise ThreadError, "can't create Thread: Resource temporarily unavailable"
+end
+
+started = Time.now
+begin
+  k.run
+rescue
+end
+delta = (Time.now-started).round(1)
+raise "sleep does not work (delta is: #{delta})" unless delta == 0.5
 puts "end"

data/lib/kommando.rb

@@ -4,6 +4,7 @@ require "timeout"
 require_relative "kommando/error"
 require_relative "kommando/version"
 require_relative "kommando/buffer"
+require_relative "kommando/when"
 
 class Kommando
   class << self
@@ -43,13 +44,24 @@ class Kommando
     end
     @timeout_happened = false
     @kill_happened = false
+    @rescue_happened = false
 
     @env = opts[:env] || {}
 
     @code = nil
     @executed = false
 
-    @retry = opts[:retry] == true
+    if opts[:retry]
+      if opts[:retry][:times]
+        @retry_times_total = opts[:retry][:times]
+        @retry_time = @retry_times_total
+      end
+      if opts[:retry][:sleep]
+        @retry_sleep = opts[:retry][:sleep]
+      end
+    end
+
+    @start_fired = false
 
     @thread = nil
     @pid = nil
@@ -60,6 +72,7 @@ class Kommando
     @matcher_buffer = ""
 
     @whens = {}
+    @when = When.new
   end
 
   def run_async
@@ -119,12 +132,7 @@ class Kommando
     end
 
     begin
-      PTY.spawn(command, *interpolated_args) do |stdout, stdin, pid|
-        if @retry && stdout.eof?
-          @executed = false
-          return run
-        end
-
+      make_pty_testable.spawn(command, *interpolated_args) do |stdout, stdin, pid|
         @pid = pid
 
         if @output_file
@@ -182,11 +190,7 @@ class Kommando
           end
         end
 
-        if @whens[:start]
-          @whens[:start].each do |block|
-            block.call
-          end
-        end
+        @when.fire :start unless @start_fired
 
         if @timeout
           begin
@@ -223,22 +227,33 @@ class Kommando
     rescue RuntimeError => ex
       if ex.message == "can't get Master/Slave device"
         #suppress, weird stuff.
+        @rescue_happened = true
+      else
+        raise ex
       end
-    rescue Errno::ENOENT => ex
-      raise Kommando::Error, "Command '#{command}' not found"
-    end
+    rescue ThreadError => ex
+      if ex.message == "can't create Thread: Resource temporarily unavailable"
+        if @retry_time && @retry_time > 0
+          @executed = false
+          @retry_time -= 1
+          sleep @retry_sleep if @retry_sleep
+          @when.fire :retry
+          return run
+        end
 
-    if @whens[:timeout]
-      @whens[:timeout].each do |block|
-        block.call
+        raise_after_callbacks(ex)
+      else
+        raise_after_callbacks(ex)
       end
+    rescue Errno::ENOENT => ex
+      @when.fire :error
+      raise Kommando::Error, "Command '#{command}' not found"
+    ensure
+      @when.fire :error if @rescue_happened
     end
 
-    if @whens[:exit]
-      @whens[:exit].each do |block|
-        block.call
-      end
-    end
+    @when.fire :timeout if @timeout_happened
+    @when.fire :exit
 
     true
   end
@@ -272,10 +287,18 @@ class Kommando
   end
 
   def when(event, &block)
-    @whens[event.to_sym] = if @whens[event.to_sym]
-      @whens[event.to_sym] << block
-    else
-      [block]
-    end
+    @when.register event, block
+  end
+
+  private
+
+  def raise_after_callbacks(exception)
+    @when.fire :error
+    @when.fire :exit
+    raise exception
+  end
+
+  def make_pty_testable
+    PTY
   end
 end

data/lib/kommando/version.rb

@@ -1,3 +1,3 @@
 class Kommando
-  VERSION = "0.0.15"
+  VERSION = "0.0.16"
 end

data/lib/kommando/when.rb

@@ -0,0 +1,34 @@
+class Kommando::When
+  VALID_EVENTS = :start, :retry, :timeout, :error, :exit
+
+  def initialize
+    @whens = {}
+  end
+
+  def register(event_name, block)
+    event_name_as_sym = event_name.to_sym
+    validate_event_name(event_name_as_sym)
+
+    @whens[event_name_as_sym] = if @whens[event_name_as_sym]
+      @whens[event_name_as_sym] << block
+    else
+      [block]
+    end
+  end
+
+  def fire(event_name)
+    event_name_as_sym = event_name.to_sym
+    validate_event_name(event_name_as_sym)
+
+    return unless blocks = @whens[event_name]
+
+    blocks.each do |block|
+      block.call
+    end
+  end
+
+  private
+  def validate_event_name(event_name_as_sym)
+    raise Kommando::Error, "When '#{event_name_as_sym}' is not known." unless VALID_EVENTS.include? event_name_as_sym
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kommando
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - Matti Paksula
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2016-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -141,6 +141,7 @@ files:
 - lib/kommando/buffer.rb
 - lib/kommando/error.rb
 - lib/kommando/version.rb
+- lib/kommando/when.rb
 - tests/forever_true.rb
 - tests/forever_uptime.rb
 homepage: http://github.com/matti/kommando