blob: b80ab9fb2954d1a31b5c0907afe8827f0c7889c0 [file] [log] [blame]
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.
# System-level imports
import argparse
import os
import re
import subprocess
import sys
import urllib2
# Imports from within Skia
# We need to add the 'gm' directory, so that we can import within
# that directory. That script allows us to parse the actual-results.json file
# written out by the GM tool.
# Make sure that the 'gm' dir is in the PYTHONPATH, but add it at the *end*
# so any dirs that are already in the PYTHONPATH will be preferred.
# This assumes that the 'gm' directory has been checked out as a sibling of
# the 'tools' directory containing this script, which will be the case if
# 'trunk' was checked out as a single unit.
GM_DIRECTORY = os.path.realpath(
os.path.join(os.path.dirname(os.path.dirname(__file__)), 'gm'))
if GM_DIRECTORY not in sys.path:
import gm_json
# Mapping of expectations/gm subdir (under
# )
# to builder name (see list at )
class _InternalException(Exception):
# Object that handles exceptions, either raising them immediately or collecting
# them to display later on.
class ExceptionHandler(object):
# params:
# keep_going_on_failure: if False, report failures and quit right away;
# if True, collect failures until
# ReportAllFailures() is called
def __init__(self, keep_going_on_failure=False):
self._keep_going_on_failure = keep_going_on_failure
self._failures_encountered = []
self._exiting = False
# Exit the program with the given status value.
def _Exit(self, status=1):
self._exiting = True
# We have encountered an exception; either collect the info and keep going,
# or exit the program right away.
def RaiseExceptionOrContinue(self, e):
# If we are already quitting the program, propagate any exceptions
# so that the proper exit status will be communicated to the shell.
if self._exiting:
raise e
if self._keep_going_on_failure:
print >> sys.stderr, 'WARNING: swallowing exception %s' % e
print >> sys.stderr, e
print >> sys.stderr, (
'Halting at first exception; to keep going, re-run ' +
'with the --keep-going-on-failure option set.')
def ReportAllFailures(self):
if self._failures_encountered:
print >> sys.stderr, ('Encountered %d failures (see above).' %
# Object that rebaselines a JSON expectations file (not individual image files).
class JsonRebaseliner(object):
# params:
# expectations_root: root directory of all expectations JSON files
# expectations_input_filename: filename (under expectations_root) of JSON
# expectations file to read; typically
# "expected-results.json"
# expectations_output_filename: filename (under expectations_root) to
# which updated expectations should be
# written; typically the same as
# expectations_input_filename, to overwrite
# the old content
# actuals_base_url: base URL from which to read actual-result JSON files
# actuals_filename: filename (under actuals_base_url) from which to read a
# summary of results; typically "actual-results.json"
# exception_handler: reference to rebaseline.ExceptionHandler object
# tests: list of tests to rebaseline, or None if we should rebaseline
# whatever files the JSON results summary file tells us to
# configs: which configs to run for each test, or None if we should
# rebaseline whatever configs the JSON results summary file tells
# us to
# add_new: if True, add expectations for tests which don't have any yet
def __init__(self, expectations_root, expectations_input_filename,
expectations_output_filename, actuals_base_url,
actuals_filename, exception_handler,
tests=None, configs=None, add_new=False):
self._expectations_root = expectations_root
self._expectations_input_filename = expectations_input_filename
self._expectations_output_filename = expectations_output_filename
self._tests = tests
self._configs = configs
self._actuals_base_url = actuals_base_url
self._actuals_filename = actuals_filename
self._exception_handler = exception_handler
self._add_new = add_new
self._image_filename_re = re.compile(gm_json.IMAGE_FILENAME_PATTERN)
self._using_svn = os.path.isdir(os.path.join(expectations_root, '.svn'))
# Executes
# Raises an Exception if the command fails.
def _Call(self, cmd):
if != 0:
raise _InternalException('error running command: ' + ' '.join(cmd))
# Returns the full contents of filepath, as a single string.
# If filepath looks like a URL, try to read it that way instead of as
# a path on local storage.
# Raises _InternalException if there is a problem.
def _GetFileContents(self, filepath):
if filepath.startswith('http:') or filepath.startswith('https:'):
return urllib2.urlopen(filepath).read()
except urllib2.HTTPError as e:
raise _InternalException('unable to read URL %s: %s' % (
filepath, e))
return open(filepath, 'r').read()
# Returns a dictionary of actual results from actual-results.json file.
# The dictionary returned has this format:
# {
# u'imageblur_565.png': [u'bitmap-64bitMD5', 3359963596899141322],
# u'imageblur_8888.png': [u'bitmap-64bitMD5', 4217923806027861152],
# u'shadertext3_8888.png': [u'bitmap-64bitMD5', 3713708307125704716]
# }
# If the JSON actual result summary file cannot be loaded, logs a warning
# message and returns None.
# If the JSON actual result summary file can be loaded, but we have
# trouble parsing it, raises an Exception.
# params:
# json_url: URL pointing to a JSON actual result summary file
# sections: a list of section names to include in the results, e.g.
# if None, then include ALL sections.
def _GetActualResults(self, json_url, sections=None):
json_contents = self._GetFileContents(json_url)
except _InternalException:
print >> sys.stderr, (
'could not read json_url %s ; skipping this platform.' %
return None
json_dict = gm_json.LoadFromString(json_contents)
results_to_return = {}
actual_results = json_dict[gm_json.JSONKEY_ACTUALRESULTS]
if not sections:
sections = actual_results.keys()
for section in sections:
section_results = actual_results[section]
if section_results:
return results_to_return
# Rebaseline all tests/types we specified in the constructor,
# within this expectations/gm subdir.
# params:
# subdir : e.g. 'base-shuttle-win7-intel-float'
# builder : e.g. 'Test-Win7-ShuttleA-HD2000-x86-Release'
def RebaselineSubdir(self, subdir, builder):
# Read in the actual result summary, and extract all the tests whose
# results we need to update.
actuals_url = '/'.join([self._actuals_base_url,
subdir, builder, subdir,
# In most cases, we won't need to re-record results that are already
# succeeding, but including the SUCCEEDED results will allow us to
# re-record expectations if they somehow get out of sync.
if self._add_new:
results_to_update = self._GetActualResults(json_url=actuals_url,
# Read in current expectations.
expectations_input_filepath = os.path.join(
self._expectations_root, subdir, self._expectations_input_filename)
expectations_dict = gm_json.LoadFromFile(expectations_input_filepath)
expected_results = expectations_dict[gm_json.JSONKEY_EXPECTEDRESULTS]
# Update the expectations in memory, skipping any tests/configs that
# the caller asked to exclude.
skipped_images = []
if results_to_update:
for (image_name, image_results) in results_to_update.iteritems():
(test, config) = self._image_filename_re.match(image_name).groups()
if self._tests:
if test not in self._tests:
if self._configs:
if config not in self._configs:
if not expected_results.get(image_name):
expected_results[image_name] = {}
expected_results[image_name][gm_json.JSONKEY_EXPECTEDRESULTS_ALLOWEDDIGESTS] = \
# Write out updated expectations.
expectations_output_filepath = os.path.join(
self._expectations_root, subdir, self._expectations_output_filename)
gm_json.WriteToFile(expectations_dict, expectations_output_filepath)
# Mark the JSON file as plaintext, so text-style diffs can be applied.
# Fixes
if self._using_svn:
self._Call(['svn', 'propset', '--quiet', 'svn:mime-type',
'text/x-json', expectations_output_filepath])
# main...
parser = argparse.ArgumentParser()
help='base URL from which to read files containing JSON ' +
'summaries of actual GM results; defaults to %(default)s',
help='filename (within platform-specific subdirectories ' +
'of ACTUALS_BASE_URL) to read a summary of results from; ' +
'defaults to %(default)s',
# TODO(epoger): Add test that exercises --add-new argument.
parser.add_argument('--add-new', action='store_true',
help='in addition to the standard behavior of ' +
'updating expectations for failing tests, add ' +
'expectations for tests which don\'t have expectations ' +
# TODO(epoger): Add test that exercises --configs argument.
parser.add_argument('--configs', metavar='CONFIG', nargs='+',
help='which configurations to rebaseline, e.g. ' +
'"--configs 565 8888", as a filter over the full set of ' +
'results in ACTUALS_FILENAME; if unspecified, rebaseline ' +
'*all* configs that are available.')
help='filename (under EXPECTATIONS_ROOT) to read ' +
'current expectations from, and to write new ' +
'expectations into (unless a separate ' +
'EXPECTATIONS_FILENAME_OUTPUT has been specified); ' +
'defaults to %(default)s',
help='filename (under EXPECTATIONS_ROOT) to write ' +
'updated expectations into; by default, overwrites the ' +
help='root of expectations directory to update-- should ' +
'contain one or more base-* subdirectories. Defaults to ' +
default=os.path.join('expectations', 'gm'))
parser.add_argument('--keep-going-on-failure', action='store_true',
help='instead of halting at the first error encountered, ' +
'keep going and rebaseline as many tests as possible, ' +
'and then report the full set of errors at the end')
parser.add_argument('--subdirs', metavar='SUBDIR', nargs='+',
help='which platform subdirectories to rebaseline; ' +
'if unspecified, rebaseline all subdirs, same as ' +
'"--subdirs %s"' % ' '.join(sorted(SUBDIR_MAPPING.keys())))
# TODO(epoger): Add test that exercises --tests argument.
parser.add_argument('--tests', metavar='TEST', nargs='+',
help='which tests to rebaseline, e.g. ' +
'"--tests aaclip bigmatrix", as a filter over the full ' +
'set of results in ACTUALS_FILENAME; if unspecified, ' +
'rebaseline *all* tests that are available.')
args = parser.parse_args()
exception_handler = ExceptionHandler(
if args.subdirs:
subdirs = args.subdirs
missing_json_is_fatal = True
subdirs = sorted(SUBDIR_MAPPING.keys())
missing_json_is_fatal = False
for subdir in subdirs:
if not subdir in SUBDIR_MAPPING.keys():
raise Exception(('unrecognized platform subdir "%s"; ' +
'should be one of %s') % (
subdir, SUBDIR_MAPPING.keys()))
builder = SUBDIR_MAPPING[subdir]
# We instantiate different Rebaseliner objects depending
# on whether we are rebaselining an expected-results.json file, or
# individual image files. Different expectations/gm subdirectories may move
# from individual image files to JSON-format expectations at different
# times, so we need to make this determination per subdirectory.
# See
expectations_json_file = os.path.join(args.expectations_root, subdir,
if os.path.isfile(expectations_json_file):
rebaseliner = JsonRebaseliner(
expectations_output_filename=(args.expectations_filename_output or
tests=args.tests, configs=args.configs,
rebaseliner.RebaselineSubdir(subdir=subdir, builder=builder)
except BaseException as e:
'expectations_json_file %s not found' % expectations_json_file))