backgroundrb-rails3 1.1

data/test/server/test_meta_worker.rb

@@ -0,0 +1,281 @@
+require File.join(File.dirname(__FILE__) + "/../bdrb_test_helper")
+require "meta_worker"
+require "chronic"
+
+context "A Meta Worker should" do
+  module Kernel
+    def packet_dump data
+      t = Marshal.dump(data)
+      t.length.to_s.rjust(9,'0') + t
+    end
+  end
+  setup do
+    options = {:schedules =>
+      {
+        :proper_worker => { :barbar => {:trigger_args=>"*/5 * * * * *", :data =>"Hello World" }},
+        :bar_worker => { :do_job => {:trigger_args=>"*/5 * * * * *", :data =>"Hello World" }}
+      },
+      :backgroundrb => {:log => "foreground", :debug_log => false, :environment => "production", :port => 11006, :ip => "localhost"}
+    }
+    BDRB_CONFIG.set(options)
+
+    BackgrounDRb::MetaWorker.worker_name = "hello_worker"
+
+    class ProperWorker < BackgrounDRb::MetaWorker
+      attr_accessor :outgoing_data
+      attr_accessor :incoming_data
+      set_worker_name :proper_worker
+      def send_data(data)
+        @outgoing_data = data
+      end
+
+      def start_reactor; end
+
+      def ivar(var)
+        instance_variable_get("@#{var}")
+      end
+    end
+    @meta_worker = ProperWorker.start_worker
+  end
+
+  specify "load appropriate db environment from config file" do
+    ENV["RAILS_ENV"] = BDRB_CONFIG[:backgroundrb][:environment]
+    @meta_worker.send(:load_rails_env)
+    ActiveRecord::Base.connection.current_database.should == "rails_sandbox_production"
+  end
+
+
+  specify "load appropriate schedule from config file" do
+    @meta_worker.my_schedule.should.not == nil
+    @meta_worker.my_schedule.should == {:barbar=>{:data=>"Hello World", :trigger_args=>"*/5 * * * * *"}}
+    trigger = @meta_worker.ivar(:worker_method_triggers)
+    trigger.should.not == nil
+    trigger[:barbar][:data].should == "Hello World"
+  end
+
+  specify "should load passed data and invoke methods" do
+    a = {:data=>{:worker_method=>"who", :arg=>"rails"}, :type=>:request, :result=>false, :client_signature=>9}
+    b = {:data=>{:worker_method=>"baz", :arg=>"rails"}, :type=>:request, :result=>true, :client_signature=>9}
+    c = {:data=>{:job_key=>:start_message}, :type=>:get_result, :result=>true, :client_signature=>9}
+    t_request = "000000088\004\b{\t:\ttype:\frequest:\025client_signaturei\016:\vresultF:\tdata{\a:\022worker_method\"\bwho:\barg\"\nrails"
+    @meta_worker.expects(:receive_data).with(a).returns(nil)
+    @meta_worker.receive_internal_data(t_request)
+  end
+
+  specify "should invoke async tasks without sending results" do
+    a = {:data=>{:worker_method=>"who", :arg=>"rails",:job_key => "lol"}, :type=>:request, :result=>false, :client_signature=>9}
+    @meta_worker.expects(:who).with("rails").returns(nil)
+    @meta_worker.receive_internal_data(packet_dump(a))
+    Thread.current[:job_key].should == "lol"
+  end
+
+  specify "should invoke sync methods and return results back" do
+    class << @meta_worker
+      def baz args
+        "hello : #{args}"
+      end
+    end
+    b = {:data=>{:worker_method=>"baz", :arg=>"rails"}, :type=>:request, :result=>true, :client_signature=>9}
+    @meta_worker.expects(:send_data).with({:data=>"hello : rails", :type=>:response, :result=>true, :client_signature=>9, :result_flag => "ok"}).returns("hello : rails")
+    @meta_worker.receive_internal_data(packet_dump(b))
+    Thread.current[:job_key].should == nil
+  end
+
+  specify "should invoke methods with and without args correctly" do
+    class << @meta_worker
+      attr_accessor :outgoing_data
+      def send_data data
+        @outgoing_data = data
+      end
+    end
+    b = {:data=> {:worker_method=>"baz", :arg => { :name => "bdrb",:age => 10} }, :type=>:request, :result=>true, :client_signature=>9 }
+    # @meta_worker.expects(:send_data).with({:data=>"hello : rails", :type=>:response, :result=>true, :client_signature=>9}).returns("hello : rails")
+    @meta_worker.expects(:baz).with({ :name => "bdrb",:age => 10}).returns("foo")
+    @meta_worker.receive_internal_data(packet_dump(b))
+    @meta_worker.outgoing_data[:data].should == "foo"
+    Thread.current[:job_key].should == nil
+  end
+
+  specify "for result request" do
+    class << @meta_worker
+      attr_accessor :t_result
+      def send_data data
+        @t_result = data
+      end
+    end
+    @meta_worker.cache[:start_message] = "helloworld"
+    c = {:data=>{:job_key=>:start_message}, :type=>:get_result, :result=>true, :client_signature=>9}
+    @meta_worker.receive_internal_data(packet_dump(c))
+    @meta_worker.t_result[:data].should == "helloworld"
+  end
+
+  specify "for results that cant be dumped" do
+    class << @meta_worker
+      def baz args
+        proc { "boy"}
+      end
+      def send_data input
+        packet_dump(input)
+      end
+    end
+    b = {:data=>{:worker_method=>"baz", :arg=>"rails"}, :type=>:request, :result=>true, :client_signature=>9}
+    a = @meta_worker.receive_internal_data(packet_dump(b))
+    p a
+    Thread.current[:job_key].should == nil
+  end
+end
+
+context "For unix schedulers" do
+  specify "remove a task from schedule if end time is reached" do
+    options = {:schedules =>
+      {
+        :unix_worker => { :barbar => { :trigger_args =>
+            {
+              :start => (Time.now + 2.seconds).to_s,
+              :end => (Time.now + 10.seconds).to_s,
+              :repeat_interval => 2.seconds,
+              :data => "unix_worker"
+            }
+          }
+        },
+      },
+      :backgroundrb =>
+      {
+        :log => "foreground", :debug_log => false, :environment => "production", :port => 11006, :ip => "localhost"
+      }
+    }
+    BDRB_CONFIG.set(options)
+
+    class UnixWorker < BackgrounDRb::MetaWorker
+      attr_accessor :outgoing_data
+      attr_accessor :incoming_data
+      set_worker_name :unix_worker
+      def send_data(data)
+        @outgoing_data = data
+      end
+
+      def start_reactor; end
+
+      def ivar(var)
+        instance_variable_get("@#{var}")
+      end
+    end
+    @meta_worker = UnixWorker.start_worker
+    @meta_worker.my_schedule.should.not == nil
+    @meta_worker.ivar(:worker_method_triggers).should.not == nil
+    @meta_worker.ivar(:worker_method_triggers)[:barbar].should.not == nil
+  end
+end
+
+context "Worker without names" do
+  specify "should throw an error on initialization" do
+    options = {:schedules =>
+      {
+        :foo_worker => { :barbar => {:trigger_args=>"*/5 * * * * *", :data =>"Hello World" }},
+        :bar_worker => { :do_job => {:trigger_args=>"*/5 * * * * *", :data =>"Hello World" }}
+      },
+      :backgroundrb => {:log => "foreground", :debug_log => false, :environment => "production", :port => 11006, :ip => "localhost"}
+    }
+    BDRB_CONFIG.set(options)
+
+    BackgrounDRb::MetaWorker.worker_name = "hello_worker"
+
+    class BoyWorker < BackgrounDRb::MetaWorker
+      attr_accessor :outgoing_data
+      attr_accessor :incoming_data
+      def send_data(data)
+        @outgoing_data = data
+      end
+
+      def start_reactor; end
+    end
+    should.raise { @meta_worker = BoyWorker.start_worker }
+  end
+end
+
+context "Worker with options" do
+  specify "should load schedule from passed options" do
+    options = { :backgroundrb => {:log => "foreground", :debug_log => false, :environment => "production", :port => 11006, :ip => "localhost"}}
+    BDRB_CONFIG.set(options)
+
+    BackgrounDRb::MetaWorker.worker_name = "hello_worker"
+
+    class CrapWorker < BackgrounDRb::MetaWorker
+      set_worker_name :crap_worker
+      set_no_auto_load true
+      attr_accessor :outgoing_data
+      attr_accessor :incoming_data
+      def send_data(data)
+        @outgoing_data = data
+      end
+
+      def start_reactor; end
+      def ivar(var); instance_variable_get("@#{var}"); end
+    end
+    write_end = mock()
+    read_end = mock()
+    worker_options = { :write_end => mock(),:read_end => mock(),
+      :options => {
+        :data => "hello", :schedule => {
+          :hello_world => { :trigger_args => "*/5 * * * * * *",
+            :data => "hello_world"
+          }
+        }
+      }
+    }
+    CrapWorker.any_instance.expects(:create).with("hello").returns(true)
+    @meta_worker = CrapWorker.start_worker(worker_options)
+    @meta_worker.my_schedule.should == {:hello_world=>{:data=>"hello_world", :trigger_args=>"*/5 * * * * * *"}}
+  end
+end
+
+context "For enqueued tasks" do
+  setup do
+    options = {:schedules =>
+      {
+        :proper_worker => { :barbar => {:trigger_args=>"*/5 * * * * *", :data =>"Hello World" }},
+        :bar_worker => { :do_job => {:trigger_args=>"*/5 * * * * *", :data =>"Hello World" }}
+      },
+      :backgroundrb => {:log => "foreground", :debug_log => false, :environment => "production", :port => 11006, :ip => "localhost"}
+    }
+    BDRB_CONFIG.set(options)
+
+    class BdrbJobQueue < ActiveRecord::Base; end
+    class QueueWorker < BackgrounDRb::MetaWorker
+      attr_accessor :outgoing_data
+      attr_accessor :incoming_data
+      set_worker_name :queue_worker
+      def send_data(data)
+        @outgoing_data = data
+      end
+
+      def start_reactor; end
+
+      def ivar(var)
+        instance_variable_get("@#{var}")
+      end
+    end
+  end
+
+  specify "should run enqueued tasks with arguments if they are there in the queue" do
+    @meta_worker = QueueWorker.start_worker
+    mocked_task = mock()
+    mocked_task.expects(:worker_method).returns(:barbar).times(2)
+    mocked_task.expects(:args).returns(Marshal.dump("hello"))
+    mocked_task.expects(:[]).returns(1).times(2)
+    @meta_worker.expects(:barbar).with("hello").returns(true)
+    BdrbJobQueue.expects(:find_next).with("queue_worker").returns(mocked_task)
+    @meta_worker.check_for_enqueued_tasks
+  end
+
+  specify "should run enqueued tasks without arguments if they are there in the queue" do
+    @meta_worker = QueueWorker.start_worker
+    mocked_task = mock()
+    mocked_task.expects(:[]).returns(1).times(2)
+    mocked_task.expects(:worker_method).returns(:barbar).times(2)
+    mocked_task.expects(:args).returns(nil)
+    @meta_worker.expects(:barbar)
+    BdrbJobQueue.expects(:find_next).with("queue_worker").returns(mocked_task)
+    @meta_worker.check_for_enqueued_tasks
+  end
+end

