resque_jobs_tree 0.0.2 → 0.1.0

data/README.md

@@ -51,10 +51,21 @@ Organise each sequences of jobs into a single file
 
 This code is defining the tree, then when it launches the sequence of jobs, it:
 * stocks in Redis all the Resque jobs which needs to be done including the needed parameters to run them.
-* stokcs in Redis the childhood relationsips between them.
+* stocks in Redis the childhood relationsips between them.
 * enqueues in Resque the jobs which are the leaves of the tree
 
-The rule: the name of a tree of jobs should be uniq, and the name of a node should be uniq in a scope of a tree.
+Limitations:
+
+* the name of a tree of jobs should be uniq
+* the name of a node should be uniq in a scope of a tree.
+* the running jobs are identified by a their tree, their name and their resources.
+So they should not overlap. In other words, for the same node,
+you can't enqueue 2 times `[:mail, User.first]`
+
+Node options:
+
+* `{ async: true }` if you need your process to wait for an outsider to continue.
+* `{ continue_on_fail: true}` if your process can continue even after a fail during a job.
 
 ## Contributing
 

data/lib/resque_jobs_tree/factory.rb

@@ -8,6 +8,7 @@ module ResqueJobsTree::Factory
     ResqueJobsTree::Tree.new(name).tap do |tree|
       @trees << tree
       tree.instance_eval &block
+      tree.validate!
     end
   end
 

data/lib/resque_jobs_tree/job.rb

@@ -3,28 +3,42 @@ class ResqueJobsTree::Job
   class << self
 
     def perform *args
-      tree, node, resources = tree_node_and_resources(*args)
+      node, resources = tree_node_and_resources(args)
       node.perform.call resources
     end
 
     private
 
     def after_perform_enqueue_parent *args
-      tree, node, resources = tree_node_and_resources(*args)
+      node, resources = tree_node_and_resources(args)
       unless node.root?
-        parent_job_args = ResqueJobsTree::Storage.parent_job_args node, resources
         ResqueJobsTree::Storage.remove(node, resources) do
-          Resque.enqueue_to tree.name, ResqueJobsTree::Job, *parent_job_args
+          parent_job_args = ResqueJobsTree::Storage.parent_job_args node, resources
+          Resque.enqueue_to node.tree.name, ResqueJobsTree::Job, *parent_job_args
         end
       end
     end
 
-    def tree_node_and_resources *args
-      tree_name , job_name = args.shift(2)
+    def on_failure_cleanup exception, *args
+      node, resources = tree_node_and_resources args
+      if node.options[:continue_on_failure]
+        begin
+          after_perform_enqueue_parent *args
+        ensure
+          ResqueJobsTree::Storage.cleanup node, resources
+        end
+      else
+        ResqueJobsTree::Storage.cleanup node, resources, global: true
+        raise exception
+      end
+    end
+
+    def tree_node_and_resources args
+      tree_name , job_name = args[0..1]
       tree                 = ResqueJobsTree::Factory.find_tree_by_name tree_name
       node                 = tree.find_node_by_name job_name
-      resources            = ResqueJobsTree::ResourcesSerializer.to_resources args
-      [tree, node, resources]
+      resources            = ResqueJobsTree::ResourcesSerializer.to_resources args[2..-1]
+      [node, resources]
     end
 
   end

data/lib/resque_jobs_tree/node.rb

@@ -1,12 +1,13 @@
 class ResqueJobsTree::Node
 
-  attr_accessor :tree, :parent, :name, :node_childs
+  attr_accessor :tree, :parent, :name, :node_childs, :options
 
   def initialize name, tree, parent=nil
     @tree        = tree
     @name        = name.to_s
     @parent      = parent
     @node_childs = []
+    @options     = {}
   end
 
   def resources &block
@@ -22,8 +23,9 @@ class ResqueJobsTree::Node
   end
 
   # Defines a child node.
-  def node name, &block
+  def node name, options={}, &block
     ResqueJobsTree::Node.new(name, tree, self).tap do |node|
+      node.options = options
       @node_childs << node
       node.instance_eval(&block) if block_given?
     end
@@ -47,7 +49,7 @@ class ResqueJobsTree::Node
       ResqueJobsTree::Storage.store self, resources, parent, parent_resources
     end
     if node_childs.empty?
