DEV: Remove the use of stubs on `Rails.logger` in our test suite.

This commit is contained in:
Guo Xiang Tan 2018-10-10 09:34:50 +08:00
parent 9b01e2b855
commit f26804394a
6 changed files with 79 additions and 37 deletions

View File

@ -62,17 +62,25 @@ module DiscourseHub
}.merge(connect_opts)
)
if response.status != 200
Rails.logger.warn("Discourse Hub (#{hub_base_url}#{rel_url}) returned a bad status #{response.status}.")
if (status = response.status) != 200
Rails.logger.warn(response_status_log_message(rel_url, status))
end
begin
JSON.parse(response.body)
rescue JSON::ParserError
Rails.logger.error("Discourse Hub returned a bad response body: " + response.body)
Rails.logger.error(response_body_log_message(response.body))
end
end
def self.response_status_log_message(rel_url, status)
"Discourse Hub (#{hub_base_url}#{rel_url}) returned a bad status #{status}."
end
def self.response_body_log_message(body)
"Discourse Hub returned a bad response body: #{body}"
end
def self.connect_opts(params = {})
params.delete(:connect_opts)&.except(:body, :headers, :query) || {}
end

View File

@ -77,23 +77,28 @@ describe DiscourseHub do
end
describe '.collection_action' do
before do
@orig_logger = Rails.logger
Rails.logger = @fake_logger = FakeLogger.new
end
it 'should log a warning if status is not 200' do
stub_request(:get, (ENV['HUB_BASE_URL'] || "http://local.hub:3000/api")).
after do
Rails.logger = @orig_logger
end
it 'should log correctly on error' do
stub_request(:get, (ENV['HUB_BASE_URL'] || "http://local.hub:3000/api/test")).
to_return(status: 500, body: "", headers: {})
Rails.logger.expects(:warn)
DiscourseHub.collection_action(:get, '/test')
DiscourseHub.collection_action(:get, "")
end
expect(Rails.logger.warnings).to eq([
DiscourseHub.response_status_log_message('/test', 500),
])
it 'should log an error if response is invalid JSON' do
stub_request(:get, (ENV['HUB_BASE_URL'] || "http://local.hub:3000/api")).
to_return(status: 200, body: "this is not valid JSON", headers: {})
Rails.logger.expects(:error)
DiscourseHub.collection_action(:get, "")
expect(Rails.logger.errors).to eq([
DiscourseHub.response_body_log_message("")
])
end
end
end

View File

@ -275,15 +275,6 @@ describe Discourse do
end
context '#deprecate' do
class FakeLogger
attr_reader :warnings
def warn(m)
@warnings ||= []
@warnings << m
end
end
def old_method(m)
Discourse.deprecate(m)
end
@ -307,7 +298,7 @@ describe Discourse do
expect(old_method_caller(k)).to include("discourse_spec")
expect(old_method_caller(k)).to include(k)
expect(@fake_logger.warnings).to eq([old_method_caller(k)])
expect(Rails.logger.warnings).to eq([old_method_caller(k)])
end
end

View File

@ -103,14 +103,27 @@ describe Email::Processor do
let(:mail2) { "From: #{from}\nTo: foo@foo.com\nSubject: BAR BAR\n\nBar bar bar bar?" }
it "sends a rejection email on an unrecognized error" do
begin
@orig_logger = Rails.logger
Rails.logger = @fake_logger = FakeLogger.new
Email::Processor.any_instance.stubs(:can_send_rejection_email?).returns(true)
Email::Receiver.any_instance.stubs(:process_internal).raises("boom")
Rails.logger.expects(:error)
Email::Processor.process!(mail)
expect(IncomingEmail.last.error).to eq("boom")
expect(IncomingEmail.last.rejection_message).to be_present
errors = Rails.logger.errors
expect(errors.size).to eq(1)
expect(errors.first).to include("boom")
incoming_email = IncomingEmail.last
expect(incoming_email.error).to eq("boom")
expect(incoming_email.rejection_message).to be_present
expect(EmailLog.last.email_type).to eq("email_reject_unrecognized_error")
ensure
Rails.logger = @orig_logger
end
end
it "sends more than one rejection email per day" do

View File

@ -814,18 +814,27 @@ describe Report do
end
describe "unexpected error on report initialization" do
before do
@orig_logger = Rails.logger
Rails.logger = @fake_logger = FakeLogger.new
end
after do
Rails.logger = @orig_logger
end
it "returns no report" do
class ReportInitError < StandardError; end
Report.stubs(:new).raises(ReportInitError.new("x"))
Rails.logger.expects(:error)
.with('Couldnt create report `signups`: <ReportInitError x>')
.once
report = Report.find('signups')
expect(report).to be_nil
expect(Rails.logger.errors).to eq([
'Couldnt create report `signups`: <ReportInitError x>'
])
end
end

View File

@ -0,0 +1,16 @@
class FakeLogger
attr_reader :warnings, :errors
def initialize
@warnings = []
@errors = []
end
def warn(message)
@warnings << message
end
def error(message)
@errors << message
end
end