data/test/server/test_result_storage.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__) + "/..","bdrb_test_helper")
+
+context "Result storage" do
+  setup do
+    @cache = BackgrounDRb::ResultStorage.new(:some_worker,:crap)
+  end
+
+  specify "should store result" do
+    @cache[:foo] = "Wow"
+    @cache[:foo].should == "Wow"
+    @cache.delete(:foo)
+    @cache[:foo].should == nil
+  end
+end

data/test/socket_mocker.rb

@@ -0,0 +1,34 @@
+require "socket"
+
+class TCPSocket
+  attr_accessor :connection_status
+  attr_accessor :internal_buffer
+  def initialize ip,port
+    @internal_buffer = []
+  end
+
+  def trigger
+
+  end
+
+  def self.open server_ip
+
+  end
+
+  def setsockopt *args; end
+
+  def >> crap
+    @internal_buffer << Marshal.dump(crap)
+  end
+
+  def read
+    @internal_buffer.shift
+  end
+
+  def write crap; end
+
+
+  def close
+    @connection_status = :closed
+  end
+end

data/test/workers/bar_worker.rb

@@ -0,0 +1,10 @@
+class BarWorker < BackgrounDRb::MetaWorker
+  set_worker_name :bar_worker
+  reload_on_schedule true
+  def create
+
+  end
+  def do_job
+
+  end
+end

