2010-11-04 Dirk Pranke <dpranke@chromium.org>
authordpranke@chromium.org <dpranke@chromium.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Fri, 5 Nov 2010 01:05:35 +0000 (01:05 +0000)
committerdpranke@chromium.org <dpranke@chromium.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Fri, 5 Nov 2010 01:05:35 +0000 (01:05 +0000)
        Reviewed by Adam Barth.

        new-run-webkit-tests: split out webkit-specific configuration stuff into a new module

        The current NRWT code has webkit-specific configuration code (like
        _script_path, default configuration, etc.) mixed in with
        layout-test-specific stuff in port/base. The configuration code
        should be split out into a separate module for easier mocking,
        testing, and isolation.

        https://bugs.webkit.org/show_bug.cgi?id=48264

        * Scripts/webkitpy/layout_tests/port/config.py: Added.
        * Scripts/webkitpy/layout_tests/port/config_unittest.py: Added.

git-svn-id: http://svn.webkit.org/repository/webkit/trunk@71374 268f45cc-cd09-0410-ab3c-d52691b4dbfc

WebKitTools/ChangeLog
WebKitTools/Scripts/webkitpy/layout_tests/port/config.py [new file with mode: 0644]
WebKitTools/Scripts/webkitpy/layout_tests/port/config_unittest.py [new file with mode: 0644]

index c0c20b42b0b751cf3906b1d3274c4e8748399c1f..5b6810a518d1a03c8c4dc3bf6d5996f9c9071b51 100644 (file)
@@ -1,3 +1,20 @@
+2010-11-04  Dirk Pranke  <dpranke@chromium.org>
+
+        Reviewed by Adam Barth.
+
+        new-run-webkit-tests: split out webkit-specific configuration stuff into a new module
+
+        The current NRWT code has webkit-specific configuration code (like
+        _script_path, default configuration, etc.) mixed in with
+        layout-test-specific stuff in port/base. The configuration code
+        should be split out into a separate module for easier mocking,
+        testing, and isolation.
+
+        https://bugs.webkit.org/show_bug.cgi?id=48264
+
+        * Scripts/webkitpy/layout_tests/port/config.py: Added.
+        * Scripts/webkitpy/layout_tests/port/config_unittest.py: Added.
+
 2010-11-02  Mihai Parparita  <mihaip@chromium.org>
 
         Reviewed by Tony Chang.
