Skip to content
This repository
tag: v3.1.0.rc3
Fetching contributors…

Cannot retrieve contributors at this time

file 101 lines (88 sloc) 3.081 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
require 'active_support/log_subscriber'
require 'active_support/buffered_logger'
require 'active_support/notifications'

module ActiveSupport
  class LogSubscriber
    # Provides some helpers to deal with testing log subscribers by setting up
    # notifications. Take for instance Active Record subscriber tests:
    #
    # class SyncLogSubscriberTest < ActiveSupport::TestCase
    # include ActiveSupport::LogSubscriber::TestHelper
    #
    # def setup
    # ActiveRecord::LogSubscriber.attach_to(:active_record)
    # end
    #
    # 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
    # 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 are responsible 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 does 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::Fanout.new

        ActiveSupport::LogSubscriber.colorize_logging = false

        @old_notifier = ActiveSupport::Notifications.notifier
        set_logger(@logger)
        ActiveSupport::Notifications.notifier = @notifier
      end

      def teardown
        set_logger(nil)
        ActiveSupport::Notifications.notifier = @old_notifier
      end

      class MockLogger
        include ActiveSupport::BufferedLogger::Severity

        attr_reader :flush_count
        attr_accessor :level

        def initialize(level = DEBUG)
          @flush_count = 0
          @level = level
          @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

        ActiveSupport::BufferedLogger::Severity.constants.each do |severity|
          class_eval <<-EOT, __FILE__, __LINE__ + 1
def #{severity.downcase}?
#{severity} >= @level
end
EOT
        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)
        ActiveSupport::LogSubscriber.logger = logger
      end
    end
  end
end
Something went wrong with that request. Please try again.