spec/lib/gitlab/loggable_spec.rb


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

# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::Loggable, feature_category: :logging do
  subject(:klass_instance) do
    Class.new do
      include Gitlab::Loggable

      def self.name
        'MyTestClass'
      end
    end.new
  end

  describe '#build_structured_payload' do
    it 'adds class and returns formatted json' do
      expected = {
        'class' => 'MyTestClass',
        'message' => 'test'
      }

      expect(klass_instance.build_structured_payload(message: 'test')).to eq(expected)
    end

    it 'appends additional params and returns formatted json' do
      expected = {
        'class' => 'MyTestClass',
        'message' => 'test',
        'extra_param' => 1
      }

      expect(klass_instance.build_structured_payload(message: 'test', extra_param: 1)).to eq(expected)
    end

    it 'does not raise an error in loggers when passed non-symbols' do
      expected = {
        'class' => 'MyTestClass',
        'message' => 'test',
        '["hello", "thing"]' => :world
      }

      payload = klass_instance.build_structured_payload(message: 'test', %w[hello thing] => :world)
      expect(payload).to eq(expected)
      expect { Gitlab::Export::Logger.info(payload) }.not_to raise_error
    end

    it 'handles anonymous classes' do
      anonymous_klass_instance = Class.new { include Gitlab::Loggable }.new

      expected = {
        'class' => '<Anonymous>',
        'message' => 'test'
      }

      expect(anonymous_klass_instance.build_structured_payload(message: 'test')).to eq(expected)
    end

    it 'handles duplicate keys' do
      expected = {
        'class' => 'MyTestClass',
        'message' => 'test2'
      }

      expect(klass_instance.build_structured_payload(message: 'test', 'message' => 'test2')).to eq(expected)
    end
  end
end