rocketjob 0.7.0

data/test/job_test.rb

@@ -0,0 +1,186 @@
+require_relative 'test_helper'
+require_relative 'jobs/test_job'
+
+# Unit Test for RocketJob::Job
+class JobTest < Minitest::Test
+  context RocketJob::Job do
+    setup do
+      @server = RocketJob::Server.new
+      @server.started
+      @description = 'Hello World'
+      @arguments   = [ 1 ]
+      @job = Jobs::TestJob.new(
+        description:         @description,
+        arguments:           @arguments,
+        destroy_on_complete: false
+      )
+    end
+
+    teardown do
+      @job.destroy if @job && !@job.new_record?
+    end
+
+    context '.config' do
+      should 'support multiple databases' do
+        assert_equal 'test_rocket_job', RocketJob::Job.collection.db.name
+      end
+    end
+
+    context '#reload' do
+      should 'handle hash' do
+        @job = Jobs::TestJob.new(
+          description:         @description,
+          arguments:           [ { key: 'value' } ],
+          destroy_on_complete: false
+        )
+
+        assert_equal 'value', @job.arguments.first[:key]
+        @job.save!
+        @job.reload
+        assert @job.arguments.first.is_a?(ActiveSupport::HashWithIndifferentAccess), @job.arguments.first.class.inspect
+        assert_equal 'value', @job.arguments.first['key']
+        assert_equal 'value', @job.arguments.first[:key]
+      end
+    end
+
+    context '#save!' do
+      should 'save a blank job' do
+        @job.save!
+        assert_nil   @job.server_name
+        assert_nil   @job.completed_at
+        assert       @job.created_at
+        assert_equal @description, @job.description
+        assert_equal false, @job.destroy_on_complete
+        assert_nil   @job.expires_at
+        assert_equal @arguments, @job.arguments
+        assert_equal 0, @job.percent_complete
+        assert_equal 50, @job.priority
+        assert_equal true, @job.repeatable
+        assert_equal 0, @job.failure_count
+        assert_nil   @job.run_at
+        assert_nil   @job.schedule
+        assert_nil   @job.started_at
+        assert_equal :queued, @job.state
+      end
+    end
+
+    context '#status' do
+      should 'return status for a queued job' do
+        assert_equal true, @job.queued?
+        h = @job.status
+        assert_equal :queued,       h[:state]
+        assert_equal @description,  h[:description]
+      end
+
+      should 'return status for a failed job' do
+        @job.build_exception(
+          class_name: 'Test',
+          message: 'hello world'
+        )
+        @job.start!
+        @job.fail!
+        assert_equal true, @job.failed?
+        h = @job.status
+        assert_equal :failed,       h[:state]
+        assert_equal @description,  h[:description]
+        assert_equal 'Test',        h[:exception][:class_name], h
+        assert_equal 'hello world', h[:exception][:message], h
+      end
+    end
+
+    context '#work' do
+      should 'call default perform method' do
+        @job.start!
+        assert_equal false, @job.work(@server)
+        assert_equal true,  @job.completed?, @job.state
+        assert_equal 2,     Jobs::TestJob.result
+      end
+
+      should 'call specific method' do
+        @job.perform_method = :sum
+        @job.arguments = [ 23, 45 ]
+        @job.start!
+        assert_equal false, @job.work(@server)
+        assert_equal true, @job.completed?
+        assert_equal 68,    Jobs::TestJob.result
+      end
+
+      should 'destroy on complete' do
+        @job.destroy_on_complete = true
+        @job.start!
+        assert_equal false, @job.work(@server)
+        assert_equal nil, RocketJob::Job.find_by_id(@job.id)
+      end
+
+      should 'silence logging when log_level is set' do
+        @job.destroy_on_complete = true
+        @job.log_level           = :warn
+        @job.perform_method      = :noisy_logger
+        @job.arguments           = []
+        @job.start!
+        logged = false
+        Jobs::TestJob.logger.stub(:log_internal, -> level, index, message, payload, exception { logged = true if message.include?('some very noisy logging')}) do
+          assert_equal false, @job.work(@server), @job.inspect
+        end
+        assert_equal false, logged
+      end
+
+      should 'raise logging when log_level is set' do
+        @job.destroy_on_complete = true
+        @job.log_level           = :trace
+        @job.perform_method      = :debug_logging
+        @job.arguments           = []
+        @job.start!
+        logged = false
+        # Raise global log level to :info
+        SemanticLogger.stub(:default_level_index, 3) do
+          Jobs::TestJob.logger.stub(:log_internal, -> { logged = true }) do
+            assert_equal false, @job.work(@server)
+          end
+        end
+        assert_equal false, logged
+      end
+
+      should 'call before and after' do
+        named_parameters = { 'counter' => 23 }
+        @job.perform_method = :event
+        @job.arguments = [ named_parameters ]
+        @job.start!
+        assert_equal false, @job.work(@server), @job.inspect
+        assert_equal true, @job.completed?
+        assert_equal named_parameters.merge('before_event' => true, 'after_event' => true), @job.arguments.first
+      end
+
+    end
+
+    context '.next_job' do
+      setup do
+        RocketJob::Job.destroy_all
+      end
+
+      should 'return nil when no jobs available' do
+        assert_equal nil, RocketJob::Job.next_job(@server.name)
+      end
+
+      should 'return the first job' do
+        @job.save!
+        assert job = RocketJob::Job.next_job(@server.name), "Failed to find job"
+        assert_equal @job.id, job.id
+      end
+
+      should 'Ignore future dated jobs' do
+        @job.run_at = Time.now + 1.hour
+        @job.save!
+        assert_equal nil, RocketJob::Job.next_job(@server.name)
+      end
+
+      should 'Process future dated jobs when time is now' do
+        @job.run_at = Time.now
+        @job.save!
+        assert job = RocketJob::Job.next_job(@server.name), "Failed to find future job"
+        assert_equal @job.id, job.id
+      end
+
+    end
+  end
+end

