src/third_party/WebKit/Tools/Scripts/webkitpy/tool/commands/rebaselineserver.py

   1 # Copyright (c) 2010 Google Inc. All rights reserved.
   2 #
   3 # Redistribution and use in source and binary forms, with or without
   4 # modification, are permitted provided that the following conditions are
   5 # met:
   6 #
   7 #     * Redistributions of source code must retain the above copyright
   8 # notice, this list of conditions and the following disclaimer.
   9 #     * Redistributions in binary form must reproduce the above
  10 # copyright notice, this list of conditions and the following disclaimer
  11 # in the documentation and/or other materials provided with the
  12 # distribution.
  13 #     * Neither the name of Google Inc. nor the names of its
  14 # contributors may be used to endorse or promote products derived from
  15 # this software without specific prior written permission.
  16 #
  17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28
  29 """Starts a local HTTP server which displays layout test failures (given a test
  30 results directory), provides comparisons of expected and actual results (both
  31 images and text) and allows one-click rebaselining of tests."""
  32
  33 from webkitpy.common import system
  34 from webkitpy.common.net.layouttestresults import for_each_test, JSONTestResult
  35 from webkitpy.layout_tests.layout_package import json_results_generator
  36 from webkitpy.tool.commands.abstractlocalservercommand import AbstractLocalServerCommand
  37 from webkitpy.tool.servers.rebaselineserver import get_test_baselines, RebaselineHTTPServer, STATE_NEEDS_REBASELINE
  38
  39
  40 class TestConfig(object):
  41     def __init__(self, test_port, layout_tests_directory, results_directory, platforms, filesystem, scm):
  42         self.test_port = test_port
  43         self.layout_tests_directory = layout_tests_directory
  44         self.results_directory = results_directory
  45         self.platforms = platforms
  46         self.filesystem = filesystem
  47         self.scm = scm
  48
  49
  50 class RebaselineServer(AbstractLocalServerCommand):
  51     name = "rebaseline-server"
  52     help_text = __doc__
  53     show_in_main_help = True
  54     argument_names = "/path/to/results/directory"
  55
  56     server = RebaselineHTTPServer
  57
  58     def _gather_baselines(self, results_json):
  59         # Rebaseline server and it's associated JavaScript expected the tests subtree to
  60         # be key-value pairs instead of hierarchical.
  61         # FIXME: make the rebaseline server use the hierarchical tree.
  62         new_tests_subtree = {}
  63
  64         def gather_baselines_for_test(test_name, result_dict):
  65             result = JSONTestResult(test_name, result_dict)
  66             if result.did_pass_or_run_as_expected():
  67                 return
  68             result_dict['state'] = STATE_NEEDS_REBASELINE
  69             result_dict['baselines'] = get_test_baselines(test_name, self._test_config)
  70             new_tests_subtree[test_name] = result_dict
  71
  72         for_each_test(results_json['tests'], gather_baselines_for_test)
  73         results_json['tests'] = new_tests_subtree
  74
  75     def _prepare_config(self, options, args, tool):
  76         results_directory = args[0]
  77         filesystem = system.filesystem.FileSystem()
  78         scm = self._tool.scm()
  79
  80         print 'Parsing full_results.json...'
  81         results_json_path = filesystem.join(results_directory, 'full_results.json')
  82         results_json = json_results_generator.load_json(filesystem, results_json_path)
  83
  84         port = tool.port_factory.get()
  85         layout_tests_directory = port.layout_tests_dir()
  86         platforms = filesystem.listdir(filesystem.join(layout_tests_directory, 'platform'))
  87         self._test_config = TestConfig(port, layout_tests_directory, results_directory, platforms, filesystem, scm)
  88
  89         print 'Gathering current baselines...'
  90         self._gather_baselines(results_json)
  91
  92         return {
  93             'test_config': self._test_config,
  94             "results_json": results_json,
  95             "platforms_json": {
  96                 'platforms': platforms,
  97                 'defaultPlatform': port.name(),
  98             },
  99         }