Automate Chrome Endure setup process.

chrome/test/functional/perf/endure_setup.py

+#!/usr/bin/env python
+# Copyright (c) 2012 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.
+
+"""Automate the setup process of Chrome Endure environment.
+
+Usage:
+  python endure_setup.py [option]
+
+We use <ENDURE_DIR> to refer to the root directory in which Chrome Endure
+is set up. By default, <ENDURE_DIR> is the current working directory.
+
+First, run "python endure_setup.py". This command will automatically setup
+Chrome Endure in <ENDURE_DIR>.
+
+Next, run your first endure test by:
+  TEST_LENGTH=30 LOCAL_GRAPH="<ENDURE_DIR>/chrome_graph" \\

[dennis_jeffrey, 2012/08/15 17:53:08]

should LOCAL_GRAPH be LOCAL_PERF_DIR?

[fdeng1, 2012/08/17 00:26:10]

Thanks for catching it.
Done.

+  python <ENDURE_DIR>/src/chrome/test/functional/perf_endure.py \\
+  perf_endure.ChromeEndureGmailTest.testGmailComposeDiscard \\
+The above commands runs a Chrome Endure test for 30 seconds and saves
+the results to <ENDURE_DIR>/chrome_graph.
+
+Last, to view the graphs, run another script endure_server.py
+within <ENDURE_DIR> to start a local HTTP server that serves
+the graph directory, see endure_server.py for details.
+
+Use python endure_setup.py --help for more options.
+
+This script depends on the following modules
+(which will be downloaded automatically):
+  depot_tools
+  src/chrome/test/pyautolib/fetch_prebuilt_pyauto.py
+"""
+
+import logging
+import optparse
+import os
+import platform
+import shutil
+import subprocess
+import sys
+import urllib
+import urllib2
+import zipfile
+
+
+class SetupError(Exception):
+  """Catch errors in setting up Chrome Endure."""
+  pass
+
+
+class HelpFormatter(optparse.IndentedHelpFormatter):
+  """Format the help message of this script."""
+
+  def format_description(self, description):

[dennis_jeffrey, 2012/08/15 17:53:08]

add a comment explaining why you're overriding this function

[fdeng1, 2012/08/17 00:26:10]

Done.

+    if description:
+      return description + '\n'
+    else:
+      return ''

[dennis_jeffrey, 2012/08/15 17:53:08]

similar comment as in the other file: i think this can be re-written as a single
line

[fdeng1, 2012/08/17 00:26:10]

Done.

+
+
+class CmdFetch(object):

[dennis_jeffrey, 2012/08/15 17:53:08]

this probably doesn't need to be a class.  There's no longer two separate
"commands" in this file since the server functionality got moved to another
file.

[fdeng1, 2012/08/17 00:26:10]

Done.

+  """Fetch Chrome Endure.
+
+  Usage:
+    python endure_setup.py [options]
+
+  Examples:
+    python endure_setup.py

[dennis_jeffrey, 2012/08/15 17:53:08]

similar comment as in the other file: add a > at the start of this line to make
it clear that this is something to type in at the command line

[fdeng1, 2012/08/17 00:26:10]

Done.

+      Fetch the latest version of Chrome Endure to the current
+      working directory.
+
+    python endure_setup.py --endure-dir=/home/user/endure_dir

[dennis_jeffrey, 2012/08/15 17:53:08]

same comment as line 70 above

[fdeng1, 2012/08/17 00:26:10]

Done.

+      Fetch the latest version of Chrome Endure to /home/user/endure_dir.
+  """
+  _URLS = {'depot_tools': ('http://src.chromium.org'
+                           '/chrome/trunk/tools/depot_tools'),
+           'pyauto': ('https://src.chromium.org/'
+                      'chrome/trunk/src/chrome/test/functional.DEPS'),
+           'binary': ('http://commondatastorage.googleapis.com/'
+                      'chromium-browser-continuous/{os_type}/{revision}'),
+           # TODO(fdeng): change to an external address after graph code
+           # is checked in
+           'graph': ('http://www.corp.google.com/'
+                     '~dennisjeffrey/chrome_perf/local_graphs.zip'),

[dennis_jeffrey, 2012/08/15 17:53:08]

for now, let's remove this directory from the script so that the internal URL is
not checked in with this external file.

I recommend we do this: for now, add a new option to this script called
"graph_zip_url" which will be the URL to a zip file containing the chrome graphs
(along with it, add a TODO saying to remove it once the Chrome Endure graphing
code is checked in).  Then when we give this script to people to run, we'll
separately tell them the internal URL from which they can download the graphing
code, then they can specify that as a command-line option to this script.

As soon as the chrome endure graphing code is checked in, we'll simplify this
and the script will just check out the graphing code from the chrome tree along
with everything else it checks out.

[fdeng1, 2012/08/17 00:26:10]

Add an option --graph-zip-url.
If not specified, will log a message saying that "Skip fetching chrome graphs
since --graph-zip-url is not set"
On 2012/08/15 17:53:08, dennis_jeffrey wrote:

+          }
+
+  def _ParseArgs(self, argv):
+    parser = optparse.OptionParser(
+        formatter=HelpFormatter(),
+        description=self.__doc__)
+    parser.add_option(
+        '-d', '--endure-dir', type='string', default=os.getcwd(),
+        help='Directory in which to setup or update. ' \
+             'Default value is the current working directory.')
+    return parser.parse_args(argv)
+
+  def Run(self, argv):
+    """Run this command."""
+    options, _ = self._ParseArgs(argv)
+    self._endure_dir = os.path.abspath(options.endure_dir)
+    self._depot_dir = os.path.join(self._endure_dir, 'depot_tools')
+    self._os_type = self._GetCurrentOSType()
+    if self._os_type == 'Win':
+      self._gclient = os.path.join(self._depot_dir, 'gclient.bat')

