-
-
Notifications
You must be signed in to change notification settings - Fork 791
Expand file tree
/
Copy pathtest_license_models.py
More file actions
694 lines (582 loc) · 27.7 KB
/
Copy pathtest_license_models.py
File metadata and controls
694 lines (582 loc) · 27.7 KB
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
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
#
# Copyright (c) nexB Inc. and others. All rights reserved.
# ScanCode is a trademark of nexB Inc.
# SPDX-License-Identifier: Apache-2.0
# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
# See https://github.com/nexB/scancode-toolkit for support or download.
# See https://aboutcode.org for more information about nexB OSS projects.
#
import os
from unittest import TestCase as TestCaseClass
from commoncode.testcase import FileBasedTesting
from licensedcode import index
from licensedcode import models
from licensedcode.models import InvalidRule
from licensedcode.models import Rule
from licensedcode.models import rules_data_dir
from licensedcode.spans import Span
from licensedcode.tokenize import get_existing_required_phrase_spans
from licensedcode.tokenize import InvalidRuleRequiredPhrase
from licensedcode_test_utils import create_rule_from_text_and_expression
from licensedcode_test_utils import create_rule_from_text_file_and_expression
from scancode.cli_test_utils import check_json
TEST_DATA_DIR = os.path.join(os.path.dirname(__file__), 'data')
def as_sorted_mapping_seq(licenses, include_text=False):
"""
Given a `licenses` iterator of to_dict()'able objects, return a sorted list
of these.
"""
return sorted((l.to_dict(include_text=include_text) for l in licenses), key=lambda x: tuple(x.items()))
class TestLicense(FileBasedTesting):
test_data_dir = TEST_DATA_DIR
def test_load_license(self):
test_dir = self.get_test_loc('models/licenses')
lics = models.load_licenses(test_dir)
# Note: one license is obsolete and not loaded. Other are various exception/version cases
results = as_sorted_mapping_seq(lics.values())
expected = self.get_test_loc('models/licenses.load.expected.json')
check_json(expected, results)
def test_dump_license(self):
test_dir = self.get_test_loc('models/licenses', copy=True)
lics = models.load_licenses(licenses_data_dir=test_dir, with_deprecated=True)
for l in lics.values():
l.dump(licenses_data_dir=test_dir)
lics = models.load_licenses(licenses_data_dir=test_dir, with_deprecated=True)
# Note: one license is obsolete and not loaded. Other are various exception/version cases
results = as_sorted_mapping_seq(lics.values())
expected = self.get_test_loc('models/licenses.dump.expected.json')
check_json(expected, results)
def test_dump_license_file(self):
test_dir = self.get_test_loc('models/licenses', copy=True)
test_dir_dump = self.get_test_loc('models/license_file_dump')
lics = models.load_licenses(licenses_data_dir=test_dir, with_deprecated=True)
lic_example = lics["apache-2.0"]
lic_example.dump(licenses_data_dir=test_dir_dump)
lics_from_dump = models.load_licenses(licenses_data_dir=test_dir_dump, with_deprecated=True)
lic_example_from_dump = lics_from_dump["apache-2.0"]
# Note: one license is obsolete and not loaded. Other are various exception/version cases
before_dump = as_sorted_mapping_seq(licenses=[lic_example], include_text=True)
after_dump = as_sorted_mapping_seq(licenses=[lic_example_from_dump], include_text=True)
assert before_dump == after_dump
def test_License_text(self):
test_dir = self.get_test_loc('models/licenses')
lics = models.load_licenses(licenses_data_dir=test_dir)
for lic in lics.values():
assert 'distribut' in lic.text.lower()
def test_build_rules_from_licenses(self):
test_dir = self.get_test_loc('models/licenses')
licenses_by_key = models.load_licenses(licenses_data_dir=test_dir)
rules = models.build_rules_from_licenses(licenses_by_key=licenses_by_key)
results = as_sorted_mapping_seq(rules)
expected = self.get_test_loc('models/license_rules.expected.json')
check_json(expected, results)
def test_validate_license_library_data(self):
errors, warnings, infos = models.License.validate(
licenses=models.load_licenses(with_deprecated=False),
verbose=False,
thorough=True,
)
assert errors == {}
assert warnings == {}
assert infos
def test_validate_license_library_can_return_errors(self):
test_dir = self.get_test_loc('models/validate')
lics = models.load_licenses(test_dir, check_consistency=False)
errors, warnings, infos = models.License.validate(
lics,
no_dupe_urls=True,
verbose=False,
)
expected_errors = {
'GLOBAL': [
'Duplicate texts in multiple licenses: apache-2.0: TEXT, bsd-ack-carrot2: TEXT',
'Duplicate short name (ignoring case): gpl 1.0 in licenses: gpl-1.0, gpl-1.0-plus',
'Duplicate name (ignoring case): gnu general public license 1.0 in licenses: gpl-1.0, gpl-1.0-plus'],
'bsd-ack-carrot2': [
'No short name',
'No name',
'No category: Use "Unstated License" if not known.',
'No owner: Use "Unspecified" if not known.',
'No SPDX license key'],
'foo-2.0': ['Unknown language: foobar', 'No SPDX license key'],
'gpl-1.0': [
'Unknown license category: GNU Copyleft.\nUse one of these valid categories:\n'
'CLA\nCommercial\nCopyleft\nCopyleft Limited\nFree Restricted\n'
'Patent License\nPermissive\nProprietary Free\nPublic Domain\nSource-available\nUnstated License',
'No SPDX license key'],
'w3c-docs-19990405': [
'Unknown license category: Permissive Restricted.\nUse one of these valid categories:\n'
'CLA\nCommercial\nCopyleft\nCopyleft Limited\nFree Restricted\n'
'Patent License\nPermissive\nProprietary Free\nPublic Domain\nSource-available\nUnstated License',
'No SPDX license key'],
}
assert errors == expected_errors
expected_warnings = {
'gpl-1.0': [
'Some empty text_urls values',
'Some empty other_urls values',
'Homepage URL also in text_urls',
'Homepage URL also in other_urls',
'Homepage URL same as faq_url',
'Homepage URL same as osi_url',
'osi_url same as faq_url',
'Some duplicated URLs']
}
assert warnings == expected_warnings
expected_infos = {
'foo-2.0': ['No license text'],
'w3c-docs-19990405': ['No license text'],
}
assert infos == expected_infos
def test_load_licenses_fails_if_file_contains_empty_yaml_frontmatter(self):
test_dir = self.get_test_loc('models/licenses_without_frontmatter')
try:
list(models.load_licenses(test_dir))
self.fail('Exception not raised')
except Exception as e:
assert 'Cannot load License with empty YAML frontmatter' in str(e)
def test_load_licenses_fails_if_file_contains_empty_text(self):
test_dir = self.get_test_loc('models/licenses_without_text')
try:
list(models.load_licenses(test_dir))
self.fail('Exception not raised')
except Exception as e:
assert 'only deprecated, generic or unknown licenses can exist without text' in str(e)
def test_license_file_is_computed_correctly(self):
licenses_data_dir = self.get_test_loc('models/data_text_files/licenses')
licenses = models.load_licenses(licenses_data_dir)
lic = licenses['gpl-1.0']
assert lic.license_file(licenses_data_dir=licenses_data_dir).startswith(licenses_data_dir)
def test_rule_from_license_have_text_file_and_data_file_are_computed_correctly(self):
licenses_data_dir = self.get_test_loc('models/data_text_files/licenses')
licenses = models.load_licenses(licenses_data_dir=licenses_data_dir)
lic = licenses['gpl-1.0']
rule = models.build_rule_from_license(license_obj=lic)
assert rule.rule_file(
licenses_data_dir=licenses_data_dir,
rules_data_dir=None,
).startswith(licenses_data_dir)
class TestRule(FileBasedTesting):
test_data_dir = TEST_DATA_DIR
def test_validate_license_rules_data(self):
list(models.get_rules(validate=True, validate_thorough=True))
def test_create_rule_ignore_punctuation(self):
test_rule = create_rule_from_text_and_expression(text='A one. A two. A three.')
expected = ['one', 'two', 'three']
assert list(test_rule.tokens()) == expected
assert test_rule.length == 3
def test_create_plain_rule_with_text_file(self):
def create_test_file(text):
tf = self.get_temp_file()
with open(tf, 'w') as of:
of.write(text)
return tf
test_rule = create_rule_from_text_file_and_expression(text_file=create_test_file('A one. A two. A three.'))
expected = ['one', 'two', 'three']
assert list(test_rule.tokens()) == expected
assert test_rule.length == 3
def test_load_rules(self):
test_dir = self.get_test_loc('models/rules')
rules = list(models.load_rules(test_dir))
assert all(isinstance(r, models.Rule) for r in rules)
results = as_sorted_mapping_seq(rules)
expected = self.get_test_loc('models/rules.expected.json')
check_json(expected, results)
def test_rules_have_only_one_flag_of_bool_type(self):
rules = list(models.load_rules(rules_data_dir))
rule_errors = []
for r in rules:
rule_flags = [
r.is_license_text,
r.is_license_notice,
r.is_license_reference,
r.is_license_tag,
r.is_license_intro,
r.is_license_clue,
r.is_false_positive,
]
number_of_flags_set = 0
for rule_flag in rule_flags:
if not type(rule_flag) == bool:
# invalid type
rule_errors.append(r.rule_file)
break
if rule_flag is True:
number_of_flags_set += 1
elif rule_flag is False:
continue
if number_of_flags_set not in (0, 1):
rule_errors.append(r.rule_file)
break
assert rule_errors == []
def test_dump_rules(self):
test_dir = self.get_test_loc('models/rules', copy=True)
rules = list(models.load_rules(test_dir))
for r in rules:
r.dump(rules_data_dir=test_dir)
rules = list(models.load_rules(test_dir))
results = as_sorted_mapping_seq(rules)
expected = self.get_test_loc('models/rules.expected.json')
check_json(expected, results)
def test_dump_rule_file(self):
test_dir = self.get_test_loc('models/rules', copy=True)
test_dir_dump = self.get_test_loc('models/rule_file_dump')
rules = list(models.load_rules(test_dir))
rules.sort(key=lambda x: x.identifier)
rule_example = rules.pop()
rule_example.dump(rules_data_dir=test_dir_dump)
rule_from_dump = list(models.load_rules(test_dir_dump))
rule_from_dump.sort(key=lambda x: x.identifier)
rule_example_from_dump = rule_from_dump.pop()
# Note: one license is obsolete and not loaded. Other are various exception/version cases
before_dump = as_sorted_mapping_seq(licenses=[rule_example], include_text=True)
after_dump = as_sorted_mapping_seq(licenses=[rule_example_from_dump], include_text=True)
assert before_dump == after_dump
def test_spdxrule(self):
rule = models.SpdxRule(
license_expression='mit OR gpl-2.0',
text='mit OR gpl-2.0',
length=12,
)
try:
rule.dump()
raise Exception('SpdxRule cannot be dumped')
except NotImplementedError:
pass
try:
rule.load()
raise Exception('SpdxRule cannot be dumped')
except NotImplementedError:
pass
assert not rule.is_small
assert rule.relevance == 100
def test_spdxrule_with_invalid_expression(self):
try:
models.SpdxRule(
license_expression='mit OR gpl-2.0 AND',
text='mit OR gpl-2.0',
length=12,
)
except Exception as e:
ex = str(e)
assert 'Unable to parse Rule license expression:' in ex
assert 'ExpressionError: AND requires two or more licenses as in: MIT AND BSD' in ex
def test_template_rule_is_loaded_correctly(self):
test_dir = self.get_test_loc('models/rule_template')
rules = list(models.load_rules(test_dir))
assert len(rules) == 1
def test_rule_len_is_computed_correctly(self):
test_text = '''zero one two three
four gap1
five six seven eight nine ten'''
r1 = create_rule_from_text_and_expression(text=test_text)
list(r1.tokens())
assert r1.length == 12
def test_rule_templates_are_ignored(self):
test_text = '''gap0 zero one two three gap2'''
r1 = create_rule_from_text_and_expression(text=test_text)
assert list(r1.tokens()) == ['gap0', 'zero', 'one', 'two', 'three', 'gap2']
def test_rule_tokens_are_computed_correctly_ignoring_templates(self):
test_text = '''I hereby abandon any SAX 2.0 (the), and Release all of the SAX 2.0 source code of his'''
rule = create_rule_from_text_and_expression(text=test_text, license_expression='public-domain')
rule_tokens = list(rule.tokens())
expected = [
'i', 'hereby', 'abandon', 'any', 'sax', '2', '0', 'the', 'and',
'release', 'all', 'of', 'the', 'sax', '2', '0', 'source', 'code',
'of', 'his'
]
assert rule_tokens == expected
def test_compute_thresholds_occurences(self):
minimum_coverage = 0.0
length = 54
high_length = 11
results = models.compute_thresholds_occurences(minimum_coverage, length, high_length)
expected_min_cov = 0.0
expected_min_matched_length = 4
expected_min_high_matched_length = 3
expected = expected_min_cov, expected_min_matched_length, expected_min_high_matched_length
assert results == expected
length_unique = 39
high_length_unique = 7
results = models.compute_thresholds_unique(
minimum_coverage, length, length_unique, high_length_unique)
expected_min_matched_length_unique = 4
expected_min_high_matched_length_unique = 3
expected = expected_min_matched_length_unique, expected_min_high_matched_length_unique
assert results == expected
def test_Thresholds(self):
r1_text = 'licensed under the GPL, licensed under the GPL'
r1 = create_rule_from_text_and_expression(license_expression='apache-1.1', text=r1_text)
r2_text = 'licensed under the GPL, licensed under the GPL' * 10
r2 = create_rule_from_text_and_expression(license_expression='apache-1.1', text=r2_text)
_idx = index.LicenseIndex([r1, r2])
results = models.compute_thresholds_occurences(r1.minimum_coverage, r1.length, r1.high_length)
expected_min_cov = 80
expected_min_matched_length = 8
expected_min_high_matched_length = 4
expected = expected_min_cov, expected_min_matched_length, expected_min_high_matched_length
assert results == expected
results = models.compute_thresholds_unique(
r1.minimum_coverage, r1.length, r1.length_unique, r1.high_length_unique)
expected_min_matched_length_unique = 3
expected_min_high_matched_length_unique = 2
expected = expected_min_matched_length_unique, expected_min_high_matched_length_unique
assert results == expected
results = models.compute_thresholds_occurences(r2.minimum_coverage, r2.length, r2.high_length)
expected_min_cov = 0.0
expected_min_matched_length = 4
expected_min_high_matched_length = 3
expected = expected_min_cov, expected_min_matched_length, expected_min_high_matched_length
assert results == expected
results = models.compute_thresholds_unique(
r2.minimum_coverage, r2.length, r2.length_unique, r2.high_length_unique)
expected_min_matched_length_unique = 4
expected_min_high_matched_length_unique = 1
expected = expected_min_matched_length_unique, expected_min_high_matched_length_unique
assert results == expected
def test_compute_relevance_does_not_change_stored_relevance(self):
rule = create_rule_from_text_and_expression(text='1', license_expression='public-domain')
rule.relevance = 13
rule.has_stored_relevance = True
rule.length = 1000
rule.set_relevance()
assert rule.relevance == 13
assert rule.has_stored_relevance
def test_compute_relevance_changes_stored_relevance_for_long_rules(self):
rule = create_rule_from_text_and_expression(text='abcd ' * 18, license_expression='public-domain')
rule.relevance = 100
rule.has_stored_relevance = True
rule.length = 18
rule.set_relevance()
assert rule.relevance == 100
assert not rule.has_stored_relevance
def test_compute_relevance_does_not_change_stored_relevance_for_short_rules(self):
rule = create_rule_from_text_and_expression(text='abcd ' * 18, license_expression='public-domain')
rule.relevance = 100
rule.has_stored_relevance = True
rule.length = 17
rule.set_relevance()
assert rule.relevance == 100
assert rule.has_stored_relevance
def test_compute_relevance_does_not_update_stored_relevance(self):
rule = create_rule_from_text_and_expression(text='abcd ' * 17, license_expression='public-domain')
rule.relevance = 100
rule.has_stored_relevance = True
rule.length = 17
rule.set_relevance()
assert rule.relevance == 100
assert rule.has_stored_relevance
def test_compute_relevance_does_not_update_stored_relevance_for_short_rules(self):
rule = create_rule_from_text_and_expression(text='abcd ' * 17, license_expression='public-domain')
rule.relevance = 99
rule.has_stored_relevance = True
rule.length = 18
rule.set_relevance()
assert rule.relevance == 99
assert rule.has_stored_relevance
def test_compute_relevance_does_update_stored_relevance_for_short_rules(self):
rule = create_rule_from_text_and_expression(text='abcd ' * 17, license_expression='public-domain')
rule.relevance = 94
rule.has_stored_relevance = True
rule.length = 17
rule.set_relevance()
assert rule.relevance == 94
assert not rule.has_stored_relevance
def test_compute_relevance_does_not_update_stored_relevance_for_short_rules_if_computed_differs(self):
rule = create_rule_from_text_and_expression(text='abcd ' * 16, license_expression='public-domain')
rule.relevance = 94
rule.has_stored_relevance = True
rule.length = 16
rule.set_relevance()
assert rule.relevance == 94
assert rule.has_stored_relevance
def test_compute_relevance_is_hundred_for_false_positive(self):
rule = create_rule_from_text_and_expression(text='1', license_expression='public-domain')
rule.relevance = 13
rule.has_stored_relevance = False
rule.is_false_positive = True
rule.length = 1000
rule.set_relevance()
assert rule.relevance == 100
def test_compute_relevance_is_using_rule_length(self):
rule = create_rule_from_text_and_expression(text='1', license_expression='some-license')
rule.relevance = 13
rule.has_stored_relevance = False
rule.is_false_positive = False
rule.length = 1000
rule.set_relevance()
assert rule.relevance == 100
rule.length = 21
rule.set_relevance()
assert rule.relevance == 100
rule.length = 20
rule.set_relevance()
assert rule.relevance == 100
rule.length = 18
rule.set_relevance()
assert rule.relevance == 100
rule.length = 17
rule.set_relevance()
assert rule.relevance == 94
rule.length = 16
rule.set_relevance()
assert rule.relevance == 88
rule.length = 15
rule.set_relevance()
assert rule.relevance == 83
rule.length = 14
rule.set_relevance()
assert rule.relevance == 77
rule.length = 13
rule.set_relevance()
assert rule.relevance == 72
rule.length = 12
rule.set_relevance()
assert rule.relevance == 66
rule.length = 11
rule.set_relevance()
assert rule.relevance == 61
rule.length = 10
rule.set_relevance()
assert rule.relevance == 55
rule.length = 8
rule.set_relevance()
assert rule.relevance == 44
rule.length = 5
rule.set_relevance()
assert rule.relevance == 27
rule.length = 2
rule.set_relevance()
assert rule.relevance == 11
rule.length = 1
rule.set_relevance()
assert rule.relevance == 5
rule.length = 0
rule.set_relevance()
assert rule.relevance == 0
def test_rule_must_have_text(self):
rule_file = self.get_test_loc('models/rule_no_text/mit.RULE')
try:
Rule.from_file(rule_file=rule_file)
self.fail('Exception not raised.')
except InvalidRule as e:
assert 'Cannot load rule with empty text' in str(e)
def test_rule_cannot_contain_extra_unknown_attributes(self):
rule_file = self.get_test_loc('models/rule_with_extra_attributes/sun-bcl.RULE')
expected = 'data file has unknown attributes: license_expressionnotuce'
try:
Rule.from_file(rule_file=rule_file)
self.fail('Exception not raised.')
except Exception as e:
assert expected in str(e)
def test_load_rules_loads_file_content_at_path_and_not_path_as_string(self):
rule_dir = self.get_test_loc('models/similar_names')
rules = list(models.load_rules(rule_dir))
result = [' '.join(list(r.tokens())[-4:]) for r in rules]
assert not any([r == 'rules proprietary 10 rule' for r in result])
def test_Rule__validate_with_false_positive_rule(self):
rule_dir = self.get_test_loc('models/rule_validate')
rule = list(models.load_rules(rule_dir))[0]
assert list(rule.validate()) == []
def test_Rule__validate_with_invalid_language(self):
rule_dir = self.get_test_loc('models/rule_validate_lang')
validations = []
for rule in sorted(models.load_rules(rule_dir)):
validations.extend(rule.validate())
expected = [
'Unknown language: foobar',
'At least one is_license_* flag is needed.',
'At least one is_license_* flag is needed.',
]
assert validations == expected
def test_key_phrases_yields_spans(self):
rule_text = (
'This released software is {{released}} by under {{the MIT license}}. '
'Which is a license originating at Massachusetts Institute of Technology (MIT).'
)
rule = models.Rule(license_expression='mit', text=rule_text)
key_phrase_spans = list(rule.build_required_phrase_spans())
assert key_phrase_spans == [Span(4), Span(7, 9)]
def test_key_phrases_raises_exception_when_markup_is_not_closed(self):
rule_text = (
'This released software is {{released}} by under {{the MIT license. '
'Which is a license originating at Massachusetts Institute of Technology (MIT).'
)
rule = models.Rule(license_expression='mit', text=rule_text)
try:
list(rule.build_required_phrase_spans())
raise Exception('Exception should be raised')
except InvalidRule:
pass
def test_rule_text_file_and_data_file_are_computed_correctly(self):
rule_dir = self.get_test_loc('models/data_text_files/rules')
rules = list(models.load_rules(rule_dir))
rule = rules[0]
assert rule.rule_file(rules_data_dir=rule_dir).startswith(rule_dir)
class TestGetKeyPhrases(TestCaseClass):
def test_get_key_phrases_yields_spans(self):
text = (
'This released software is {{released}} by under {{the MIT license}}. '
'Which is a license originating at Massachusetts Institute of Technology (MIT).'
)
key_phrase_spans = get_existing_required_phrase_spans(text)
assert list(key_phrase_spans) == [Span(4), Span(7, 9)]
def test_get_key_phrases_raises_exception_key_phrase_markup_is_not_closed(self):
text = 'This software is {{released by under the MIT license.'
try:
list(get_existing_required_phrase_spans(text))
raise Exception('Exception should be raised')
except InvalidRuleRequiredPhrase:
pass
def test_get_key_phrases_ignores_stopwords_in_positions(self):
text = 'The word comma is a stop word so comma does not increase the span position {{MIT license}}.'
key_phrase_spans = get_existing_required_phrase_spans(text)
assert list(key_phrase_spans) == [Span(11, 12)]
def test_get_key_phrases_yields_spans_without_stop_words(self):
text = 'This released software is {{released span}} by under {{the MIT quot license}}.'
key_phrase_spans = get_existing_required_phrase_spans(text)
assert list(key_phrase_spans) == [Span(4), Span(7, 9)]
def test_get_key_phrases_does_not_yield_empty_spans(self):
text = 'This released software {{comma}} is {{}} by under {{the MIT license}}.'
try:
list(get_existing_required_phrase_spans(text))
raise Exception('Exception should be raised')
except InvalidRuleRequiredPhrase:
pass
def test_get_key_phrases_only_considers_outer_key_phrase_markup(self):
text = 'This released {{{software under the MIT}}} license.'
key_phrase_spans = get_existing_required_phrase_spans(text)
assert list(key_phrase_spans) == [Span(2, 5)]
def test_get_key_phrases_ignores_nested_key_phrase_markup(self):
text = 'This released {{software {{under the}} MIT}} license.'
try:
list(get_existing_required_phrase_spans(text))
raise Exception('Exception should be raised')
except InvalidRuleRequiredPhrase:
pass
class TestLicenseYamlFrontmatterSyntax(FileBasedTesting):
"""
Validate that all license data files have valid YAML syntax.
See: https://github.com/aboutcode-org/scancode-toolkit/issues/3947
"""
test_data_dir = TEST_DATA_DIR
def test_license_yaml_frontmatter_integrity(self):
"""
Ensure all .LICENSE files in licenses_data_dir have valid YAML syntax
in their frontmatter section.
"""
from pathlib import Path
from licensedcode.frontmatter import load_frontmatter
from licensedcode.models import licenses_data_dir
licenses_path = Path(licenses_data_dir)
errors = []
for license_file in sorted(licenses_path.glob('*.LICENSE')):
try:
load_frontmatter(str(license_file))
except Exception as e:
errors.append(f'{license_file.name}: {e}')
if errors:
error_msg = '\n'.join(errors[:20]) # Show first 20 errors
if len(errors) > 20:
error_msg += f'\n... and {len(errors) - 20} more errors'
assert False, f'Invalid YAML in {len(errors)} license files:\n{error_msg}'