data/test/jobs/test_job.rb

@@ -0,0 +1,42 @@
+require 'rocketjob'
+module Jobs
+  class TestJob < RocketJob::Job
+    @@result = nil
+
+    # For holding test results
+    def self.result
+      @@result
+    end
+
+    def perform(first)
+      @@result = first + 1
+    end
+
+    def sum(a, b)
+      @@result = a + b
+    end
+
+    # Test silencing noisy logging
+    def noisy_logger
+      logger.info 'some very noisy logging'
+    end
+
+    # Test increasing log level for debugging purposes
+    def debug_logging
+      logger.trace 'enable tracing level for just the job instance'
+    end
+
+    def before_event(hash)
+      hash['before_event'] = true
+    end
+
+    def event(hash)
+      hash['event'] = true
+    end
+
+    def after_event(hash)
+      hash['after_event'] = true
+    end
+
+  end
+end

data/test/server_test.rb

@@ -0,0 +1,39 @@
+require_relative 'test_helper'
+require_relative 'jobs/test_job'
+
+# Unit Test for RocketJob::Server
+class ServerTest < Minitest::Test
+  context RocketJob::Server do
+    setup do
+      RocketJob::Config.instance.heartbeat_seconds = 0.1
+      RocketJob::Config.instance.max_poll_seconds  = 0.1
+      @server = RocketJob::Server.new
+      @description = 'Hello World'
+      @arguments   = [ 1 ]
+      @job = Jobs::TestJob.new(
+        description:         @description,
+        arguments:           @arguments,
+        destroy_on_complete: false
+      )
+    end
+
+    teardown do
+      @job.destroy if @job && !@job.new_record?
+    end
+
+    context '.config' do
+      should 'support multiple databases' do
+        assert_equal 'test_rocket_job', RocketJob::Job.collection.db.name
+      end
+    end
+
+    context '#run' do
+      should 'run a server' do
+        Thread.new { sleep 1; @server.stop!}
+        @server.run
+        assert_equal :stopping, @server.state, @server.inspect
+      end
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,43 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'yaml'
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'minitest/stub_any_instance'
+require 'shoulda/context'
+require 'rocketjob'
+require 'awesome_print'
+require 'symmetric-encryption'
+
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+
+SemanticLogger.add_appender('test.log', &SemanticLogger::Appender::Base.colorized_formatter)
+SemanticLogger.default_level = :debug
+
+# Setup MongoMapper from mongo config file
+config_file = File.join(File.dirname(__FILE__), 'config', 'mongo.yml')
+if config = YAML.load(ERB.new(File.read(config_file)).result)
+  cfg                    = config['test']
+  options                = cfg['options'] || {}
+  options[:logger]       = SemanticLogger::DebugAsTraceLogger.new('Mongo')
+
+  MongoMapper.config     = cfg
+  MongoMapper.connection = Mongo::MongoClient.from_uri(cfg['uri'], options)
+  MongoMapper.database   = MongoMapper.connection.db.name
+
+  # If this environment has a separate Work server
+  if cfg = config['test_work']
+    options           = cfg['options'] || {}
+    options[:logger]  = SemanticLogger::DebugAsTraceLogger.new('MongoWork')
+    RocketJob::Config.mongo_work_connection = Mongo::MongoClient.from_uri(cfg['uri'], options)
+  end
+end
+
+# Test cipher
+SymmetricEncryption.cipher = SymmetricEncryption::Cipher.new(
+  cipher_name: 'aes-128-cbc',
+  key:         '1234567890ABCDEF1234567890ABCDEF',
+  iv:          '1234567890ABCDEF',
+  encoding:    :base64strict
+)
+

