unravel 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afd743ff5179fe977b6debe400556ab59ad99670
-  data.tar.gz: 6695e4301a3613543d2c8dd8010575bb6cf11493
+  metadata.gz: 45a416271c45d03fd6342e3296481e60d966df23
+  data.tar.gz: 5268e00db454da494c02ca35dcadd1bccbd27371
 SHA512:
-  metadata.gz: 6f36434d71cbd49e18c1fd821e57c924d6d84aa21bf5d26b811fe7912449b745ecaca0010a71116d498980e9c88535da35a2d56e596aa8530e986c41bb38e95e
-  data.tar.gz: efe37ac90793b627fa77656f536cb216bb4cc29162be7ae06277a118a48ebbc54b888988d047e82187a8d5d17129a5df38c69ab5a313b0bc23faff168bf68ed6
+  metadata.gz: dca889ad5427a5173cbbe2545a2b997c89b25a63c2c2ef4eaee2c3da4a347e6a78fcfebc746a2c954094aa52dd12d4fcc10750839b52dc28e704e879a47a8731
+  data.tar.gz: 8b0b5d637a46caafa23e478218355460ab08db89c1c823b69c90718ee14b88a305512d8868d3857af29f69a912ef488168ce3e71ed35493f2222d24ef42b5211

data/README.md

@@ -1,3 +1,5 @@
+Ruby lib for easily defining solutions for non-deterministic problems caused by interdependent "black-box" components
+
 Sorry ...
 
 - not ready for production yet

data/lib/unravel.rb

@@ -21,6 +21,19 @@ module Unravel
   class NoKnownRootCause < HumanInterventionNeeded ; end
   class SameCauseReoccurringCause < HumanInterventionNeeded; end
 
+  class NoErrorHandler
+    attr_reader :name
+    attr_reader :exception
+    def initialize(name, ex)
+      @name = name
+      @exception = ex
+    end
+
+    def message
+      "Achievement #{name.inspect} is not declared to handle exceptions of type: #{ex.class}"
+    end
+  end
+
   class Registry
     attr_reader :achievements, :symptoms, :fixes, :contexts, :errors
 
@@ -32,14 +45,18 @@ module Unravel
       @errors = {}
     end
 
-    def get_fix(name)
-      @fixes[name].tap do |cause|
-        fail HumanInterventionNeeded, "No fix for: #{name}" unless cause
-      end
+    def has_fix_for?(cause)
+      @fixes.key?(cause)
+    end
+
+    def get_fix_for(cause)
+      achievement_or_block = @fixes[cause]
+      fail HumanInterventionNeeded, "No fix for: #{cause}" unless achievement_or_block
+      achievement_or_block
     end
 
     def add_fix(name, block)
-      fail HumanInterventionNeeded, "fix already exists: #{name}" if @fixes.key?(name)
+      fail HumanInterventionNeeded, "fix for root cause #{name} already exists" if @fixes.key?(name)
       @fixes[name] = block
     end
 
@@ -77,39 +94,62 @@ module Unravel
   end
 
   class Session
+    class DefaultConfig
+      def max_retries
+        5
+      end
+
+      def after_achievement_success(name)
+      end
+    end
+
     attr_reader :registry
+    attr_reader :config
 
     class FixableError < RuntimeError
       attr_reader :symptom
-      def initialize(symptom_name)
+      attr_reader :extracted_info
+      def initialize(symptom_name, extracted_info)
         @symptom = symptom_name
+
+        # TODO: clean this up
+        matchdata = extracted_info
+        @extracted_info = matchdata.captures.empty? ? [] : [matchdata]
       end
     end
 
-    def initialize
+    def initialize(config = DefaultConfig.new)
+      @config = config
       @registry = Registry.new
     end
 
-    def achieve(name, max_retries = 5)
+    def achieve(name, *args)
       check # TODO: overhead?
 
       prev_causes = Set.new
+      max_retries = config.max_retries
       retries_left = max_retries
 
       begin
         Unravel.logger.info("Achieving (attempt: #{max_retries - retries_left + 1}/#{max_retries}): #{name.inspect}")
 
         block = registry.get_achievement(name)
+        if block.arity >= 0
+          unless block.arity == args.size
+            fail ArgumentError, "expected #{block.arity} args for #{name.inspect}, got: #{args.inspect}"
+          end
+        end
+
         error_contexts = registry.error_contexts_for_achievement(name)
 
         begin
-          res = return_wrap(&block)
+          res = return_wrap(*args, &block)
         rescue *error_contexts.keys
           ex = $!
           econtext = error_contexts[ex.class]
           unless econtext
             # TODO: not tested
-            fail "No error context given for #{name} to handle exception: #{ex.message}"
+            fail NoErrorHandler.new(name, ex)
           end
 
           econtext.each do |fix_name|
@@ -119,7 +159,11 @@ module Unravel
           fail
         end
 
-        return true if res == true
+        if res == true
+          config.after_achievement_success(name)
+          return true
+        end
+
         fail NotImplementedError, "#{name} unexpectedly returned #{res.inspect} (expected true or exception)"
 
       rescue FixableError => error
