faktory_worker_ruby 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a613d7ced7f98e8ec3112b9be6a31b367b1ce4bf
-  data.tar.gz: 71a106dc660e67ecd0833a1e1815148de8022fb8
+  metadata.gz: 672affacf993528eedff478961a96bbc222e62bc
+  data.tar.gz: 8b58b6e46e4d6965690bc4a17f3067548671edd0
 SHA512:
-  metadata.gz: 657cce3245c5c4dd8d790b041d212a20d2cb477dfcf54176040450df6ee7634da443f79b0e2076c5ab372176f8dda18a4dc2329c6a35b91bd94c47bba0236285
-  data.tar.gz: 132a39b2db88d47f5b7e770f125b612326a34183982eb3231dea407cbaae16207601ddd580c7a7440ed9e388c3c066650b5b6c76bbc75cabb563d5a043a4462f
+  metadata.gz: 7210a8933baf0a671a608d41b5bb183fec3ea93b5c233c937c3882e921634d1baedb5985be1ecd6142ee1ca9257d3483012a7511f40c4f58fc4c13d0f34a4f4f
+  data.tar.gz: 1a2e769ad7b96d539842e29c7056e36523d878cb81ccda8610247b99e8f239877dfbe7caee93be6d194213801c2a31fbfb876c69f5a5850bad6b15461661c4e4

data/Changes.md

@@ -1,5 +1,10 @@
 # Changes
 
+## 0.7.0
+
+- Add testing API, almost identical to Sidekiq's `sidekiq/testing` API.
+  [#7, thebadmonkeydev, jagthedrummer]
+
 ## 0.6.1
 
 - Fix password hashing

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    faktory_worker_ruby (0.6.1)
+    faktory_worker_ruby (0.7.0)
       connection_pool (~> 2.2, >= 2.2.1)
 
 GEM
@@ -22,4 +22,4 @@ DEPENDENCIES
   rake (~> 12)
 
 BUNDLED WITH
-   1.15.4
+   1.16.0

data/faktory_worker_ruby.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["mike@contribsys.com"]
   gem.summary       = "Ruby worker for Faktory"
   gem.description   = "Ruby worker for Faktory."
-  gem.homepage      = "http://github.com/contribsys/faktory_worker_ruby"
+  gem.homepage      = "https://github.com/contribsys/faktory_worker_ruby"
   gem.license       = "LGPL-3.0"
 
   gem.executables   = ['faktory-worker']

data/lib/faktory/cli.rb

@@ -99,7 +99,18 @@ module Faktory
 
     def self.banner
 %q{
-    INSERT SWEET FAKTORY BANNER HERE
+                    ,,,,
+            ,,,,    |  |
+            |  |    |  |
+            |  |    |  |
+            |  |,,~~'  '~,          ___       _
+       ,,~~''   ,~~,      '~,      / __)     | |      _
+ ,,~~''   ,~~,  |  |        |    _| |__ _____| |  _ _| |_ ___   ____ _   _
+ |  ,~~,  |  |  |  |        |   (_   __|____ | |_/ |_   _) _ \ / ___) | | |
+ |  |  |  |  |  |  |        |     | |  / ___ |  _ (  | || |_| | |   | |_| |
+ |  |__|  |__|  |__|        |     |_|  \_____|_| \_)  \__)___/|_|    \__  |
+ |__________________________|                                       (____/
+
 }
     end
 

data/lib/faktory/client.rb

@@ -35,9 +35,9 @@ module Faktory
     # MY_FAKTORY_URL=tcp://:somepass@my-server.example.com:7419
     #
     # Note above, the URL can contain the password for secure installations.
-    def initialize(url: 'tcp://localhost:7419', debug: false)
+    def initialize(url: uri_from_env || 'tcp://localhost:7419', debug: false)
       @debug = debug
-      @location = uri_from_env || URI(url)
+      @location = URI(url)
       open
     end
 
@@ -235,14 +235,15 @@ module Faktory
     # MY_FAKTORY_URL=tcp://:some-pass@some-hostname:7419
     def uri_from_env
       prov = ENV['FAKTORY_PROVIDER']
-      return nil unless prov
-      raise(ArgumentError, <<-EOM) if prov.index(":")
-Invalid FAKTORY_PROVIDER '#{prov}', it should be the name of the ENV variable that contains the URL
-    FAKTORY_PROVIDER=MY_FAKTORY_URL
-    MY_FAKTORY_URL=tcp://:some-pass@some-hostname:7419
-EOM
-      val = ENV[prov]
-      return URI(val) if val
+      if prov
+        raise(ArgumentError, <<-EOM) if prov.index(":")
+  Invalid FAKTORY_PROVIDER '#{prov}', it should be the name of the ENV variable that contains the URL
+      FAKTORY_PROVIDER=MY_FAKTORY_URL
+      MY_FAKTORY_URL=tcp://:some-pass@some-hostname:7419
+  EOM
+        val = ENV[prov]
+        return URI(val) if val
+      end
 
       val = ENV['FAKTORY_URL']
       return URI(val) if val

