summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/grape_logging/loggers/exception_logger_spec.rb
diff options
context:
space:
mode:
Diffstat (limited to 'spec/lib/gitlab/grape_logging/loggers/exception_logger_spec.rb')
-rw-r--r--spec/lib/gitlab/grape_logging/loggers/exception_logger_spec.rb69
1 files changed, 64 insertions, 5 deletions
diff --git a/spec/lib/gitlab/grape_logging/loggers/exception_logger_spec.rb b/spec/lib/gitlab/grape_logging/loggers/exception_logger_spec.rb
index c9021e2f436..cc9535d4d2c 100644
--- a/spec/lib/gitlab/grape_logging/loggers/exception_logger_spec.rb
+++ b/spec/lib/gitlab/grape_logging/loggers/exception_logger_spec.rb
@@ -3,14 +3,73 @@
require 'spec_helper'
describe Gitlab::GrapeLogging::Loggers::ExceptionLogger do
- subject { described_class.new }
-
let(:mock_request) { OpenStruct.new(env: {}) }
+ let(:response_body) { nil }
describe ".parameters" do
+ subject { described_class.new.parameters(mock_request, response_body) }
+
describe 'when no exception is available' do
it 'returns an empty hash' do
- expect(subject.parameters(mock_request, nil)).to eq({})
+ expect(subject).to eq({})
+ end
+ end
+
+ describe 'with a response' do
+ before do
+ mock_request.env[::API::Helpers::API_RESPONSE_STATUS_CODE] = code
+ end
+
+ context 'with a String response' do
+ let(:response_body) { { message: "something went wrong" }.to_json }
+ let(:code) { 400 }
+ let(:expected) { { api_error: [response_body.to_s] } }
+
+ it 'logs the response body' do
+ expect(subject).to eq(expected)
+ end
+ end
+
+ context 'with an Array response' do
+ let(:response_body) { ["hello world", 1] }
+ let(:code) { 400 }
+ let(:expected) { { api_error: ["hello world", "1"] } }
+
+ it 'casts all elements to strings' do
+ expect(subject).to eq(expected)
+ end
+ end
+
+ # Rack v2.0.9 can return a BodyProxy. This was changed in later versions:
+ # https://github.com/rack/rack/blob/2.0.9/lib/rack/response.rb#L69
+ context 'with a Rack BodyProxy response' do
+ let(:message) { { message: "something went wrong" }.to_json }
+ let(:response) { Rack::Response.new(message, code, {}) }
+ let(:response_body) { Rack::BodyProxy.new(response) }
+ let(:code) { 400 }
+ let(:expected) { { api_error: [message] } }
+
+ it 'logs the response body' do
+ expect(subject).to eq(expected)
+ end
+ end
+
+ context 'unauthorized error' do
+ let(:response_body) { 'unauthorized' }
+ let(:code) { 401 }
+
+ it 'does not log an api_error field' do
+ expect(subject).not_to have_key(:api_error)
+ end
+ end
+
+ context 'HTTP success' do
+ let(:response_body) { 'success' }
+ let(:code) { 200 }
+
+ it 'does not log an api_error field' do
+ expect(subject).not_to have_key(:api_error)
+ end
end
end
@@ -32,7 +91,7 @@ describe Gitlab::GrapeLogging::Loggers::ExceptionLogger do
end
it 'returns the correct fields' do
- expect(subject.parameters(mock_request, nil)).to eq(expected)
+ expect(subject).to eq(expected)
end
context 'with backtrace' do
@@ -43,7 +102,7 @@ describe Gitlab::GrapeLogging::Loggers::ExceptionLogger do
end
it 'includes the backtrace' do
- expect(subject.parameters(mock_request, nil)).to eq(expected)
+ expect(subject).to eq(expected)
end
end
end