[fdeng1, 2012/08/14 19:14:20]

I haven't got a chance to test this script on other platforms. Is there a way to
do it or do we assume it runs only on linux? 

[dennis_jeffrey, 2012/08/15 17:53:08]

Let's assume for now that it's only going to run on linux.  I haven't tried
running the endurance tests on Win or Mac yet.  It should work in theory, but in
practice there may be a few kinks to iron out to get it to work.  Let's just
focus on linux right now.

[fdeng1, 2012/08/17 00:26:10]

Ok, it now checks whether the system is Linux and I mention we only support
Linux in doc string.
Done.

+    else:
+      self._gclient = os.path.join(self._depot_dir, 'gclient')
+    self._fetch_py = os.path.join(self._endure_dir, 'src', 'chrome',
+                                  'test', 'pyautolib',
+                                  'fetch_prebuilt_pyauto.py')
+    self._binary_dir = os.path.join(self._endure_dir, 'src', 'out', 'Release')
+    self._graph_dir = os.path.join(self._endure_dir, 'chrome_graph')
+
+    if not os.path.isdir(self._endure_dir):
+      os.makedirs(self._endure_dir)
+
+    logging.info('Fetching depot tools...')
+    self._FetchDepot()
+    logging.info('Fetching PyAuto (python code)...')
+    self._FetchPyAuto()
+    logging.info('Fetching binaries(chrome, pyautolib, chrome driver)...')
+    self._FetchBinaries()
+    # TODO(fdeng): remove this after it is check into the chrome tree.
+    logging.info('Fetching chrome graphing files...')
+    self._FetchGraph()
+    return 0
+
+  def _FetchDepot(self):
+    """Fetch depot_tools."""
+    if self._CheckDepot():
+      return
+    else:

[dennis_jeffrey, 2012/08/15 17:53:08]

maybe we can just remove the above 3 lines and always check out the depot tools.
 Even if the depot tools are already checked out, then checking them out again
shouldn't hurt.  In fact, if the depot tools are updated since the last time we
ran this setup script, then checking the files out again will give us the latest
version, which is probably a good thing.

[fdeng1, 2012/08/17 00:26:10]

Done.

+      subprocess.call(['svn', 'co', self._URLS['depot_tools'],
+                       self._depot_dir])
+    if not self._CheckDepot():
+      raise SetupError('Could not get depot_tools.')
+
+  def _CheckDepot(self):
+    """Check that some known depot_tools files exist.
+
+    Returns:
+      True if check passes otherwise False.
+    """
+    gclient_py = os.path.join(self._depot_dir, 'gclient.py')
+    files = [self._gclient, gclient_py]
+    for f in files:
+      if not os.path.exists(f):
+        return False
+    try:
+      subprocess.call([self._gclient, '--version'])
+    except OSError:
+      return False
+    return True
+
+  def _FetchPyAuto(self):
+    """Use gclient to fetch python code."""
+    cur_dir = os.getcwd()
+    os.chdir(self._endure_dir)
+    # gclient config
+    config_cmd = [self._gclient, 'config', self._URLS['pyauto']]
+    code = subprocess.call(config_cmd)
+    if code != 0:

[dennis_jeffrey, 2012/08/15 17:53:08]

can just get rid of the "code" variable:

if subprocess.call(config_cmd) != 0:

[fdeng1, 2012/08/17 00:26:10]

Done.

+      raise SetupError('Running "%s" failed.' % ' '.join(config_cmd))
+    # gclient sync
+    sync_cmd = [self._gclient, 'sync']
+    code = subprocess.call(sync_cmd)
+    if code != 0:

[dennis_jeffrey, 2012/08/15 17:53:08]

same comment as line 163 above

[fdeng1, 2012/08/17 00:26:10]

Done.

+      raise SetupError('Running "%s" failed.' % ' '.join(sync_cmd))
+    self._CheckPyAuto()
+    logging.info('Sync PyAuto python code done.')
+    os.chdir(cur_dir)
+
+  def _CheckPyAuto(self):
+    pyauto_py = os.path.join(self._endure_dir, 'src',
+                             'chrome', 'test',
+                             'pyautolib', 'pyauto.py')
+    files = [self._fetch_py, pyauto_py]
+    for f in files:
+      if not os.path.exists(f):
+        raise SetupError('Checking %s failed.' % f)
+
+  def _FetchBinaries(self):
+    """Get the prebuilt binaries from continuous build archive."""
+    revision = self._GetLatestRevision(self._os_type)
+    logging.info('Cleaning %s', self._binary_dir)
+    if os.path.exists(self._binary_dir):
+      shutil.rmtree(self._binary_dir)
+    logging.info('Downloading binaries...')
+    cmd = [self._fetch_py, '-d', self._binary_dir,
+           self._URLS['binary'].format(
+               os_type=self._os_type, revision=revision)]
+    code = subprocess.call(cmd)
+    if code == 0:

