rails-four-queueing 0.1.0

data/test/rails/four/queueing/threaded_consumer_test.rb

@@ -0,0 +1,111 @@
+# Original File: RAILS_ROOT/activesupport/test/queueing/threaded_consumer_test.rb
+require "support/active_support_abstract_unit"
+require "rails/four/queueing"
+require "active_support/log_subscriber/test_helper"
+
+class TestThreadConsumer < ActiveSupport::TestCase
+  class Job
+    attr_reader :id
+    def initialize(id = 1, &block)
+      @id = id
+      @block = block
+    end
+
+    def run
+      @block.call if @block
+    end
+  end
+
+  def setup
+    @logger = ActiveSupport::LogSubscriber::TestHelper::MockLogger.new
+    @queue = Rails::Four::Queueing::Queue.new(logger: @logger)
+  end
+
+  def teardown
+    @queue.drain
+  end
+
+  test "the jobs are executed" do
+    ran = false
+    job = Job.new { ran = true }
+
+    @queue.push job
+    @queue.drain
+
+    assert_equal true, ran
+  end
+
+  test "the jobs are not executed synchronously" do
+    run, ran = Queue.new, Queue.new
+    job = Job.new { ran.push run.pop }
+
+    @queue.consumer.start
+    @queue.push job
+    assert ran.empty?
+
+    run.push true
+    assert_equal true, ran.pop
+  end
+
+  test "shutting down the queue synchronously drains the jobs" do
+    ran = false
+    job = Job.new do
+      sleep 0.1
+      ran = true
+    end
+
+    @queue.consumer.start
+    @queue.push job
+    assert_equal false, ran
+
+    @queue.consumer.shutdown
+    assert_equal true, ran
+  end
+
+  test "log job that raises an exception" do
+    job = Job.new { raise "RuntimeError: Error!" }
+
+    @queue.push job
+    consume_queue @queue
+
+    assert_equal 1, @logger.logged(:error).size
+    assert_match "Job Error: #{job.inspect}\nRuntimeError: Error!", @logger.logged(:error).last
+  end
+
+  test "logger defaults to stderr" do
+    begin
+      $stderr, old_stderr = StringIO.new, $stderr
+      queue = Rails::Four::Queueing::Queue.new
+      queue.push Job.new { raise "RuntimeError: Error!" }
+      consume_queue queue
+      assert_match 'Job Error', $stderr.string
+    ensure
+      $stderr = old_stderr
+    end
+  end
+
+  test "test overriding exception handling" do
+    @queue.consumer.instance_eval do
+      def handle_exception(job, exception)
+        @last_error = exception.message
+      end
+
+      def last_error
+        @last_error
+      end
+    end
+
+    job = Job.new { raise "RuntimeError: Error!" }
+
+    @queue.push job
+    consume_queue @queue
+
+    assert_equal "RuntimeError: Error!", @queue.consumer.last_error
+  end
+
+  private
+    def consume_queue(queue)
+      queue.push nil
+      queue.consumer.consume
+    end
+end

data/test/rails/initializers/frameworks_test.rb

