Skip to content

Commit 3706744

Browse files
AyanSinhaMahapatraAyanSinhaMahapatra
committed
Sort top level license detections
This makes the top level license detection sorted, first in alphabetical order, then in descending order of detection_count and then on the identifier/UUID. Also regens tests for the same. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent a29ae81 commit 3706744

File tree

58 files changed

+592
-575
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+592
-575
lines changed

‎src/licensedcode/detection.py‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -810,6 +810,20 @@ def get_license_detection_object(self):
810810
)
811811

812812

813+
def sort_unique_detections(license_detections):
814+
"""
815+
Return a sorted list of UniqueDetection mappings from a unsorted list of the same.
816+
These are sorted in alphabetical order of the license_expression (and same license
817+
expressions are sorted by their detection_count in descending order, and then by their
818+
UUID).
819+
"""
820+
821+
def by_expression_count(detection):
822+
return detection["license_expression"], -detection["detection_count"], detection["identifier"]
823+
824+
return sorted(license_detections, key=by_expression_count)
825+
826+
813827
def get_detections_by_id(license_detections):
814828
"""
815829
Get a dict(hashmap) where each item is: {detection.identifier: all_detections} where

‎src/licensedcode/plugin_license.py‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
from licensedcode.detection import get_referenced_filenames
2828
from licensedcode.detection import DetectionCategory
2929
from licensedcode.detection import LicenseDetectionFromResult
30+
from licensedcode.detection import sort_unique_detections
3031
from licensedcode.detection import UniqueDetection
3132
from packagedcode.utils import combine_expressions
3233
from scancode.api import SCANCODE_LICENSEDB_URL
@@ -228,11 +229,13 @@ def process_codebase(self, codebase, license_diagnostics, **kwargs):
228229
f'unique_license_detections: {unique_license_detections}',
229230
)
230231

231-
codebase.attributes.license_detections.extend([
232+
unsorted_license_detections = [
232233
unique_detection.to_dict(license_diagnostics=license_diagnostics)
233234
for unique_detection in unique_license_detections
234-
])
235-
235+
]
236+
codebase.attributes.license_detections.extend(
237+
sort_unique_detections(unsorted_license_detections)
238+
)
236239

237240

238241
def add_referenced_filenames_license_matches_for_detections(resource, codebase):

‎tests/cluecode/data/copyrights/openoffice_org_report_builder_bin.copyright.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ copyrights:
1818
- Copyright (c) 2002 France Telecom
1919
- Copyright (c) 1990-2003 Sleepycat Software
2020
- Copyright (c) 1990, 1993, 1994, 1995 The Regents of the University of California
21-
- Copyright (c) 2003 by Bitstream, Inc. Cppyright
21+
- Copyright (c) 2003 by Bitstream, Inc.
2222
- Copyright (c) 2006 by Tavmjong Bah
2323
- Copyright (c) 2007 Red Hat, Inc
2424
- Copyright (c) 2007 Red Hat, Inc.

‎tests/formattedcode/data/common/manifests-expected.json‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -471,39 +471,34 @@
471471
],
472472
"license_detections": [
473473
{
474-
"identifier": "cddl_1_0-c6dbef4d-659c-289f-5ee9-1ca0278edad6",
475-
"license_expression": "cddl-1.0",
476-
"detection_count": 1
474+
"identifier": "apache_2_0-d66ab77d-a5cc-7104-e702-dc7df61fe9e8",
475+
"license_expression": "apache-2.0",
476+
"detection_count": 3
477477
},
478478
{
479-
"identifier": "cddl_1_0-9893b55c-3b2b-4ee8-a932-6c6c93a63fc5",
480-
"license_expression": "cddl-1.0",
479+
"identifier": "apache_2_0-ec759ae0-ea5a-f138-793e-388520e080c0",
480+
"license_expression": "apache-2.0",
481481
"detection_count": 1
482482
},
483483
{
484-
"identifier": "cddl_1_0-ef82fc8c-50cb-6f35-1814-d2eb0bc13e83",
484+
"identifier": "cddl_1_0-9893b55c-3b2b-4ee8-a932-6c6c93a63fc5",
485485
"license_expression": "cddl-1.0",
486486
"detection_count": 1
487487
},
488488
{
489-
"identifier": "apache_2_0-ec759ae0-ea5a-f138-793e-388520e080c0",
490-
"license_expression": "apache-2.0",
489+
"identifier": "cddl_1_0-c6dbef4d-659c-289f-5ee9-1ca0278edad6",
490+
"license_expression": "cddl-1.0",
491491
"detection_count": 1
492492
},
493493
{
494-
"identifier": "apache_2_0-d66ab77d-a5cc-7104-e702-dc7df61fe9e8",
495-
"license_expression": "apache-2.0",
496-
"detection_count": 3
497-
},
498-
{
499-
"identifier": "mit-3fce6ea2-8abd-6c6b-3ede-a37af7c6efee",
500-
"license_expression": "mit",
494+
"identifier": "cddl_1_0-ef82fc8c-50cb-6f35-1814-d2eb0bc13e83",
495+
"license_expression": "cddl-1.0",
501496
"detection_count": 1
502497
},
503498
{
504-
"identifier": "mit-a822f434-d61f-f2b1-c792-8b8cb9e7b9bf",
505-
"license_expression": "mit",
506-
"detection_count": 1
499+
"identifier": "lgpl_3_0-272571eb-5e68-95b6-ddb0-71de2d8df321",
500+
"license_expression": "lgpl-3.0",
501+
"detection_count": 2
507502
},
508503
{
509504
"identifier": "lgpl_3_0-121be3c2-9c80-df84-d3da-8f674e4125c0",
@@ -516,13 +511,18 @@
516511
"detection_count": 1
517512
},
518513
{
519-
"identifier": "lgpl_3_0-272571eb-5e68-95b6-ddb0-71de2d8df321",
514+
"identifier": "lgpl_3_0-38174920-e8ed-7bda-41ec-94df7380b7d5",
520515
"license_expression": "lgpl-3.0",
521-
"detection_count": 2
516+
"detection_count": 1
522517
},
523518
{
524-
"identifier": "lgpl_3_0-38174920-e8ed-7bda-41ec-94df7380b7d5",
525-
"license_expression": "lgpl-3.0",
519+
"identifier": "mit-3fce6ea2-8abd-6c6b-3ede-a37af7c6efee",
520+
"license_expression": "mit",
521+
"detection_count": 1
522+
},
523+
{
524+
"identifier": "mit-a822f434-d61f-f2b1-c792-8b8cb9e7b9bf",
525+
"license_expression": "mit",
526526
"detection_count": 1
527527
}
528528
],

‎tests/formattedcode/data/common/manifests-expected.jsonlines‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -507,39 +507,34 @@
507507
{
508508
"license_detections": [
509509
{
510-
"identifier": "cddl_1_0-c6dbef4d-659c-289f-5ee9-1ca0278edad6",
511-
"license_expression": "cddl-1.0",
512-
"detection_count": 1
510+
"identifier": "apache_2_0-d66ab77d-a5cc-7104-e702-dc7df61fe9e8",
511+
"license_expression": "apache-2.0",
512+
"detection_count": 3
513513
},
514514
{
515-
"identifier": "cddl_1_0-9893b55c-3b2b-4ee8-a932-6c6c93a63fc5",
516-
"license_expression": "cddl-1.0",
515+
"identifier": "apache_2_0-ec759ae0-ea5a-f138-793e-388520e080c0",
516+
"license_expression": "apache-2.0",
517517
"detection_count": 1
518518
},
519519
{
520-
"identifier": "cddl_1_0-ef82fc8c-50cb-6f35-1814-d2eb0bc13e83",
520+
"identifier": "cddl_1_0-9893b55c-3b2b-4ee8-a932-6c6c93a63fc5",
521521
"license_expression": "cddl-1.0",
522522
"detection_count": 1
523523
},
524524
{
525-
"identifier": "apache_2_0-ec759ae0-ea5a-f138-793e-388520e080c0",
526-
"license_expression": "apache-2.0",
525+
"identifier": "cddl_1_0-c6dbef4d-659c-289f-5ee9-1ca0278edad6",
526+
"license_expression": "cddl-1.0",
527527
"detection_count": 1
528528
},
529529
{
530-
"identifier": "apache_2_0-d66ab77d-a5cc-7104-e702-dc7df61fe9e8",
531-
"license_expression": "apache-2.0",
532-
"detection_count": 3
533-
},
534-
{
535-
"identifier": "mit-3fce6ea2-8abd-6c6b-3ede-a37af7c6efee",
536-
"license_expression": "mit",
530+
"identifier": "cddl_1_0-ef82fc8c-50cb-6f35-1814-d2eb0bc13e83",
531+
"license_expression": "cddl-1.0",
537532
"detection_count": 1
538533
},
539534
{
540-
"identifier": "mit-a822f434-d61f-f2b1-c792-8b8cb9e7b9bf",
541-
"license_expression": "mit",
542-
"detection_count": 1
535+
"identifier": "lgpl_3_0-272571eb-5e68-95b6-ddb0-71de2d8df321",
536+
"license_expression": "lgpl-3.0",
537+
"detection_count": 2
543538
},
544539
{
545540
"identifier": "lgpl_3_0-121be3c2-9c80-df84-d3da-8f674e4125c0",
@@ -552,13 +547,18 @@
552547
"detection_count": 1
553548
},
554549
{
555-
"identifier": "lgpl_3_0-272571eb-5e68-95b6-ddb0-71de2d8df321",
550+
"identifier": "lgpl_3_0-38174920-e8ed-7bda-41ec-94df7380b7d5",
556551
"license_expression": "lgpl-3.0",
557-
"detection_count": 2
552+
"detection_count": 1
558553
},
559554
{
560-
"identifier": "lgpl_3_0-38174920-e8ed-7bda-41ec-94df7380b7d5",
561-
"license_expression": "lgpl-3.0",
555+
"identifier": "mit-3fce6ea2-8abd-6c6b-3ede-a37af7c6efee",
556+
"license_expression": "mit",
557+
"detection_count": 1
558+
},
559+
{
560+
"identifier": "mit-a822f434-d61f-f2b1-c792-8b8cb9e7b9bf",
561+
"license_expression": "mit",
562562
"detection_count": 1
563563
}
564564
]

‎tests/formattedcode/data/common/manifests-expected.yaml‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -465,39 +465,39 @@ dependencies:
465465
datafile_path: manifests/npm-license-string/package.json
466466
datasource_id: npm_package_json
467467
license_detections:
468-
- identifier: cddl_1_0-c6dbef4d-659c-289f-5ee9-1ca0278edad6
469-
license_expression: cddl-1.0
468+
- identifier: apache_2_0-d66ab77d-a5cc-7104-e702-dc7df61fe9e8
469+
license_expression: apache-2.0
470+
detection_count: 3
471+
- identifier: apache_2_0-ec759ae0-ea5a-f138-793e-388520e080c0
472+
license_expression: apache-2.0
470473
detection_count: 1
471474
- identifier: cddl_1_0-9893b55c-3b2b-4ee8-a932-6c6c93a63fc5
472475
license_expression: cddl-1.0
473476
detection_count: 1
474-
- identifier: cddl_1_0-ef82fc8c-50cb-6f35-1814-d2eb0bc13e83
477+
- identifier: cddl_1_0-c6dbef4d-659c-289f-5ee9-1ca0278edad6
475478
license_expression: cddl-1.0
476479
detection_count: 1
477-
- identifier: apache_2_0-ec759ae0-ea5a-f138-793e-388520e080c0
478-
license_expression: apache-2.0
479-
detection_count: 1
480-
- identifier: apache_2_0-d66ab77d-a5cc-7104-e702-dc7df61fe9e8
481-
license_expression: apache-2.0
482-
detection_count: 3
483-
- identifier: mit-3fce6ea2-8abd-6c6b-3ede-a37af7c6efee
484-
license_expression: mit
485-
detection_count: 1
486-
- identifier: mit-a822f434-d61f-f2b1-c792-8b8cb9e7b9bf
487-
license_expression: mit
480+
- identifier: cddl_1_0-ef82fc8c-50cb-6f35-1814-d2eb0bc13e83
481+
license_expression: cddl-1.0
488482
detection_count: 1
483+
- identifier: lgpl_3_0-272571eb-5e68-95b6-ddb0-71de2d8df321
484+
license_expression: lgpl-3.0
485+
detection_count: 2
489486
- identifier: lgpl_3_0-121be3c2-9c80-df84-d3da-8f674e4125c0
490487
license_expression: lgpl-3.0
491488
detection_count: 1
492489
- identifier: lgpl_3_0-2db87bcf-56b4-9d7d-7075-2effae31c631
493490
license_expression: lgpl-3.0
494491
detection_count: 1
495-
- identifier: lgpl_3_0-272571eb-5e68-95b6-ddb0-71de2d8df321
496-
license_expression: lgpl-3.0
497-
detection_count: 2
498492
- identifier: lgpl_3_0-38174920-e8ed-7bda-41ec-94df7380b7d5
499493
license_expression: lgpl-3.0
500494
detection_count: 1
495+
- identifier: mit-3fce6ea2-8abd-6c6b-3ede-a37af7c6efee
496+
license_expression: mit
497+
detection_count: 1
498+
- identifier: mit-a822f434-d61f-f2b1-c792-8b8cb9e7b9bf
499+
license_expression: mit
500+
detection_count: 1
501501
license_references:
502502
- key: apache-2.0
503503
language: en

‎tests/formattedcode/data/yaml/package-and-licenses-expected.yaml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ headers:
2929
system_environment:
3030
operating_system: linux
3131
cpu_architecture: 64
32-
platform: Linux-5.14.0-1059-oem-x86_64-with-glibc2.29
33-
platform_version: '#67-Ubuntu SMP Mon Mar 13 14:22:10 UTC 2023'
34-
python_version: "3.8.10 (default, Mar 13 2023, 10:26:41) \n[GCC 9.4.0]"
32+
platform: Linux-5.15.0-73-generic-x86_64-with-glibc2.29
33+
platform_version: '#80~20.04.1-Ubuntu SMP Wed May 17 14:58:14 UTC 2023'
34+
python_version: "3.8.10 (default, May 26 2023, 14:05:08) \n[GCC 9.4.0]"
3535
spdx_license_list_version: '3.20'
3636
files_count: 4
3737
summary:
@@ -121,18 +121,18 @@ packages:
121121
purl: pkg:pypi/codebase
122122
dependencies: []
123123
license_detections:
124+
- identifier: apache_2_0-ec759ae0-ea5a-f138-793e-388520e080c0
125+
license_expression: apache-2.0
126+
detection_count: 2
124127
- identifier: apache_2_0-ab23f79b-ec38-9a8a-9b23-85059407f34d
125128
license_expression: apache-2.0
126129
detection_count: 1
127-
- identifier: mit-cacd5c0c-204a-85c2-affc-e4c125b2492a
128-
license_expression: mit
129-
detection_count: 1
130130
- identifier: apache_2_0_and__apache_2_0_or_mit-9b638e72-e872-a67f-3447-eec297ef7b39
131131
license_expression: apache-2.0 AND (apache-2.0 OR mit)
132132
detection_count: 1
133-
- identifier: apache_2_0-ec759ae0-ea5a-f138-793e-388520e080c0
134-
license_expression: apache-2.0
135-
detection_count: 2
133+
- identifier: mit-cacd5c0c-204a-85c2-affc-e4c125b2492a
134+
license_expression: mit
135+
detection_count: 1
136136
license_references:
137137
- key: apache-2.0
138138
language: en

0 commit comments

Comments
 (0)