spec/lib/gitlab/ci/reports/codequality_reports_comparer_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
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254

# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::Ci::Reports::CodequalityReportsComparer do
  let(:comparer) { described_class.new(base_report, head_report) }
  let(:base_report) { Gitlab::Ci::Reports::CodequalityReports.new }
  let(:head_report) { Gitlab::Ci::Reports::CodequalityReports.new }
  let(:degradation_1) { build(:codequality_degradation_1) }
  let(:degradation_2) { build(:codequality_degradation_2) }

  describe '#status' do
    subject(:report_status) { comparer.status }

    context 'when head report has an error' do
      before do
        head_report.add_degradation(degradation_1)
      end

      it 'returns status failed' do
        expect(report_status).to eq(described_class::STATUS_FAILED)
      end
    end

    context 'when head report does not have errors' do
      it 'returns status success' do
        expect(report_status).to eq(described_class::STATUS_SUCCESS)
      end
    end
  end

  describe '#errors_count' do
    subject(:errors_count) { comparer.errors_count }

    context 'when head report has an error' do
      before do
        head_report.add_degradation(degradation_1)
      end

      it 'returns the number of new errors' do
        expect(errors_count).to eq(1)
      end
    end

    context 'when head report does not have an error' do
      it 'returns zero' do
        expect(errors_count).to be_zero
      end
    end
  end

  describe '#resolved_count' do
    subject(:resolved_count) { comparer.resolved_count }

    context 'when base report has an error and head has a different error' do
      before do
        base_report.add_degradation(degradation_1)
        head_report.add_degradation(degradation_2)
      end

      it 'counts the base report error as resolved' do
        expect(resolved_count).to eq(1)
      end
    end

    context 'when base report has errors head has no errors' do
      before do
        base_report.add_degradation(degradation_1)
      end

      it 'counts the base report errors as resolved' do
        expect(resolved_count).to eq(1)
      end
    end

    context 'when base report has errors and head has the same error' do
      before do
        base_report.add_degradation(degradation_1)
        head_report.add_degradation(degradation_1)
      end

      it 'returns zero' do
        expect(resolved_count).to eq(0)
      end
    end

    context 'when base report does not have errors and head has errors' do
      before do
        head_report.add_degradation(degradation_1)
      end

      it 'returns zero' do
        expect(resolved_count).to be_zero
      end
    end
  end

  describe '#total_count' do
    subject(:total_count) { comparer.total_count }

    context 'when base report has an error' do
      before do
        base_report.add_degradation(degradation_1)
      end

      it 'returns zero' do
        expect(total_count).to be_zero
      end
    end

    context 'when head report has an error' do
      before do
        head_report.add_degradation(degradation_1)
      end

      it 'includes the head report error in the count' do
        expect(total_count).to eq(1)
      end
    end

    context 'when base report has errors and head report has errors' do
      before do
        base_report.add_degradation(degradation_1)
        head_report.add_degradation(degradation_2)
      end

      it 'includes errors in the count' do
        expect(total_count).to eq(1)
      end
    end

    context 'when base report has errors and head report has the same error' do
      before do
        base_report.add_degradation(degradation_1)
        head_report.add_degradation(degradation_1)
        head_report.add_degradation(degradation_2)
      end

      it 'includes errors in the count' do
        expect(total_count).to eq(2)
      end
    end
  end

  describe '#existing_errors' do
    subject(:existing_errors) { comparer.existing_errors }

    context 'when base report has errors and head has the same error' do
      before do
        base_report.add_degradation(degradation_1)
        head_report.add_degradation(degradation_1)
        head_report.add_degradation(degradation_2)
      end

      it 'includes the base report errors' do
        expect(existing_errors).to contain_exactly(degradation_1)
      end
    end

    context 'when base report has errors and head has a different error' do
      before do
        base_report.add_degradation(degradation_1)
        head_report.add_degradation(degradation_2)
      end

      it 'returns an empty array' do
        expect(existing_errors).to be_empty
      end
    end

    context 'when base report does not have errors and head has errors' do
      before do
        head_report.add_degradation(degradation_1)
      end

      it 'returns an empty array' do
        expect(existing_errors).to be_empty
      end
    end
  end

  describe '#new_errors' do
    subject(:new_errors) { comparer.new_errors }

    context 'when base report has errors and head has more errors' do
      before do
        base_report.add_degradation(degradation_1)
        head_report.add_degradation(degradation_1)
        head_report.add_degradation(degradation_2)
      end

      it 'includes errors not found in the base report' do
        expect(new_errors).to eq([degradation_2])
      end
    end

    context 'when base report has an error and head has no errors' do
      before do
        base_report.add_degradation(degradation_1)
      end

      it 'returns an empty array' do
        expect(new_errors).to be_empty
      end
    end

    context 'when base report does not have errors and head has errors' do
      before do
        head_report.add_degradation(degradation_1)
      end

      it 'returns the head report error' do
        expect(new_errors).to eq([degradation_1])
      end
    end
  end

  describe '#resolved_errors' do
    subject(:resolved_errors) { comparer.resolved_errors }

    context 'when base report errors are still found in the head report' do
      before do
        base_report.add_degradation(degradation_1)
        head_report.add_degradation(degradation_1)
        head_report.add_degradation(degradation_2)
      end

      it 'returns an empty array' do
        expect(resolved_errors).to be_empty
      end
    end

    context 'when base report has errors and head has a different error' do
      before do
        base_report.add_degradation(degradation_1)
        head_report.add_degradation(degradation_2)
      end

      it 'returns the base report error' do
        expect(resolved_errors).to eq([degradation_1])
      end
    end

    context 'when base report does not have errors and head has errors' do
      before do
        head_report.add_degradation(degradation_1)
      end

      it 'returns an empty array' do
        expect(resolved_errors).to be_empty
      end
    end
  end
end