@@ -0,0 +1,247 @@
+# require "isolation/abstract_unit"
+# require 'set'
+
+# module ApplicationTests
+#   class FrameworksTest < ActiveSupport::TestCase
+#     include ActiveSupport::Testing::Isolation
+
+#     def setup
+#       build_app
+#       boot_rails
+#       FileUtils.rm_rf "#{app_path}/config/environments"
+#     end
+
+#     def teardown
+#       teardown_app
+#     end
+
+#     # AC & AM
+#     test "set load paths set only if action controller or action mailer are in use" do
+#       assert_nothing_raised NameError do
+#         add_to_config <<-RUBY
+#           config.root = "#{app_path}"
+#         RUBY
+
+#         use_frameworks []
+#         require "#{app_path}/config/environment"
+#       end
+#     end
+
+#     test "sets action_controller and action_mailer load paths" do
+#       add_to_config <<-RUBY
+#         config.root = "#{app_path}"
+#       RUBY
+
+#       require "#{app_path}/config/environment"
+
+#       expanded_path = File.expand_path("app/views", app_path)
+#       assert_equal ActionController::Base.view_paths[0].to_s, expanded_path
+#       assert_equal ActionMailer::Base.view_paths[0].to_s, expanded_path
+#     end
+
+#     test "allows me to configure default url options for ActionMailer" do
+#       app_file "config/environments/development.rb", <<-RUBY
+#         AppTemplate::Application.configure do
+#           config.action_mailer.default_url_options = { :host => "test.rails" }
+#         end
+#       RUBY
+
+#       require "#{app_path}/config/environment"
+#       assert_equal "test.rails", ActionMailer::Base.default_url_options[:host]
+#     end
+
+#     test "uses the default queue for ActionMailer" do
+#       require "#{app_path}/config/environment"
+#       assert_kind_of ActiveSupport::Queue, ActionMailer::Base.queue
+#     end
+
+#     test "allows me to configure queue for ActionMailer" do
+#       app_file "config/environments/development.rb", <<-RUBY
+#         AppTemplate::Application.configure do
+#           config.action_mailer.queue = ActiveSupport::TestQueue.new
+#         end
+#       RUBY
+
+#       require "#{app_path}/config/environment"
+#       assert_kind_of ActiveSupport::TestQueue, ActionMailer::Base.queue
+#     end
+
+#     test "does not include url helpers as action methods" do
+#       app_file "config/routes.rb", <<-RUBY
+#         AppTemplate::Application.routes.draw do
+#           get "/foo", :to => lambda { |env| [200, {}, []] }, :as => :foo
+#         end
+#       RUBY
+
+#       app_file "app/mailers/foo.rb", <<-RUBY
+#         class Foo < ActionMailer::Base
+#           def notify
+#           end
+#         end
+#       RUBY
+
+#       require "#{app_path}/config/environment"
+#       assert Foo.method_defined?(:foo_path)
+#       assert Foo.method_defined?(:main_app)
+#       assert_equal Set.new(["notify"]), Foo.action_methods
+#     end
+
+#     test "allows to not load all helpers for controllers" do
+#       add_to_config "config.action_controller.include_all_helpers = false"
+
+#       app_file "app/controllers/application_controller.rb", <<-RUBY
+#         class ApplicationController < ActionController::Base
+#         end
+#       RUBY
+
+#       app_file "app/controllers/foo_controller.rb", <<-RUBY
+#         class FooController < ApplicationController
+#           def included_helpers
+#             render :inline => "<%= from_app_helper -%> <%= from_foo_helper %>"
+#           end
+
+#           def not_included_helper
+#             render :inline => "<%= respond_to?(:from_bar_helper) -%>"
+#           end
+#         end
+#       RUBY
+
+#       app_file "app/helpers/application_helper.rb", <<-RUBY
+#         module ApplicationHelper
+#           def from_app_helper
+#             "from_app_helper"
+#           end
+#         end
+#       RUBY
+
+#       app_file "app/helpers/foo_helper.rb", <<-RUBY
+#         module FooHelper
+#           def from_foo_helper
+#             "from_foo_helper"
+#           end
+#         end
+#       RUBY
+
+#       app_file "app/helpers/bar_helper.rb", <<-RUBY
+#         module BarHelper
+#           def from_bar_helper
+#             "from_bar_helper"
+#           end
+#         end
+#       RUBY
+
+#       app_file "config/routes.rb", <<-RUBY
+#         AppTemplate::Application.routes.draw do
+#           get "/:controller(/:action)"
+#         end
+#       RUBY
+
+#       require 'rack/test'
+#       extend Rack::Test::Methods
+
+#       get "/foo/included_helpers"
+#       assert_equal "from_app_helper from_foo_helper", last_response.body
+
+#       get "/foo/not_included_helper"
+#       assert_equal "false", last_response.body
+#     end
+
+#     # AD
+#     test "action_dispatch extensions are applied to ActionDispatch" do
+#       add_to_config "config.action_dispatch.tld_length = 2"
+#       require "#{app_path}/config/environment"
+#       assert_equal 2, ActionDispatch::Http::URL.tld_length
+#     end
+
+#     test "assignment config.encoding to default_charset" do
+#       charset = 'Shift_JIS'
+#       add_to_config "config.encoding = '#{charset}'"
+#       require "#{app_path}/config/environment"
+#       assert_equal charset, ActionDispatch::Response.default_charset
+#     end
+
+#     # AS
+#     test "if there's no config.active_support.bare, all of ActiveSupport is required" do
+#       use_frameworks []
+#       require "#{app_path}/config/environment"
+#       assert_nothing_raised { [1,2,3].sample }
+#     end
+
+#     test "config.active_support.bare does not require all of ActiveSupport" do
+#       add_to_config "config.active_support.bare = true"
+
+#       use_frameworks []
+
+#       Dir.chdir("#{app_path}/app") do
+#         require "#{app_path}/config/environment"
+#         assert_raises(NoMethodError) { "hello".exclude? "lo" }
+#       end
+#     end
+
+#     # AR
+#     test "active_record extensions are applied to ActiveRecord" do
+#       add_to_config "config.active_record.table_name_prefix = 'tbl_'"
+#       require "#{app_path}/config/environment"
+#       assert_equal 'tbl_', ActiveRecord::Base.table_name_prefix
+#     end
+
+#     test "database middleware doesn't initialize when activerecord is not in frameworks" do
+#       use_frameworks []
+#       require "#{app_path}/config/environment"
+#       assert_nil defined?(ActiveRecord::Base)
+#     end
+
+#     test "use schema cache dump" do
+#       Dir.chdir(app_path) do
+#         `rails generate model post title:string;
+#          bundle exec rake db:migrate db:schema:cache:dump`
+#       end
+#       require "#{app_path}/config/environment"
+#       ActiveRecord::Base.connection.drop_table("posts") # force drop posts table for test.
+#       assert ActiveRecord::Base.connection.schema_cache.tables["posts"]
+#     end
+
+#     test "expire schema cache dump" do
+#       Dir.chdir(app_path) do
+#         `rails generate model post title:string;
+#          bundle exec rake db:migrate db:schema:cache:dump db:rollback`
+#       end
+#       silence_warnings {
+#         require "#{app_path}/config/environment"
+#         assert !ActiveRecord::Base.connection.schema_cache.tables["posts"]
+#       }
+#     end
+
+#     test "active record establish_connection uses Rails.env if DATABASE_URL is not set" do
+#       begin
+#         require "#{app_path}/config/environment"
+#         orig_database_url = ENV.delete("DATABASE_URL")
+#         orig_rails_env, Rails.env = Rails.env, 'development'
+#         ActiveRecord::Base.establish_connection
+#         assert ActiveRecord::Base.connection
+#         assert_match /#{ActiveRecord::Base.configurations[Rails.env]['database']}/, ActiveRecord::Base.connection_config[:database]
+#       ensure
+#         ActiveRecord::Base.remove_connection
+#         ENV["DATABASE_URL"] = orig_database_url if orig_database_url
+#         Rails.env = orig_rails_env if orig_rails_env
+#       end
+#     end
+
+#     test "active record establish_connection uses DATABASE_URL even if Rails.env is set" do
+#       begin
+#         require "#{app_path}/config/environment"
+#         orig_database_url = ENV.delete("DATABASE_URL")
+#         orig_rails_env, Rails.env = Rails.env, 'development'
+#         database_url_db_name = "db/database_url_db.sqlite3"
+#         ENV["DATABASE_URL"] = "sqlite3://:@localhost/#{database_url_db_name}"
+#         ActiveRecord::Base.establish_connection
+#         assert ActiveRecord::Base.connection
+#         assert_match /#{database_url_db_name}/, ActiveRecord::Base.connection_config[:database]
+#       ensure
+#         ActiveRecord::Base.remove_connection
+#         ENV["DATABASE_URL"] = orig_database_url if orig_database_url
+#         Rails.env = orig_rails_env if orig_rails_env
+#       end
+#     end
+#   end
+# end

