Update check_package_boundaries.

Before reformatting GN files (see [1] for why this is needed), the
presubmit check to ensure targets are not violating package boundaries
needs to be fixed because its regular expressions don't always work with
the new format.

This CL removes the parsing of line numbers to relax the regular
expressions without losing any functionality.

Error before this CL:
***************
<PATH>/webrtc/src/BUILD.gn:674 in target 'android_junit_tests':
  Source file 'examples/androidjunit/src/org/appspot/apprtc/BluetoothManagerTest.java'
  crosses boundary of package 'examples'.

<PATH>/webrtc/src/BUILD.gn:675 in target 'android_junit_tests':
  Source file 'examples/androidjunit/src/org/appspot/apprtc/DirectRTCClientTest.java'
  crosses boundary of package 'examples'.

<PATH>/webrtc/src/BUILD.gn:676 in target 'android_junit_tests':
  Source file 'examples/androidjunit/src/org/appspot/apprtc/TCPChannelClientTest.java'
  crosses boundary of package 'examples'.

<PATH>/webrtc/src/BUILD.gn:677 in target 'android_junit_tests':
  Source file 'sdk/android/tests/src/org/webrtc/AndroidVideoDecoderTest.java'
  crosses boundary of package 'sdk'.

<PATH>/webrtc/src/BUILD.gn:678 in target 'android_junit_tests':
  Source file 'sdk/android/tests/src/org/webrtc/CameraEnumerationTest.java'
  crosses boundary of package 'sdk'.
***************


Error after this CL:
***************
<PATH>/webrtc/src/BUILD.gn in target 'android_junit_tests':
  Source file 'examples/androidjunit/src/org/appspot/apprtc/BluetoothManagerTest.java'
  crosses boundary of package 'examples'.

<PATH>/webrtc/src/BUILD.gn in target 'android_junit_tests':
  Source file 'examples/androidjunit/src/org/appspot/apprtc/DirectRTCClientTest.java'
  crosses boundary of package 'examples'.

<PATH>/webrtc/src/BUILD.gn in target 'android_junit_tests':
  Source file 'examples/androidjunit/src/org/appspot/apprtc/TCPChannelClientTest.java'
  crosses boundary of package 'examples'.

<PATH>/webrtc/src/BUILD.gn in target 'android_junit_tests':
  Source file 'sdk/android/tests/src/org/webrtc/AndroidVideoDecoderTest.java'
  crosses boundary of package 'sdk'.

<PATH>/webrtc/src/BUILD.gn in target 'android_junit_tests':
  Source file 'sdk/android/tests/src/org/webrtc/CameraEnumerationTest.java'
  crosses boundary of package 'sdk'.
***************


[1] - https://gn-review.googlesource.com/c/gn/+/6860

Bug: webrtc:11302
Change-Id: Ia39387d089a0c56a2c3ad9a7264c20eb5a38ac93
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/166535
Reviewed-by: Patrik Höglund <phoglund@webrtc.org>
Commit-Queue: Mirko Bonadei <mbonadei@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#30331}
This commit is contained in:
Mirko Bonadei 2020-01-21 08:42:41 +01:00 committed by Commit Bot
parent e77f94c54c
commit b7dc45f8e8
5 changed files with 8 additions and 21 deletions

View File

@ -16,23 +16,23 @@ import sys
# TARGET_RE matches a GN target, and extracts the target name and the contents.
TARGET_RE = re.compile(r'\d+\$(?P<indent>\s*)\w+\("(?P<target_name>\w+)"\) {'
TARGET_RE = re.compile(r'(?P<indent>\s*)\w+\("(?P<target_name>\w+)"\) {'
r'(?P<target_contents>.*?)'
r'\d+\$(?P=indent)}',
r'(?P=indent)}',
re.MULTILINE | re.DOTALL)
# SOURCES_RE matches a block of sources inside a GN target.
SOURCES_RE = re.compile(r'sources \+?= \[(?P<sources>.*?)\]',
re.MULTILINE | re.DOTALL)
ERROR_MESSAGE = ("{build_file_path}:{line_number} in target '{target_name}':\n"
ERROR_MESSAGE = ("{build_file_path} in target '{target_name}':\n"
" Source file '{source_file}'\n"
" crosses boundary of package '{subpackage}'.")
class PackageBoundaryViolation(
collections.namedtuple('PackageBoundaryViolation',
'build_file_path line_number target_name source_file subpackage')):
'build_file_path target_name source_file subpackage')):
def __str__(self):
return ERROR_MESSAGE.format(**self._asdict())
@ -42,7 +42,7 @@ def _BuildSubpackagesPattern(packages, query):
of the given query."""
query += os.path.sep
length = len(query)
pattern = r'(?P<line_number>\d+)\$\s*"(?P<source_file>(?P<subpackage>'
pattern = r'\s*"(?P<source_file>(?P<subpackage>'
pattern += '|'.join(re.escape(package[length:].replace(os.path.sep, '/'))
for package in packages if package.startswith(query))
pattern += r')/[\w\./]*)"'
@ -50,10 +50,9 @@ def _BuildSubpackagesPattern(packages, query):
def _ReadFileAndPrependLines(file_path):
"""Reads the contents of a file and prepends the line number to every line."""
"""Reads the contents of a file."""
with open(file_path) as f:
return "".join("{}${}".format(line_number, line)
for line_number, line in enumerate(f, 1))
return "".join(f.readlines())
def _CheckBuildFile(build_file_path, packages):
@ -73,9 +72,8 @@ def _CheckBuildFile(build_file_path, packages):
for subpackages_match in subpackages_re.finditer(sources):
subpackage = subpackages_match.group('subpackage')
source_file = subpackages_match.group('source_file')
line_number = subpackages_match.group('line_number')
if subpackage:
yield PackageBoundaryViolation(build_file_path, line_number,
yield PackageBoundaryViolation(build_file_path,
target_name, source_file, subpackage)

View File

@ -1,20 +1,16 @@
[('subpackage2/BUILD.gn',
'12',
'error_2',
'subsubpackage2/dummy_subsubpackage2.cc',
'subsubpackage2'),
('subpackage2/BUILD.gn',
'13',
'error_2',
'subsubpackage2/dummy_subsubpackage2.h',
'subsubpackage2'),
('subpackage1/BUILD.gn',
'12',
'error_1',
'subsubpackage1/dummy_subsubpackage1.cc',
'subsubpackage1'),
('subpackage1/BUILD.gn',
'13',
'error_1',
'subsubpackage1/dummy_subsubpackage1.h',
'subsubpackage1')]

View File

@ -1,5 +1,4 @@
[("BUILD.gn",
"13",
"dummy_target",
"libc++/dummy_subpackage_file.h",
"libc++")]

View File

@ -1,20 +1,16 @@
[('BUILD.gn',
'18',
'error_1',
'subpackage1/dummy_subpackage1.cc',
'subpackage1'),
('BUILD.gn',
'19',
'error_1',
'subpackage1/dummy_subpackage1.h',
'subpackage1'),
('BUILD.gn',
'25',
'error_2',
'subpackage1/dummy_subpackage2.cc',
'subpackage1'),
('BUILD.gn',
'26',
'error_2',
'subpackage1/dummy_subpackage2.h',
'subpackage1')]

View File

@ -1,10 +1,8 @@
[("BUILD.gn",
"11",
"dummy_target",
"subpackage/dummy_subpackage_file.cc",
"subpackage"),
("BUILD.gn",
"12",
"dummy_target",
"subpackage/dummy_subpackage_file.h",
"subpackage")]