Add telemetry_bootstrap module

tools/telemetry/tools/telemetry_bootstrap.py

Index: tools/telemetry/tools/telemetry_bootstrap.py
===================================================================
--- tools/telemetry/tools/telemetry_bootstrap.py	(revision 0)
+++ tools/telemetry/tools/telemetry_bootstrap.py	(revision 0)
@@ -0,0 +1,120 @@
+# 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.
+
+"""Bootstrap Chrome Telemetry by downloading all its files from SVN servers.
+
+Requires a DEPS file to specify which directories on which SVN servers
+are required to run Telemetry. Format of that DEPS file is a subset of the
+normal DEPS file format[1]; currently only only the "deps" dictionary is
+supported and nothing else.
+
+DEPS can be specified with --deps or defaults to ./DEPS

[nduca, 2013/01/09 11:19:57]

no longer required, given removal of main()

[wiltzius, 2013/01/10 00:56:33]

Done.

+
+Fetches all files in the specified directories using WebDAV (SVN is WebDAV under
+the hood).
+
+[1] http://dev.chromium.org/developers/how-tos/depottools#TOC-DEPS-file
+"""
+
+import imp
+import logging
+import os
+import urllib
+import urlparse
+
+# Link to file containing the 'davclient' WebDAV client library.
+# TODO(wiltzius): Change this to point at Chromium SVN server after checkin.
+_DAVCLIENT_URL = 'http://svn.osafoundation.org/tools/davclient/trunk/src/davclient/davclient.py'
+
+def _download_and_import_davclient_module():
+  """Dynamically import davclient helper library."""
+  global davclient
+  davclient_src = urllib.urlopen(_DAVCLIENT_URL).read()
+  davclient = imp.new_module('davclient')
+  exec davclient_src in davclient.__dict__
+
+
+class DAVClientWrapper():
+  """Knows how to retrieve subdirectories and files from WebDAV/SVN servers."""
+
+  def __init__(self, root_url):
+    """Initialize SVN server root_url, save files to local dest_dir.
+
+    Args:
+      root_url: string url of SVN/WebDAV server
+    """
+    self.root_url = root_url
+    self.client = davclient.DAVClient(root_url)
+
+  def GetSubdirs(self, path):
+    """Returns string names of all subdirs of this path on the SVN server."""
+    props = self.client.propfind(path, depth=1)
+    return map(os.path.basename, props.keys())
+
+  def IsFile(self, path):
+    """Returns True if the path is a file on the server, False if directory."""
+    props = self.client.propfind(path, depth=1)
+    # Build up normalized path list since paths to directories may or may not
+    # have trailing slashes.
+    norm_keys = {}
+    for entry in props.keys():
+      norm_keys[os.path.normpath(entry)] = entry
+    return props[norm_keys[os.path.normpath(path)]]['resourcetype'] is None
+
+  def Traverse(self, src_path, dst_path):
+    """Walks the directory hierarchy pointed to by src_path download all files.
+
+    Recursively walks src_path and saves all files and subfolders into
+    dst_path.
+
+    Args:
+      src_path: string path on SVN server to save (absolute path on server).
+      dest_path: string local path (relative or absolute) to save to.
+    """
+    if self.IsFile(src_path):
+      if not os.path.exists(os.path.dirname(dst_path)):
+        logging.info("creating %s", os.path.dirname(dst_path))
+        os.makedirs(os.path.dirname(dst_path))
+      logging.info("Saving %s to %s", self.root_url + src_path, dst_path)
+      urllib.urlretrieve(self.root_url + src_path, dst_path)
+      return
+    else:
+      for subdir in self.GetSubdirs(src_path):
+        if subdir:
+          self.Traverse(os.path.join(src_path, subdir),
+                        os.path.join(dst_path, subdir))
+
+
+def DownloadDEPS(deps_path='DEPS',
+                 destination_dir=os.path.join(os.getcwd(),'telemetry')):

[nduca, 2013/01/09 11:19:57]

just require it to be provided.

[also, probably better to make the folder not-relative to cwd --- e.g. if i run
./tools/perf/run_multipage_benchmarks, you'd not get the same result as cd
tools/perf; ./run_mbpr. a solution for this is using os.path.dirname(__FILE__)
which gives you the dirname of the current file, e.g. the location of *this*
file --- but you'd want to do this in the run_multipage_benchmark script rather
than here. Anyhooo --- for now, make the arguments mandatory.

[wiltzius, 2013/01/10 00:56:33]

Done.

+  """Saves all the dependencies in deps_path.
+
+  Reads the file at deps_path, assuming this file in the standard gclient DEPS
+  format, and then download all files/directories listed in that DEPS file to
+  the destination_dir.
+
+  Args:
+    deps_path: String path to DEPS file. Defaults to ./DEPS.
+    destination_dir: String path to directory to download files into. Defaults
+      to ./telemetry.
+  """
+  # TODO(wiltzius): Add a parameter for which revision to pull.
+  logging.basicConfig(level=logging.INFO)

[nduca, 2013/01/09 11:19:57]

this shouldn't be here

[wiltzius, 2013/01/10 00:56:33]

Done.

+  # Dynamically import davclient library.

[nduca, 2013/01/09 11:19:57]

this comment isnt adding much value, i think

[wiltzius, 2013/01/10 00:56:33]

Done.

+  _download_and_import_davclient_module()
+  with open(deps_path) as deps_file:

[nduca, 2013/01/09 11:19:57]

space above this --- and the comment might be more like # LOAD deps file

[wiltzius, 2013/01/10 00:56:33]

Done.

+    deps_content = deps_file.read()
+  deps = imp.new_module('deps')

[nduca, 2013/01/09 11:19:57]

i think some whitespace between logical blocks may make this more readable

one above the deps= line

[wiltzius, 2013/01/10 00:56:33]

Done.

+  exec deps_content in deps.__dict__
+  for dst_path, src_path in deps.deps.iteritems():

[nduca, 2013/01/09 11:19:57]

newline above this line

[wiltzius, 2013/01/10 00:56:33]

Done.

+    full_dst_path = os.path.join(destination_dir, dst_path)
+    parsed_url = urlparse.urlparse(src_path)
+    root_url = parsed_url.scheme + '://' + parsed_url.netloc
+    dav_client = DAVClientWrapper(root_url)

[nduca, 2013/01/09 11:19:57]

newline above this line

[wiltzius, 2013/01/10 00:56:33]

Done.

+    dav_client.Traverse(parsed_url.path, full_dst_path)
+    # Recursively fetch any DEPS defined in a subdirectory we just fetched.

[nduca, 2013/01/09 11:19:57]

newline above this line

[wiltzius, 2013/01/10 00:56:33]

Done.

+    for dirpath, dirnames, filenames in os.walk(full_dst_path):
+      if 'DEPS' in filenames:
+        DownloadDEPS(os.path.join(dirpath, 'DEPS'), destination_dir)
+
Property changes on: tools/telemetry/tools/telemetry_bootstrap.py
___________________________________________________________________
Added: svn:executable
   + *