rebaseline.py : add self-tests

tools/rebaseline.py

 #!/usr/bin/python
 
 '''
 Copyright 2012 Google Inc.
 
 Use of this source code is governed by a BSD-style license that can be
 found in the LICENSE file.
 '''
 
 '''
 Rebaselines the given GM tests, on all bots and all configurations.
 Must be run from the gm-expected directory.  If run from a git or SVN
 checkout, the files will be added to the staging area for commit.
 '''
 
 import argparse
 import os
 import subprocess
 import sys
-import tempfile
 
 # Mapping of gm-expectations subdir (under
 # https://skia.googlecode.com/svn/gm-expected/ )
 # to builder name (see list at http://108.170.217.252:10117/builders )
 SUBDIR_MAPPING = {
    'base-shuttle-win7-intel-float':
     'Test-Win7-ShuttleA-HD2000-x86-Release',
    'base-shuttle-win7-intel-angle':
     'Test-Win7-ShuttleA-HD2000-x86-Release-ANGLE',
    'base-shuttle-win7-intel-directwrite':
@@ skipping 10 matching lines @@
     'Test-Android-Nexus7-Tegra3-Arm7-Release',
    'base-android-nexus-s':
     'Test-Android-NexusS-SGX540-Arm7-Release',
    'base-android-xoom':
     'Test-Android-Xoom-Tegra2-Arm7-Release',
    'base-android-nexus-10':
     'Test-Android-Nexus10-MaliT604-Arm7-Release',
 }
 
 
+class CommandFailedException(Exception):
+    pass
+
 class Rebaseliner(object):
 
     # params:
     #  tests: list of tests to rebaseline
     #  configs: which configs to run for each test
     #  subdirs: which platform subdirectories to rebaseline; if an empty list,
     #           rebaseline all platform subdirectories
     #  dry_run: if True, instead of actually downloading files or adding
     #           files to checkout, display a list of operations that
     #           we would normally perform
     def __init__(self, tests, configs=[], subdirs=[], dry_run=False):
         if not tests:
             raise Exception('at least one test must be specified')
         self._tests = tests
         self._configs = configs
         if not subdirs:
             self._subdirs = sorted(SUBDIR_MAPPING.keys())
         else:
             self._subdirs = subdirs
         self._dry_run = dry_run
         self._is_svn_checkout = (
             os.path.exists('.svn') or
             os.path.exists(os.path.join(os.pardir, '.svn')))
         self._is_git_checkout = (
             os.path.exists('.git') or
             os.path.exists(os.path.join(os.pardir, '.git')))
 
-    # Execute subprocess.call(), unless dry_run is True
-    def _Call(self, cmd, stdout=None):
+    # If dry_run is False, execute subprocess.call(cmd).
+    # If dry_run is True, print the command we would have otherwise run.
+    # Raises a CommandFailedException if the command fails.
+    def _Call(self, cmd):
         if self._dry_run:
             print '%s' % ' '.join(cmd)
-            return 0
-        if stdout:
-            return subprocess.call(cmd, stdout=stdout)
-        else:
-            return subprocess.call(cmd)
+            return
+        if subprocess.call(cmd) != 0:
+            raise CommandFailedException('error running command: ' +
+                                         ' '.join(cmd))
+
+    # Download a single file, raising a CommandFailedException if it fails.
+    def _DownloadFile(self, source_url, dest_filename):
+        # Download into a temporary file and then rename it afterwards,
+        # so that we don't corrupt the existing file if it fails midway thru.
+        temp_filename = os.path.join(os.path.dirname(dest_filename),
+                                     '.temp-' + os.path.basename(dest_filename))
+
+        # TODO(epoger): Replace calls to "curl"/"mv" (which will only work on
+        # Unix) with a Python HTTP library (which should work cross-platform)
+        self._Call([ 'curl', '--fail', '--silent', source_url,
+                     '--output', temp_filename ])
+        self._Call([ 'mv', temp_filename, dest_filename ])
 
     # Rebaseline a single file.
     def _RebaselineOneFile(self, expectations_subdir, builder_name,
                            infilename, outfilename):
         url = ('http://skia-autogen.googlecode.com/svn/gm-actual/' +
                expectations_subdir + '/' + builder_name + '/' +
                expectations_subdir + '/' + infilename)
-        cmd = [ 'curl', '--fail', '--silent', url ]
-        temp = tempfile.NamedTemporaryFile()
-        ret = self._Call(cmd, stdout=temp)
-        if ret != 0:
+
+        # Try to download this file, but if that fails, keep going...
+        #
+        # This not treated as a fatal failure because not all
+        # platforms generate all configs (e.g., Android does not
+        # generate PDF).
+        #
+        # We could tweak the list of configs within this tool to
+        # reflect which combinations the bots actually generate, and
+        # then fail if any of those expected combinations are
+        # missing... but then this tool would become useless every
+        # time someone tweaked the configs on the bots without
+        # updating this script.
+        try:
+            self._DownloadFile(source_url=url, dest_filename=outfilename)
+        except CommandFailedException:
             print '# Couldn\'t fetch ' + url
             return
-        cmd = [ 'cp', temp.name, outfilename ]
-        self._Call(cmd);
+
+        # Add this file to version control (if it isn't already).
         if self._is_svn_checkout:
             cmd = [ 'svn', 'add', '--quiet', outfilename ]
             self._Call(cmd)
             cmd = [ 'svn', 'propset', '--quiet', 'svn:mime-type', 'image/png',
                     outfilename ];
             self._Call(cmd)
         elif self._is_git_checkout:
             cmd = [ 'git', 'add', outfilename ]
             self._Call(cmd)
 
@@ skipping 51 matching lines @@
                     help='which platform subdirectories to rebaseline; ' +
                     'if unspecified, rebaseline all subdirs, same as ' +
                     '"--subdirs %s"' % ' '.join(sorted(SUBDIR_MAPPING.keys())))
 parser.add_argument('--tests', metavar='TEST', nargs='+', required=True,
                     help='which tests to rebaseline, e.g. ' +
                     '"--tests aaclip bigmatrix"')
 args = parser.parse_args()
 rebaseliner = Rebaseliner(tests=args.tests, configs=args.configs,
                           subdirs=args.subdirs, dry_run=args.dry_run)
 rebaseliner.RebaselineAll()