Testing and bugfixing for the new MB gyp/gn wrapper.

tools/mb/mb.py

 #!/usr/bin/env python
 # Copyright 2015 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """MB - the Meta-Build wrapper around GYP and GN
 
 MB is a wrapper script for GYP and GN that can be used to generate build files
 for sets of canned configurations and analyze them.
 """
 
 from __future__ import print_function
 
 import argparse
 import ast
 import json
 import os
 import pipes
 import shlex
 import shutil
 import sys
 import subprocess
 
 
 def main(args):
-  mb = MetaBuildWrapper()
-  mb.ParseArgs(args)
-  return mb.args.func()
+  mbw = MetaBuildWrapper()
+  mbw.ParseArgs(args)
+  return mbw.args.func()
 
 
 class MetaBuildWrapper(object):
   def __init__(self):
     p = os.path
     d = os.path.dirname
     self.chromium_src_dir = p.normpath(d(d(d(p.abspath(__file__)))))
     self.default_config = p.join(self.chromium_src_dir, 'tools', 'mb',
                                  'mb_config.pyl')
     self.args = argparse.Namespace()
@@ skipping 238 matching lines @@
     }
 
     visited = []
     self.FlattenMixins(mixins, vals, visited)
     return vals
 
   def FlattenMixins(self, mixins, vals, visited):
     for m in mixins:
       if m not in self.mixins:
         raise MBErr('Unknown mixin "%s"' % m)
-      if m in visited:
-        raise MBErr('Cycle in mixins for "%s": %s' % (m, visited))

[Dirk Pranke, 2015/04/08 21:37:31]

This logic didn't actually work right; it would err out if the config repeated a
mixin, even if it wasn't a true cycle. 

Arguably, repeated mixins should also be bad, but I'm still on the fence about
that.

+
+      # TODO: check for cycles in mixins.
 
       visited.append(m)
 
       mixin_vals = self.mixins[m]
       if 'type' in mixin_vals:
         vals['type'] = mixin_vals['type']
       if 'gn_args' in mixin_vals:
         if vals['gn_args']:
           vals['gn_args'] += ' ' + mixin_vals['gn_args']
         else:
@@ skipping 10 matching lines @@
     return vals
 
   def RunGNGen(self, path, vals):
     cmd = self.GNCmd(path, vals['gn_args'])
     ret, _, _ = self.Run(cmd)
     return ret
 
   def GNCmd(self, path, gn_args):
     # TODO(dpranke): Find gn explicitly in the path ...
     cmd = ['gn', 'gen', path]
-    gn_args = gn_args.replace("$(goma_dir)", gn_args)
+    gn_args = gn_args.replace("$(goma_dir)", self.args.goma_dir)
     if gn_args:
       cmd.append('--args=%s' % gn_args)
     return cmd
 
   def RunGYPGen(self, path, vals):
     output_dir, gyp_config = self.ParseGYPConfigPath(path)
     if gyp_config != vals['gyp_config']:
       raise MBErr('The last component of the path (%s) must match the '
                   'GYP configuration specified in the config (%s), and '
                   'it does not.' % (gyp_config, vals['gyp_config']))
     cmd = self.GYPCmd(output_dir, vals['gyp_defines'], config=gyp_config)
     ret, _, _ = self.Run(cmd)
     return ret
 
   def RunGYPAnalyze(self, vals):
     output_dir, gyp_config = self.ParseGYPConfigPath(self.args.path[0])
     if gyp_config != vals['gyp_config']:
       raise MBErr('The last component of the path (%s) must match the '
                   'GYP configuration specified in the config (%s), and '
                   'it does not.' % (gyp_config, vals['gyp_config']))
     cmd = self.GYPCmd(output_dir, vals['gyp_defines'], config=gyp_config)
     cmd.extend(['-G', 'config_path=%s' % self.args.input_path[0],
                 '-G', 'analyzer_output_path=%s' % self.args.output_path[0]])
     ret, _, _ = self.Run(cmd)
     return ret
 
-  def ParseGYPOutputPath(self, path):
+  def ToSrcRelPath(self, path):
+    """Returns a relative path from the top of the repo."""
+    # TODO: Support normal paths in addition to source-absolute paths.
     assert(path.startswith('//'))
     return path[2:]
 
   def ParseGYPConfigPath(self, path):
-    assert(path.startswith('//'))
-    output_dir, _, config = path[2:].rpartition('/')
+    rpath = self.ToSrcRelPath(path)
+    output_dir, _, config = rpath.rpartition('/')
     self.CheckGYPConfigIsSupported(config, path)
     return output_dir, config
 
   def CheckGYPConfigIsSupported(self, config, path):
     if config not in ('Debug', 'Release'):
       if (sys.platform in ('win32', 'cygwin') and
           config not in ('Debug_x64', 'Release_x64')):
         raise MBErr('Unknown or unsupported config type "%s" in "%s"' %
                     config, path)
 
@@ skipping 19 matching lines @@
     if any(f.endswith('.gn') or f.endswith('.gni') for f in inp['files']):
       self.WriteJSONOutput({'status': 'Found dependency (all)'})
       return 0
 
     # TODO: Break long lists of files that might exceed the max command line
     # up into chunks so that we can return more accurate info.
     if len(' '.join(inp['files'])) > 1024:
       self.WriteJSONOutput({'status': 'Found dependency (all)'})
       return 0
 
-    cmd = (['gn', 'refs', self.args.path[0]] + inp['files'] +
+    cmd = (['gn', 'refs', self.args.path[0] ] +
+           ['//' + f for f in inp['files']] +
            ['--type=executable', '--all', '--as=output'])
     needed_targets = []
     ret, out, _ = self.Run(cmd)
-
     if ret:
       self.WriteFailureAndRaise('gn refs returned %d: %s' % (ret, out))
 
-    rpath = os.path.relpath(self.args.path[0], self.chromium_src_dir) + os.sep
+    rpath = self.ToSrcRelPath(self.args.path[0]) + os.sep
     needed_targets = [t.replace(rpath, '') for t in out.splitlines()]
     needed_targets = [nt for nt in needed_targets if nt in inp['targets']]
 
-    for nt in needed_targets:
-      self.Print(nt)
-
     if needed_targets:
       # TODO: it could be that a target X might depend on a target Y
       # and both would be listed in the input, but we would only need
       # to specify target X as a build_target (whereas both X and Y are
       # targets). I'm not sure if that optimization is generally worth it.
       self.WriteJSON({'targets': needed_targets,
                       'build_targets': needed_targets,
                       'status': 'Found dependency'})
     else:
       self.WriteJSON({'targets': [],
@@ skipping 20 matching lines @@
     return inp
 
   def WriteFailureAndRaise(self, msg):
     self.WriteJSON({'error': msg})
     raise MBErr(msg)
 
   def WriteJSON(self, obj):
     output_path = self.args.output_path[0]
     if output_path:
       try:
-        self.WriteFile(output_path, json.dumps(obj))
+        self.WriteFile(output_path, json.dumps(obj, indent=2) + '\n')
       except Exception as e:
         raise MBErr('Error %s writing to the output path "%s"' %
                    (e, output_path))
 
   def PrintCmd(self, cmd):
     if cmd[0] == sys.executable:
       cmd = ['python'] + cmd[1:]
     self.Print(*[pipes.quote(c) for c in cmd])
 
   def Print(self, *args, **kwargs):
     # This function largely exists so it can be overridden for testing.
     print(*args, **kwargs)
 
   def Run(self, cmd):
     # This function largely exists so it can be overridden for testing.
     if self.args.dryrun or self.args.verbose:
       self.PrintCmd(cmd)
     if self.args.dryrun:
       return 0, '', ''
     ret, out, err = self.Call(cmd)
     if self.args.verbose:
       if out:
-        self.Print(out)
+        self.Print(out, end='')
       if err:
-        self.Print(err, file=sys.stderr)
+        self.Print(err, end='', file=sys.stderr)
     return ret, out, err
 
   def Call(self, cmd):
     p = subprocess.Popen(cmd, shell=False, cwd=self.chromium_src_dir,
                          stdout=subprocess.PIPE, stderr=subprocess.PIPE)
     out, err = p.communicate()
     return p.returncode, out, err
 
   def ExpandUser(self, path):
     # This function largely exists so it can be overridden for testing.
@@ skipping 19 matching lines @@
 
 if __name__ == '__main__':
   try:
     sys.exit(main(sys.argv[1:]))
   except MBErr as e:
     print(e)
     sys.exit(1)
   except KeyboardInterrupt:
     print("interrupted, exiting", stream=sys.stderr)
     sys.exit(130)