[dennis_jeffrey, 2012/08/15 17:53:08]

same comment as line 163 above

[fdeng1, 2012/08/17 00:26:10]

Done.

+      logging.info('Binaries at revision %s', revision)
+    else:
+      raise SetupError('Running "%s" failed.' % ' '.join(cmd))
+
+  def _FetchGraph(self):
+    """Fetch graph code."""
+    graph_zip = urllib.urlretrieve(self._URLS['graph'])[0]
+    if graph_zip is None or not os.path.exists(graph_zip):
+      raise SetupError('Unable to retrieve %s' % self._URLS['graph'])
+    if not os.path.exists(self._graph_dir):
+      os.mkdir(self._graph_dir)
+    self._UnzipFilenameToDir(graph_zip, self._graph_dir)
+    logging.info('Graph code is downloaded to %s', self._graph_dir)
+
+  def _GetCurrentOSType(self):
+    """Get a string representation for the current os.

[dennis_jeffrey, 2012/08/15 17:53:08]

nit: os --> OS

[fdeng1, 2012/08/17 00:26:10]

Done.

+
+    Returns:
+      'Mac', 'Win', 'Linux', or 'Linux_64'
+    Raises:

[dennis_jeffrey, 2012/08/15 17:53:08]

add a blank line right above this

[fdeng1, 2012/08/17 00:26:10]

Done.

+      RuntimeError: if os can't be identified.

[dennis_jeffrey, 2012/08/15 17:53:08]

nit: os --> OS

[fdeng1, 2012/08/17 00:26:10]

Done.

+    """
+    if sys.platform == 'darwin':
+      os_type = 'Mac'
+    if sys.platform == 'win32':
+      os_type = 'Win'
+    if sys.platform.startswith('linux'):
+      os_type = 'Linux'
+      if platform.architecture()[0] == '64bit':
+        os_type += '_x64'
+    else:
+      raise RuntimeError('Unknown platform')
+    return os_type
+
+  def _GetLatestRevision(self, os_type):
+    """Figure out the latest revision number of the prebuilt binary archive.
+
+    Args:
+      os_type: 'Mac', 'Win', 'Linux', or 'Linux_64'
+
+    Returns:
+      A string of latest revision number.
+
+    Raises:
+      SetupError: if unable to get the latest revision number.
+    """
+    last_change_url = ('http://commondatastorage.googleapis.com/'
+                       'chromium-browser-continuous/%s/LAST_CHANGE' % os_type)
+    response = urllib2.urlopen(last_change_url)
+    last_change = response.read()
+    if not last_change:
+      raise SetupError('Unable to get  the latest revision number from %s' %

[dennis_jeffrey, 2012/08/15 17:53:08]

remove one of the spaces in "get  the"

[fdeng1, 2012/08/17 00:26:10]

Done.

+                       last_change_url)
+    return last_change
+
+  @classmethod
+  def _UnzipFilenameToDir(cls, filename, directory):

[dennis_jeffrey, 2012/08/15 17:53:08]

This function will probably go away as soon as the Chrome Endure graphs are
checked in, because then the graph files can be directly checked out from the
chrome tree (no need to unzip anything).  We should add a TODO here saying to
remove this function as soon as the Chrome Endure graphing code is checked into
the chrome tree.

[fdeng1, 2012/08/17 00:26:10]

Done.

+    """Unzip |filename| to directory |directory|.
+
+    This works with as low as python2.4 (used on win).
+    (Code is adapted from fetch_prebuilt_pyauto.py)
+    """
+    zf = zipfile.ZipFile(filename)
+    pushd = os.getcwd()
+    if not os.path.isdir(directory):
+      os.mkdir(directory)
+    os.chdir(directory)
+    # Extract files.
+    for info in zf.infolist():
+      name = info.filename
+      if name.endswith('/'):  # dir
+        if not os.path.isdir(name):
+          os.makedirs(name)
+      else:  # file
+        directory = os.path.dirname(name)
+        if directory and not os.path.isdir(directory):
+          os.makedirs(directory)
+        out = open(name, 'wb')
+        out.write(zf.read(name))
+        out.close()
+      # Set permissions. Permission info in external_attr is shifted 16 bits.
+      os.chmod(name, info.external_attr >> 16L)
+    os.chdir(pushd)
+
+
+def Main(argv):
+  command = CmdFetch()
+  return command.Run(argv)
+
+
+if '__main__' == __name__:
+  logging.basicConfig(format='[%(levelname)s] %(message)s', level=logging.DEBUG)
+  sys.exit(Main(sys.argv[1:]))