diff --git a/WebKitTools/Scripts/webkitpy/layout_tests/port/config.py b/WebKitTools/Scripts/webkitpy/layout_tests/port/config.py
new file mode 100644 (file)
index 0000000..2364098
--- /dev/null
@@ -0,0 +1,154 @@
+#!/usr/bin/env python
+# Copyright (C) 2010 Google Inc. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above
+# copyright notice, this list of conditions and the following disclaimer
+# in the documentation and/or other materials provided with the
+# distribution.
+#     * Neither the name of Google Inc. nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+"""Wrapper objects for WebKit-specific utility routines."""
+
+# FIXME: This file needs to be unified with common/checkout/scm.py and
+# common/config/ports.py .
+
+from __future__ import with_statement
+
+import codecs
+import os
+
+from webkitpy.common.checkout import scm
+from webkitpy.common.system import logutils
+
+
+_log = logutils.get_logger(__file__)
+
+#
+# This is used to record if we've already hit the filesystem to look
+# for a default configuration. We cache this to speed up the unit tests,
+# but this can be reset with clear_cached_configuration().
+#
+_determined_configuration = None
+
+
+def clear_cached_configuration():
+    global _determined_configuration
+    _determined_configuration = -1
+
+
+class Config(object):
+    _FLAGS_FROM_CONFIGURATIONS = {
+        "Debug": "--debug",
+        "Release": "--release",
+    }
+
+    def __init__(self, executive):
+        self._executive = executive
+        self._webkit_base_dir = None
+        self._default_configuration = None
+        self._build_directories = {}
+
+    def build_directory(self, configuration):
+        """Returns the path to the build directory for the configuration."""
+        if configuration:
+            flags = ["--configuration",
+                     self._FLAGS_FROM_CONFIGURATIONS[configuration]]
+            configuration = ""
+        else:
+            configuration = ""
+            flags = ["--top-level"]
+
+        if not self._build_directories.get(configuration):
+            args = ["perl", self._script_path("webkit-build-directory")] + flags
+            self._build_directories[configuration] = (
+                self._executive.run_command(args).rstrip())
+
+        return self._build_directories[configuration]
+
+    def build_dumprendertree(self, configuration):
+        """Builds DRT in the given configuration.
+
+        Returns True if the  build was successful and up-to-date."""
+        flag = self._FLAGS_FROM_CONFIGURATIONS[configuration]
+        exit_code = self._executive.run_command([
+            self._script_path("build-dumprendertree"), flag],
+            return_exit_code=True)
+        if exit_code != 0:
+            _log.error("Failed to build DumpRenderTree")
+            return False
+        return True
+
+    def default_configuration(self):
+        """Returns the default configuration for the user.
+
+        Returns the value set by 'set-webkit-configuration', or "Release"
+        if that has not been set. This mirrors the logic in webkitdirs.pm."""
+        if not self._default_configuration:
+            self._default_configuration = self._determine_configuration()
+        if not self._default_configuration:
+            self._default_configuration = 'Release'
+        if self._default_configuration not in self._FLAGS_FROM_CONFIGURATIONS:
+            _log.warn("Configuration \"%s\" is not a recognized value.\n" %
+                      self._default_configuration)
+            _log.warn("Scripts may fail.  "
+                      "See 'set-webkit-configuration --help'.")
+        return self._default_configuration
+
+    def path_from_webkit_base(self, *comps):
+        return os.path.join(self.webkit_base_dir(), *comps)
+
+    def webkit_base_dir(self):
+        """Returns the absolute path to the top of the WebKit tree.
+
+        Raises an AssertionError if the top dir can't be determined."""
+        # FIXME: Consider determining this independently of scm in order
+        # to be able to run in a bare tree.
+        if not self._webkit_base_dir:
+            self._webkit_base_dir = scm.find_checkout_root()
+            assert self._webkit_base_dir, "Could not determine the top of the WebKit checkout"
+        return self._webkit_base_dir
+
+    def _script_path(self, script_name):
+        return os.path.join(self.webkit_base_dir(), "WebKitTools",
+                            "Scripts", script_name)
+
+    def _determine_configuration(self):
+        # This mirrors the logic in webkitdirs.pm:determineConfiguration().
+        global _determined_configuration
+        if _determined_configuration == -1:
+            contents = self._read_configuration()
+            if contents == "Deployment":
+                contents = "Release"
+            if contents == "Development":
+                contents = "Debug"
+            _determined_configuration = contents
+        return _determined_configuration
+
+    def _read_configuration(self):
+        configuration_path = os.path.join(self.build_directory(None),
+                                          "Configuration")
+        if not os.path.exists(configuration_path):
+            return None
+
+        with codecs.open(configuration_path, "r", "utf-8") as fh:
+            return fh.read().rstrip()
diff --git a/WebKitTools/Scripts/webkitpy/layout_tests/port/config_unittest.py b/WebKitTools/Scripts/webkitpy/layout_tests/port/config_unittest.py
new file mode 100644 (file)
index 0000000..4674cba
--- /dev/null
@@ -0,0 +1,176 @@
+# Copyright (C) 2010 Google Inc. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#    * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#    * Redistributions in binary form must reproduce the above
+# copyright notice, this list of conditions and the following disclaimer
+# in the documentation and/or other materials provided with the
+# distribution.
+#    * Neither the name of Google Inc. nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+import codecs
+import os
+import StringIO
+import unittest
+
+from webkitpy.common.system import outputcapture
+
+import config
+
+
+# FIXME: This makes StringIO objects work with "with". Remove
+# when we upgrade to 2.6.
+class NewStringIO(StringIO.StringIO):
+    def __enter__(self):
+        return self
+
+    def __exit__(self, type, value, traceback):
+        pass
+
+
+class MockExecutive(object):
+    def __init__(self, output='', exit_code=0):
+        self._output = output
+        self._exit_code = exit_code
+
+    def run_command(self, arg_list, return_exit_code=False,
+                    decode_output=False):
+        if return_exit_code:
+            return self._exit_code
+        return self._output
+
+
+class ConfigTest(unittest.TestCase):
+    def tearDown(self):
+        config.clear_cached_configuration()
+
+    def assertConfiguration(self, contents, expected):
+        # This tests that a configuration file containing
+        # _contents_ endsd up being interpreted as _expected_.
+        #
+        # FIXME: rewrite this when we have a filesystem abstraction we
+        # can mock out more easily.
+        config.clear_cached_configuration()
+        orig_open = codecs.open
+
+        def wrap_open(contents):
+            def open_wrapper(path, mode, encoding):
+                return NewStringIO(contents)
+            return open_wrapper
+
+        try:
+            orig_exists = os.path.exists
+            os.path.exists = lambda p: True
+            codecs.open = wrap_open(contents)
+
+            e = MockExecutive(output='foo')
+            c = config.Config(e)
+            self.assertEqual(c.default_configuration(), expected)
+        finally:
+            os.path.exists = orig_exists
+            codecs.open = orig_open
+
+    def test_build_directory_toplevel(self):
+        e = MockExecutive(output="toplevel")
+        c = config.Config(e)
+        self.assertEqual(c.build_directory(None), 'toplevel')
+
+        # Test again to check caching
+        self.assertEqual(c.build_directory(None), 'toplevel')
+
+    def test_build_directory__release(self):
+        e = MockExecutive(output="release")
+        c = config.Config(e)
+        self.assertEqual(c.build_directory('Release'), 'release')
+
+    def test_build_directory__debug(self):
+        e = MockExecutive(output="debug")
+        c = config.Config(e)
+        self.assertEqual(c.build_directory('Debug'), 'debug')
+
+    def test_build_directory__unknown(self):
+        e = MockExecutive(output="unknown")
+        c = config.Config(e)
+        self.assertRaises(KeyError, c.build_directory, 'Unknown')
+
+    def test_build_dumprendertree__success(self):
+        e = MockExecutive(exit_code=0)
+        c = config.Config(e)
+        self.assertTrue(c.build_dumprendertree("Debug"))
+        self.assertTrue(c.build_dumprendertree("Release"))
+        self.assertRaises(KeyError, c.build_dumprendertree, "Unknown")
+
+    def test_build_dumprendertree__failure(self):
+        e = MockExecutive(exit_code=-1)
+        c = config.Config(e)
+
+        oc = outputcapture.OutputCapture()
+        oc.capture_output()
+        self.assertFalse(c.build_dumprendertree('Debug'))
+        (out, err) = oc.restore_output()
+
+        oc.capture_output()
+        self.assertFalse(c.build_dumprendertree('Release'))
+        oc.restore_output()
+
+    def test_default_configuration__release(self):
+        self.assertConfiguration('Release', 'Release')
+
+    def test_default_configuration__debug(self):
+        self.assertConfiguration('Debug', 'Debug')
+
+    def test_default_configuration__deployment(self):
+        self.assertConfiguration('Deployment', 'Release')
+
+    def test_default_configuration__development(self):
+        self.assertConfiguration('Development', 'Debug')
+
+    def test_default_configuration__notfound(self):
+        # This tests what happens if the default configuration file
+        # doesn't exist.
+        config.clear_cached_configuration()
+        try:
+            orig_exists = os.path.exists
+            os.path.exists = lambda p: False
+            e = MockExecutive(output="foo")
+            c = config.Config(e)
+            self.assertEqual(c.default_configuration(), "Release")
+        finally:
+            os.path.exists = orig_exists
+
+    def test_default_configuration__unknown(self):
+        # Ignore the warning about an unknown configuration value.
+        oc = outputcapture.OutputCapture()
+        oc.capture_output()
+        self.assertConfiguration('Unknown', 'Unknown')
+        oc.restore_output()
+
+    def test_path_from_webkit_base(self, *comps):
+        c = config.Config(None)
+        self.assertTrue(c.path_from_webkit_base('foo'))
+
+    def test_webkit_base_dir(self):
+        c = config.Config(None)
+        self.assertTrue(c.webkit_base_dir())
+
+
+if __name__ == '__main__':
+    unittest.main()