add schema version to rebaseline_server intermediate JSON

gm/rebaseline_server/results.py

 #!/usr/bin/python
 
 """
 Copyright 2013 Google Inc.
 
 Use of this source code is governed by a BSD-style license that can be
 found in the LICENSE file.
 
 Repackage expected/actual GM results as needed by our HTML rebaseline viewer.
 """
@@ skipping 34 matching lines @@
 KEY__EXTRACOLUMN__CONFIG = 'config'
 KEY__EXTRACOLUMN__RESULT_TYPE = 'resultType'
 KEY__EXTRACOLUMN__TEST = 'test'
 KEY__HEADER = 'header'
 KEY__HEADER__DATAHASH = 'dataHash'
 KEY__HEADER__IS_EDITABLE = 'isEditable'
 KEY__HEADER__IS_EXPORTED = 'isExported'
 KEY__HEADER__IS_STILL_LOADING = 'resultsStillLoading'
 KEY__HEADER__RESULTS_ALL = 'all'
 KEY__HEADER__RESULTS_FAILURES = 'failures'
+KEY__HEADER__SCHEMA_VERSION = 'schemaVersion'
+KEY__HEADER__SCHEMA_VERSION_CURRENT = 1

[rmistry, 2014/03/13 16:13:43]

Can we create a separate constant for the version number? This is to make it
more noticable. If I was looking to update the version number these group of
constants look like only keys to me.

Maybe something like
REBASELINE_SERVER_VERSION_NUMBER = 1.

[epoger, 2014/03/13 16:32:44]

You mean just because they are named KEY__* you think they are all keys ?

Good idea, done.

 KEY__HEADER__TIME_NEXT_UPDATE_AVAILABLE = 'timeNextUpdateAvailable'
 KEY__HEADER__TIME_UPDATED = 'timeUpdated'
 KEY__HEADER__TYPE = 'type'
 KEY__NEW_IMAGE_URL = 'newImageUrl'
 KEY__RESULT_TYPE__FAILED = gm_json.JSONKEY_ACTUALRESULTS_FAILED
 KEY__RESULT_TYPE__FAILUREIGNORED = gm_json.JSONKEY_ACTUALRESULTS_FAILUREIGNORED
 KEY__RESULT_TYPE__NOCOMPARISON = gm_json.JSONKEY_ACTUALRESULTS_NOCOMPARISON
 KEY__RESULT_TYPE__SUCCEEDED = gm_json.JSONKEY_ACTUALRESULTS_SUCCEEDED
 
 EXPECTATION_FIELDS_PASSED_THRU_VERBATIM = [
@@ skipping 121 matching lines @@
           must be one of the RESULTS_* constants
       reload_seconds: if specified, note that new results may be available once
           these results are reload_seconds old
       is_editable: whether clients are allowed to submit new baselines
       is_exported: whether these results are being made available to other
           network hosts
     """
     response_dict = self._results[results_type]
     time_updated = self.get_timestamp()
     response_dict[KEY__HEADER] = {
+        KEY__HEADER__SCHEMA_VERSION: KEY__HEADER__SCHEMA_VERSION_CURRENT,
+
         # Timestamps:
         # 1. when this data was last updated
         # 2. when the caller should check back for new data (if ever)
         KEY__HEADER__TIME_UPDATED: time_updated,
         KEY__HEADER__TIME_NEXT_UPDATE_AVAILABLE: (
             (time_updated+reload_seconds) if reload_seconds else None),
 
         # The type we passed to get_results_of_type()
         KEY__HEADER__TYPE: results_type,
 
@@ skipping 286 matching lines @@
   results = Results(actuals_root=args.actuals,
                     expected_root=args.expectations,
                     generated_images_root=args.workdir)
   gm_json.WriteToFile(
       results.get_packaged_results_of_type(results_type=args.results),
       args.outfile)
 
 
 if __name__ == '__main__':
   main()