Refactor `Gitlab::ErrorTracking.track_exception specs

spec/lib/gitlab/error_tracking_spec.rb

@@ -198,47 +198,39 @@
   end
 
   describe '.track_exception' do
-    it 'calls Raven.capture_exception' do
-      expected_extras = {
-        some_other_info: 'info',
-        issue_url: issue_url
-      }
+    let(:extra) { { issue_url: issue_url, some_other_info: 'info' } }
 
-      expected_tags = {
-        correlation_id: 'cid'
-      }
+    subject(:track_exception) { described_class.track_exception(exception, extra) }
 
-      expect(Raven).to receive(:capture_exception)
-                         .with(exception,
-                          tags: a_hash_including(expected_tags),
-                          extra: a_hash_including(expected_extras))
-
-      described_class.track_exception(
-        exception,
-        issue_url: issue_url,
-        some_other_info: 'info'
-      )
+    before do
+      allow(Raven).to receive(:capture_exception).and_call_original
+      allow(Gitlab::ErrorTracking::Logger).to receive(:error)
+    end
+
+    it 'calls Raven.capture_exception' do
+      track_exception
+
+      expect(Raven).to have_received(:capture_exception)
+                   .with(exception,
+                         tags: a_hash_including(correlation_id: 'cid'),
+                         extra: a_hash_including(some_other_info: 'info', issue_url: issue_url))
     end
 
     it 'calls Gitlab::ErrorTracking::Logger.error with formatted payload' do
-      expect(Gitlab::ErrorTracking::Logger).to receive(:error)
-        .with(a_hash_including(*expected_payload_includes))
+      track_exception
 
-      described_class.track_exception(
-        exception,
-        issue_url: issue_url,
-        some_other_info: 'info'
-      )
+      expect(Gitlab::ErrorTracking::Logger).to have_received(:error)
+                                           .with(a_hash_including(*expected_payload_includes))
     end
 
     context 'with filterable parameters' do
       let(:extra) { { test: 1, my_token: 'test' } }
 
       it 'filters parameters' do
-        expect(Gitlab::ErrorTracking::Logger).to receive(:error).with(
-          hash_including({ 'extra.test' => 1, 'extra.my_token' => '[FILTERED]' }))
+        track_exception
 
-        described_class.track_exception(exception, extra)
+        expect(Gitlab::ErrorTracking::Logger).to have_received(:error)
+                                             .with(hash_including({ 'extra.test' => 1, 'extra.my_token' => '[FILTERED]' }))
       end
     end
 
@@ -247,56 +239,55 @@
       let(:exception) { double(message: 'bang!', sentry_extra_data: extra_info, backtrace: caller) }
 
       it 'includes the extra data from the exception in the tracking information' do
-        expect(Raven).to receive(:capture_exception)
-          .with(exception, a_hash_including(extra: a_hash_including(extra_info)))
+        track_exception
 
-        described_class.track_exception(exception)
+        expect(Raven).to have_received(:capture_exception)
+                     .with(exception, a_hash_including(extra: a_hash_including(extra_info)))
       end
     end
 
     context 'the exception implements :sentry_extra_data, which returns nil' do
       let(:exception) { double(message: 'bang!', sentry_extra_data: nil, backtrace: caller) }
+      let(:extra) { { issue_url: issue_url } }
 
       it 'just includes the other extra info' do
-        extra_info = { issue_url: issue_url }
-        expect(Raven).to receive(:capture_exception)
-          .with(exception, a_hash_including(extra: a_hash_including(extra_info)))
+        track_exception
 
-        described_class.track_exception(exception, extra_info)
+        expect(Raven).to have_received(:capture_exception)
+                     .with(exception, a_hash_including(extra: a_hash_including(extra)))
       end
     end
 
     context 'with sidekiq args' do
-      it 'ensures extra.sidekiq.args is a string' do
-        extra = { sidekiq: { 'class' => 'PostReceive', 'args' => [1, { 'id' => 2, 'name' => 'hello' }, 'some-value', 'another-value'] } }
+      context 'when the args does not have anything sensitive' do
+        let(:extra) { { sidekiq: { 'class' => 'PostReceive', 'args' => [1, { 'id' => 2, 'name' => 'hello' }, 'some-value', 'another-value'] } } }
 
-        expect(Gitlab::ErrorTracking::Logger).to receive(:error).with(
-          hash_including({ 'extra.sidekiq' => { 'class' => 'PostReceive', 'args' => ['1', '{"id"=>2, "name"=>"hello"}', 'some-value', 'another-value'] } }))
+        it 'ensures extra.sidekiq.args is a string' do
+          track_exception
 
-        described_class.track_exception(exception, extra)
+          expect(Gitlab::ErrorTracking::Logger).to have_received(:error).with(
+            hash_including({ 'extra.sidekiq' => { 'class' => 'PostReceive', 'args' => ['1', '{"id"=>2, "name"=>"hello"}', 'some-value', 'another-value'] } }))
+        end
       end
 
-      it 'filters sensitive arguments before sending' do
-        extra = { sidekiq: { 'class' => 'UnknownWorker', 'args' => ['sensitive string', 1, 2] } }
-
-        expect(Gitlab::ErrorTracking::Logger).to receive(:error).with(
-          hash_including('extra.sidekiq' => { 'class' => 'UnknownWorker', 'args' => ['[FILTERED]', '1', '2'] }))
+      context 'when the args has sensitive information' do
+        let(:extra) { { sidekiq: { 'class' => 'UnknownWorker', 'args' => ['sensitive string', 1, 2] } } }
 
-        described_class.track_exception(exception, extra)
+        it 'filters sensitive arguments before sending' do
+          track_exception
 
-        expect(sentry_event.dig('extra', 'sidekiq', 'args')).to eq(['[FILTERED]', 1, 2])
+          expect(sentry_event.dig('extra', 'sidekiq', 'args')).to eq(['[FILTERED]', 1, 2])
+          expect(Gitlab::ErrorTracking::Logger).to have_received(:error).with(
+            hash_including('extra.sidekiq' => { 'class' => 'UnknownWorker', 'args' => ['[FILTERED]', '1', '2'] }))
+        end
       end
     end
 
     context 'when the error is kind of an `ActiveRecord::StatementInvalid`' do
       let(:exception) { ActiveRecord::StatementInvalid.new(sql: :foo) }
 
-      before do
-        allow(Raven).to receive(:capture_exception)
-      end
-
       it 'injects the sql query into extra' do
-        described_class.track_exception(exception)
+        track_exception
 
         expect(Raven).to have_received(:capture_exception)
           .with(exception, a_hash_including(extra: a_hash_including(sql: :foo)))