data/test/rails/queue_test.rb

@@ -0,0 +1,169 @@
+require "support/isolation_abstract_unit"
+
+class QueueTest < ActiveSupport::TestCase
+  include ActiveSupport::Testing::Isolation
+
+  # overwrite the default `build_app` method to inject the gem for testing
+  def build_app
+    super
+
+    # inject the path to the gem we're testing
+    environment = File.read("#{app_path}/config/application.rb")
+    if environment =~ /(module AppTemplate)/
+      rails_four_queueing_path = File.expand_path(
+        "../../../lib/rails-four-queueing", __FILE__
+      )
+      File.open("#{app_path}/config/application.rb", 'w') do |f|
+        # BOOYA!!
+        f.puts $` + %Q(\nrequire "#{rails_four_queueing_path}"\n) + $1 + $'
+      end
+    end
+  end
+
+  def setup
+    build_app
+    boot_rails
+  end
+
+  def teardown
+    teardown_app
+  end
+
+  def app_const
+    @app_const ||= Class.new(Rails::Application)
+  end
+
+  test "the queue is a SynchronousQueue in test mode" do
+    app("test")
+    assert_kind_of Rails::Four::Queueing::SynchronousQueue, Rails.application.queue
+    assert_kind_of Rails::Four::Queueing::SynchronousQueue, Rails.queue
+  end
+
+  test "the queue is a SynchronousQueue in development mode" do
+    app("development")
+    assert_kind_of Rails::Four::Queueing::SynchronousQueue, Rails.application.queue
+    assert_kind_of Rails::Four::Queueing::SynchronousQueue, Rails.queue
+  end
+
+  class ThreadTrackingJob
+    def initialize
+      @origin = Thread.current.object_id
+    end
+
+    def run
+      @target = Thread.current.object_id
+    end
+
+    def ran_in_different_thread?
+      @origin != @target
+    end
+
+    def ran?
+      @target
+    end
+  end
+
+  test "in development mode, an enqueued job will be processed in the same thread" do
+    app("development")
+
+    job = ThreadTrackingJob.new
+    Rails.queue.push job
+    sleep 0.1
+
+    assert job.ran?, "Expected job to be run"
+    refute job.ran_in_different_thread?, "Expected job to run in the same thread"
+  end
+
+  test "in test mode, an enqueued job will be processed in the same thread" do
+    app("test")
+
+    job = ThreadTrackingJob.new
+    Rails.queue.push job
+    sleep 0.1
+
+    assert job.ran?, "Expected job to be run"
+    refute job.ran_in_different_thread?, "Expected job to run in the same thread"
+  end
+
+  test "in production, automatically spawn a queue consumer in a background thread" do
+    add_to_env_config "production", <<-RUBY
+      config.queue = Rails::Four::Queueing::Queue.new
+    RUBY
+
+    app("production")
+
+    assert_nil Rails.application.config.queue_consumer
+    assert_kind_of Rails::Four::Queueing::ThreadedQueueConsumer, Rails.application.queue_consumer
+    assert_equal Rails.logger, Rails.application.queue_consumer.logger
+  end
+
+  test "attempting to marshal a queue will raise an exception" do
+    app("test")
+    assert_raises TypeError do
+      Marshal.dump Rails.queue
+    end
+  end
+
+  def setup_custom_queue
+    add_to_env_config "production", <<-RUBY
+      require "my_queue"
+      config.queue = MyQueue.new
+    RUBY
+
+    app_file "lib/my_queue.rb", <<-RUBY
+      class MyQueue
+        def push(job)
+          job.run
+        end
+      end
+    RUBY
+
+    app("production")
+  end
+
+  test "a custom queue implementation can be provided" do
+    setup_custom_queue
+
+    assert_kind_of MyQueue, Rails.queue
+
+    job = Struct.new(:id, :ran) do
+      def run
+        self.ran = true
+      end
+    end
+
+    job1 = job.new(1)
+    Rails.queue.push job1
+
+    assert_equal true, job1.ran
+  end
+
+  test "a custom consumer implementation can be provided" do
+    add_to_env_config "production", <<-RUBY
+      require "my_queue_consumer"
+      config.queue = Rails::Four::Queueing::Queue.new
+      config.queue_consumer = MyQueueConsumer.new
+    RUBY
+
+    app_file "lib/my_queue_consumer.rb", <<-RUBY
+      class MyQueueConsumer
+        attr_reader :started
+
+        def start
+          @started = true
+        end
+      end
+    RUBY
+
+    app("production")
+
+    assert_kind_of MyQueueConsumer, Rails.application.queue_consumer
+    assert Rails.application.queue_consumer.started
+  end
+
+  test "default consumer is not used with custom queue implementation" do
+    setup_custom_queue
+
+    assert_nil Rails.application.queue_consumer
+  end
+end