data/test/worker_test.rb

@@ -0,0 +1,89 @@
+require_relative 'test_helper'
+require_relative 'jobs/test_job'
+
+# Unit Test for RocketJob::Job
+class WorkerTest < Minitest::Test
+  context RocketJob::Job do
+    [true, false].each do |inline_mode|
+      setup do
+        RocketJob::Config.inline_mode = inline_mode
+        @server = RocketJob::Server.new
+        @server.started
+      end
+
+      teardown do
+        @job.destroy if @job && !@job.new_record?
+        RocketJob::Config.inline_mode = false
+      end
+
+      context '.perform_later' do
+        should "process single request (inline_mode=#{inline_mode})" do
+          @job = Jobs::TestJob.perform_later(1) do |job|
+            job.destroy_on_complete = false
+          end
+          assert_nil   @job.server_name
+          assert_nil   @job.completed_at
+          assert       @job.created_at
+          assert_nil   @job.description
+          assert_equal false, @job.destroy_on_complete
+          assert_nil   @job.expires_at
+          assert_equal 0, @job.percent_complete
+          assert_equal 50, @job.priority
+          assert_equal true, @job.repeatable
+          assert_equal 0, @job.failure_count
+          assert_nil   @job.run_at
+          assert_nil   @job.schedule
+          assert_nil   @job.started_at
+          assert_equal :queued, @job.state
+
+          @job.server_name = 'me'
+          @job.start
+          assert_equal false,    @job.work(@server), @job.exception.inspect
+          assert_equal true, @job.completed?
+          assert_equal 2,    Jobs::TestJob.result
+
+          assert       @job.server_name
+          assert       @job.completed_at
+          assert       @job.created_at
+          assert_nil   @job.description
+          assert_equal false, @job.destroy_on_complete
+          assert_nil   @job.expires_at
+          assert_equal 100, @job.percent_complete
+          assert_equal 50, @job.priority
+          assert_equal true, @job.repeatable
+          assert_equal 0, @job.failure_count
+          assert_nil   @job.run_at
+          assert_nil   @job.schedule
+          assert       @job.started_at
+        end
+      end
+
+      context '.later' do
+        should "process non default method (inline_mode=#{inline_mode})" do
+          @job = Jobs::TestJob.later(:sum, 23, 45)
+          @job.start
+          assert_equal false, @job.work(@server), @job.exception.inspect
+          assert_equal true,  @job.completed?
+          assert_equal 68,    Jobs::TestJob.result
+        end
+      end
+
+      context '.perform_now' do
+        should "process perform (inline_mode=#{inline_mode})" do
+          @job = Jobs::TestJob.perform_now(5)
+          assert_equal true,  @job.completed?
+          assert_equal 6,     Jobs::TestJob.result
+        end
+      end
+
+      context '.now' do
+        should "process non default method (inline_mode=#{inline_mode})" do
+          @job = Jobs::TestJob.now(:sum, 23, 45)
+          assert_equal true,  @job.completed?, @job.inspect
+          assert_equal 68,    Jobs::TestJob.result
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: rocketjob
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+platform: ruby
+authors:
+- Reid Morrison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aasm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: semantic_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: mongo_ha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: symmetric-encryption
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sync_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Designed for batch processing from single records to millions of records
+  in a single batch. Uses threading instead of process forking for greater throughtput.
+email:
+- reidmo@gmail.com
+executables:
+- rocketjob
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bin/rocketjob
+- lib/rocket_job/cli.rb
+- lib/rocket_job/concerns/worker.rb
+- lib/rocket_job/config.rb
+- lib/rocket_job/heartbeat.rb
+- lib/rocket_job/job.rb
+- lib/rocket_job/job_exception.rb
+- lib/rocket_job/server.rb
+- lib/rocket_job/version.rb
+- lib/rocketjob.rb
+- test/config/mongo.yml
+- test/job_test.rb
+- test/jobs/test_job.rb
+- test/server_test.rb
+- test/test_helper.rb
+- test/worker_test.rb
+homepage: https://github.com/rocketjob/rocketjob
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: High volume, priority based, Enterprise Batch Processing solution for Ruby
+test_files:
+- test/config/mongo.yml
+- test/job_test.rb
+- test/jobs/test_job.rb
+- test/server_test.rb
+- test/test_helper.rb
+- test/worker_test.rb