This is an automated email from the ASF dual-hosted git repository.
sbp pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tooling-trusted-release.git
The following commit(s) were added to refs/heads/main by this push:
new 311a95b Make LICENSE and NOTICE file checks more informative
311a95b is described below
commit 311a95b9575f277d42dd87aeaaff36964956f494
Author: Sean B. Palmer <[email protected]>
AuthorDate: Fri Jun 20 20:13:00 2025 +0100
Make LICENSE and NOTICE file checks more informative
---
atr/static.py | 223 ++++++++++++++++++++++++++++++++
atr/static/css/atr.css | 4 +
atr/tasks/checks/license.py | 189 ++++++++++++++-------------
atr/templates/report-selected-path.html | 8 +-
4 files changed, 331 insertions(+), 93 deletions(-)
diff --git a/atr/static.py b/atr/static.py
new file mode 100644
index 0000000..6d8b32b
--- /dev/null
+++ b/atr/static.py
@@ -0,0 +1,223 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Final
+
+APACHE_LICENSE_2_0: Final[str] = """\
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+"""
diff --git a/atr/static/css/atr.css b/atr/static/css/atr.css
index 2c76604..801bef3 100644
--- a/atr/static/css/atr.css
+++ b/atr/static/css/atr.css
@@ -482,3 +482,7 @@ aside.sidebar nav a:hover {
.atr-hide {
display: none;
}
+
+.atr-pre-wrap {
+ white-space: pre-wrap;
+}
diff --git a/atr/tasks/checks/license.py b/atr/tasks/checks/license.py
index cc1d9a2..9063d89 100644
--- a/atr/tasks/checks/license.py
+++ b/atr/tasks/checks/license.py
@@ -16,6 +16,7 @@
# under the License.
import asyncio
+import difflib
import hashlib
import logging
import os
@@ -25,6 +26,7 @@ from typing import Any, Final
import atr.db.models as models
import atr.schema as schema
+import atr.static as static
import atr.tarzip as tarzip
import atr.tasks.checks as checks
@@ -193,21 +195,8 @@ def headers_validate(content: bytes, _filename: str) ->
tuple[bool, str | None]:
def _files_check_core_logic(artifact_path: str) -> Iterator[Result]:
"""Verify that LICENSE and NOTICE files exist and are placed and formatted
correctly."""
- files_found = []
- license_ok = False
- notice_ok = False
- notice_issues: list[str] = []
-
- # # First find and validate the root directory
- # try:
- # root_dir = targz.root_directory(artifact_path)
- # except targz.RootDirectoryError as e:
- # yield ArtifactResult(
- # status=models.CheckResultStatus.WARNING,
- # message=f"Could not determine root directory: {e!s}",
- # data=None,
- # )
- # # Continue checking files
+ license_results: dict[str, str | None] = {}
+ notice_results: dict[str, tuple[bool, list[str], str]] = {}
# Check for license files in the root directory
with tarzip.open_archive(artifact_path) as archive:
@@ -222,67 +211,59 @@ def _files_check_core_logic(artifact_path: str) ->
Iterator[Result]:
continue
filename = os.path.basename(member.name)
- if filename in {"LICENSE", "NOTICE"}:
- files_found.append(filename)
- if filename == "LICENSE":
- # TODO: Check length, should be 11,358 bytes
- license_ok = _files_check_core_logic_license(archive,
member)
- elif filename == "NOTICE":
- # TODO: Check length doesn't exceed some preset
- notice_ok, notice_issues =
_files_check_core_logic_notice(archive, member)
-
- yield from _files_messages_build(files_found, license_ok, notice_ok,
notice_issues)
-
- if license_ok and notice_ok:
- yield ArtifactResult(
- status=models.CheckResultStatus.SUCCESS,
- message="LICENSE and NOTICE files present and valid",
- data=None,
- )
- elif license_ok:
- yield ArtifactResult(
- status=models.CheckResultStatus.FAILURE,
- message="LICENSE file present but NOTICE file is not valid",
- data=None,
- )
- elif notice_ok:
- yield ArtifactResult(
- status=models.CheckResultStatus.FAILURE,
- message="NOTICE file present but LICENSE file is not valid",
- data=None,
- )
- else:
- yield ArtifactResult(
- status=models.CheckResultStatus.FAILURE,
- message="LICENSE and NOTICE files are not valid",
- data=None,
- )
+ if filename == "LICENSE":
+ # TODO: Check length, should be 11,358 bytes
+ license_diff = _files_check_core_logic_license(archive, member)
+ license_results[filename] = license_diff
+ elif filename == "NOTICE":
+ # TODO: Check length doesn't exceed some preset
+ notice_ok, notice_issues, notice_preamble =
_files_check_core_logic_notice(archive, member)
+ notice_results[filename] = (notice_ok, notice_issues,
notice_preamble)
+ yield from __license_results(license_results)
+ yield from __notice_results(notice_results)
-def _files_check_core_logic_license(archive: tarzip.Archive, member:
tarzip.Member) -> bool:
- """Verify that the LICENSE file matches the Apache 2.0 license."""
+
+def _files_check_core_logic_license(archive: tarzip.Archive, member:
tarzip.Member) -> str | None:
+ """Verify that the start of the LICENSE file matches the Apache 2.0
license."""
f = archive.extractfile(member)
if not f:
- return False
+ return None
- sha3_expected =
"5efa4839f385df309ffc022ca5ce9763c4bc709dab862ca77d9a894db6598456"
- sha3 = hashlib.sha3_256()
- for line in f:
- octets = line.strip(b" \t\r\n")
- if octets:
- sha3.update(octets)
- if sha3.hexdigest() == sha3_expected:
- return True
- return False
+ sha3e = hashlib.sha3_256()
+ sha3e.update(static.APACHE_LICENSE_2_0.encode("utf-8"))
+ sha3_expected = sha3e.hexdigest()
+
+ if sha3_expected !=
"5efa4839f385df309ffc022ca5ce9763c4bc709dab862ca77d9a894db6598456":
+ _LOGGER.error("SHA3 expected value is incorrect, please update the
static.LICENSE constant")
+
+ # It is common for the license to be used without the leading blank line
+ apache_license_2_0 = static.APACHE_LICENSE_2_0.removeprefix("\n")
+ # Remove the trailing newline for further normalisation
+ apache_license_2_0 = apache_license_2_0.removesuffix("\n")
+ content = f.read()
+ package_license = content.decode("utf-8", errors="replace")
+ package_license = package_license.removeprefix("\n")
+ package_license = package_license[: len(apache_license_2_0)]
+ if package_license != apache_license_2_0:
+ # TODO: Only show a contextual diff, not the full diff
+ diff = difflib.ndiff(apache_license_2_0.splitlines(),
package_license.splitlines())
+ return "\n".join(diff)
+
+ return None
-def _files_check_core_logic_notice(archive: tarzip.Archive, member:
tarzip.Member) -> tuple[bool, list[str]]:
+def _files_check_core_logic_notice(archive: tarzip.Archive, member:
tarzip.Member) -> tuple[bool, list[str], str]:
"""Verify that the NOTICE file follows the required format."""
f = archive.extractfile(member)
if not f:
- return False, ["Could not read NOTICE file"]
+ return False, ["the NOTICE file is missing or could not be read"], ""
- content = f.read().decode("utf-8")
+ try:
+ content = f.read().decode("utf-8")
+ except UnicodeDecodeError:
+ return False, ["the NOTICE file is not valid UTF-8"], ""
+ preamble = "".join(content.splitlines(keepends=True)[:3])
issues = []
if not re.search(r"Apache\s+[\w\-\.]+", content, re.MULTILINE):
@@ -294,53 +275,81 @@ def _files_check_core_logic_notice(archive:
tarzip.Archive, member: tarzip.Membe
):
issues.append("missing or invalid foundation attribution")
- return len(issues) == 0, issues
+ return len(issues) == 0, issues, preamble
-def _files_messages_build(
- files_found: list[str],
- license_ok: bool,
- notice_ok: bool,
- notice_issues: list[str],
+def __license_results(
+ license_results: dict[str, str | None],
) -> Iterator[Result]:
"""Build status messages for license file verification."""
- if not files_found:
+ license_files_size = len(license_results)
+ if license_files_size == 0:
yield ArtifactResult(
status=models.CheckResultStatus.FAILURE,
- message="No LICENSE or NOTICE files found",
+ message="No LICENSE file found",
data=None,
)
return
- # Check the LICENSE file
- if "LICENSE" not in files_found:
+ if license_files_size > 1:
yield ArtifactResult(
status=models.CheckResultStatus.FAILURE,
- message="LICENSE file not found",
- data=None,
- )
- elif not license_ok:
- yield MemberResult(
- status=models.CheckResultStatus.FAILURE,
- path="LICENSE",
- message="LICENSE file does not match Apache 2.0 license",
+ message="Multiple LICENSE files found",
data=None,
)
+ return
+
+ for filename, license_diff in license_results.items():
+ # Unpack the single result by iterating
+ if license_diff is None:
+ yield ArtifactResult(
+ status=models.CheckResultStatus.SUCCESS,
+ message=f"{filename} is valid",
+ data=None,
+ )
+ else:
+ yield ArtifactResult(
+ status=models.CheckResultStatus.FAILURE,
+ message=f"{filename} is invalid",
+ data={"diff": license_diff},
+ )
- # Check the NOTICE file
- if "NOTICE" not in files_found:
+
+def __notice_results(
+ notice_results: dict[str, tuple[bool, list[str], str]],
+) -> Iterator[Result]:
+ """Build status messages for notice file verification."""
+ notice_files_size = len(notice_results)
+ if notice_files_size == 0:
yield ArtifactResult(
status=models.CheckResultStatus.FAILURE,
- message="NOTICE file not found",
+ message="No NOTICE file found",
data=None,
)
- elif not notice_ok:
- yield MemberResult(
+ return
+
+ if notice_files_size > 1:
+ yield ArtifactResult(
status=models.CheckResultStatus.FAILURE,
- path="NOTICE",
- message="NOTICE file format issues: " + "; ".join(notice_issues),
+ message="Multiple NOTICE files found",
data=None,
)
+ return
+
+ for filename, (notice_ok, notice_issues, notice_preamble) in
notice_results.items():
+ # Unpack the single result by iterating
+ if notice_ok:
+ yield ArtifactResult(
+ status=models.CheckResultStatus.SUCCESS,
+ message=f"{filename} is valid",
+ data=None,
+ )
+ else:
+ yield ArtifactResult(
+ status=models.CheckResultStatus.FAILURE,
+ message=f"{filename} is invalid",
+ data={"issues": notice_issues, "preamble": notice_preamble},
+ )
# Header helpers
diff --git a/atr/templates/report-selected-path.html
b/atr/templates/report-selected-path.html
index a4b4b53..edcc12e 100644
--- a/atr/templates/report-selected-path.html
+++ b/atr/templates/report-selected-path.html
@@ -150,7 +150,9 @@
{% for k, v in value.items() %}
<tr>
<th class="bg-light fw-bold">{{
k|replace('_', ' ') |title }}</th>
- <td>{{ v }}</td>
+ <td>
+ <pre class="atr-pre-wrap">{{ v
}}</pre>
+ </td>
</tr>
{% endfor %}
</table>
@@ -175,10 +177,10 @@
{% else %}
None
{% endif %}
- {% elif value is sequence and value is not
string %}
+ {% elif (value is sequence) and (value is
not string) %}
{{ value|join(", ") }}
{% else %}
- {{ value }}
+ <pre class="atr-pre-wrap">{{ value }}</pre>
{% endif %}
</td>
</tr>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
