97 lines
2.9 KiB
Ruby
97 lines
2.9 KiB
Ruby
require 'rails/log_subscriber'
|
|
|
|
module Rails
|
|
class LogSubscriber
|
|
# Provides some helpers to deal with testing log subscribers by setting up
|
|
# notifications. Take for instance ActiveRecord subscriber tests:
|
|
#
|
|
# class SyncLogSubscriberTest < ActiveSupport::TestCase
|
|
# include Rails::LogSubscriber::TestHelper
|
|
# Rails::LogSubscriber.add(:active_record, ActiveRecord::Railties::LogSubscriber.new)
|
|
#
|
|
# def test_basic_query_logging
|
|
# Developer.all
|
|
# wait
|
|
# assert_equal 1, @logger.logged(:debug).size
|
|
# assert_match /Developer Load/, @logger.logged(:debug).last
|
|
# assert_match /SELECT \* FROM "developers"/, @logger.logged(:debug).last
|
|
# end
|
|
#
|
|
# class SyncLogSubscriberTest < ActiveSupport::TestCase
|
|
# include Rails::LogSubscriber::SyncTestHelper
|
|
# include LogSubscriberTest
|
|
# end
|
|
#
|
|
# class AsyncLogSubscriberTest < ActiveSupport::TestCase
|
|
# include Rails::LogSubscriber::AsyncTestHelper
|
|
# include LogSubscriberTest
|
|
# end
|
|
# end
|
|
#
|
|
# All you need to do is to ensure that your log subscriber is added to Rails::Subscriber,
|
|
# as in the second line of the code above. The test helpers is reponsible for setting
|
|
# up the queue, subscriptions and turning colors in logs off.
|
|
#
|
|
# The messages are available in the @logger instance, which is a logger with limited
|
|
# powers (it actually do not send anything to your output), and you can collect them
|
|
# doing @logger.logged(level), where level is the level used in logging, like info,
|
|
# debug, warn and so on.
|
|
#
|
|
module TestHelper
|
|
def setup
|
|
@logger = MockLogger.new
|
|
@notifier = ActiveSupport::Notifications::Notifier.new(queue)
|
|
|
|
Rails::LogSubscriber.colorize_logging = false
|
|
|
|
set_logger(@logger)
|
|
ActiveSupport::Notifications.notifier = @notifier
|
|
end
|
|
|
|
def teardown
|
|
set_logger(nil)
|
|
ActiveSupport::Notifications.notifier = nil
|
|
end
|
|
|
|
class MockLogger
|
|
attr_reader :flush_count
|
|
|
|
def initialize
|
|
@flush_count = 0
|
|
@logged = Hash.new { |h,k| h[k] = [] }
|
|
end
|
|
|
|
def method_missing(level, message)
|
|
@logged[level] << message
|
|
end
|
|
|
|
def logged(level)
|
|
@logged[level].compact.map { |l| l.to_s.strip }
|
|
end
|
|
|
|
def flush
|
|
@flush_count += 1
|
|
end
|
|
end
|
|
|
|
# Wait notifications to be published.
|
|
def wait
|
|
@notifier.wait
|
|
end
|
|
|
|
# Overwrite if you use another logger in your log subscriber:
|
|
#
|
|
# def logger
|
|
# ActiveRecord::Base.logger = @logger
|
|
# end
|
|
#
|
|
def set_logger(logger)
|
|
Rails.logger = logger
|
|
end
|
|
|
|
def queue
|
|
ActiveSupport::Notifications::Fanout.new
|
|
end
|
|
end
|
|
end
|
|
end |