[android log] Add documentation and presubmit checks for log usage.
The new check warns for new log usages that don't use base.Log
The documentation is added in-tree as a markdown file
BUG=472152
Review URL: https://codereview.chromium.org/1114593002
Cr-Commit-Position: refs/heads/master@{#327504}
diff --git a/PRESUBMIT.py b/PRESUBMIT.py
index 71360cb..8f5d3b9 100644
--- a/PRESUBMIT.py
+++ b/PRESUBMIT.py
@@ -1300,6 +1300,35 @@
black_list=_EXCLUDED_PATHS + input_api.DEFAULT_BLACK_LIST)
+def _CheckNoNewUtilLogUsage(input_api, output_api):
+ """Checks that new logs are using org.chromium.base.Log."""
+
+ chromium_log_import_pattern = input_api.re.compile(
+ r'^import org\.chromium\.base\.Log;$', input_api.re.MULTILINE);
+ log_pattern = input_api.re.compile(r'^\s*(android\.util\.)?Log\.\w')
+ sources = lambda x: input_api.FilterSourceFile(x, white_list=(r'.*\.java$',))
+
+ errors = []
+
+ for f in input_api.AffectedSourceFiles(sources):
+ if chromium_log_import_pattern.search(input_api.ReadFile(f)) is not None:
+ # Uses org.chromium.base.Log already
+ continue
+
+ for line_num, line in f.ChangedContents():
+ if log_pattern.search(line):
+ errors.append("%s:%d" % (f.LocalPath(), line_num))
+
+ results = []
+ if len(errors):
+ results.append(output_api.PresubmitPromptWarning(
+ 'Please use org.chromium.base.Log for new logs.\n' +
+ 'See base/android/java/src/org/chromium/base/README_logging.md ' +
+ 'or contact [email protected] for more info.',
+ errors))
+ return results
+
+
def _CheckForCopyrightedCode(input_api, output_api):
"""Verifies that newly added code doesn't contain copyrighted material
and is properly licensed under the standard Chromium license.
@@ -1468,6 +1497,7 @@
results.extend(_CheckForCopyrightedCode(input_api, output_api))
results.extend(_CheckForWindowsLineEndings(input_api, output_api))
results.extend(_CheckSingletonInHeaders(input_api, output_api))
+ results.extend(_CheckNoNewUtilLogUsage(input_api, output_api))
if any('PRESUBMIT.py' == f.LocalPath() for f in input_api.AffectedFiles()):
results.extend(input_api.canned_checks.RunUnitTestsInDirectory(
