Skip to content

tweaks #1

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

Closed
neatudarius wants to merge 1 commit into from
Closed

tweaks #1

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
86 changes: 31 additions & 55 deletions tools/beman-tidy/beman_tidy/lib/checks/beman_standard/license.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

from ..base.file_base_check import FileBaseCheck
from ..system.registry import register_beman_standard_check
import re
import textwrap


# [LICENSE.*] checks category.
Expand All @@ -22,63 +24,37 @@ def __init__(self, repo_info, beman_standard_check_config):
super().__init__(repo_info, beman_standard_check_config)

def check(self):
lines = self.read_lines_strip()

separator_line = "=============================================================================="
approved_licenses = [
"Apache License v2.0 with LLVM Exceptions",
"Boost Software License 1.0",
"MIT License",
]

# Check if license header is correct
license_header = lines[0:3]

has_approved_license_header = False
for approved_license in approved_licenses:
if (
license_header[0] == separator_line
and license_header[1]
== f"The Beman Project is under the {approved_license}:"
and license_header[2] == separator_line
):
has_approved_license_header = True

if not has_approved_license_header:
self.log(
"Incorrect header for LICENSE. "
"See https://github.com/bemanproject/beman/blob/main/docs/BEMAN_STANDARD.md#licenseapproved for more information."
)
return False

# Check if license footer is correct
license_footer = lines[-11:]

correct_license_footer = [
"==============================================================================",
"Software from third parties included in the Beman Project:",
"==============================================================================",
"The Beman Project contains third party software which is under different license",
"terms. All such code will be identified clearly using at least one of two",
"mechanisms:",
"1) It will be in a separate directory tree with its own `LICENSE.txt` or",
"`LICENSE` file at the top containing the specific license and restrictions",
"which apply to that software, or",
"2) It will contain specific license and restriction terms at the top of every",
"file.",
]

if license_footer != correct_license_footer:
self.log(
"Incorrect footer for LICENSE. "
"See https://github.com/bemanproject/beman/blob/main/docs/BEMAN_STANDARD.md#licenseapproved for more information."
)
return False
license_text = self.read()

pattern = re.compile(
textwrap.dedent(r"""
^={78}\n
The Beman Project is under the
(Apache License v2\.0 with LLVM Exceptions|
Boost Software License 1\.0|
MIT License):
\n={78}\n

(.+?) # Non-empty license body

={78}\n
Software from third parties included in the Beman Project:\n
={78}\n
The Beman Project contains third party software which is under different license
terms\. All such code will be identified clearly using at least one of two
mechanisms:\n
1\) It will be in a separate directory tree with its own `LICENSE\.txt` or
`LICENSE` file at the top containing the specific license and restrictions
which apply to that software, or\n
2\) It will contain specific license and restriction terms at the top of every
file\.
"""),
re.DOTALL | re.VERBOSE,
)

# Check if there's any content between the header and footer
if len(lines) < 17:
if not pattern.match(license_text):
self.log(
"LICENSE contains only footer and header. There should be actual license content. "
"The LICENSE file does not contain an approved license. "
"See https://github.com/bemanproject/beman/blob/main/docs/BEMAN_STANDARD.md#licenseapproved for more information."
)
return False
Expand Down