• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1#!/usr/bin/env vpython3
2
3# Copyright (c) 2016 The WebRTC project authors. All Rights Reserved.
4#
5# Use of this source code is governed by a BSD-style license
6# that can be found in the LICENSE file in the root of the source
7# tree. An additional intellectual property rights grant can be found
8# in the file PATENTS.  All contributing project authors may
9# be found in the AUTHORS file in the root of the source tree.
10"""
11This tool tries to fix (some) errors reported by `gn gen --check` or
12`gn check`.
13It will run `mb gen` in a temporary directory and it is really useful to
14check for different configurations.
15
16Usage:
17    $ vpython3 tools_webrtc/gn_check_autofix.py -m some_mater -b some_bot
18    or
19    $ vpython3 tools_webrtc/gn_check_autofix.py -c some_mb_config
20"""
21
22import os
23import re
24import shutil
25import subprocess
26import sys
27import tempfile
28
29from collections import defaultdict
30
31SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__))
32
33CHROMIUM_DIRS = [
34    'base', 'build', 'buildtools', 'testing', 'third_party', 'tools'
35]
36
37TARGET_RE = re.compile(
38    r'(?P<indentation_level>\s*)\w*\("(?P<target_name>\w*)"\) {$')
39
40
41class TemporaryDirectory:
42  def __init__(self):
43    self._closed = False
44    self._name = None
45    self._name = tempfile.mkdtemp()
46
47  def __enter__(self):
48    return self._name
49
50  def __exit__(self, exc, value, _tb):
51    if self._name and not self._closed:
52      shutil.rmtree(self._name)
53      self._closed = True
54
55
56def Run(cmd):
57  print('Running:', ' '.join(cmd))
58  sub = subprocess.Popen(cmd,
59                         stdout=subprocess.PIPE,
60                         stderr=subprocess.PIPE,
61                         universal_newlines=True)
62  return sub.communicate()
63
64
65def FixErrors(filename, missing_deps, deleted_sources):
66  with open(filename) as f:
67    lines = f.readlines()
68
69  fixed_file = ''
70  indentation_level = None
71  for line in lines:
72    match = TARGET_RE.match(line)
73    if match:
74      target = match.group('target_name')
75      if target in missing_deps:
76        indentation_level = match.group('indentation_level')
77    elif indentation_level is not None:
78      match = re.match(indentation_level + '}$', line)
79      if match:
80        line = ('deps = [\n' + ''.join('  "' + dep + '",\n'
81                                       for dep in missing_deps[target]) +
82                ']\n') + line
83        indentation_level = None
84      elif line.strip().startswith('deps = ['):
85        joined_deps = ''.join('  "' + dep + '",\n'
86                              for dep in missing_deps[target])
87        line = line.replace('deps = [', 'deps = [' + joined_deps)
88        indentation_level = None
89
90    if line.strip() not in deleted_sources:
91      fixed_file += line
92
93  with open(filename, 'w') as f:
94    f.write(fixed_file)
95
96  Run(['gn', 'format', filename])
97
98
99def FirstNonEmpty(iterable):
100  """Return first item which evaluates to True, or fallback to None."""
101  return next((x for x in iterable if x), None)
102
103
104def Rebase(base_path, dependency_path, dependency):
105  """Adapt paths so they work both in stand-alone WebRTC and Chromium tree.
106
107  To cope with varying top-level directory (WebRTC VS Chromium), we use:
108    * relative paths for WebRTC modules.
109    * absolute paths for shared ones.
110  E.g. '//common_audio/...' -> '../../common_audio/'
111       '//third_party/...' remains as is.
112
113  Args:
114    base_path: current module path  (E.g. '//video')
115    dependency_path: path from root (E.g. '//rtc_base/time')
116    dependency: target itself       (E.g. 'timestamp_extrapolator')
117
118  Returns:
119    Full target path (E.g. '../rtc_base/time:timestamp_extrapolator').
120  """
121
122  root = FirstNonEmpty(dependency_path.split('/'))
123  if root in CHROMIUM_DIRS:
124    # Chromium paths must remain absolute. E.g. //third_party//abseil-cpp...
125    rebased = dependency_path
126  else:
127    base_path = base_path.split(os.path.sep)
128    dependency_path = dependency_path.split(os.path.sep)
129
130    first_difference = None
131    shortest_length = min(len(dependency_path), len(base_path))
132    for i in range(shortest_length):
133      if dependency_path[i] != base_path[i]:
134        first_difference = i
135        break
136
137    first_difference = first_difference or shortest_length
138    base_path = base_path[first_difference:]
139    dependency_path = dependency_path[first_difference:]
140    rebased = os.path.sep.join((['..'] * len(base_path)) + dependency_path)
141  return rebased + ':' + dependency
142
143
144def main():
145  deleted_sources = set()
146  errors_by_file = defaultdict(lambda: defaultdict(set))
147
148  with TemporaryDirectory() as tmp_dir:
149    mb_script_path = os.path.join(SCRIPT_DIR, 'mb', 'mb.py')
150    mb_config_file_path = os.path.join(SCRIPT_DIR, 'mb', 'mb_config.pyl')
151    mb_gen_command = ([
152        mb_script_path,
153        'gen',
154        tmp_dir,
155        '--config-file',
156        mb_config_file_path,
157    ] + sys.argv[1:])
158
159  mb_output = Run(mb_gen_command)
160  errors = mb_output[0].split('ERROR')[1:]
161
162  if mb_output[1]:
163    print(mb_output[1])
164    return 1
165
166  for error in errors:
167    error = error.split('\n')
168    target_msg = 'The target:'
169    if target_msg not in error:
170      target_msg = 'It is not in any dependency of'
171    if target_msg not in error:
172      print('\n'.join(error))
173      continue
174    index = error.index(target_msg) + 1
175    path, target = error[index].strip().split(':')
176    if error[index + 1] in ('is including a file from the target:',
177                            'The include file is in the target(s):'):
178      dep = error[index + 2].strip()
179      dep_path, dep = dep.split(':')
180      dep = Rebase(path, dep_path, dep)
181      # Replacing /target:target with /target
182      dep = re.sub(r'/(\w+):(\1)$', r'/\1', dep)
183      # Replacing target:target with target
184      dep = re.sub(r'^(\w+):(\1)$', r'\1', dep)
185      path = os.path.join(path[2:], 'BUILD.gn')
186      errors_by_file[path][target].add(dep)
187    elif error[index + 1] == 'has a source file:':
188      deleted_file = '"' + os.path.basename(error[index + 2].strip()) + '",'
189      deleted_sources.add(deleted_file)
190    else:
191      print('\n'.join(error))
192      continue
193
194  for path, missing_deps in list(errors_by_file.items()):
195    FixErrors(path, missing_deps, deleted_sources)
196
197  return 0
198
199
200if __name__ == '__main__':
201  sys.exit(main())
202