First cut of testing infrastructure for recipes.

scripts/slave/annotated_checkout.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.
 
 """Helper script for fully-annotated builds. Performs checkouts of various
 kinds.
 
 This script is part of the effort to move all builds to annotator-based systems.
 Any builder configured to use the AnnotatorFactory uses run.py as its entry
 point. If that builder's factory_properties include a spec for a checkout, then
 the work of actually performing that checkout is done here.
 """
 
+import cStringIO as StringIO
 import optparse
 import os
+import pipes
 import subprocess
 import sys
-import pipes
 
 from common import annotator
 from common import chromium_utils
 
 
 SCRIPT_PATH = os.path.dirname(os.path.abspath(__file__))
 
 
 def get_args():
   """Process command-line arguments."""
@@ skipping 38 matching lines @@
   Attributes:
     CHECKOUT_TYPE: String identifier used when selecting the type of checkout to
         perform. All subclasses must specify a unique CHECKOUT_TYPE value.
   """
   __metaclass__ = _CheckoutMetaclass
   CHECKOUT_TYPE = None
 
   def __init__(self, spec):
     self.spec = spec
 
+  def setup(self):
+    pass
+
   def clean(self):
     pass
 
   def checkout(self):
     pass
 
   def root(self):
     pass
 
 
 def CheckoutFactory(type_name, spec):
   """Factory to build Checkout class instances."""
   class_ = _CheckoutMetaclass.checkout_registry.get(type_name)
   if not class_ or not issubclass(class_, Checkout):
     raise KeyError('unrecognized checkout type: %s' % type_name)
   return class_(spec)
 
 
 class GclientCheckout(Checkout):
   CHECKOUT_TYPE = 'gclient'
 
   gclient_path = os.path.abspath(
     os.path.join(SCRIPT_PATH, '..', '..', '..', 'depot_tools', 'gclient'))
   if sys.platform.startswith('win'):
     gclient_path += '.bat'
 
   def __init__(self, *args, **kwargs):
     super(GclientCheckout, self).__init__(*args, **kwargs)
     assert 'solutions' in self.spec
+
+  @classmethod
+  def run_gclient(cls, *cmd):
+    print 'Running: gclient %s' % ' '.join(pipes.quote(x) for x in cmd)
+    subprocess.check_call((cls.gclient_path,)+cmd)
+
+  def setup(self):
     spec_string = ''
     for key in self.spec:
       # We should be using json.dumps here, but gclient directly execs the dict
       # that it receives as the argument to --spec, so we have to have True,
       # False, and None instead of JSON's true, false, and null.
       spec_string += '%s = %s\n' % (key, str(self.spec[key]))
     self.run_gclient('config', '--spec', spec_string)
 
-  @classmethod
-  def run_gclient(cls, *cmd):
-    print 'Running: gclient %s' % ' '.join(pipes.quote(x) for x in cmd)
-    subprocess.check_call((cls.gclient_path,)+cmd)
-
   def clean(self):
     self.run_gclient('revert', '--nohooks')
 
   def checkout(self):
     self.run_gclient('sync', '--nohooks')
 
   def root(self):
     return os.path.abspath(self.spec['solutions'][0]['name'])
 
 
@@ skipping 35 matching lines @@
     assert os.pardir not in self.spec.get('directory', '')
 
     dir_path = self.spec.get('directory')
     if not dir_path:
       dir_path = self.spec['url'].rsplit('/', 1)[-1]
       if dir_path.endswith('.git'):  # ex: https://host/foobar.git
         dir_path = dir_path[:-len('.git')]
       if not dir_path:  # ex: ssh://host:repo/foobar/.git
         dir_path = dir_path.rsplit('/', 1)[-1]
     self.cwd = os.path.abspath(os.path.join(os.curdir, dir_path))
+
+  def setup(self):
     if not os.path.exists(self.cwd):
       os.makedirs(self.cwd)
 
     try:
       self.run_git('branch')
       exists = True
     except subprocess.CalledProcessError:
       exists = False
     if exists:
       self.run_git('remote', 'rm', 'origin')
@@ skipping 21 matching lines @@
     self.run_git('submodule', 'update', '--init', '--recursive')
 
   def root(self):
     return self.cwd
 
 
 class SvnCheckout(Checkout):
   CHECKOUT_TYPE = 'svn'
 
 
-def run(checkout_type, checkout_spec):
+def run(checkout_type, checkout_spec, test_mode=False):
   """Perform a checkout with the given type and configuration.
 
     Args:
       checkout_type: Type of checkout to perform (matching a Checkout subclass
           CHECKOUT_TYPE attribute).
       checkout_spec: Configuration values needed for the type of checkout
           (repository url, etc.).
+      test_mode: If we're in test_mode, just return error code and root without
+          actually doing anything.
 
     Returns:
       Tuple of (<retcode>, <root_path>) where root_path is the absolute path
           to the 'root' of the checkout (as defined by |checkout_type|).
   """
+  stream = sys.stdout
+  if test_mode:
+    stream = StringIO.StringIO()

[Isaac (away), 2013/05/12 09:24:56]

Would open(os.devnull, 'w') work?

[iannucci, 2013/05/14 04:31:35]

Actually yes, that would work. For some reason I forgot that os.devnull is 'nul'
on windows. There's another instance of this in the other script, too.

   stream = annotator.StructuredAnnotationStream(
-      seed_steps=['checkout_setup', 'checkout_clean', 'checkout'])
+      seed_steps=['checkout_setup', 'checkout_clean', 'checkout'],
+      stream=stream)
+
   with stream.step('checkout_setup') as s:
     try:
       checkout = CheckoutFactory(checkout_type, checkout_spec)
     except KeyError as e:
       s.step_text(e)
       s.step_failure()
       return (1, None)
+    if test_mode:
+      return (0, checkout.root())
+    checkout.setup()
   with stream.step('checkout_clean') as s:
     checkout.clean()
   with stream.step('checkout') as s:
     checkout.checkout()
   return (0, checkout.root())
 
 
 def main():
   opts, _ = get_args()
   return run(opts.type, opts.spec)[0]
 
 
 if __name__ == '__main__':
   sys.exit(main())