# Copyright (C) 2009, 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.
#
# WebKit's Python module for understanding the various ports

import os
import platform
import sys

from webkitpy.common.system.executive import Executive


class DeprecatedPort(object):
    results_directory = "/tmp/layout-test-results"

    # Subclasses must override
    port_flag_name = None

    # FIXME: This is only used by BotInfo.
    def name(self):
        return self.__class__

    def flag(self):
        if self.port_flag_name:
            return "--port=%s" % self.port_flag_name
        return None

    # We might need to pass scm into this function for scm.checkout_root
    def script_path(self, script_name):
        return os.path.join("Tools", "Scripts", script_name)

    def script_shell_command(self, script_name):
        script_path = self.script_path(script_name)
        return Executive.shell_command_for_script(script_path)

    @staticmethod
    def port(port_name):
        ports = {
            "chromium": ChromiumPort,
            "chromium-android": ChromiumAndroidPort,
            "chromium-xvfb": ChromiumXVFBPort,
            "gtk": GtkPort,
            "mac": MacPort,
            "win": WinPort,
            "qt": QtPort,
            "efl": EflPort,
        }
        default_port = {
            "Windows": WinPort,
            "Darwin": MacPort,
        }
        # Do we really need MacPort as the ultimate default?
        return ports.get(port_name, default_port.get(platform.system(), MacPort))()

    def makeArgs(self):
        # FIXME: This shouldn't use a static Executive().
        args = '--makeargs="-j%s"' % Executive().cpu_count()
        if os.environ.has_key('MAKEFLAGS'):
            args = '--makeargs="%s"' % os.environ['MAKEFLAGS']
        return args

    def update_webkit_command(self, non_interactive=False):
        return self.script_shell_command("update-webkit")

    def check_webkit_style_command(self):
        return self.script_shell_command("check-webkit-style")

    def prepare_changelog_command(self):
        return self.script_shell_command("prepare-ChangeLog")

    def build_webkit_command(self, build_style=None):
        command = self.script_shell_command("build-webkit")
        if build_style == "debug":
            command.append("--debug")
        if build_style == "release":
            command.append("--release")
        return command

    def run_javascriptcore_tests_command(self):
        return self.script_shell_command("run-javascriptcore-tests")

    def run_webkit_unit_tests_command(self):
        return None

    def run_webkit_tests_command(self):
        return self.script_shell_command("run-webkit-tests")

    def run_python_unittests_command(self):
        return self.script_shell_command("test-webkitpy")

    def run_perl_unittests_command(self):
        return self.script_shell_command("test-webkitperl")

    def layout_tests_results_path(self):
        return os.path.join(self.results_directory, "full_results.json")

    def unit_tests_results_path(self):
        return os.path.join(self.results_directory, "webkit_unit_tests_output.xml")


class MacPort(DeprecatedPort):
    port_flag_name = "mac"


class WinPort(DeprecatedPort):
    port_flag_name = "win"


class GtkPort(DeprecatedPort):
    port_flag_name = "gtk"

    def build_webkit_command(self, build_style=None):
        command = super(GtkPort, self).build_webkit_command(build_style=build_style)
        command.append("--gtk")
        command.append("--update-gtk")
        command.append(super(GtkPort, self).makeArgs())
        return command

    def run_webkit_tests_command(self):
        command = super(GtkPort, self).run_webkit_tests_command()
        command.append("--gtk")
        return command


class QtPort(DeprecatedPort):
    port_flag_name = "qt"

    def build_webkit_command(self, build_style=None):
        command = super(QtPort, self).build_webkit_command(build_style=build_style)
        command.append("--qt")
        command.append(super(QtPort, self).makeArgs())
        return command


class EflPort(DeprecatedPort):
    port_flag_name = "efl"

    def build_webkit_command(self, build_style=None):
        command = super(EflPort, self).build_webkit_command(build_style=build_style)
        command.append("--efl")
        command.append("--update-efl")
        command.append(super(EflPort, self).makeArgs())
        return command


class ChromiumPort(DeprecatedPort):
    port_flag_name = "chromium"

    def update_webkit_command(self, non_interactive=False):
        command = super(ChromiumPort, self).update_webkit_command(non_interactive=non_interactive)
        command.append("--chromium")
        if non_interactive:
            command.append("--force-update")
        return command

    def build_webkit_command(self, build_style=None):
        command = super(ChromiumPort, self).build_webkit_command(build_style=build_style)
        command.append("--chromium")
        command.append("--update-chromium")
        return command

    def run_webkit_tests_command(self):
        # Note: This could be run-webkit-tests now.
        command = self.script_shell_command("new-run-webkit-tests")
        command.append("--chromium")
        command.append("--skip-failing-tests")
        return command

    def run_webkit_unit_tests_command(self):
        return self.script_shell_command("run-chromium-webkit-unit-tests")

    def run_javascriptcore_tests_command(self):
        return None


class ChromiumAndroidPort(ChromiumPort):
    port_flag_name = "chromium-android"

    def update_webkit_command(self, non_interactive=False):
        command = super(ChromiumAndroidPort, self).update_webkit_command(non_interactive=non_interactive)
        command.append("--chromium-android")
        return command

    def build_webkit_command(self, build_style=None):
        command = super(ChromiumAndroidPort, self).build_webkit_command(build_style=build_style)
        command.append("--chromium-android")
        return command


class ChromiumXVFBPort(ChromiumPort):
    port_flag_name = "chromium-xvfb"

    def run_webkit_tests_command(self):
        return ["xvfb-run"] + super(ChromiumXVFBPort, self).run_webkit_tests_command()