Support running gn_check_autofix.py on a local build dir (e.g. out/Default)

Bug: webrtc:42226242
Change-Id: I8afedb8c316ab86a7219b07774f93da782f80a4d
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/355000
Commit-Queue: Björn Terelius <terelius@webrtc.org>
Reviewed-by: Harald Alvestrand <hta@webrtc.org>
Cr-Commit-Position: refs/heads/main@{#42513}
This commit is contained in:
Björn Terelius 2024-06-18 15:29:11 +02:00 committed by WebRTC LUCI CQ
parent aefed55c25
commit d5238b0998

View File

@ -10,15 +10,19 @@
"""
This tool tries to fix (some) errors reported by `gn gen --check` or
`gn check`.
It will run `mb gen` in a temporary directory and it is really useful to
check for different configurations.
If a command line flag `-C out/<dir>` is supplied, it will run `gn gen --check`
in that directory. Otherwise it will run `mb gen` in a temporary directory
which is useful to check for different configurations.
Usage:
$ vpython3 tools_webrtc/gn_check_autofix.py -C out/Default
or
$ vpython3 tools_webrtc/gn_check_autofix.py -m some_mater -b some_bot
or
$ vpython3 tools_webrtc/gn_check_autofix.py -c some_mb_config
"""
import argparse
import os
import re
import shutil
@ -39,6 +43,7 @@ TARGET_RE = re.compile(
class TemporaryDirectory:
def __init__(self):
self._closed = False
self._name = None
@ -62,9 +67,9 @@ def Run(cmd):
return sub.communicate()
def FixErrors(filename, missing_deps, deleted_sources):
with open(filename) as f:
lines = f.readlines()
def fix_errors(filename, missing_deps, deleted_sources):
with open(filename) as file:
lines = file.readlines()
fixed_file = ''
indentation_level = None
@ -78,8 +83,8 @@ def FixErrors(filename, missing_deps, deleted_sources):
match = re.match(indentation_level + '}$', line)
if match:
line = ('deps = [\n' + ''.join(' "' + dep + '",\n'
for dep in missing_deps[target]) +
']\n') + line
for dep in missing_deps[target])
+ ']\n') + line
indentation_level = None
elif line.strip().startswith('deps = ['):
joined_deps = ''.join(' "' + dep + '",\n'
@ -90,18 +95,18 @@ def FixErrors(filename, missing_deps, deleted_sources):
if line.strip() not in deleted_sources:
fixed_file += line
with open(filename, 'w') as f:
f.write(fixed_file)
with open(filename, 'w') as file:
file.write(fixed_file)
Run(['gn', 'format', filename])
def FirstNonEmpty(iterable):
def first_non_empty(iterable):
"""Return first item which evaluates to True, or fallback to None."""
return next((x for x in iterable if x), None)
def Rebase(base_path, dependency_path, dependency):
def rebase(base_path, dependency_path, dependency):
"""Adapt paths so they work both in stand-alone WebRTC and Chromium tree.
To cope with varying top-level directory (WebRTC VS Chromium), we use:
@ -119,9 +124,10 @@ def Rebase(base_path, dependency_path, dependency):
Full target path (E.g. '../rtc_base/time:timestamp_extrapolator').
"""
root = FirstNonEmpty(dependency_path.split('/'))
root = first_non_empty(dependency_path.split('/'))
if root in CHROMIUM_DIRS:
# Chromium paths must remain absolute. E.g. //third_party//abseil-cpp...
# Chromium paths must remain absolute. E.g.
# //third_party//abseil-cpp...
rebased = dependency_path
else:
base_path = base_path.split(os.path.sep)
@ -142,21 +148,41 @@ def Rebase(base_path, dependency_path, dependency):
def main():
helptext = """
This tool tries to fix (some) errors reported by `gn gen --check`.
If a command line flag `-C out/<dir>` is supplied, it will run `gn gen --check`
in that directory. Otherwise it will run `mb gen` in a temporary directory
with all other command line arguments forwarded to `mb gen`. This mode is
useful to check for different configurations."""
parser = argparse.ArgumentParser(
description=helptext,
formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument('-C',
dest='local_build_dir',
help='Path lo a local build dir, e.g. out/Default')
(flags, argv_to_forward) = parser.parse_known_args(sys.argv[1:])
deleted_sources = set()
errors_by_file = defaultdict(lambda: defaultdict(set))
if flags.local_build_dir:
mb_output = Run(["gn", "gen", "--check", flags.local_build_dir])
else:
with TemporaryDirectory() as tmp_dir:
mb_script_path = os.path.join(SCRIPT_DIR, 'mb', 'mb.py')
mb_config_file_path = os.path.join(SCRIPT_DIR, 'mb', 'mb_config.pyl')
mb_config_file_path = os.path.join(SCRIPT_DIR, 'mb',
'mb_config.pyl')
mb_gen_command = ([
mb_script_path,
'gen',
tmp_dir,
'--config-file',
mb_config_file_path,
] + sys.argv[1:])
] + argv_to_forward)
mb_output = Run(mb_gen_command)
errors = mb_output[0].split('ERROR')[1:]
if mb_output[1]:
@ -177,7 +203,7 @@ def main():
'The include file is in the target(s):'):
dep = error[index + 2].strip()
dep_path, dep = dep.split(':')
dep = Rebase(path, dep_path, dep)
dep = rebase(path, dep_path, dep)
# Replacing /target:target with /target
dep = re.sub(r'/(\w+):(\1)$', r'/\1', dep)
# Replacing target:target with target
@ -185,14 +211,15 @@ def main():
path = os.path.join(path[2:], 'BUILD.gn')
errors_by_file[path][target].add(dep)
elif error[index + 1] == 'has a source file:':
deleted_file = '"' + os.path.basename(error[index + 2].strip()) + '",'
deleted_file = '"' + os.path.basename(
error[index + 2].strip()) + '",'
deleted_sources.add(deleted_file)
else:
print('\n'.join(error))
continue
for path, missing_deps in list(errors_by_file.items()):
FixErrors(path, missing_deps, deleted_sources)
fix_errors(path, missing_deps, deleted_sources)
return 0