Added separate checkout and config file generation to bisect script

tools/bisect-perf-regression.py

 #!/usr/bin/env python
 # Copyright (c) 2013 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.
 
 """Performance Test Bisect Tool
 
 This script bisects a series of changelists using binary search. It starts at
 a bad revision where a performance metric has regressed, and asks for a last
 known-good revision. It will then binary search across this revision range by
@@ skipping 17 matching lines @@
 An example usage (using git hashes):
 
 ./tools/bisect-perf-regression.py -c\
 "out/Release/performance_ui_tests --gtest_filter=ShutdownTest.SimpleUserQuit"\
 -g 1f6e67861535121c5c819c16a666f2436c207e7b\
 -b b732f23b4f81c382db0b23b9035f3dadc7d925bb\
 -m shutdown/simple-user-quit
 
 """
 
-
+import errno
+import imp
+import optparse
+import os
 import re
-import os
-import imp
+import shlex
+import subprocess
 import sys
-import shlex
-import optparse
-import subprocess
 
 
 # The additional repositories that might need to be bisected.
 # If the repository has any dependant repositories (such as skia/src needs
 # skia/include and skia/gyp to be updated), specify them in the 'depends'
 # so that they're synced appropriately.
 # Format is:
 # src: path to the working directory.
 # recurse: True if this repositry will get bisected.
 # depends: A list of other repositories that are actually part of the same
@@ skipping 26 matching lines @@
                       "recurse" : False,
                       "svn" : "http://skia.googlecode.com/svn/trunk/gyp",
                       "depends" : None
                     }
                   }
 
 DEPOT_NAMES = DEPOT_DEPS_NAME.keys()
 
 FILE_DEPS_GIT = '.DEPS.git'
 
+GCLIENT_SPEC = """
+solutions = [
+  { "name"        : "src",
+    "url"         : "https://chromium.googlesource.com/chromium/src.git",
+    "deps_file"   : ".DEPS.git",
+    "managed"     : True,
+    "custom_deps" : {
+    },
+    "safesync_url": "",
+  },
+  { "name"        : "src-internal",
+    "url"         : "ssh://gerrit-int.chromium.org:29419/" +
+                    "chrome/src-internal.git",
+    "deps_file"   : ".DEPS.git",
+  },
+]
+"""
+GCLIENT_SPEC = ''.join([l for l in GCLIENT_SPEC.splitlines()])
+
 
 
 def IsStringFloat(string_to_check):
   """Checks whether or not the given string can be converted to a floating
   point number.
 
   Args:
     string_to_check: Input string to check if it can be converted to a float.
 
   Returns:
@@ skipping 26 matching lines @@
 
 def OutputAnnotationStepStart(name):
   """Outputs appropriate annotation to signal the start of a step to
   a trybot.
 
   Args:
     name: The name of the step.
   """
   print '@@@SEED_STEP %s@@@' % name
   print '@@@STEP_CURSOR %s@@@' % name
   print '@@@STEP_STARTED@@@'

[Mike Stip (use stip instead), 2013/02/21 02:15:32]

check if this shows up OK on the waterfall. if it's all blank steps, then you'll
need to add a STEP_TEXT with the step name here.

[shatch, 2013/02/21 16:58:08]

Seems to show up ok on my local buildbot.

 
 
 def OutputAnnotationStepClosed():
   """Outputs appropriate annotation to signal the closing of a step to
   a trybot."""
   print '@@@STEP_CLOSED@@@'
 
 
 def RunProcess(command):
   """Run an arbitrary command, returning its output and return code.
