src/third_party/skia/gm/gm_json.py

   1 #!/usr/bin/env python
   2 # Copyright (c) 2013 The Chromium Authors. All rights reserved.
   3 # Use of this source code is governed by a BSD-style license that can be
   4 # found in the LICENSE file.
   5
   6 """Schema of the JSON summary file written out by the GM tool.
   7
   8 This must be kept in sync with the kJsonKey_ constants in gm_expectations.cpp !
   9 """
  10
  11 __author__ = 'Elliot Poger'
  12
  13
  14 # system-level imports
  15 import io
  16 import json
  17 import os
  18 import posixpath
  19 import re
  20
  21
  22 # Key strings used in GM results JSON files (both expected-results.json and
  23 # actual-results.json).
  24 #
  25 # NOTE: These constants must be kept in sync with the kJsonKey_ constants in
  26 # gm_expectations.cpp and tools/PictureRenderer.cpp !
  27 # Eric suggests: create gm/gm_expectations_constants.h containing ONLY variable
  28 # declarations so as to be readable by both gm/gm_expectations.cpp and Python.
  29
  30
  31 JSONKEY_ACTUALRESULTS = 'actual-results'
  32
  33 # Tests whose results failed to match expectations.
  34 JSONKEY_ACTUALRESULTS_FAILED = 'failed'
  35
  36 # Tests whose results failed to match expectations, but IGNOREFAILURE causes
  37 # us to take them less seriously.
  38 JSONKEY_ACTUALRESULTS_FAILUREIGNORED = 'failure-ignored'
  39
  40 # Tests for which we do not have any expectations.  They may be new tests that
  41 # we haven't had a chance to check in expectations for yet, or we may have
  42 # consciously decided to leave them without expectations because we are unhappy
  43 # with the results (although we should try to move away from that, and instead
  44 # check in expectations with the IGNOREFAILURE flag set).
  45 JSONKEY_ACTUALRESULTS_NOCOMPARISON = 'no-comparison'
  46
  47 # Tests whose results matched their expectations.
  48 JSONKEY_ACTUALRESULTS_SUCCEEDED = 'succeeded'
  49
  50
  51 # Descriptions of the result set as a whole.
  52 JSONKEY_DESCRIPTIONS = 'descriptions'
  53
  54
  55 JSONKEY_EXPECTEDRESULTS = 'expected-results'
  56
  57 # One or more [HashType/DigestValue] pairs representing valid results for this
  58 # test.  Typically, there will just be one pair, but we allow for multiple
  59 # expectations, and the test will pass if any one of them is matched.
  60 JSONKEY_EXPECTEDRESULTS_ALLOWEDDIGESTS = 'allowed-digests'
  61
  62 # Optional: one or more integers listing Skia bugs (under
  63 # https://code.google.com/p/skia/issues/list ) that pertain to this expectation.
  64 JSONKEY_EXPECTEDRESULTS_BUGS = 'bugs'
  65
  66 # If IGNOREFAILURE is set to True, a failure of this test will be reported
  67 # within the FAILUREIGNORED section (thus NOT causing the buildbots to go red)
  68 # rather than the FAILED section (which WOULD cause the buildbots to go red).
  69 JSONKEY_EXPECTEDRESULTS_IGNOREFAILURE = 'ignore-failure'
  70
  71 # Optional: a free-form text string with human-readable information about
  72 # this expectation.
  73 JSONKEY_EXPECTEDRESULTS_NOTES = 'notes'
  74
  75 # Optional: boolean indicating whether this expectation was reviewed/approved
  76 # by a human being.
  77 # If True: a human looked at this image and approved it.
  78 # If False: this expectation was committed blind.  (In such a case, please
  79 #   add notes indicating why!)
  80 # If absent: this expectation was committed by a tool that didn't enforce human
  81 #   review of expectations.
  82 JSONKEY_EXPECTEDRESULTS_REVIEWED = 'reviewed-by-human'
  83
  84 # Allowed hash types for test expectations.
  85 JSONKEY_HASHTYPE_BITMAP_64BITMD5 = 'bitmap-64bitMD5'
  86
  87 JSONKEY_HEADER = 'header'
  88 JSONKEY_HEADER_TYPE = 'type'
  89 JSONKEY_HEADER_REVISION = 'revision'
  90 JSONKEY_IMAGE_CHECKSUMALGORITHM = 'checksumAlgorithm'
  91 JSONKEY_IMAGE_CHECKSUMVALUE = 'checksumValue'
  92 JSONKEY_IMAGE_COMPARISONRESULT = 'comparisonResult'
  93 JSONKEY_IMAGE_FILEPATH = 'filepath'
  94 JSONKEY_SOURCE_TILEDIMAGES = 'tiled-images'
  95 JSONKEY_SOURCE_WHOLEIMAGE = 'whole-image'
  96
  97
  98 # Root directory where the buildbots store their actually-generated images...
  99 #  as a publicly readable HTTP URL:
 100 GM_ACTUALS_ROOT_HTTP_URL = (
 101     'http://chromium-skia-gm.commondatastorage.googleapis.com/gm')
 102 #  as a GS URL that allows credential-protected write access:
 103 GM_ACTUALS_ROOT_GS_URL = 'gs://chromium-skia-gm/gm'
 104
 105 # Root directory where buildbots store skimage actual results json files.
 106 SKIMAGE_ACTUALS_BASE_URL = (
 107     'http://chromium-skia-gm.commondatastorage.googleapis.com/skimage/actuals')
 108 # Root directory inside trunk where skimage expectations are stored.
 109 SKIMAGE_EXPECTATIONS_ROOT = os.path.join('expectations', 'skimage')
 110
 111 # Pattern used to assemble each image's filename
 112 IMAGE_FILENAME_PATTERN = '(.+)_(.+)\.png'  # matches (testname, config)
 113
 114 # Pattern used to create image URLs, relative to some base URL.
 115 GM_RELATIVE_URL_FORMATTER = '%s/%s/%s.png' # pass in (hash_type, test_name,
 116                                            #          hash_digest)
 117 GM_RELATIVE_URL_PATTERN = '(.+)/(.+)/(.+).png' # matches (hash_type, test_name,
 118                                                #          hash_digest)
 119 GM_RELATIVE_URL_RE = re.compile(GM_RELATIVE_URL_PATTERN)
 120
 121
 122 def CreateGmActualUrl(test_name, hash_type, hash_digest,
 123                       gm_actuals_root_url=GM_ACTUALS_ROOT_HTTP_URL):
 124   """Return the URL we can use to download a particular version of
 125   the actually-generated image for this particular GM test.
 126
 127   test_name: name of the test, e.g. 'perlinnoise'
 128   hash_type: string indicating the hash type used to generate hash_digest,
 129              e.g. JSONKEY_HASHTYPE_BITMAP_64BITMD5
 130   hash_digest: the hash digest of the image to retrieve
 131   gm_actuals_root_url: root url where actual images are stored
 132   """
 133   return posixpath.join(
 134       gm_actuals_root_url, CreateGmRelativeUrl(
 135           test_name=test_name, hash_type=hash_type, hash_digest=hash_digest))
 136
 137
 138 def CreateGmRelativeUrl(test_name, hash_type, hash_digest):
 139   """Returns a relative URL pointing at a test result's image.
 140
 141   Returns the URL we can use to download a particular version of
 142   the actually-generated image for this particular GM test,
 143   relative to the URL root.
 144
 145   Args:
 146     test_name: name of the test, e.g. 'perlinnoise'
 147     hash_type: string indicating the hash type used to generate hash_digest,
 148                e.g. JSONKEY_HASHTYPE_BITMAP_64BITMD5
 149     hash_digest: the hash digest of the image to retrieve
 150   """
 151   return GM_RELATIVE_URL_FORMATTER % (hash_type, test_name, hash_digest)
 152
 153
 154 def SplitGmRelativeUrl(url):
 155   """Splits the relative URL into (test_name, hash_type, hash_digest) tuple.
 156
 157   This is the inverse of CreateGmRelativeUrl().
 158
 159   Args:
 160     url: a URL generated with CreateGmRelativeUrl().
 161
 162   Returns: (test_name, hash_type, hash_digest) tuple.
 163   """
 164   hash_type, test_name, hash_digest = GM_RELATIVE_URL_RE.match(url).groups()
 165   return (test_name, hash_type, hash_digest)
 166
 167
 168 def LoadFromString(file_contents):
 169   """Loads the JSON summary written out by the GM tool.
 170
 171      Returns a dictionary keyed by the values listed as JSONKEY_ constants
 172      above; if file_contents is empty, returns None."""
 173   # TODO(epoger): we should add a version number to the JSON file to ensure
 174   # that the writer and reader agree on the schema (raising an exception
 175   # otherwise).
 176   if not file_contents:
 177     return None
 178   json_dict = json.loads(file_contents)
 179   return json_dict
 180
 181
 182 def LoadFromFile(file_path):
 183   """Loads the JSON summary written out by the GM tool.
 184      Returns a dictionary keyed by the values listed as JSONKEY_ constants
 185      above."""
 186   file_contents = open(file_path, 'r').read()
 187   return LoadFromString(file_contents)
 188
 189
 190 def WriteToFile(json_dict, file_path):
 191   """Writes the JSON summary in json_dict out to file_path.
 192
 193   The file is written Unix-style (each line ends with just LF, not CRLF);
 194   see https://code.google.com/p/skia/issues/detail?id=1815 for reasons."""
 195   with io.open(file_path, mode='w', newline='', encoding='utf-8') as outfile:
 196     outfile.write(unicode(json.dumps(json_dict, outfile, sort_keys=True,
 197                                      indent=2)))