build/landmines.py

   1 #!/usr/bin/env python
   2 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
   3 # Use of this source code is governed by a BSD-style license that can be
   4 # found in the LICENSE file.
   5
   6 """
   7 This script runs every build as the first hook (See DEPS). If it detects that
   8 the build should be clobbered, it will remove the build directory.
   9
  10 A landmine is tripped when a builder checks out a different revision, and the
  11 diff between the new landmines and the old ones is non-null. At this point, the
  12 build is clobbered.
  13 """
  14
  15 import difflib
  16 import errno
  17 import gyp_environment
  18 import logging
  19 import optparse
  20 import os
  21 import shutil
  22 import sys
  23 import subprocess
  24 import time
  25
  26 import landmine_utils
  27
  28
  29 SRC_DIR = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
  30
  31
  32 def get_build_dir(build_tool, is_iphone=False):
  33   """
  34   Returns output directory absolute path dependent on build and targets.
  35   Examples:
  36     r'c:\b\build\slave\win\build\src\out'
  37     '/mnt/data/b/build/slave/linux/build/src/out'
  38     '/b/build/slave/ios_rel_device/build/src/xcodebuild'
  39
  40   Keep this function in sync with tools/build/scripts/slave/compile.py
  41   """
  42   ret = None
  43   if build_tool == 'xcode':
  44     ret = os.path.join(SRC_DIR, 'xcodebuild')
  45   elif build_tool in ['make', 'ninja', 'ninja-ios']:  # TODO: Remove ninja-ios.
  46     ret = os.path.join(SRC_DIR, os.environ.get('CHROMIUM_OUT_DIR', 'out'))
  47   elif build_tool in ['msvs', 'vs', 'ib']:
  48     ret = os.path.join(SRC_DIR, 'build')
  49   else:
  50     raise NotImplementedError('Unexpected GYP_GENERATORS (%s)' % build_tool)
  51   return os.path.abspath(ret)
  52
  53
  54 def clobber_if_necessary(new_landmines):
  55   """Does the work of setting, planting, and triggering landmines."""
  56   out_dir = get_build_dir(landmine_utils.builder())
  57   landmines_path = os.path.normpath(os.path.join(out_dir, '..', '.landmines'))
  58   try:
  59     os.makedirs(out_dir)
  60   except OSError as e:
  61     if e.errno == errno.EEXIST:
  62       pass
  63
  64   if os.path.exists(landmines_path):
  65     with open(landmines_path, 'r') as f:
  66       old_landmines = f.readlines()
  67     if old_landmines != new_landmines:
  68       old_date = time.ctime(os.stat(landmines_path).st_ctime)
  69       diff = difflib.unified_diff(old_landmines, new_landmines,
  70           fromfile='old_landmines', tofile='new_landmines',
  71           fromfiledate=old_date, tofiledate=time.ctime(), n=0)
  72       sys.stdout.write('Clobbering due to:\n')
  73       sys.stdout.writelines(diff)
  74
  75       # Clobber.
  76       shutil.rmtree(out_dir)
  77
  78   # Save current set of landmines for next time.
  79   with open(landmines_path, 'w') as f:
  80     f.writelines(new_landmines)
  81
  82
  83 def process_options():
  84   """Returns a list of landmine emitting scripts."""
  85   parser = optparse.OptionParser()
  86   parser.add_option(
  87       '-s', '--landmine-scripts', action='append',
  88       default=[os.path.join(SRC_DIR, 'build', 'get_landmines.py')],
  89       help='Path to the script which emits landmines to stdout. The target '
  90            'is passed to this script via option -t. Note that an extra '
  91            'script can be specified via an env var EXTRA_LANDMINES_SCRIPT.')
  92   parser.add_option('-v', '--verbose', action='store_true',
  93       default=('LANDMINES_VERBOSE' in os.environ),
  94       help=('Emit some extra debugging information (default off). This option '
  95           'is also enabled by the presence of a LANDMINES_VERBOSE environment '
  96           'variable.'))
  97
  98   options, args = parser.parse_args()
  99
 100   if args:
 101     parser.error('Unknown arguments %s' % args)
 102
 103   logging.basicConfig(
 104       level=logging.DEBUG if options.verbose else logging.ERROR)
 105
 106   extra_script = os.environ.get('EXTRA_LANDMINES_SCRIPT')
 107   if extra_script:
 108     return options.landmine_scripts + [extra_script]
 109   else:
 110     return options.landmine_scripts
 111
 112
 113 def main():
 114   landmine_scripts = process_options()
 115
 116   if landmine_utils.builder() in ('dump_dependency_json', 'eclipse'):
 117     return 0
 118
 119   gyp_environment.SetEnvironment()
 120
 121   landmines = []
 122   for s in landmine_scripts:
 123     proc = subprocess.Popen([sys.executable, s], stdout=subprocess.PIPE)
 124     output, _ = proc.communicate()
 125     landmines.extend([('%s\n' % l.strip()) for l in output.splitlines()])
 126   clobber_if_necessary(landmines)
 127
 128   return 0
 129
 130
 131 if __name__ == '__main__':
 132   sys.exit(main())