summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/utils/override_spec.rb
blob: 7c97cee982aa4d56ecdc200eac15881ec2735a0e (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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
require 'spec_helper'

describe Gitlab::Utils::Override do
  let(:base) { Struct.new(:good) }

  let(:derived) { Class.new(base).tap { |m| m.extend described_class } }
  let(:extension) { Module.new.tap { |m| m.extend described_class } }

  let(:prepending_class) { base.tap { |m| m.prepend extension } }
  let(:including_class) { base.tap { |m| m.include extension } }

  let(:klass) { subject }

  def good(mod)
    mod.module_eval do
      override :good
      def good
        super.succ
      end
    end

    mod
  end

  def bad(mod)
    mod.module_eval do
      override :bad
      def bad
        true
      end
    end

    mod
  end

  shared_examples 'checking as intended' do
    it 'checks ok for overriding method' do
      good(subject)
      result = klass.new(0).good

      expect(result).to eq(1)
      described_class.verify!
    end

    it 'raises NotImplementedError when it is not overriding anything' do
      expect do
        bad(subject)
        klass.new(0).bad
        described_class.verify!
      end.to raise_error(NotImplementedError)
    end
  end

  shared_examples 'nothing happened' do
    it 'does not complain when it is overriding something' do
      good(subject)
      result = klass.new(0).good

      expect(result).to eq(1)
      described_class.verify!
    end

    it 'does not complain when it is not overriding anything' do
      bad(subject)
      result = klass.new(0).bad

      expect(result).to eq(true)
      described_class.verify!
    end
  end

  before do
    # Make sure we're not touching the internal cache
    allow(described_class).to receive(:extensions).and_return({})
  end

  describe '#override' do
    context 'when STATIC_VERIFICATION is set' do
      before do
        stub_env('STATIC_VERIFICATION', 'true')
      end

      context 'when subject is a class' do
        subject { derived }

        it_behaves_like 'checking as intended'
      end

      context 'when subject is a module, and class is prepending it' do
        subject { extension }
        let(:klass) { prepending_class }

        it_behaves_like 'checking as intended'
      end

      context 'when subject is a module, and class is including it' do
        subject { extension }
        let(:klass) { including_class }

        it 'raises NotImplementedError because it is not overriding it' do
          expect do
            good(subject)
            klass.new(0).good
            described_class.verify!
          end.to raise_error(NotImplementedError)
        end

        it 'raises NotImplementedError when it is not overriding anything' do
          expect do
            bad(subject)
            klass.new(0).bad
            described_class.verify!
          end.to raise_error(NotImplementedError)
        end
      end
    end
  end

  context 'when STATIC_VERIFICATION is not set' do
    before do
      stub_env('STATIC_VERIFICATION', nil)
    end

    context 'when subject is a class' do
      subject { derived }

      it_behaves_like 'nothing happened'
    end

    context 'when subject is a module, and class is prepending it' do
      subject { extension }
      let(:klass) { prepending_class }

      it_behaves_like 'nothing happened'
    end

    context 'when subject is a module, and class is including it' do
      subject { extension }
      let(:klass) { including_class }

      it 'does not complain when it is overriding something' do
        good(subject)
        result = klass.new(0).good

        expect(result).to eq(0)
        described_class.verify!
      end

      it 'does not complain when it is not overriding anything' do
        bad(subject)
        result = klass.new(0).bad

        expect(result).to eq(true)
        described_class.verify!
      end
    end
  end
end