data/test/workers/foo_worker.rb

@@ -0,0 +1,10 @@
+class FooWorker < BackgrounDRb::MetaWorker
+  set_worker_name :foo_worker
+  reload_on_schedule :true
+  def create args = nil
+  end
+
+  def barbar args
+    "lol"
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,345 @@
+--- !ruby/object:Gem::Specification 
+name: backgroundrb-rails3
+version: !ruby/object:Gem::Version 
+  hash: 13
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  version: "1.1"
+platform: ruby
+authors: 
+- Matteo Latini
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-14 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 2
+        - 3
+        version: 0.2.3
+  type: :runtime
+  name: chronic
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 1
+        - 15
+        version: 0.1.15
+  type: :runtime
+  name: packet
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: shoulda
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  name: bundler
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  name: jeweler
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rcov
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 2
+        - 3
+        version: 0.2.3
+  type: :runtime
+  name: chronic
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 1
+        - 15
+        version: 0.1.15
+  type: :runtime
+  name: packet
+  prerelease: false
+  version_requirements: *id008
+description: |-
+  
+      BackgrounDRb is a Ruby job server and scheduler. Its main intent is to be used with Ruby on Rails applications for offloading long-running tasks. 
+      Since a Rails application blocks while serving a request it is best to move long-running tasks off into a background process that is divorced from http request/response cycle.
+email: mtylty@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- ChangeLog
+- LICENSE
+- README
+files: 
+- .autotest
+- ChangeLog
+- Gemfile
+- LICENSE
+- MIT-LICENSE
+- README
+- Rakefile
+- TODO.org
+- app/controller/backgroundrb_status_controller.rb
+- backgroundrb-rails3.gemspec
+- config/backgroundrb.yml
+- doc/Rakefile
+- doc/config.yaml
+- doc/content/advanced/advanced.txt
+- doc/content/advanced/advanced.yaml
+- doc/content/bugs/bugs.txt
+- doc/content/bugs/bugs.yaml
+- doc/content/community/community.txt
+- doc/content/community/community.yaml
+- doc/content/content.txt
+- doc/content/content.yaml
+- doc/content/faq/faq.txt
+- doc/content/faq/faq.yaml
+- doc/content/rails/rails.txt
+- doc/content/rails/rails.yaml
+- doc/content/scheduling/scheduling.txt
+- doc/content/scheduling/scheduling.yaml
+- doc/content/workers/workers.txt
+- doc/content/workers/workers.yaml
+- doc/layouts/default/default.erb
+- doc/layouts/default/default.yaml
+- doc/lib/default.rb
+- doc/output/Assets/BG-Ad-Top.png
+- doc/output/Assets/BG-Body.png
+- doc/output/Assets/BG-Feed.png
+- doc/output/Assets/BG-Menu-Hover.png
+- doc/output/Assets/BG-Menu.png
+- doc/output/Assets/BG-Sidebar-Bottom.png
+- doc/output/Assets/Button-Feed.png
+- doc/output/images/bg-ad-top.png
+- doc/output/images/bg-body.png
+- doc/output/images/bg-feed.gif
+- doc/output/images/bg-footer.jpg
+- doc/output/images/bg-header.jpg
+- doc/output/images/bg-menu-hover.png
+- doc/output/images/bg-menu.png
+- doc/output/images/bg-sidebar-bottom.gif
+- doc/output/images/button-feed.png
+- doc/output/images/icon-comment.png
+- doc/output/images/more_icon.gif
+- doc/output/style.css
+- doc/page_defaults.yaml
+- doc/tasks/default.rake
+- doc/templates/default/default.txt
+- doc/templates/default/default.yaml
+- examples/backgroundrb.yml
+- examples/foo_controller.rb
+- examples/god_worker.rb
+- examples/worker_tests/god_worker_test.rb
+- examples/workers/error_worker.rb
+- examples/workers/foo_worker.rb
+- examples/workers/god_worker.rb
+- examples/workers/model_worker.rb
+- examples/workers/renewal_worker.rb
+- examples/workers/rss_worker.rb
+- examples/workers/server_worker.rb
+- examples/workers/world_worker.rb
+- examples/workers/xmpp_worker.rb
+- init.rb
+- install.rb
+- know_issues.org
+- lib/backgroundrb.rb
+- lib/backgroundrb/bdrb_client_helper.rb
+- lib/backgroundrb/bdrb_cluster_connection.rb
+- lib/backgroundrb/bdrb_config.rb
+- lib/backgroundrb/bdrb_conn_error.rb
+- lib/backgroundrb/bdrb_connection.rb
+- lib/backgroundrb/bdrb_job_queue.rb
+- lib/backgroundrb/bdrb_result.rb
+- lib/backgroundrb/bdrb_start_stop.rb
+- lib/backgroundrb/rails_worker_proxy.rb
+- lib/backgroundrb/railtie.rb
+- lib/generators/backgroundrb/bdrb_migration/USAGE
+- lib/generators/backgroundrb/bdrb_migration/bdrb_migration_generator.rb
+- lib/generators/backgroundrb/bdrb_migration/templates/migration.rb
+- lib/generators/backgroundrb/worker/USAGE
+- lib/generators/backgroundrb/worker/templates/unit_test.rb
+- lib/generators/backgroundrb/worker/templates/worker.rb
+- lib/generators/backgroundrb/worker/worker_generator.rb
+- lib/tasks/backgroundrb_tasks.rake
+- release_notes.org
+- release_points.org
+- script/backgroundrb
+- script/bdrb_test_helper.rb
+- script/load_worker_env.rb
+- script/monitrc
+- server/backgroundrb_server.rb
+- server/lib/bdrb_result_storage.rb
+- server/lib/bdrb_server_helper.rb
+- server/lib/bdrb_thread_pool.rb
+- server/lib/cron_trigger.rb
+- server/lib/invalid_dump_error.rb
+- server/lib/log_worker.rb
+- server/lib/master_proxy.rb
+- server/lib/master_worker.rb
+- server/lib/meta_worker.rb
+- server/lib/trigger.rb
+- test/bdrb_client_test_helper.rb
+- test/bdrb_test_helper.rb
+- test/client/backgroundrb.yml
+- test/client/test_bdrb_client_helper.rb
+- test/client/test_bdrb_cluster_connection.rb
+- test/client/test_bdrb_config.rb
+- test/client/test_bdrb_connection.rb
+- test/client/test_bdrb_job_queue.rb
+- test/client/test_worker_proxy.rb
+- test/server/test_cron_trigger.rb
+- test/server/test_master_proxy.rb
+- test/server/test_master_worker.rb
+- test/server/test_meta_worker.rb
+- test/server/test_result_storage.rb
+- test/socket_mocker.rb
+- test/workers/bar_worker.rb
+- test/workers/foo_worker.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/mtylty/backgroundrb-rails3
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: BackgrounDRb is a Ruby job server and scheduler.
+test_files: 
+- examples/foo_controller.rb
+- examples/god_worker.rb
+- examples/worker_tests/god_worker_test.rb
+- examples/workers/error_worker.rb
+- examples/workers/foo_worker.rb
+- examples/workers/god_worker.rb
+- examples/workers/model_worker.rb
+- examples/workers/renewal_worker.rb
+- examples/workers/rss_worker.rb
+- examples/workers/server_worker.rb
+- examples/workers/world_worker.rb
+- examples/workers/xmpp_worker.rb
+- test/bdrb_client_test_helper.rb
+- test/bdrb_test_helper.rb
+- test/client/test_bdrb_client_helper.rb
+- test/client/test_bdrb_cluster_connection.rb
+- test/client/test_bdrb_config.rb
+- test/client/test_bdrb_connection.rb
+- test/client/test_bdrb_job_queue.rb
+- test/client/test_worker_proxy.rb
+- test/server/test_cron_trigger.rb
+- test/server/test_master_proxy.rb
+- test/server/test_master_worker.rb
+- test/server/test_meta_worker.rb
+- test/server/test_result_storage.rb
+- test/socket_mocker.rb
+- test/workers/bar_worker.rb
+- test/workers/foo_worker.rb