aboutsummaryrefslogtreecommitdiffstats
path: root/python/tidy/servo_tidy/tidy.py
diff options
context:
space:
mode:
authoredunham <edunham@mozilla.com>2016-04-19 13:57:09 -0700
committerUK992 <urbankrajnc92@gmail.com>2016-08-12 13:32:09 +0200
commit48ace17b5419a9795a13bded286e113e79d56905 (patch)
treebc78a198ae1129c8c16979b868fba2b2634d0eb1 /python/tidy/servo_tidy/tidy.py
parent1f4dd8765fe06784f052765f63f3e4869faf8164 (diff)
downloadservo-48ace17b5419a9795a13bded286e113e79d56905.tar.gz
servo-48ace17b5419a9795a13bded286e113e79d56905.zip
Improve tidy's license validation logic
fixes https://github.com/servo/servo/issues/10716 I took the lazy way out and hardcoded the size of block we examine for licenses. fixes https://github.com/servo/servo/issues/10719 Includes tests for new functionality.
Diffstat (limited to 'python/tidy/servo_tidy/tidy.py')
-rw-r--r--python/tidy/servo_tidy/tidy.py42
1 files changed, 30 insertions, 12 deletions
diff --git a/python/tidy/servo_tidy/tidy.py b/python/tidy/servo_tidy/tidy.py
index 3433e8265ed..fac5f8e7063 100644
--- a/python/tidy/servo_tidy/tidy.py
+++ b/python/tidy/servo_tidy/tidy.py
@@ -17,12 +17,9 @@ import site
import StringIO
import subprocess
import sys
-from licenseck import licenses, licenses_toml, licenses_dep_toml
+from licenseck import MPL, APACHE, COPYRIGHT, licenses_toml, licenses_dep_toml
-# License and header checks
-EMACS_HEADER = "/* -*- Mode:"
-VIM_HEADER = "/* vim:"
-MAX_LICENSE_LINESPAN = max(len(license.splitlines()) for license in licenses)
+COMMENTS = ["// ", "# ", " *", "/* "]
# File patterns to include in the non-WPT tidy check.
FILE_PATTERNS_TO_CHECK = ["*.rs", "*.rc", "*.cpp", "*.c",
@@ -55,7 +52,6 @@ IGNORED_FILES = [
IGNORED_DIRS = [
# Upstream
os.path.join(".", "support", "android", "apk"),
- os.path.join(".", "support", "rust-task_info"),
os.path.join(".", "tests", "wpt", "css-tests"),
os.path.join(".", "tests", "wpt", "harness"),
os.path.join(".", "tests", "wpt", "update"),
@@ -147,13 +143,35 @@ def filter_files(start_dir, only_changed_files, progress):
yield file_name
+def uncomment(line):
+ for c in COMMENTS:
+ if line.startswith(c):
+ if line.endswith("*/"):
+ return line[len(c):(len(line) - 3)].strip()
+ return line[len(c):].strip()
+
+
+def licensed_mpl(header):
+ return MPL in header
+
+
+def licensed_apache(header):
+ if APACHE in header:
+ return any(c in header for c in COPYRIGHT)
+
+
def check_license(file_name, lines):
if any(file_name.endswith(ext) for ext in (".toml", ".lock", ".json")):
raise StopIteration
- while lines and (lines[0].startswith(EMACS_HEADER) or lines[0].startswith(VIM_HEADER)):
- lines = lines[1:]
- contents = "".join(lines[:MAX_LICENSE_LINESPAN])
- valid_license = any(contents.startswith(license) for license in licenses)
+ block = min(len(lines), licenseck.MAX_LICENSE_LINESPAN)
+ license_block = []
+ for l in lines[:block]:
+ l = l.rstrip('\n')
+ line = uncomment(l)
+ if line is not None:
+ license_block += [line]
+ contents = " ".join(license_block)
+ valid_license = licensed_mpl(contents) or licensed_apache(contents)
acknowledged_bad_license = "xfail-license" in contents
if not (valid_license or acknowledged_bad_license):
yield (1, "incorrect license")
@@ -305,8 +323,8 @@ def check_toml(file_name, lines):
for idx, line in enumerate(lines):
if line.find("*") != -1:
yield (idx + 1, "found asterisk instead of minimum version number")
- for license in licenses_toml:
- ok_licensed |= (license in line)
+ for license_line in licenses_toml:
+ ok_licensed |= (license_line in line)
if not ok_licensed:
yield (0, ".toml file should contain a valid license.")