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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::GithubImport::Representation::DiffNote, :clean_gitlab_redis_cache do
let(:hunk) do
'@@ -1 +1 @@
-Hello
+Hello world'
end
let(:merge_request) do
double(
:merge_request,
id: 54,
diff_refs: double(
:refs,
base_sha: 'base',
start_sha: 'start',
head_sha: 'head'
)
)
end
let(:project) { double(:project, id: 836) }
let(:note_id) { 1 }
let(:in_reply_to_id) { nil }
let(:start_line) { nil }
let(:end_line) { 23 }
let(:note_body) { 'Hello world' }
let(:user_data) { { 'id' => 4, 'login' => 'alice' } }
let(:side) { 'RIGHT' }
let(:created_at) { Time.new(2017, 1, 1, 12, 00) }
let(:updated_at) { Time.new(2017, 1, 1, 12, 15) }
shared_examples 'a DiffNote representation' do
it 'returns an instance of DiffNote' do
expect(note).to be_an_instance_of(described_class)
end
context 'the returned DiffNote' do
it 'includes the number of the merge request' do
expect(note.noteable_id).to eq(42)
end
it 'includes the file path of the diff' do
expect(note.file_path).to eq('README.md')
end
it 'includes the commit ID' do
expect(note.commit_id).to eq('123abc')
end
it 'includes the created timestamp' do
expect(note.created_at).to eq(created_at)
end
it 'includes the updated timestamp' do
expect(note.updated_at).to eq(updated_at)
end
it 'includes the GitHub ID' do
expect(note.note_id).to eq(note_id)
end
it 'returns the noteable type' do
expect(note.noteable_type).to eq('MergeRequest')
end
describe '#diff_hash' do
it 'returns a Hash containing the diff details' do
expect(note.diff_hash).to eq(
diff: hunk,
new_path: 'README.md',
old_path: 'README.md',
a_mode: '100644',
b_mode: '100644',
new_file: false
)
end
end
describe '#diff_position' do
before do
note.merge_request = double(
:merge_request,
diff_refs: double(
:refs,
base_sha: 'base',
start_sha: 'start',
head_sha: 'head'
)
)
end
context 'when the diff is an addition' do
it 'returns a Gitlab::Diff::Position' do
expect(note.diff_position.to_h).to eq(
base_sha: 'base',
head_sha: 'head',
line_range: nil,
new_line: 23,
new_path: 'README.md',
old_line: nil,
old_path: 'README.md',
position_type: 'text',
start_sha: 'start'
)
end
end
context 'when the diff is an deletion' do
let(:side) { 'LEFT' }
it 'returns a Gitlab::Diff::Position' do
expect(note.diff_position.to_h).to eq(
base_sha: 'base',
head_sha: 'head',
line_range: nil,
old_line: 23,
new_path: 'README.md',
new_line: nil,
old_path: 'README.md',
position_type: 'text',
start_sha: 'start'
)
end
end
end
describe '#discussion_id' do
before do
note.project = project
note.merge_request = merge_request
end
context 'when the note is a reply to a discussion' do
it 'uses the cached value as the discussion_id only when responding an existing discussion' do
expect(Discussion)
.to receive(:discussion_id)
.and_return('FIRST_DISCUSSION_ID', 'SECOND_DISCUSSION_ID')
# Creates the first discussion id and caches its value
expect(note.discussion_id)
.to eq('FIRST_DISCUSSION_ID')
reply_note = described_class.from_json_hash(
'note_id' => note.note_id + 1,
'in_reply_to_id' => note.note_id
)
reply_note.project = project
reply_note.merge_request = merge_request
# Reading from the cached value
expect(reply_note.discussion_id)
.to eq('FIRST_DISCUSSION_ID')
new_discussion_note = described_class.from_json_hash(
'note_id' => note.note_id + 2,
'in_reply_to_id' => nil
)
new_discussion_note.project = project
new_discussion_note.merge_request = merge_request
# Because it's a new discussion, it must not use the cached value
expect(new_discussion_note.discussion_id)
.to eq('SECOND_DISCUSSION_ID')
end
context 'when cached value does not exist' do
it 'falls back to generating a new discussion_id' do
expect(Discussion)
.to receive(:discussion_id)
.and_return('NEW_DISCUSSION_ID')
reply_note = described_class.from_json_hash(
'note_id' => note.note_id + 1,
'in_reply_to_id' => note.note_id
)
reply_note.project = project
reply_note.merge_request = merge_request
expect(reply_note.discussion_id).to eq('NEW_DISCUSSION_ID')
end
end
end
end
describe '#github_identifiers' do
it 'returns a hash with needed identifiers' do
expect(note.github_identifiers).to eq(
noteable_id: 42,
noteable_type: 'MergeRequest',
note_id: 1
)
end
end
describe '#line_code' do
it 'generates the proper line code' do
note = described_class.new(diff_hunk: hunk, file_path: 'README.md')
expect(note.line_code).to eq('8ec9a00bfd09b3190ac6b22251dbb1aa95a0579d_2_2')
end
end
describe '#note and #contains_suggestion?' do
it 'includes the note body' do
expect(note.note).to eq('Hello world')
expect(note.contains_suggestion?).to eq(false)
end
context 'when the note have a suggestion' do
let(:note_body) do
<<~BODY
```suggestion
Hello World
```
BODY
end
it 'returns the suggestion formatted in the note' do
expect(note.note).to eq <<~BODY
```suggestion:-0+0
Hello World
```
BODY
expect(note.contains_suggestion?).to eq(true)
end
end
context 'when the note have a multiline suggestion' do
let(:start_line) { 20 }
let(:end_line) { 23 }
let(:note_body) do
<<~BODY
```suggestion
Hello World
```
BODY
end
it 'returns the multi-line suggestion formatted in the note' do
expect(note.note).to eq <<~BODY
```suggestion:-3+0
Hello World
```
BODY
expect(note.contains_suggestion?).to eq(true)
end
end
describe '#author' do
it 'includes the user details' do
expect(note.author).to be_an_instance_of(
Gitlab::GithubImport::Representation::User
)
expect(note.author.id).to eq(4)
expect(note.author.login).to eq('alice')
end
context 'when the author is empty' do
let(:user_data) { nil }
it 'does not set the user if the response did not include a user' do
expect(note.author).to be_nil
end
end
end
end
end
end
describe '.from_api_response' do
it_behaves_like 'a DiffNote representation' do
let(:response) do
double(
:response,
id: note_id,
html_url: 'https://github.com/foo/bar/pull/42',
path: 'README.md',
commit_id: '123abc',
original_commit_id: 'original123abc',
side: side,
user: user_data && double(:user, user_data),
diff_hunk: hunk,
body: note_body,
created_at: created_at,
updated_at: updated_at,
line: end_line,
start_line: start_line,
in_reply_to_id: in_reply_to_id
)
end
subject(:note) { described_class.from_api_response(response) }
end
end
describe '.from_json_hash' do
it_behaves_like 'a DiffNote representation' do
let(:hash) do
{
'note_id' => note_id,
'noteable_type' => 'MergeRequest',
'noteable_id' => 42,
'file_path' => 'README.md',
'commit_id' => '123abc',
'original_commit_id' => 'original123abc',
'side' => side,
'author' => user_data,
'diff_hunk' => hunk,
'note' => note_body,
'created_at' => created_at.to_s,
'updated_at' => updated_at.to_s,
'end_line' => end_line,
'start_line' => start_line,
'in_reply_to_id' => in_reply_to_id
}
end
subject(:note) { described_class.from_json_hash(hash) }
end
end
end
|