data/lib/faktory/launcher.rb

@@ -9,9 +9,10 @@ module Faktory
     attr_accessor :manager
 
     def initialize(options)
-      @manager = Faktory::Manager.new(options)
+      merged_options = Faktory.options.merge(options)
+      @manager = Faktory::Manager.new(merged_options)
       @done = false
-      @options = options
+      @options = merged_options
     end
 
     def run

data/lib/faktory/middleware/chain.rb

@@ -9,7 +9,7 @@ module Faktory
   # To add middleware to run when a job is pushed to Faktory:
   #
   # Faktory.configure_client do |config|
-  #   config.push_middleware do |chain|
+  #   config.client_middleware do |chain|
   #     chain.add MyClientHook
   #   end
   # end
@@ -27,15 +27,15 @@ module Faktory
   # To insert immediately preceding another entry:
   #
   # Faktory.configure_client do |config|
-  #   config.middleware do |chain|
-  #     chain.insert_before ActiveRecord, MyClientHook
+  #   config.client_middleware do |chain|
+  #     chain.insert_before SomeOtherMiddleware, MyClientHook
   #   end
   # end
   #
   # To insert immediately after another entry:
   #
   # Faktory.configure_client do |config|
-  #   config.middleware do |chain|
+  #   config.client_middleware do |chain|
   #     chain.insert_after ActiveRecord, MyClientHook
   #   end
   # end

data/lib/faktory/processor.rb

@@ -39,9 +39,9 @@ module Faktory
       @down = false
       @done = false
       @thread = nil
-      @reloader = Faktory.options[:reloader]
+      @reloader = mgr.options[:reloader]
       @logging = (mgr.options[:job_logger] || Faktory::JobLogger).new
-      @fetcher = Faktory::Fetcher.new(Faktory.options)
+      @fetcher = Faktory::Fetcher.new(mgr.options)
     end
 
     def terminate(wait=false)
@@ -153,7 +153,7 @@ module Faktory
         # within the timeout.  Don't acknowledge the work since
         # we didn't properly finish it.
       rescue Exception => ex
-        handle_exception(ex, { :context => "Job raised exception", :job => job })
+        handle_exception(ex, { :context => "Job raised exception", :job => work.job })
         work.fail(ex)
         raise ex
       end

data/lib/faktory/testing.rb

