summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/error_tracking/log_formatter_spec.rb
blob: 15d201401f44272ec3a2163bb2260b122a48f6e9 (plain)
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
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::ErrorTracking::LogFormatter do
  let(:exception) { StandardError.new('boom') }
  let(:context_payload) do
    {
      server: 'local-hostname-of-the-server',
      user: {
        ip_address: '127.0.0.1',
        username: 'root'
      },
      tags: {
        locale: 'en',
        feature_category: 'category_a'
      },
      extra: {
        some_other_info: 'other_info',
        sidekiq: {
          'class' => 'HelloWorker',
          'args' => ['senstive string', 1, 2],
          'another_field' => 'field'
        }
      }
    }
  end

  before do
    Raven.context.user[:user_flag] = 'flag'
    Raven.context.tags[:shard] = 'catchall'
    Raven.context.extra[:some_info] = 'info'

    allow(exception).to receive(:backtrace).and_return(
      [
        'lib/gitlab/file_a.rb:1',
        'lib/gitlab/file_b.rb:2'
      ]
    )
  end

  after do
    ::Raven::Context.clear!
  end

  it 'appends error-related log fields and filters sensitive Sidekiq arguments' do
    payload = described_class.new.generate_log(exception, context_payload)

    expect(payload).to eql(
      'exception.class' => 'StandardError',
      'exception.message' => 'boom',
      'exception.backtrace' => [
        'lib/gitlab/file_a.rb:1',
        'lib/gitlab/file_b.rb:2'
      ],
      'user.ip_address' => '127.0.0.1',
      'user.username' => 'root',
      'user.user_flag' => 'flag',
      'tags.locale' => 'en',
      'tags.feature_category' => 'category_a',
      'tags.shard' => 'catchall',
      'extra.some_other_info' => 'other_info',
      'extra.some_info' => 'info',
      "extra.sidekiq" => {
        "another_field" => "field",
        "args" => ["[FILTERED]", "1", "2"],
        "class" => "HelloWorker"
      }
    )
  end
end