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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
|
# SPDX-FileCopyrightText: 2019 Free Software Foundation Europe e.V. <https://fsfe.org>
# SPDX-FileCopyrightText: 2022 Florian Snow <florian@familysnow.net>
# SPDX-FileCopyrightText: 2024 Carmen Bianca BAKKER <carmenbianca@fsfe.org>
#
# SPDX-License-Identifier: GPL-3.0-or-later
"""All tests for reuse.header"""
from inspect import cleandoc
import pytest
from reuse import ReuseInfo
from reuse.comment import CppCommentStyle
from reuse.exceptions import CommentCreateError, MissingReuseInfoError
from reuse.header import add_new_header, create_header, find_and_replace_header
# REUSE-IgnoreStart
def test_create_header_simple():
"""Create a super simple header."""
info = ReuseInfo({"GPL-3.0-or-later"}, {"SPDX-FileCopyrightText: Jane Doe"})
expected = cleandoc(
"""
# SPDX-FileCopyrightText: Jane Doe
#
# SPDX-License-Identifier: GPL-3.0-or-later
"""
)
assert create_header(info).strip() == expected
def test_create_header_simple_with_contributor():
"""Create a super simple header."""
info = ReuseInfo(
{"GPL-3.0-or-later"}, {"SPDX-FileCopyrightText: Jane Doe"}, {"John Doe"}
)
expected = cleandoc(
"""
# SPDX-FileCopyrightText: Jane Doe
# SPDX-FileContributor: John Doe
#
# SPDX-License-Identifier: GPL-3.0-or-later
"""
)
assert create_header(info).strip() == expected
def test_create_header_template_simple(template_simple):
"""Create a header with a simple template."""
info = ReuseInfo({"GPL-3.0-or-later"}, {"SPDX-FileCopyrightText: Jane Doe"})
expected = cleandoc(
"""
# Hello, world!
#
# SPDX-FileCopyrightText: Jane Doe
#
# SPDX-License-Identifier: GPL-3.0-or-later
"""
)
assert create_header(info, template=template_simple).strip() == expected
def test_create_header_template_no_spdx(template_no_spdx):
"""Create a header with a template that does not have all REUSE info."""
info = ReuseInfo({"GPL-3.0-or-later"}, {"SPDX-FileCopyrightText: Jane Doe"})
with pytest.raises(MissingReuseInfoError):
create_header(info, template=template_no_spdx)
def test_create_header_template_commented(template_commented):
"""Create a header with an already-commented template."""
info = ReuseInfo({"GPL-3.0-or-later"}, {"SPDX-FileCopyrightText: Jane Doe"})
expected = cleandoc(
"""
# Hello, world!
#
# SPDX-FileCopyrightText: Jane Doe
#
# SPDX-License-Identifier: GPL-3.0-or-later
"""
)
assert (
create_header(
info,
template=template_commented,
template_is_commented=True,
style=CppCommentStyle,
).strip()
== expected
)
def test_create_header_already_contains_spdx():
"""Create a new header from a header that already contains REUSE info."""
info = ReuseInfo({"GPL-3.0-or-later"}, {"SPDX-FileCopyrightText: Jane Doe"})
existing = cleandoc(
"""
# SPDX-FileCopyrightText: John Doe
#
# SPDX-License-Identifier: MIT
"""
)
expected = cleandoc(
"""
# SPDX-FileCopyrightText: Jane Doe
# SPDX-FileCopyrightText: John Doe
#
# SPDX-License-Identifier: GPL-3.0-or-later
# SPDX-License-Identifier: MIT
"""
)
assert create_header(info, header=existing).strip() == expected
def test_create_header_existing_is_wrong():
"""If the existing header contains errors, raise a CommentCreateError."""
info = ReuseInfo({"GPL-3.0-or-later"}, {"SPDX-FileCopyrightText: Jane Doe"})
existing = cleandoc(
"""
# SPDX-FileCopyrightText: John Doe
#
# SPDX-License-Identifier: MIT AND OR 0BSD
"""
)
with pytest.raises(CommentCreateError):
create_header(info, header=existing)
def test_create_header_old_syntax():
"""Old copyright syntax is preserved when creating a new header."""
info = ReuseInfo({"GPL-3.0-or-later"})
existing = cleandoc(
"""
# Copyright John Doe
"""
)
expected = cleandoc(
"""
# Copyright John Doe
#
# SPDX-License-Identifier: GPL-3.0-or-later
"""
)
assert create_header(info, header=existing).strip() == expected
def test_create_header_remove_fluff():
"""Any stuff that isn't REUSE info is removed when using create_header."""
info = ReuseInfo({"GPL-3.0-or-later"})
existing = cleandoc(
"""
# SPDX-FileCopyrightText: John Doe
#
# Hello, world!
pass
"""
)
expected = cleandoc(
"""
# SPDX-FileCopyrightText: John Doe
#
# SPDX-License-Identifier: GPL-3.0-or-later
"""
)
assert create_header(info, header=existing).strip() == expected
def test_add_new_header_simple():
"""Given text that already contains a header, create a new one, and preserve
the old one.
"""
info = ReuseInfo({"GPL-3.0-or-later"}, {"SPDX-FileCopyrightText: Jane Doe"})
text = cleandoc(
"""
# SPDX-FileCopyrightText: John Doe
#
# SPDX-License-Identifier: MIT
pass
"""
)
expected = cleandoc(
"""
# SPDX-FileCopyrightText: Jane Doe
#
# SPDX-License-Identifier: GPL-3.0-or-later
# SPDX-FileCopyrightText: John Doe
#
# SPDX-License-Identifier: MIT
pass
"""
)
assert add_new_header(text, info) == expected
def test_find_and_replace_no_header():
"""Given text without header, add a header."""
info = ReuseInfo({"GPL-3.0-or-later"}, {"SPDX-FileCopyrightText: Jane Doe"})
text = "pass"
expected = cleandoc(
"""
# SPDX-FileCopyrightText: Jane Doe
#
# SPDX-License-Identifier: GPL-3.0-or-later
pass
"""
)
assert (
find_and_replace_header(text, info)
== add_new_header(text, info)
== expected
)
def test_find_and_replace_verbatim():
"""Replace a header with itself."""
info = ReuseInfo()
text = cleandoc(
"""
# SPDX-FileCopyrightText: Jane Doe
#
# SPDX-License-Identifier: GPL-3.0-or-later
pass
"""
)
assert find_and_replace_header(text, info) == text
def test_find_and_replace_newline_before_header():
"""In a scenario where the header is preceded by whitespace, remove the
preceding whitespace.
"""
info = ReuseInfo({"GPL-3.0-or-later"}, {"SPDX-FileCopyrightText: John Doe"})
text = cleandoc(
"""
# SPDX-FileCopyrightText: Jane Doe
pass
"""
)
text = "\n" + text
expected = cleandoc(
"""
# SPDX-FileCopyrightText: Jane Doe
# SPDX-FileCopyrightText: John Doe
#
# SPDX-License-Identifier: GPL-3.0-or-later
pass
"""
)
assert find_and_replace_header(text, info) == expected
def test_find_and_replace_preserve_preceding():
"""When the SPDX header is in the middle of the file, keep it there."""
info = ReuseInfo({"GPL-3.0-or-later"}, {"SPDX-FileCopyrightText: John Doe"})
text = cleandoc(
"""
# Hello, world!
def foo(bar):
return bar
# SPDX-FileCopyrightText: Jane Doe
pass
"""
)
expected = cleandoc(
"""
# Hello, world!
def foo(bar):
return bar
# SPDX-FileCopyrightText: Jane Doe
# SPDX-FileCopyrightText: John Doe
#
# SPDX-License-Identifier: GPL-3.0-or-later
pass
"""
)
assert find_and_replace_header(text, info) == expected
def test_find_and_replace_keep_shebang():
"""When encountering a shebang, keep it and put the REUSE header beneath
it.
"""
info = ReuseInfo({"GPL-3.0-or-later"}, {"SPDX-FileCopyrightText: John Doe"})
text = cleandoc(
"""
#!/usr/bin/env python3
# SPDX-FileCopyrightText: Jane Doe
pass
"""
)
expected = cleandoc(
"""
#!/usr/bin/env python3
# SPDX-FileCopyrightText: Jane Doe
# SPDX-FileCopyrightText: John Doe
#
# SPDX-License-Identifier: GPL-3.0-or-later
pass
"""
)
assert find_and_replace_header(text, info) == expected
def test_find_and_replace_separate_shebang():
"""When the shebang is part of the same comment as the SPDX comment,
separate the two.
"""
info = ReuseInfo({"GPL-3.0-or-later"})
text = cleandoc(
"""
#!/usr/bin/env python3
#!nix-shell -p python3
# SPDX-FileCopyrightText: Jane Doe
pass
"""
)
expected = cleandoc(
"""
#!/usr/bin/env python3
#!nix-shell -p python3
# SPDX-FileCopyrightText: Jane Doe
#
# SPDX-License-Identifier: GPL-3.0-or-later
pass
"""
)
assert find_and_replace_header(text, info) == expected
def test_find_and_replace_shebang_but_no_copyright():
"""When the file contains a shebang but no copyright information, keep it at
the top of the file.
"""
info = ReuseInfo({"GPL-3.0-or-later"})
text = cleandoc(
"""
#!/usr/bin/env python3
# Hello, world!
pass
"""
)
expected = cleandoc(
"""
#!/usr/bin/env python3
# SPDX-License-Identifier: GPL-3.0-or-later
# Hello, world!
pass
"""
)
assert find_and_replace_header(text, info) == expected
def test_find_and_replace_only_shebang():
"""When the file only contains a shebang, add copyright info below it."""
info = ReuseInfo({"GPL-3.0-or-later"})
text = "#!/usr/bin/env python3"
expected = (
cleandoc(
"""
#!/usr/bin/env python3
# SPDX-License-Identifier: GPL-3.0-or-later
"""
)
+ "\n"
)
assert find_and_replace_header(text, info) == expected
def test_find_and_replace_keep_old_comment():
"""When encountering a comment that does not contain copyright and
licensing information, preserve it below the REUSE header.
"""
info = ReuseInfo({"GPL-3.0-or-later"}, {"SPDX-FileCopyrightText: Jane Doe"})
text = cleandoc(
"""
# Hello, world!
pass
"""
)
expected = cleandoc(
"""
# SPDX-FileCopyrightText: Jane Doe
#
# SPDX-License-Identifier: GPL-3.0-or-later
# Hello, world!
pass
"""
)
assert find_and_replace_header(text, info) == expected
def test_find_and_replace_preserve_newline():
"""If the file content ends with a newline, don't remove it."""
info = ReuseInfo()
text = (
cleandoc(
"""
# SPDX-FileCopyrightText: Jane Doe
#
# SPDX-License-Identifier: GPL-3.0-or-later
pass
"""
)
+ "\n"
)
assert find_and_replace_header(text, info) == text
# REUSE-IgnoreEnd
|
