2019-01-09 06:09:39 +03:00
|
|
|
# Copyright 2019 The ANGLE Project Authors. All rights reserved.
|
|
|
|
# Use of this source code is governed by a BSD-style license that can be
|
|
|
|
# found in the LICENSE file.
|
|
|
|
"""Top-level presubmit script for code generation.
|
|
|
|
|
|
|
|
See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts
|
|
|
|
for more details on the presubmit API built into depot_tools.
|
|
|
|
"""
|
|
|
|
|
2019-10-04 21:57:25 +03:00
|
|
|
from subprocess import call
|
2019-01-09 06:09:39 +03:00
|
|
|
|
2019-01-09 18:33:16 +03:00
|
|
|
# Fragment of a regular expression that matches C++ and Objective-C++ implementation files.
|
|
|
|
_IMPLEMENTATION_EXTENSIONS = r'\.(cc|cpp|cxx|mm)$'
|
|
|
|
|
|
|
|
# Fragment of a regular expression that matches C++ and Objective-C++ header files.
|
|
|
|
_HEADER_EXTENSIONS = r'\.(h|hpp|hxx)$'
|
|
|
|
|
|
|
|
|
2019-07-05 15:44:23 +03:00
|
|
|
def _CheckChangeHasBugField(input_api, output_api):
|
|
|
|
"""Requires that the changelist have a Bug: field."""
|
|
|
|
bugs = input_api.change.BugsFromDescription()
|
|
|
|
if not bugs:
|
|
|
|
return [
|
|
|
|
output_api.PresubmitError(
|
|
|
|
'If this change has an associated bug, add Bug: angleproject:[bug number].')
|
|
|
|
]
|
|
|
|
elif not all([' ' not in bug for bug in bugs]):
|
|
|
|
return [
|
|
|
|
output_api.PresubmitError(
|
|
|
|
'Check bug tag formatting. Ensure there are no spaces after the colon.')
|
|
|
|
]
|
|
|
|
else:
|
|
|
|
return []
|
|
|
|
|
|
|
|
|
2019-01-09 18:33:16 +03:00
|
|
|
def _CheckCodeGeneration(input_api, output_api):
|
2019-04-01 21:40:21 +03:00
|
|
|
|
|
|
|
class Msg(output_api.PresubmitError):
|
2019-05-06 20:15:35 +03:00
|
|
|
"""Specialized error message"""
|
|
|
|
|
|
|
|
def __init__(self, message):
|
|
|
|
super(output_api.PresubmitError, self).__init__(
|
|
|
|
message,
|
2019-07-05 15:44:23 +03:00
|
|
|
long_text='Please run scripts/run_code_generation.py to refresh generated hashes.\n'
|
|
|
|
'\n'
|
|
|
|
'If that fails, ensure your ANGLE repositiory is synced to tip-of-tree\n'
|
|
|
|
'and all ANGLE DEPS are fully up-to-date by running gclient sync.\n'
|
|
|
|
'\n'
|
|
|
|
'If you are building ANGLE inside Chromium you must bootstrap ANGLE\n'
|
|
|
|
'before gclient sync. See the DevSetup documentation for more details.\n')
|
2019-04-01 21:40:21 +03:00
|
|
|
|
2019-01-09 06:09:39 +03:00
|
|
|
code_gen_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
|
|
|
|
'scripts/run_code_generation.py')
|
|
|
|
cmd_name = 'run_code_generation'
|
|
|
|
cmd = [input_api.python_executable, code_gen_path, '--verify-no-dirty']
|
2019-05-06 20:15:35 +03:00
|
|
|
test_cmd = input_api.Command(name=cmd_name, cmd=cmd, kwargs={}, message=Msg)
|
2019-01-09 06:09:39 +03:00
|
|
|
if input_api.verbose:
|
|
|
|
print('Running ' + cmd_name)
|
|
|
|
return input_api.RunTests([test_cmd])
|
|
|
|
|
2019-01-09 18:33:16 +03:00
|
|
|
|
|
|
|
# Taken directly from Chromium's PRESUBMIT.py
|
|
|
|
def _CheckNewHeaderWithoutGnChange(input_api, output_api):
|
2019-05-06 20:15:35 +03:00
|
|
|
"""Checks that newly added header files have corresponding GN changes.
|
2019-01-09 18:33:16 +03:00
|
|
|
Note that this is only a heuristic. To be precise, run script:
|
|
|
|
build/check_gn_headers.py.
|
|
|
|
"""
|
|
|
|
|
2019-05-06 20:15:35 +03:00
|
|
|
def headers(f):
|
|
|
|
return input_api.FilterSourceFile(f, white_list=(r'.+%s' % _HEADER_EXTENSIONS,))
|
|
|
|
|
|
|
|
new_headers = []
|
|
|
|
for f in input_api.AffectedSourceFiles(headers):
|
|
|
|
if f.Action() != 'A':
|
|
|
|
continue
|
|
|
|
new_headers.append(f.LocalPath())
|
|
|
|
|
|
|
|
def gn_files(f):
|
|
|
|
return input_api.FilterSourceFile(f, white_list=(r'.+\.gn',))
|
|
|
|
|
|
|
|
all_gn_changed_contents = ''
|
|
|
|
for f in input_api.AffectedSourceFiles(gn_files):
|
|
|
|
for _, line in f.ChangedContents():
|
|
|
|
all_gn_changed_contents += line
|
|
|
|
|
|
|
|
problems = []
|
|
|
|
for header in new_headers:
|
|
|
|
basename = input_api.os_path.basename(header)
|
|
|
|
if basename not in all_gn_changed_contents:
|
|
|
|
problems.append(header)
|
|
|
|
|
|
|
|
if problems:
|
|
|
|
return [
|
|
|
|
output_api.PresubmitPromptWarning(
|
|
|
|
'Missing GN changes for new header files',
|
|
|
|
items=sorted(problems),
|
|
|
|
long_text='Please double check whether newly added header files need '
|
|
|
|
'corresponding changes in gn or gni files.\nThis checking is only a '
|
|
|
|
'heuristic. Run build/check_gn_headers.py to be precise.\n'
|
|
|
|
'Read https://crbug.com/661774 for more info.')
|
|
|
|
]
|
|
|
|
return []
|
2019-01-09 18:33:16 +03:00
|
|
|
|
|
|
|
|
2019-01-09 06:09:39 +03:00
|
|
|
def CheckChangeOnUpload(input_api, output_api):
|
2019-01-09 18:33:16 +03:00
|
|
|
results = []
|
|
|
|
results.extend(_CheckCodeGeneration(input_api, output_api))
|
2019-07-05 15:44:23 +03:00
|
|
|
results.extend(_CheckChangeHasBugField(input_api, output_api))
|
2019-05-06 20:15:35 +03:00
|
|
|
results.extend(input_api.canned_checks.CheckChangeHasDescription(input_api, output_api))
|
2019-01-09 18:33:16 +03:00
|
|
|
results.extend(_CheckNewHeaderWithoutGnChange(input_api, output_api))
|
2019-07-05 15:44:23 +03:00
|
|
|
results.extend(
|
|
|
|
input_api.canned_checks.CheckPatchFormatted(
|
|
|
|
input_api, output_api, result_factory=output_api.PresubmitError))
|
2019-01-09 18:33:16 +03:00
|
|
|
return results
|
2019-01-09 06:09:39 +03:00
|
|
|
|
|
|
|
|
|
|
|
def CheckChangeOnCommit(input_api, output_api):
|
2019-01-09 18:33:16 +03:00
|
|
|
results = []
|
2019-04-01 21:40:21 +03:00
|
|
|
results.extend(_CheckCodeGeneration(input_api, output_api))
|
2019-07-05 15:44:23 +03:00
|
|
|
results.extend(
|
|
|
|
input_api.canned_checks.CheckPatchFormatted(
|
|
|
|
input_api, output_api, result_factory=output_api.PresubmitError))
|
|
|
|
results.extend(_CheckChangeHasBugField(input_api, output_api))
|
2019-05-06 20:15:35 +03:00
|
|
|
results.extend(input_api.canned_checks.CheckChangeHasDescription(input_api, output_api))
|
2019-01-09 18:33:16 +03:00
|
|
|
return results
|