@@ skipping 978 matching lines @@
   """
 
   (output, return_code) = RunGit(['rev-parse', '--is-inside-work-tree'])
 
   if output.strip() == 'true':
     return GitSourceControl()
 
   return None
 
 
+def CreateAndChangeToSourceDirectory(working_directory):
+  """Creates a directory 'bisect' as a subdirectory of 'working_directory'.  If
+  the function is successful, the current working directory will change to that
+  of the new 'bisect' directory.
+
+  Returns:
+    True if the directory was successfully created (or already existed).
+  """
+  cwd = os.getcwd()
+  os.chdir(working_directory)
+  try:
+    os.mkdir('bisect')
+  except OSError, e:
+    if e.errno != errno.EEXIST:
+      return False
+  os.chdir('bisect')
+  return True
+
+
+def RunGClient(params):
+  """Runs gclient with the specified parameters.
+
+  Args:
+    params: A list of parameters to pass to gclient.
+
+  Returns:
+    The return code of the call.
+  """
+  cmd = ['gclient'] + params
+  return subprocess.call(cmd)
+
+
+def RunGClientAndCreateConfig():
+  """Runs gclient and creates a config containing both src and src-internal.
+
+  Returns:
+    The return code of the call.
+  """
+  return_code = RunGClient(
+      ['config', '--spec=%s' % GCLIENT_SPEC, '--git-deps'])
+  return return_code
+
+
+def RunGClientAndSync():
+  """Runs gclient and does a normal sync.
+
+  Returns:
+    The return code of the call.
+  """
+  return RunGClient(['sync'])
+
+
+def SetupGitDepot(output_buildbot_annotations):
+  """Sets up the depot for the bisection. The depot will be located in a
+  subdirectory called 'bisect'.
+
+  Returns:
+    True if gclient successfully created the config file and did a sync, False
+    otherwise.
+  """
+  name = 'Setting up Bisection Depot'
+
+  if output_buildbot_annotations:

[Mike Stip (use stip instead), 2013/02/21 02:15:32]

probably want to use OutputAnnotationStepStart() here

[shatch, 2013/02/21 16:58:08]

Done.

+    print '@@@SEED_STEP %s@@@' % name
+    print '@@@STEP_CURSOR %s@@@' % name
+    print '@@@STEP_STARTED@@@'
+
+  passed = False
+
+  if not RunGClientAndCreateConfig():
+    if not RunGClientAndSync():
+      passed = True
+
+  if output_buildbot_annotations:
+    print

[Mike Stip (use stip instead), 2013/02/21 02:15:32]

OutputAnnotationStepClosed()

[shatch, 2013/02/21 16:58:08]

Done.

+    print '@@@STEP_CLOSED@@@'
+
+  return passed
+
+
 def main():
 
   usage = ('%prog [options] [-- chromium-options]\n'
            'Perform binary search on revision history to find a minimal '
            'range of revisions where a peformance metric regressed.\n')
 
   parser = optparse.OptionParser(usage=usage)
 
   parser.add_option('-c', '--command',
                     type='str',
                     help='A command to execute your performance test at' +
                     ' each point in the bisection.')
   parser.add_option('-b', '--bad_revision',
                     type='str',
                     help='A bad revision to start bisection. ' +
                     'Must be later than good revision. May be either a git' +
                     ' or svn revision.')
   parser.add_option('-g', '--good_revision',
                     type='str',
                     help='A revision to start bisection where performance' +
                     ' test is known to pass. Must be earlier than the ' +
                     'bad revision. May be either a git or svn revision.')
   parser.add_option('-m', '--metric',
                     type='str',
                     help='The desired metric to bisect on. For example ' +
                     '"vm_rss_final_b/vm_rss_f_b"')
+  parser.add_option('-w', '--working_directory',
+                    type='str',
+                    help='Path to the working directory where the script will '
+                    'do an initial checkout of the chromium depot. The '
+                    'files will be placed in a subdirectory "bisect" under '
+                    'working_directory and that will be used to perform the '
+                    'bisection. This parameter is optional, if it is not '
+                    'supplied, the script will work from the current depot.')
   parser.add_option('--use_goma',
                     action="store_true",
                     help='Add a bunch of extra threads for goma.')
   parser.add_option('--output_buildbot_annotations',
                     action="store_true",
                     help='Add extra annotation output for buildbot.')
   parser.add_option('--debug_ignore_build',
                     action="store_true",
                     help='DEBUG: Don\'t perform builds.')
   parser.add_option('--debug_ignore_sync',
@@ skipping 27 matching lines @@
     print
     parser.print_help()
     return 1
 
   # Haven't tested the script out on any other platforms yet.
   if not os.name in ['posix']:
     print "Sorry, this platform isn't supported yet."
     print
     return 1
 
+  metric_values = opts.metric.split('/')
+  if len(metric_values) != 2:
+    print "Invalid metric specified: [%s]" % (opts.metric,)
+    print
+    return 1
+
+  if opts.working_directory:
+    if not CreateAndChangeToSourceDirectory(opts.working_directory):
+      print 'Error: Could not create bisect directory.'
+      print
+      return 1
+
+    if not SetupGitDepot(opts.output_buildbot_annotations):
+      print 'Error: Failed to grab source.'
+      print
+      return 1
+
+    os.chdir(os.path.join(os.getcwd(), 'src'))
 
   # Check what source control method they're using. Only support git workflow
   # at the moment.
   source_control = DetermineAndCreateSourceControl()
 
   if not source_control:
     print "Sorry, only the git workflow is supported at the moment."
     print
     return 1
 
   # gClient sync seems to fail if you're not in master branch.
   if not source_control.IsInProperBranch() and not opts.debug_ignore_sync:
     print "You must switch to master branch to run bisection."
     print
     return 1
 
-  metric_values = opts.metric.split('/')
-  if len(metric_values) < 2:
-    print "Invalid metric specified: [%s]" % (opts.metric,)
-    print
-    return 1
-
-
   bisect_test = BisectPerformanceMetrics(source_control, opts)
   bisect_results = bisect_test.Run(opts.command,
                                    opts.bad_revision,
                                    opts.good_revision,
                                    metric_values)
 
   if not(bisect_results['error']):
     bisect_test.FormatAndPrintResults(bisect_results)
     return 0
   else:
     print 'Error: ' + bisect_results['error']
     print
     return 1
 
 if __name__ == '__main__':
   sys.exit(main())