@@ -131,12 +175,18 @@ module Unravel
         fail NoKnownRootCause, "Can't find root cause for: #{error.symptom}, #{error.message}" unless cause
 
         Unravel.logger.info("#{name}: Cause: #{cause.inspect}")
-        if prev_causes.include? cause
-          fail SameCauseReoccurringCause, "#{cause.to_s} wasn't ultimately fixed (it occured again)"
+
+        # Since causes can be generic (parametized), they're unique based on error matchers
+        unique_context = error.extracted_info
+        unique_cause = [cause, unique_context]
+
+        if prev_causes.include? unique_cause
+          fail SameCauseReoccurringCause, "#{cause.to_s} (with #{unique_context.inspect}) wasn't ultimately fixed (it occured again)"
         end
 
-        prev_causes << cause
-        recipe_for(cause).call
+        prev_causes << unique_cause
+        fix = registry.get_fix_for(cause)
+        fix.call(error)
 
         retries_left -= 1
         retry if retries_left > 0
@@ -170,7 +220,13 @@ module Unravel
         if name.is_a?(Hash)
           name, achievement = *name.first
         end
-        fix_for(name) { achieve achievement } unless block_given?
+        # TODO: this recursively calls self (just to provied block), though -
+        # is the block_given check needed?
+        unless block_given?
+          fix_for(name)  do |error|
+            achieve(achievement, *error.extracted_info)
+          end
+        end
       end
     end
 
@@ -179,14 +235,18 @@ module Unravel
       root_cause_name = "no_#{fix_name}".to_sym
       error[error_name] = regexp
       root_cause_for error_name => root_cause_name
-      fix_for root_cause_name =>  fix_name
+      unless registry.has_fix_for?(root_cause_name)
+        fix_for root_cause_name => fix_name
+      end
       achievement fix_name, handlers, &method(fix_name)
     end
 
     private
 
-    def return_wrap(&block)
-      Thread.new { return block.yield }.join
+    def return_wrap(*args, &block)
+      Thread.new do
+        return block.yield(*args)
+      end.join
     rescue LocalJumpError => ex
       ex.exit_value
     end
@@ -213,16 +273,14 @@ module Unravel
       unless regexp
         fail HumanInterventionNeeded, "Unregistered error: #{name} to match #{error.inspect}"
       end
+
       # TODO: encoding not tested
-      fail FixableError.new(name) if regexp.match(error.force_encoding(Encoding::ASCII_8BIT))
+      match = regexp.match(error.force_encoding(Encoding::ASCII_8BIT))
+      fail FixableError.new(name, match) if match
     end
 
     def get_root_cause_for(symptom)
       registry.get_root_cause(symptom)
     end
-
-    def recipe_for(name, &block)
-      registry.get_fix(name)
-    end
   end
 end

data/lib/unravel/exec.rb

@@ -1,6 +1,35 @@
 module Unravel
   class Exec
-    class Error < Unravel::HumanInterventionNeeded; end
+    class Error < Unravel::HumanInterventionNeeded
+      class Standard < Error
+      end
+
+      class Silent < Error
+        attr_reader :exitcode
+        attr_reader :exitstatus
+        def initialize(exitcode, stdout)
+          @exitcode = exitcode
+          @stdout = stdout
+          super()
+        end
+
+        def to_s
+          message
+        end
+
+        def message
+          lines = @stdout.lines.to_a
+          output =
+            if lines.size > 1
+              indent = "\n  stdout"
+              "#{indent}: #{lines * indent}\n"
+            else
+              "stdout: #{@stdout.inspect}"
+            end
+          "No stderr available: #{output} (exited with #{@exitcode})"
+        end
+      end
+    end
   end
 
   class << self
@@ -16,10 +45,12 @@ module Unravel
       return true if status.success?
       Unravel.logger.debug "Errors from #{args.inspect}: -----"
       Unravel.logger.debug "#{error}"
-      error = out if error.strip.empty?
-      raise Exec::Error, error
+
+      # TODO: is strip a good idea?
+      raise Exec::Error::Silent.new(status.exitstatus, out) if error.strip.empty?
+      raise Exec::Error::Standard, error
     rescue Errno::ENOENT => e
-      raise Exec::Error, e.message
+      raise Exec::Error::ENOENT, e.message
     end
 
     def Capture(args)
@@ -29,9 +60,9 @@ module Unravel
       Unravel.logger.debug "Errors from #{args.inspect}: -----"
       Unravel.logger.debug "#{error}"
       error = out if error.strip.empty?
-      raise Exec::Error, error
+      raise Exec::Error::Standard, error
     rescue Errno::ENOENT => e
-      raise Exec::Error, e.message
+      raise Exec::Error::ENOENT, e.message
     end
   end
 end

data/lib/unravel/version.rb

@@ -1,3 +1,3 @@
 module Unravel
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unravel
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Cezary Baginski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-01 00:00:00.000000000 Z
+date: 2016-03-26 00:00:00.000000000 Z
 dependencies: []
 description: Tool for solving non-deterministic problems given goals, symptoms, fixes
   and root causes