-      @tree.enqueue name, *resources
+      @tree.enqueue(name, *resources) unless options[:async]
     else
       childs.call(resources).each do |name, *child_resources|
         find_node_by_name(name).launch child_resources, resources
@@ -60,4 +62,24 @@ class ResqueJobsTree::Node
     node_childs.detect{ |node| node.find_node_by_name _name }
   end
 
+  def validate!
+    if childs.kind_of?(Proc) && node_childs.empty?
+      raise ResqueJobsTree::NodeInvalid,
+        "node `#{name}` from tree `#{tree.name}` defines childs without child nodes"
+    end
+    unless perform.kind_of? Proc
+      raise ResqueJobsTree::NodeInvalid,
+        "node `#{name}` from tree `#{tree.name}` has no perform block"
+    end
+    if (tree.nodes - [self]).map(&:name).include? name
+      raise ResqueJobsTree::NodeInvalid,
+        "node name `#{name}` is already taken in tree `#{tree.name}`"
+    end
+    node_childs.each &:validate!
+  end
+
+  def nodes
+    node_childs+node_childs.map(&:nodes)
+  end
+
 end

data/lib/resque_jobs_tree/storage.rb

@@ -9,7 +9,10 @@ module ResqueJobsTree::Storage
     parent_key = key parent, parent_resources
     Resque.redis.hset PARENTS_KEY, node_key, parent_key
     childs_key = childs_key parent, parent_resources
-    Resque.redis.sadd childs_key, node_key
+    unless Resque.redis.sadd childs_key, node_key
+      raise ResqueJobsTree::JobNotUniq,
+        "Job #{parent.name} already has the child #{node.name} with resources: #{resources}"
+    end
   end
 
   def remove node, resources
@@ -20,8 +23,16 @@ module ResqueJobsTree::Storage
     end
   end
 
+  def cleanup node, resources, option={}
+    cleanup_childs node, resources
+    unless node.root?
+      remove_from_siblings node, resources
+      option[:global] ?  cleanup_parent(node, resources) : remove_parent_key(node, resources)
+    end
+  end
+
   def parent_job_args node, resources
-    JSON.load parent_key(node, resources).gsub(/JobsTree:Node:/, '')
+    args_from_key parent_key(node, resources)
   end
 
   private
@@ -59,4 +70,36 @@ module ResqueJobsTree::Storage
     Resque.redis.del key
   end
 
+  def cleanup_childs *node_info
+    key = childs_key *node_info
+    Resque.redis.smembers(key).each do |child_key|
+      cleanup *node_info_from_key(child_key)
+    end
+    Resque.redis.del key
+  end
+
+  def cleanup_parent *node_info
+    parent, parent_resources = node_info_from_key(parent_key(*node_info))
+    remove_parent_key *node_info
+    cleanup parent, parent_resources
+  end
+
+  def remove_parent_key *node_info
+    Resque.redis.hdel PARENTS_KEY, key(*node_info)
+  end
+
+  def remove_from_siblings *node_info
+    Resque.redis.srem siblings_key(*node_info), key(*node_info)
+  end
+
+  def args_from_key key
+    JSON.load key.gsub(/JobsTree:Node:/, '')
+  end
+
+  def node_info_from_key key
+    tree_name, node_name, resources = args_from_key(key)
+    node = ResqueJobsTree::Factory.find_tree_by_name(tree_name).find_node_by_name(node_name)
+    [node, resources]
+  end
+
 end

data/lib/resque_jobs_tree/tree.rb

@@ -28,6 +28,15 @@ class ResqueJobsTree::Tree
     root.find_node_by_name name.to_s
   end
 
+  def validate!
+    raise(ResqueJobsTree::TreeInvalid, "`#{name}` has no root node") unless @root
+    root.validate!
+  end
+
+  def nodes
+    [root, root.nodes].flatten
+  end
+
   private
 
   def enqueue_leaves_jobs

data/lib/resque_jobs_tree/version.rb

@@ -1,3 +1,3 @@
 module ResqueJobsTree
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/resque_jobs_tree.rb

@@ -9,4 +9,7 @@ require 'resque_jobs_tree/resources_serializer'
 require 'resque_jobs_tree/storage'
 
 module ResqueJobsTree
