Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix package resource assign bug for jar manifests #3983

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Fix package resource assign bug for jar manifests #3983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions src/packagedcode/maven.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@ def assemble(cls, package_data, resource, codebase, package_adder=models.add_to_
yield from models.DatafileHandler.assemble(package_data, resource, codebase)
return

if not package_data.purl:
return

datafile_path = resource.path

# This order is important as we want pom.xml to be used for package
Expand Down Expand Up @@ -116,11 +119,11 @@ def assemble(cls, package_data, resource, codebase, package_adder=models.add_to_
parent_resource=parent_resource,
)
elif manifests and not pom_xmls:
yield from JavaJarManifestHandlerMixin.assemble(package_data, resource, codebase)
yield from JavaJarManifestHandlerMixin.assemble(package_data, resource, codebase, package_adder)
elif pom_xmls and not manifests:
yield from MavenPomXmlHandlerMixin.assemble(package_data, resource, codebase)
yield from MavenPomXmlHandlerMixin.assemble(package_data, resource, codebase, package_adder)
else:
yield from models.DatafileHandler.assemble(package_data, resource, codebase)
yield from models.DatafileHandler.assemble(package_data, resource, codebase, package_adder)


class JavaJarManifestHandler(MavenBasePackageHandler):
Expand Down Expand Up @@ -149,7 +152,7 @@ def assign_package_to_resources(cls, package, resource, codebase, package_adder)
# we want to root of the jar, two levels up
parent = resource.parent(codebase)
if parent:
parent = resource.parent(codebase)
parent = parent.parent(codebase)
if parent:
models.DatafileHandler.assign_package_to_resources(
package,
Expand Down
6 changes: 6 additions & 0 deletions src/packagedcode/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1199,6 +1199,12 @@ def assign_package_to_resources(cls, package, resource, codebase, package_adder=
# NOTE: we do not attach files to the Package level. Instead we
# update `for_packages` of a codebase resource.
package_uid = package.package_uid
if resource.path.endswith("-extract"):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You may consider using https://github.com/aboutcode-org/commoncode/blob/878be6140deac30e2b95fb0fad9eb8feca015fc8/src/commoncode/resource.py#L1264

archive_resource_path = resource.path.removesuffix("-extract")
archive_resource = codebase.get_resource(archive_resource_path)
if archive_resource:
package_adder(package_uid, archive_resource, codebase)

if resource and package_uid:
package_adder(package_uid, resource, codebase)
for res in resource.walk(codebase):
Expand Down
4 changes: 3 additions & 1 deletion tests/packagedcode/data/maven_misc/assemble/jackson-dataformat-xml-2.13.5-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,9 @@
"path": "jackson-dataformat-xml-2.13.5",
"type": "directory",
"package_data": [],
"for_packages": [],
"for_packages": [
"pkg:jar/Jackson-dataformat-XML@2.13.5?uuid=fixed-uid-done-for-testing-5642512d1758"
],
"detected_license_expression": null,
"detected_license_expression_spdx": null,
"license_detections": [],
Expand Down
321 changes: 321 additions & 0 deletions tests/packagedcode/data/maven_misc/assemble/spring-web-5.3.20-jar-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,321 @@
{
"packages": [
{
"type": "jar",
"namespace": null,
"name": "spring-web",
"version": "5.3.20",
"qualifiers": {},
"subpath": null,
"primary_language": null,
"description": null,
"release_date": null,
"parties": [],
"keywords": [],
"homepage_url": null,
"download_url": null,
"size": null,
"sha1": null,
"md5": null,
"sha256": null,
"sha512": null,
"bug_tracking_url": null,
"code_view_url": null,
"vcs_url": null,
"copyright": null,
"holder": null,
"declared_license_expression": "apache-2.0",
"declared_license_expression_spdx": "Apache-2.0",
"license_detections": [
{
"license_expression": "apache-2.0",
"license_expression_spdx": "Apache-2.0",
"matches": [
{
"license_expression": "apache-2.0",
"license_expression_spdx": "Apache-2.0",
"from_file": "spring-web-5.3.20-jar/spring-web-5.3.20.jar-extract/META-INF/notice.txt",
"start_line": 4,
"end_line": 6,
"matcher": "2-aho",
"score": 100.0,
"matched_length": 27,
"match_coverage": 100.0,
"rule_relevance": 100,
"rule_identifier": "apache-2.0_701.RULE",
"rule_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/rules/apache-2.0_701.RULE"
}
],
"detection_log": [],
"identifier": "apache_2_0-dda7c7b6-8825-2c52-d55b-46f66d469baa"
}
],
"other_license_expression": null,
"other_license_expression_spdx": null,
"other_license_detections": [],
"extracted_license_statement": null,
"notice_text": null,
"source_packages": [],
"is_private": false,
"is_virtual": false,
"extra_data": {},
"repository_homepage_url": null,
"repository_download_url": null,
"api_data_url": null,
"package_uid": "pkg:jar/spring-web@5.3.20?uuid=fixed-uid-done-for-testing-5642512d1758",
"datafile_paths": [
"spring-web-5.3.20-jar/spring-web-5.3.20.jar-extract/META-INF/MANIFEST.MF"
],
"datasource_ids": [
"java_jar_manifest"
],
"purl": "pkg:jar/spring-web@5.3.20"
}
],
"dependencies": [],
"license_detections": [
{
"identifier": "apache_2_0-dda7c7b6-8825-2c52-d55b-46f66d469baa",
"license_expression": "apache-2.0",
"license_expression_spdx": "Apache-2.0",
"detection_count": 2,
"detection_log": [],
"reference_matches": [
{
"license_expression": "apache-2.0",
"license_expression_spdx": "Apache-2.0",
"from_file": "spring-web-5.3.20-jar/spring-web-5.3.20.jar-extract/META-INF/notice.txt",
"start_line": 4,
"end_line": 6,
"matcher": "2-aho",
"score": 100.0,
"matched_length": 27,
"match_coverage": 100.0,
"rule_relevance": 100,
"rule_identifier": "apache-2.0_701.RULE",
"rule_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/rules/apache-2.0_701.RULE"
}
]
}
],
"files": [
{
"path": "spring-web-5.3.20-jar",
"type": "directory",
"package_data": [],
"for_packages": [],
"detected_license_expression": null,
"detected_license_expression_spdx": null,
"license_detections": [],
"license_clues": [],
"percentage_of_license_text": 0,
"scan_errors": []
},
{
"path": "spring-web-5.3.20-jar/spring-web-5.3.20.jar",
"type": "file",
"package_data": [
{
"type": "jar",
"namespace": null,
"name": null,
"version": null,
"qualifiers": {},
"subpath": null,
"primary_language": null,
"description": null,
"release_date": null,
"parties": [],
"keywords": [],
"homepage_url": null,
"download_url": null,
"size": null,
"sha1": null,
"md5": null,
"sha256": null,
"sha512": null,
"bug_tracking_url": null,
"code_view_url": null,
"vcs_url": null,
"copyright": null,
"holder": null,
"declared_license_expression": null,
"declared_license_expression_spdx": null,
"license_detections": [],
"other_license_expression": null,
"other_license_expression_spdx": null,
"other_license_detections": [],
"extracted_license_statement": null,
"notice_text": null,
"source_packages": [],
"file_references": [],
"is_private": false,
"is_virtual": false,
"extra_data": {},
"dependencies": [],
"repository_homepage_url": null,
"repository_download_url": null,
"api_data_url": null,
"datasource_id": "java_jar",
"purl": null
}
],
"for_packages": [
"pkg:jar/spring-web@5.3.20?uuid=fixed-uid-done-for-testing-5642512d1758"
],
"detected_license_expression": null,
"detected_license_expression_spdx": null,
"license_detections": [],
"license_clues": [],
"percentage_of_license_text": 0,
"scan_errors": []
},
{
"path": "spring-web-5.3.20-jar/spring-web-5.3.20.jar-extract",
"type": "directory",
"package_data": [],
"for_packages": [
"pkg:jar/spring-web@5.3.20?uuid=fixed-uid-done-for-testing-5642512d1758"
],
"detected_license_expression": null,
"detected_license_expression_spdx": null,
"license_detections": [],
"license_clues": [],
"percentage_of_license_text": 0,
"scan_errors": []
},
{
"path": "spring-web-5.3.20-jar/spring-web-5.3.20.jar-extract/META-INF",
"type": "directory",
"package_data": [],
"for_packages": [
"pkg:jar/spring-web@5.3.20?uuid=fixed-uid-done-for-testing-5642512d1758"
],
"detected_license_expression": null,
"detected_license_expression_spdx": null,
"license_detections": [],
"license_clues": [],
"percentage_of_license_text": 0,
"scan_errors": []
},
{
"path": "spring-web-5.3.20-jar/spring-web-5.3.20.jar-extract/META-INF/MANIFEST.MF",
"type": "file",
"package_data": [
{
"type": "jar",
"namespace": null,
"name": "spring-web",
"version": "5.3.20",
"qualifiers": {},
"subpath": null,
"primary_language": null,
"description": "",
"release_date": null,
"parties": [],
"keywords": [],
"homepage_url": null,
"download_url": null,
"size": null,
"sha1": null,
"md5": null,
"sha256": null,
"sha512": null,
"bug_tracking_url": null,
"code_view_url": null,
"vcs_url": null,
"copyright": null,
"holder": null,
"declared_license_expression": "apache-2.0",
"declared_license_expression_spdx": "Apache-2.0",
"license_detections": [
{
"license_expression": "apache-2.0",
"license_expression_spdx": "Apache-2.0",
"matches": [
{
"license_expression": "apache-2.0",
"license_expression_spdx": "Apache-2.0",
"from_file": "spring-web-5.3.20-jar/spring-web-5.3.20.jar-extract/META-INF/notice.txt",
"start_line": 4,
"end_line": 6,
"matcher": "2-aho",
"score": 100.0,
"matched_length": 27,
"match_coverage": 100.0,
"rule_relevance": 100,
"rule_identifier": "apache-2.0_701.RULE",
"rule_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/rules/apache-2.0_701.RULE"
}
],
"detection_log": [],
"identifier": "apache_2_0-dda7c7b6-8825-2c52-d55b-46f66d469baa"
}
],
"other_license_expression": null,
"other_license_expression_spdx": null,
"other_license_detections": [],
"extracted_license_statement": null,
"notice_text": null,
"source_packages": [],
"file_references": [],
"is_private": false,
"is_virtual": false,
"extra_data": {},
"dependencies": [],
"repository_homepage_url": null,
"repository_download_url": null,
"api_data_url": null,
"datasource_id": "java_jar_manifest",
"purl": "pkg:jar/spring-web@5.3.20"
}
],
"for_packages": [
"pkg:jar/spring-web@5.3.20?uuid=fixed-uid-done-for-testing-5642512d1758"
],
"detected_license_expression": null,
"detected_license_expression_spdx": null,
"license_detections": [],
"license_clues": [],
"percentage_of_license_text": 0,
"scan_errors": []
},
{
"path": "spring-web-5.3.20-jar/spring-web-5.3.20.jar-extract/META-INF/notice.txt",
"type": "file",
"package_data": [],
"for_packages": [
"pkg:jar/spring-web@5.3.20?uuid=fixed-uid-done-for-testing-5642512d1758"
],
"detected_license_expression": "apache-2.0",
"detected_license_expression_spdx": "Apache-2.0",
"license_detections": [
{
"license_expression": "apache-2.0",
"license_expression_spdx": "Apache-2.0",
"matches": [
{
"license_expression": "apache-2.0",
"license_expression_spdx": "Apache-2.0",
"from_file": "spring-web-5.3.20-jar/spring-web-5.3.20.jar-extract/META-INF/notice.txt",
"start_line": 4,
"end_line": 6,
"matcher": "2-aho",
"score": 100.0,
"matched_length": 27,
"match_coverage": 100.0,
"rule_relevance": 100,
"rule_identifier": "apache-2.0_701.RULE",
"rule_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/rules/apache-2.0_701.RULE"
}
],
"detection_log": [],
"identifier": "apache_2_0-dda7c7b6-8825-2c52-d55b-46f66d469baa"
}
],
"license_clues": [],
"percentage_of_license_text": 71.05,
"scan_errors": []
}
]
}
Binary file added tests/packagedcode/data/maven_misc/assemble/spring-web-5.3.20-jar/spring-web-5.3.20.jar
View file
Open in desktop
Binary file not shown.
6 changes: 6 additions & 0 deletions ...en_misc/assemble/spring-web-5.3.20-jar/spring-web-5.3.20.jar-extract/META-INF/MANIFEST.MF
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Manifest-Version: 1.0
Implementation-Title: spring-web
Automatic-Module-Name: spring.web
Implementation-Version: 5.3.20
Created-By: 1.8.0_332 (Oracle Corporation)

6 changes: 6 additions & 0 deletions ...ven_misc/assemble/spring-web-5.3.20-jar/spring-web-5.3.20.jar-extract/META-INF/notice.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Spring Framework 5.3.20
Copyright (c) 2002-2022 Pivotal, Inc.

This product is licensed to you under the Apache License, Version 2.0
(the "License"). You may not use this product except in compliance with
the License.
Loading
Loading