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
|
# frozen_string_literal: true
require 'rspec-parameterized'
require 'gitlab-dangerfiles'
require 'danger'
require 'danger/plugins/internal/helper'
require 'gitlab/dangerfiles/spec_helper'
require_relative '../../../tooling/danger/specs'
require_relative '../../../tooling/danger/project_helper'
RSpec.describe Tooling::Danger::Specs do
include_context "with dangerfile"
let(:fake_danger) { DangerSpecHelper.fake_danger.include(described_class) }
let(:fake_project_helper) { instance_double('Tooling::Danger::ProjectHelper') }
let(:filename) { 'spec/foo_spec.rb' }
let(:file_lines) do
[
" describe 'foo' do",
" expect(foo).to match(['bar'])",
" end",
" expect(foo).to match(['bar'])", # same line as line 1 above, we expect two different suggestions
" ",
" expect(foo).to match ['bar']",
" expect(foo).to eq(['bar'])",
" expect(foo).to eq ['bar']",
" expect(foo).to(match(['bar']))",
" expect(foo).to(eq(['bar']))",
" foo.eq(['bar'])"
]
end
let(:matching_lines) do
[
"+ expect(foo).to match(['should not error'])",
"+ expect(foo).to match(['bar'])",
"+ expect(foo).to match(['bar'])",
"+ expect(foo).to match ['bar']",
"+ expect(foo).to eq(['bar'])",
"+ expect(foo).to eq ['bar']",
"+ expect(foo).to(match(['bar']))",
"+ expect(foo).to(eq(['bar']))"
]
end
let(:changed_lines) do
[
" expect(foo).to match(['bar'])",
" expect(foo).to match(['bar'])",
" expect(foo).to match ['bar']",
" expect(foo).to eq(['bar'])",
" expect(foo).to eq ['bar']",
"- expect(foo).to match(['bar'])",
"- expect(foo).to match(['bar'])",
"- expect(foo).to match ['bar']",
"- expect(foo).to eq(['bar'])",
"- expect(foo).to eq ['bar']",
"+ expect(foo).to eq([])"
] + matching_lines
end
subject(:specs) { fake_danger.new(helper: fake_helper) }
before do
allow(specs).to receive(:project_helper).and_return(fake_project_helper)
allow(specs.helper).to receive(:changed_lines).with(filename).and_return(matching_lines)
allow(specs.project_helper).to receive(:file_lines).and_return(file_lines)
end
describe '#changed_specs_files' do
let(:base_expected_files) { %w[spec/foo_spec.rb ee/spec/foo_spec.rb spec/bar_spec.rb ee/spec/bar_spec.rb spec/zab_spec.rb ee/spec/zab_spec.rb] }
before do
all_changed_files = %w[
app/workers/a.rb
app/workers/b.rb
app/workers/e.rb
spec/foo_spec.rb
ee/spec/foo_spec.rb
spec/bar_spec.rb
ee/spec/bar_spec.rb
spec/zab_spec.rb
ee/spec/zab_spec.rb
]
allow(specs.helper).to receive(:all_changed_files).and_return(all_changed_files)
end
it 'returns added, modified, and renamed_after files by default' do
expect(specs.changed_specs_files).to match_array(base_expected_files)
end
context 'with include_ee: :exclude' do
it 'returns spec files without EE-specific files' do
expect(specs.changed_specs_files(ee: :exclude)).not_to include(%w[ee/spec/foo_spec.rb ee/spec/bar_spec.rb ee/spec/zab_spec.rb])
end
end
context 'with include_ee: :only' do
it 'returns EE-specific spec files only' do
expect(specs.changed_specs_files(ee: :only)).to match_array(%w[ee/spec/foo_spec.rb ee/spec/bar_spec.rb ee/spec/zab_spec.rb])
end
end
end
describe '#add_suggestions_for_match_with_array' do
let(:template) do
<<~MARKDOWN
```suggestion
%<suggested_line>s
```
If order of the result is not important, please consider using `match_array` to avoid flakiness.
MARKDOWN
end
it 'adds suggestions at the correct lines' do
[
{ suggested_line: " expect(foo).to match_array(['bar'])", number: 2 },
{ suggested_line: " expect(foo).to match_array(['bar'])", number: 4 },
{ suggested_line: " expect(foo).to match_array ['bar']", number: 6 },
{ suggested_line: " expect(foo).to match_array(['bar'])", number: 7 },
{ suggested_line: " expect(foo).to match_array ['bar']", number: 8 },
{ suggested_line: " expect(foo).to(match_array(['bar']))", number: 9 },
{ suggested_line: " expect(foo).to(match_array(['bar']))", number: 10 }
].each do |test_case|
comment = format(template, suggested_line: test_case[:suggested_line])
expect(specs).to receive(:markdown).with(comment, file: filename, line: test_case[:number])
end
specs.add_suggestions_for_match_with_array(filename)
end
end
describe '#add_suggestions_for_project_factory_usage' do
let(:template) do
<<~MARKDOWN
```suggestion
%<suggested_line>s
```
Project creations are very slow. Use `let_it_be`, `build` or `build_stubbed` if possible.
See [testing best practices](https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#optimize-factory-usage)
for background information and alternative options.
MARKDOWN
end
let(:file_lines) do
[
" let(:project) { create(:project) }",
" let_it_be(:project) { create(:project, :repository)",
" let!(:project) { create(:project) }",
" let(:var) { create(:project) }",
" let(:merge_request) { create(:merge_request, project: project)",
" context 'when merge request exists' do",
" it { is_expected.to be_success }",
" end",
" let!(:var) { create(:project) }",
" let(:project) { create(:thing) }",
" let(:project) { build(:project) }",
" let(:project) do",
" create(:project)",
" end",
" let(:project) { create(:project, :repository) }",
" str = 'let(:project) { create(:project) }'",
" let(:project) { create(:project_empty_repo) }",
" let(:project) { create(:forked_project_with_submodules) }",
" let(:project) { create(:project_with_design) }",
" let(:authorization) { create(:project_authorization) }"
]
end
let(:matching_lines) do
[
"+ let(:should_not_error) { create(:project) }",
"+ let(:project) { create(:project) }",
"+ let!(:project) { create(:project) }",
"+ let(:var) { create(:project) }",
"+ let!(:var) { create(:project) }",
"+ let(:project) { create(:project, :repository) }",
"+ let(:project) { create(:project_empty_repo) }",
"+ let(:project) { create(:forked_project_with_submodules) }",
"+ let(:project) { create(:project_with_design) }"
]
end
let(:changed_lines) do
[
"+ line which doesn't exist in the file and should not cause an error",
"+ let_it_be(:project) { create(:project, :repository)",
"+ let(:project) { create(:thing) }",
"+ let(:project) do",
"+ create(:project)",
"+ end",
"+ str = 'let(:project) { create(:project) }'",
"+ let(:authorization) { create(:project_authorization) }"
] + matching_lines
end
it 'adds suggestions at the correct lines', :aggregate_failures do
[
{ suggested_line: " let_it_be(:project) { create(:project) }", number: 1 },
{ suggested_line: " let_it_be(:project) { create(:project) }", number: 3 },
{ suggested_line: " let_it_be(:var) { create(:project) }", number: 4 },
{ suggested_line: " let_it_be(:var) { create(:project) }", number: 9 },
{ suggested_line: " let_it_be(:project) { create(:project, :repository) }", number: 15 },
{ suggested_line: " let_it_be(:project) { create(:project_empty_repo) }", number: 17 },
{ suggested_line: " let_it_be(:project) { create(:forked_project_with_submodules) }", number: 18 },
{ suggested_line: " let_it_be(:project) { create(:project_with_design) }", number: 19 }
].each do |test_case|
comment = format(template, suggested_line: test_case[:suggested_line])
expect(specs).to receive(:markdown).with(comment, file: filename, line: test_case[:number])
end
specs.add_suggestions_for_project_factory_usage(filename)
end
end
end
|