+  class TreeInvalid < Exception ; end
+  class NodeInvalid < Exception ; end
+  class JobNotUniq  < Exception ; end
 end

data/test/factory_test.rb

@@ -3,25 +3,7 @@ require 'test_helper'
 class FactoryTest < MiniTest::Unit::TestCase
 
   def setup
-    @tree = ResqueJobsTree::Factory.create :tree1 do
-      root :job1 do
-        perform do |*args|
-          puts 'FactoryTest job1'
-        end
-        childs do |resources|
-          [].tap do |childs|
-            3.times do
-              childs << [:job2, resources.last]
-            end
-          end
-        end
-        node :job2 do
-          perform do |*args|
-            puts 'FactoryTest job2'
-          end
-        end
-      end
-    end
+    create_tree
   end
 
   def test_tree_creation

data/test/job_test.rb

@@ -3,31 +3,13 @@ require 'test_helper'
 class JobTest < MiniTest::Unit::TestCase
 	
 	def setup
-    @tree = ResqueJobsTree::Factory.create :tree1 do
-      root :job1 do
-        perform do |*args|
-          puts 'FactoryTest job1'
-        end
-        childs do |resources|
-          [].tap do |childs|
-            3.times do
-              childs << [:job2, resources.last]
-            end
-          end
-        end
-        node :job2 do
-          perform do |*args|
-            puts 'FactoryTest job2'
-          end
-        end
-      end
-    end
+		create_tree
 		@args = [@tree.name, @tree.find_node_by_name('job1').name, 1, 2, 3]
 	end
 
 	def test_tree_node_and_resources
-		result = [@tree, @tree.find_node_by_name('job1'), [1, 2, 3]]
-		assert_equal result, ResqueJobsTree::Job.send(:tree_node_and_resources, *@args)
+		result = [@tree.find_node_by_name('job1'), [1, 2, 3]]
+		assert_equal result, ResqueJobsTree::Job.send(:tree_node_and_resources, @args)
 	end
 
 end

data/test/node_test.rb

@@ -65,4 +65,90 @@ class NodeTest < MiniTest::Unit::TestCase
     assert_equal @tree.jobs.first, ['tree1', 'node2', 1, 2, 3]
   end
 
+  def test_childs_validation
+    assert_raises ResqueJobsTree::NodeInvalid do
+      ResqueJobsTree::Factory.create :tree1 do
+        root :job1 do
+          perform {}
+          childs {}
+        end
+      end
+    end
+    ResqueJobsTree::Factory.create :tree1 do
+      root :job1 do
+        perform {}
+      end
+    end
+  end
+
+  def test_perform_validation
+    assert_raises ResqueJobsTree::NodeInvalid do
+      ResqueJobsTree::Factory.create :tree1 do
+        root :job1 do
+        end
+      end
+    end
+  end
+
+  def test_perform_validation
+    assert_raises ResqueJobsTree::NodeInvalid do
+      ResqueJobsTree::Factory.create :tree1 do
+        root :job1 do
+          perform {}
+          childs {}
+          node :job2 do
+            perform {}
+          end
+          node :job2 do
+            perform {}
+          end
+        end
+      end
+    end
+  end
+
+  def test_options
+    create_async_tree
+    options = { async: true }
+    assert_equal options, @tree.find_node_by_name(:job2).options
+  end
+
+  def test_launch_async
+    create_async_tree
+    resources = [1, 2, 3]
+    @tree.launch resources
+    assert @tree.jobs.empty?
+  end
+
+  def test_launch_continue_on_failure
+    tree = ResqueJobsTree::Factory.create :tree1 do
+      root :job1 do
+        perform { raise 'an unexpected failure' }
+        childs { [:job2] }
+        node :job2, continue_on_failure: true do
+          perform { raise 'an expected failure' }
+        end
+      end
+    end
+    resources = [1, 2, 3]
+    assert_raises RuntimeError, 'an unexpected failure' do
+      tree.launch resources
+    end
+    assert_equal [], Resque.keys
+  end
+
+  private
+
+  def create_async_tree
+    @tree = ResqueJobsTree::Factory.create :tree1 do
+      root :job1 do
+        perform { raise 'should not arrive here' }
+        childs { [:job2] }
+        node :job2, async: true do
+          perform {}
+        end
+      end
+    end
+  end
+
 end

data/test/storage_test.rb