@@ -0,0 +1,336 @@
+module Faktory
+  module Testing
+    def self.__test_mode
+      @__test_mode
+    end
+
+    def self.__test_mode=(mode)
+      @__test_mode = mode
+    end
+
+    def self.__set_test_mode(mode)
+      if block_given?
+        current_mode = self.__test_mode
+        begin
+          self.__test_mode = mode
+          yield
+        ensure
+          self.__test_mode = current_mode
+        end
+      else
+        self.__test_mode = mode
+      end
+    end
+
+    def self.disable!(&block)
+      __set_test_mode(:disable, &block)
+    end
+
+    def self.fake!(&block)
+      __set_test_mode(:fake, &block)
+    end
+
+    def self.inline!(&block)
+      # Only allow blockless inline via `blockless_inline_is_a_bad_idea_but_I_wanna_do_it_anyway!`
+      # https://github.com/mperham/sidekiq/issues/3495
+      unless block_given?
+        raise 'Must provide a block to Faktory::Testing.inline!'
+      end
+
+      __set_test_mode(:inline, &block)
+    end
+
+    def self.blockless_inline_is_a_bad_idea_but_I_wanna_do_it_anyway!
+      __set_test_mode(:inline)
+    end
+
+    def self.enabled?
+      self.__test_mode != :disable
+    end
+
+    def self.disabled?
+      self.__test_mode == :disable
+    end
+
+    def self.fake?
+      self.__test_mode == :fake
+    end
+
+    def self.inline?
+      self.__test_mode == :inline
+    end
+
+    def self.constantize(str)
+      names = str.split('::')
+      names.shift if names.empty? || names.first.empty?
+
+      names.inject(Object) do |constant, name|
+        # the false flag limits search for name to under the constant namespace
+        # which mimics Rails' behaviour
+        constant.const_defined?(name, false) ? constant.const_get(name, false) : constant.const_missing(name)
+      end
+    end
+  end
+
+  # Test modes have to be opted into explicitly.
+  # Just requiring the testing module shouldn't automatically change the testing mode.
+  Faktory::Testing.disable!
+
+  class EmptyQueueError < RuntimeError; end
+
+  class Client
+    alias_method :real_push, :push
+    alias_method :real_open, :open
+
+    def push(job)
+      if Faktory::Testing.inline?
+        job = Faktory.load_json(Faktory.dump_json(job))
+        job_class = Faktory::Testing.constantize(job['jobtype'])
+        job_class.new.perform(*job['args'])
+        return job['jid']
+      elsif Faktory::Testing.fake?
+        job = Faktory.load_json(Faktory.dump_json(job))
+        job.merge!('enqueued_at' => Time.now.to_f) unless job['at']
+        Queues.push(job['queue'], job['jobtype'], job)
+        return job['jid']
+      else
+        real_push(job)
+      end
+    end
+
+    def open
+      unless Faktory::Testing.enabled?
+        real_open
+      end
+    end
+  end
+
+  module Queues
+    ##
+    # The Queues class is only for testing the fake queue implementation.
+    # There are 2 data structures involved in tandem. This is due to the
+    # Rspec syntax of change(QueueWorker.jobs, :size). It keeps a reference
+    # to the array. Because the array was dervied from a filter of the total
+    # jobs enqueued, it appeared as though the array didn't change.
+    #
+    # To solve this, we'll keep 2 hashes containing the jobs. One with keys based
+    # on the queue, and another with keys of the worker names, so the array for
+    # QueueWorker.jobs is a straight reference to a real array.
+    #
+    # Queue-based hash:
+    #
+    # {
+    #   "default"=>[
+    #     {
+    #       "class"=>"TestTesting::QueueWorker",
+    #       "args"=>[1, 2],
+    #       "retry"=>true,
+    #       "queue"=>"default",
+    #       "jid"=>"abc5b065c5c4b27fc1102833",
+    #       "created_at"=>1447445554.419934
+    #     }
+    #   ]
+    # }
+    #
+    # Worker-based hash:
+    #
+    # {
+    #   "TestTesting::QueueWorker"=>[
+    #     {
+    #       "class"=>"TestTesting::QueueWorker",
+    #       "args"=>[1, 2],
+    #       "retry"=>true,
+    #       "queue"=>"default",
+    #       "jid"=>"abc5b065c5c4b27fc1102833",
+    #       "created_at"=>1447445554.419934
+    #     }
+    #   ]
+    # }
+    #
+    # Example:
+    #
+    #   require 'faktory/testing'
+    #
+    #   assert_equal 0, Faktory::Queues["default"].size
+    #   HardWorker.perform_async(:something)
+    #   assert_equal 1, Faktory::Queues["default"].size
+    #   assert_equal :something, Faktory::Queues["default"].first['args'][0]
+    #
+    # You can also clear all workers' jobs:
+    #
+    #   assert_equal 0, Faktory::Queues["default"].size
+    #   HardWorker.perform_async(:something)
+    #   Faktory::Queues.clear_all
+    #   assert_equal 0, Faktory::Queues["default"].size
+    #
+    # This can be useful to make sure jobs don't linger between tests:
+    #
+    #   RSpec.configure do |config|
+    #     config.before(:each) do
+    #       Faktory::Queues.clear_all
+    #     end
+    #   end
+    #
+    class << self
+      def [](queue)
+        jobs_by_queue[queue]
+      end
+
+      def push(queue, klass, job)
+        jobs_by_queue[queue] << job
+        jobs_by_worker[klass] << job
+      end
+
+      def jobs_by_queue
+        @jobs_by_queue ||= Hash.new { |hash, key| hash[key] = [] }
+      end
+
+      def jobs_by_worker
+        @jobs_by_worker ||= Hash.new { |hash, key| hash[key] = [] }
+      end
+
+      def delete_for(jid, queue, klass)
+        jobs_by_queue[queue.to_s].delete_if { |job| job["jid"] == jid }
+        jobs_by_worker[klass].delete_if { |job| job["jid"] == jid }
+      end
+
+      def clear_for(queue, klass)
+        jobs_by_queue[queue].clear
+        jobs_by_worker[klass].clear
+      end
+
+      def clear_all
+        jobs_by_queue.clear
+        jobs_by_worker.clear
+      end
+    end
+  end
+
+  module Job
+    ##
+    # The Faktory testing infrastructure overrides perform_async
+    # so that it does not actually touch the network.  Instead it
+    # stores the asynchronous jobs in a per-class array so that
+    # their presence/absence can be asserted by your tests.
+    #
+    # This is similar to ActionMailer's :test delivery_method and its
+    # ActionMailer::Base.deliveries array.
+    #
+    # Example:
+    #
+    #   require 'faktory/testing'
+    #
+    #   assert_equal 0, HardWorker.jobs.size
+    #   HardWorker.perform_async(:something)
+    #   assert_equal 1, HardWorker.jobs.size
+    #   assert_equal :something, HardWorker.jobs[0]['args'][0]
+    #
+    #   assert_equal 0, Faktory::Extensions::DelayedMailer.jobs.size
+    #   MyMailer.delay.send_welcome_email('foo@example.com')
+    #   assert_equal 1, Faktory::Extensions::DelayedMailer.jobs.size
+    #
+    # You can also clear and drain all workers' jobs:
+    #
+    #   assert_equal 0, Faktory::Extensions::DelayedMailer.jobs.size
+    #   assert_equal 0, Faktory::Extensions::DelayedModel.jobs.size
+    #
+    #   MyMailer.delay.send_welcome_email('foo@example.com')
+    #   MyModel.delay.do_something_hard
+    #
+    #   assert_equal 1, Faktory::Extensions::DelayedMailer.jobs.size
+    #   assert_equal 1, Faktory::Extensions::DelayedModel.jobs.size
+    #
+    #   Faktory::Worker.clear_all # or .drain_all
+    #
+    #   assert_equal 0, Faktory::Extensions::DelayedMailer.jobs.size
+    #   assert_equal 0, Faktory::Extensions::DelayedModel.jobs.size
+    #
+    # This can be useful to make sure jobs don't linger between tests:
+    #
+    #   RSpec.configure do |config|
+    #     config.before(:each) do
+    #       Faktory::Worker.clear_all
+    #     end
+    #   end
+    #
+    # or for acceptance testing, i.e. with cucumber:
+    #
+    #   AfterStep do
+    #     Faktory::Worker.drain_all
+    #   end
+    #
+    #   When I sign up as "foo@example.com"
+    #   Then I should receive a welcome email to "foo@example.com"
+    #
+    module ClassMethods
+
+      # Queue for this worker
+      def queue
+        self.faktory_options["queue"]
+      end
+
+      # Jobs queued for this worker
+      def jobs
+        Queues.jobs_by_worker[self.to_s]
+      end
+
+      # Clear all jobs for this worker
+      def clear
+        Queues.clear_for(queue, self.to_s)
+      end
+
+      # Drain and run all jobs for this worker
+      def drain
+        while jobs.any?
+          next_job = jobs.first
+          Queues.delete_for(next_job["jid"], next_job["queue"], self.to_s)
+          process_job(next_job)
+        end
+      end
+
+      # Pop out a single job and perform it
+      def perform_one
+        raise(EmptyQueueError, "perform_one called with empty job queue") if jobs.empty?
+        next_job = jobs.first
+        Queues.delete_for(next_job["jid"], queue, self.to_s)
+        process_job(next_job)
+      end
+
+      def process_job(job)
+        worker = new
+        worker.jid = job['jid']
+        worker.bid = job['bid'] if worker.respond_to?(:bid=)
+        #Faktory::Testing.server_middleware.invoke(worker, job, job['queue']) do
+          execute_job(worker, job['args'])
+        #end
+      end
+
+      def execute_job(worker, args)
+        worker.perform(*args)
+      end
+    end
+
+    class << self
+      def jobs # :nodoc:
+        Queues.jobs_by_queue.values.flatten
+      end
+
+      # Clear all queued jobs across all workers
+      def clear_all
+        Queues.clear_all
+      end
+
+      # Drain all queued jobs across all workers
+      def drain_all
+        while jobs.any?
+          worker_classes = jobs.map { |job| job["jobtype"] }.uniq
+
+          worker_classes.each do |worker_class|
+            Faktory::Testing.constantize(worker_class).drain
+          end
+        end
+      end
+    end
+  end
+
+end

data/lib/faktory/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Faktory
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faktory_worker_ruby
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Mike Perham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-13 00:00:00.000000000 Z
+date: 2018-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -104,10 +104,11 @@ files:
 - lib/faktory/middleware/i18n.rb
 - lib/faktory/processor.rb
 - lib/faktory/rails.rb
+- lib/faktory/testing.rb
 - lib/faktory/util.rb
 - lib/faktory/version.rb
 - lib/faktory_worker_ruby.rb
-homepage: http://github.com/contribsys/faktory_worker_ruby
+homepage: https://github.com/contribsys/faktory_worker_ruby
 licenses:
 - LGPL-3.0
 metadata: {}
@@ -127,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Ruby worker for Faktory