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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
|
# frozen_string_literal: true
require 'fast_spec_helper'
require 'gitlab/dangerfiles/spec_helper'
require_relative '../../../tooling/danger/analytics_instrumentation'
require_relative '../../../tooling/danger/project_helper'
RSpec.describe Tooling::Danger::AnalyticsInstrumentation, feature_category: :service_ping do
include_context "with dangerfile"
subject(:analytics_instrumentation) { fake_danger.new(helper: fake_helper) }
let(:fake_danger) { DangerSpecHelper.fake_danger.include(described_class) }
let(:previous_label_to_add) { 'label_to_add' }
let(:labels_to_add) { [previous_label_to_add] }
let(:ci_env) { true }
let(:has_analytics_instrumentation_label) { true }
before do
allow(fake_helper).to receive(:changed_lines).and_return(changed_lines) if defined?(changed_lines)
allow(fake_helper).to receive(:labels_to_add).and_return(labels_to_add)
allow(fake_helper).to receive(:ci?).and_return(ci_env)
allow(fake_helper).to receive(:mr_has_labels?).with('analytics instrumentation').and_return(has_analytics_instrumentation_label)
end
describe '#check!' do
subject { analytics_instrumentation.check! }
let(:markdown_formatted_list) { 'markdown formatted list' }
let(:review_pending_label) { 'analytics instrumentation::review pending' }
let(:approved_label) { 'analytics instrumentation::approved' }
let(:changed_files) { ['metrics/counts_7d/test_metric.yml'] }
let(:changed_lines) { ['+tier: ee'] }
let(:fake_changes) { instance_double(Gitlab::Dangerfiles::Changes, files: changed_files) }
before do
allow(fake_changes).to receive(:by_category).with(:analytics_instrumentation).and_return(fake_changes)
allow(fake_helper).to receive(:changes).and_return(fake_changes)
allow(fake_helper).to receive(:all_changed_files).and_return(changed_files)
allow(fake_helper).to receive(:markdown_list).with(changed_files).and_return(markdown_formatted_list)
end
shared_examples "doesn't add new labels" do
it "doesn't add new labels" do
subject
expect(labels_to_add).to match_array [previous_label_to_add]
end
end
shared_examples "doesn't add new warnings" do
it "doesn't add new warnings" do
expect(analytics_instrumentation).not_to receive(:warn)
subject
end
end
shared_examples 'adds new labels' do
it 'adds new labels' do
subject
expect(labels_to_add).to match_array [previous_label_to_add, review_pending_label]
end
it 'receives all the changed files by calling the correct helper method', :aggregate_failures do
expect(fake_helper).not_to receive(:changes_by_category)
expect(fake_helper).to receive(:changes)
expect(fake_changes).to receive(:by_category).with(:analytics_instrumentation)
expect(fake_changes).to receive(:files)
subject
end
end
context 'with growth experiment label' do
before do
allow(fake_helper).to receive(:mr_has_labels?).with('growth experiment').and_return(true)
end
include_examples "doesn't add new labels"
include_examples "doesn't add new warnings"
end
context 'without growth experiment label' do
before do
allow(fake_helper).to receive(:mr_has_labels?).with('growth experiment').and_return(false)
end
context 'with approved label' do
let(:mr_labels) { [approved_label] }
include_examples "doesn't add new labels"
include_examples "doesn't add new warnings"
end
context 'without approved label' do
include_examples 'adds new labels'
it 'warns with proper message' do
expect(analytics_instrumentation).to receive(:warn).with(%r{#{markdown_formatted_list}})
subject
end
end
context 'with analytics instrumentation::review pending label' do
let(:mr_labels) { ['analytics instrumentation::review pending'] }
include_examples "doesn't add new labels"
end
context 'with analytics instrumentation::approved label' do
let(:mr_labels) { ['analytics instrumentation::approved'] }
include_examples "doesn't add new labels"
end
context 'with the analytics instrumentation label' do
let(:has_analytics_instrumentation_label) { true }
context 'with ci? false' do
let(:ci_env) { false }
include_examples "doesn't add new labels"
end
context 'with ci? true' do
include_examples 'adds new labels'
end
end
end
end
describe '#check_affected_scopes!' do
let(:fixture_dir_glob) { Dir.glob(File.join('spec', 'tooling', 'fixtures', 'metrics', '*.rb')) }
let(:changed_lines) { ['+ scope :active, -> { iwhere(email: Array(emails)) }'] }
before do
allow(Dir).to receive(:glob).and_return(fixture_dir_glob)
allow(fake_helper).to receive(:markdown_list).with({ 'active' => fixture_dir_glob }).and_return('a')
end
context 'when a model was modified' do
let(:modified_files) { ['app/models/super_user.rb'] }
context 'when a scope is changed' do
context 'and a metrics uses the affected scope' do
it 'producing warning' do
expect(analytics_instrumentation).to receive(:warn).with(%r{#{modified_files}})
analytics_instrumentation.check_affected_scopes!
end
end
context 'when no metrics using the affected scope' do
let(:changed_lines) { ['+scope :foo, -> { iwhere(email: Array(emails)) }'] }
it 'doesnt do anything' do
expect(analytics_instrumentation).not_to receive(:warn)
analytics_instrumentation.check_affected_scopes!
end
end
end
end
context 'when an unrelated model with matching scope was modified' do
let(:modified_files) { ['app/models/post_box.rb'] }
it 'doesnt do anything' do
expect(analytics_instrumentation).not_to receive(:warn)
analytics_instrumentation.check_affected_scopes!
end
end
context 'when models arent modified' do
let(:modified_files) { ['spec/app/models/user_spec.rb'] }
it 'doesnt do anything' do
expect(analytics_instrumentation).not_to receive(:warn)
analytics_instrumentation.check_affected_scopes!
end
end
end
describe '#check_usage_data_insertions!' do
context 'when usage_data.rb is modified' do
let(:modified_files) { ['lib/gitlab/usage_data.rb'] }
before do
allow(fake_helper).to receive(:changed_lines).with("lib/gitlab/usage_data.rb").and_return(changed_lines)
end
context 'and has insertions' do
let(:changed_lines) { ['+ ci_runners: count(::Ci::CiRunner),'] }
it 'produces warning' do
expect(analytics_instrumentation).to receive(:warn).with(/usage_data\.rb has been deprecated/)
analytics_instrumentation.check_usage_data_insertions!
end
end
context 'and changes are not insertions' do
let(:changed_lines) { ['- ci_runners: count(::Ci::CiRunner),'] }
it 'doesnt do anything' do
expect(analytics_instrumentation).not_to receive(:warn)
analytics_instrumentation.check_usage_data_insertions!
end
end
end
context 'when usage_data.rb is not modified' do
context 'and another file has insertions' do
let(:modified_files) { ['tooling/danger/analytics_instrumentation.rb'] }
it 'doesnt do anything' do
expect(fake_helper).to receive(:changed_lines).with("lib/gitlab/usage_data.rb").and_return([])
allow(fake_helper).to receive(:changed_lines).with("tooling/danger/analytics_instrumentation.rb").and_return(["+ Inserting"])
expect(analytics_instrumentation).not_to receive(:warn)
analytics_instrumentation.check_usage_data_insertions!
end
end
end
end
describe '#check_deprecated_data_sources!' do
let(:fake_project_helper) { instance_double(Tooling::Danger::ProjectHelper) }
subject(:check_data_source) { analytics_instrumentation.check_deprecated_data_sources! }
before do
allow(fake_helper).to receive(:added_files).and_return([added_file])
allow(fake_helper).to receive(:changed_lines).with(added_file).and_return(changed_lines)
allow(analytics_instrumentation).to receive(:project_helper).and_return(fake_project_helper)
allow(analytics_instrumentation.project_helper).to receive(:file_lines).and_return(changed_lines.map { |line| line.delete_prefix('+') })
end
context 'when no metric definitions were modified' do
let(:added_file) { 'app/models/user.rb' }
let(:changed_lines) { ['+ data_source: redis,'] }
it 'does not trigger warning' do
expect(analytics_instrumentation).not_to receive(:markdown)
check_data_source
end
end
context 'when metrics fields were modified' do
let(:added_file) { 'config/metrics/count7_d/example_metric.yml' }
[:redis, :redis_hll].each do |source|
context "when source is #{source}" do
let(:changed_lines) { ["+ data_source: #{source}"] }
let(:template) do
<<~SUGGEST_COMMENT
```suggestion
data_source: internal_events
```
%<message>s
SUGGEST_COMMENT
end
it 'issues a warning' do
expected_comment = format(template, message: Tooling::Danger::AnalyticsInstrumentation::CHANGE_DEPRECATED_DATA_SOURCE_MESSAGE)
expect(analytics_instrumentation).to receive(:markdown).with(expected_comment.strip, file: added_file, line: 1)
check_data_source
end
end
end
context 'when neither redis nor redis_hll used as a data_source' do
let(:changed_lines) { ['+ data_source: database,'] }
it 'does not issue a warning' do
expect(analytics_instrumentation).not_to receive(:markdown)
check_data_source
end
end
end
end
end
|