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
102
103
104
105
106
107
108
109
110
|
# frozen_string_literal: true
require "test_prof"
module TestProf
module Rails
# Add `with_logging` and `with_ar_logging helpers`
module LoggingHelpers
class << self
attr_writer :logger
def logger
return @logger if instance_variable_defined?(:@logger)
@logger = Logger.new(STDOUT)
end
def ar_loggables
return @ar_loggables if instance_variable_defined?(:@ar_loggables)
@ar_loggables = [
::ActiveRecord::Base,
::ActiveSupport::LogSubscriber
]
end
# rubocop:disable Metrics/CyclomaticComplexity
# rubocop:disable Metrics/PerceivedComplexity
def all_loggables
return @all_loggables if instance_variable_defined?(:@all_loggables)
@all_loggables = [
::ActiveSupport::LogSubscriber,
::Rails,
defined?(::ActiveRecord::Base) && ::ActiveRecord::Base,
defined?(::ActiveJob::Base) && ::ActiveJob::Base,
defined?(::ActionView::Base) && ::ActionView::Base,
defined?(::ActionMailer::Base) && ::ActionMailer::Base,
defined?(::ActionCable::Server::Base.config) && ::ActionCable::Server::Base.config,
defined?(::ActiveStorage) && ::ActiveStorage
].compact
end
# rubocop:enable Metrics/CyclomaticComplexity
# rubocop:enable Metrics/PerceivedComplexity
def swap_logger(loggables)
loggables.map do |loggable|
was_logger = loggable.logger
loggable.logger = logger
was_logger
end
end
def restore_logger(was_loggers, loggables)
loggables.each_with_index do |loggable, i|
loggable.logger = was_loggers[i]
end
end
end
# Enable verbose Rails logging within a block
def with_logging
*loggers = LoggingHelpers.swap_logger(LoggingHelpers.all_loggables)
yield
ensure
LoggingHelpers.restore_logger(loggers, LoggingHelpers.all_loggables)
end
def with_ar_logging
*loggers = LoggingHelpers.swap_logger(LoggingHelpers.ar_loggables)
yield
ensure
LoggingHelpers.restore_logger(loggers, LoggingHelpers.ar_loggables)
end
end
end
end
if TestProf.rspec?
RSpec.shared_context "logging:verbose" do
around(:each) do |ex|
with_logging(&ex)
end
end
RSpec.shared_context "logging:active_record" do
around(:each) do |ex|
with_ar_logging(&ex)
end
end
RSpec.configure do |config|
config.include TestProf::Rails::LoggingHelpers
config.include_context "logging:active_record", log: :ar
config.include_context "logging:verbose", log: true
end
end
TestProf.activate("LOG", "all") do
TestProf.log :info, "Rails verbose logging enabled"
ActiveSupport::LogSubscriber.logger =
Rails.logger =
ActiveRecord::Base.logger = TestProf::Rails::LoggingHelpers.logger
end
TestProf.activate("LOG", "ar") do
TestProf.log :info, "Active Record verbose logging enabled"
ActiveSupport::LogSubscriber.logger =
ActiveRecord::Base.logger = TestProf::Rails::LoggingHelpers.logger
end
|