@@ -3,25 +3,7 @@ require 'test_helper'
 class StorageTest < MiniTest::Unit::TestCase
 
 	def setup
-    @tree = ResqueJobsTree::Factory.create :tree1 do
-      root :job1 do
-        perform do |*args|
-          puts 'FactoryTest job1'
-        end
-        childs do |resources|
-          [].tap do |childs|
-            3.times do
-              childs << [:job2, resources.last]
-            end
-          end
-        end
-        node :job2 do
-          perform do |*args|
-            puts 'FactoryTest job2'
-          end
-        end
-      end
-    end
+		create_tree
 		@resources = [1, 2, 3]
 		@root = @tree.find_node_by_name(:job1)
 		@leaf = @tree.find_node_by_name(:job2)
@@ -51,6 +33,23 @@ class StorageTest < MiniTest::Unit::TestCase
 		assert_equal 2, variable
 	end
 
+	def test_store_already_stored
+		wrong_tree = ResqueJobsTree::Factory.create :tree1 do
+      root :job1 do
+        perform {}
+        childs do |resources|
+					[ [:job2], [:job2] ]
+        end
+        node :job2 do
+          perform {}
+        end
+      end
+    end
+		assert_raises ResqueJobsTree::JobNotUniq do
+			wrong_tree.launch
+		end
+	end
+
 	private
 
 	def store

data/test/test_helper.rb

@@ -9,8 +9,14 @@ $LOAD_PATH.unshift $dir + '/../lib'
 require 'resque_jobs_tree'
 $TESTING = true
 
+require 'mock_redis'
+Resque.redis = MockRedis.new
+
 Resque.inline = true
 
+#
+# Fixtures
+#
 class Model
   def id
     @id ||= rand 1000
@@ -20,14 +26,53 @@ class Model
   end
 end
 
+
 # Run resque callbacks in inline mode
 class ResqueJobsTree::Job
   class << self
     def perform_with_hook *args
-      perform_without_hook *args
-      after_perform_enqueue_parent *args
+      begin
+        perform_without_hook *args
+        after_perform_enqueue_parent *args
+      rescue => exception
+        on_failure_cleanup exception, *args
+      end
     end
     alias_method :perform_without_hook, :perform
     alias_method :perform, :perform_with_hook
   end
 end
+
+class MiniTest::Unit::TestCase
+
+  def teardown
+    redis.keys.each{ |key| redis.del key }
+  end
+
+  def create_tree
+    @tree = ResqueJobsTree::Factory.create :tree1 do
+      root :job1 do
+        perform do |*args|
+          Resque.redis.rpush 'history', 'tree1 job1'
+        end
+        childs do |resources|
+          [].tap do |childs|
+            3.times do |n|
+              childs << [:job2, n]
+            end
+          end
+        end
+        node :job2 do
+          perform do |*args|
+            Resque.redis.rpush 'history', 'tree1 job2'
+          end
+        end
+      end
+    end
+  end
+
+  def redis
+    Resque.redis
+  end
+
+end

data/test/tree_test.rb

@@ -3,25 +3,7 @@ require 'test_helper'
 class TreeTest < MiniTest::Unit::TestCase
 
   def setup
-    @tree = ResqueJobsTree::Factory.create :tree1 do
-      root :job1 do
-        perform do |*args|
-          # puts 'TreeTest job1'
-        end
-        childs do |resources|
-          [].tap do |childs|
-            3.times do
-              childs << [:job2, resources.last]
-            end
-          end
-        end
-        node :job2 do
-          perform do |*args|
-            # puts 'TreeTest job2'
-          end
-        end
-      end
-    end
+    create_tree
   end
 
   def test_name
@@ -49,6 +31,19 @@ class TreeTest < MiniTest::Unit::TestCase
   def test_launch
     resources = [1, 2, 3]
     @tree.launch *resources
+    history = ['tree1 job2']*3+['tree1 job1']
+    assert_equal history, redis.lrange('history', 0, -1)
+  end
+
+  def test_launch_with_no_resources
+    @tree.launch
+  end
+
+  def test_should_have_root
+    assert_raises ResqueJobsTree::TreeInvalid do
+      ResqueJobsTree::Factory.create :tree1 do
+      end
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque_jobs_tree
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-09 00:00:00.000000000 Z
+date: 2013-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler