# Copyright (C) 2010 Google Inc. All rights reserved.
# Copyright (C) 2017 Apple 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 logging
import optparse
import os
import platform
import re
import sys
from webkitpy.tool.steps.abstractstep import AbstractStep
from webkitpy.tool.steps.options import Options
from webkitpy.common.system.executive import ScriptError, Executive
from webkitpy.common.host import Host
from webkitpy.layout_tests.controllers.layout_test_finder import LayoutTestFinder

_log = logging.getLogger(__name__)


class RunTests(AbstractStep):
    # FIXME: This knowledge really belongs in the commit-queue.
    NON_INTERACTIVE_FAILURE_LIMIT_COUNT = 30

    @classmethod
    def options(cls):
        return AbstractStep.options() + [
            Options.build_style,
            Options.test,
            Options.iterate_on_new_tests,
            Options.non_interactive,
            Options.quiet,
            Options.group,
        ]

    def run(self, state):
        if self._options.group == "jsc":
            self._run_javascriptcore_tests()
            return

        if self._options.group == "api":
            self._run_api_tests()
            return

        if self._options.group == "bindings":
            self._run_bindings_tests()
            return

        if self._options.group == "webkitpy":
            self._run_webkitpy_tests()
            return

        if self._options.iterate_on_new_tests:
            _log.info("Running run-webkit-tests on new tests")
            self._run_webkit_tests(self._options.iterate_on_new_tests)

        if not self._options.test:
            return

        if not self._options.non_interactive:
            python_unittests_command = self._tool.deprecated_port().run_python_unittests_command()
            if python_unittests_command:
                _log.info("Running Python unit tests")
                self._tool.executive.run_and_throw_if_fail(python_unittests_command, cwd=self._tool.scm().checkout_root)

            perl_unittests_command = self._tool.deprecated_port().run_perl_unittests_command()
            if perl_unittests_command:
                _log.info("Running Perl unit tests")
                self._tool.executive.run_and_throw_if_fail(perl_unittests_command, cwd=self._tool.scm().checkout_root)

            javascriptcore_tests_command = self._tool.deprecated_port().run_javascriptcore_tests_command()
            if javascriptcore_tests_command:
                _log.info("Running JavaScriptCore tests")
                self._tool.executive.run_and_throw_if_fail(javascriptcore_tests_command, quiet=True, cwd=self._tool.scm().checkout_root)

        _log.info("Running run-webkit-tests")
        self._run_webkit_tests()

    def _new_or_modified_tests(self):
        touched_files = self._tool.scm().changed_files()
        touched_files.extend(self._tool.scm().untracked_files())
        if not touched_files:
            return None

        configuration = "Debug" if (self._options.build_style == "debug") else "Release"
        port = Host().port_factory.get(self._tool.deprecated_port().port_flag_name, optparse.Values({'configuration': configuration}))
        return LayoutTestFinder(port, optparse.Values({'skipped': 'always', 'skip_failing_tests': False, 'http': True})).find_touched_tests(touched_files)

    def _run_webkit_tests(self, iterate_on_new_tests=0):
        args = self._tool.deprecated_port().run_webkit_tests_command(build_style=self._options.build_style)
        if self._options.non_interactive:
            args.extend([
                "--no-new-test-results",
                "--no-show-results",
                "--exit-after-n-failures=%s" % self.NON_INTERACTIVE_FAILURE_LIMIT_COUNT,
            ])

            # old-run-webkit-tests does not support --skip-failing-tests
            # Using --quiet one Windows fails when we try to use /dev/null, disabling for now until we find a fix
            if sys.platform != "cygwin":
                args.append("--quiet")
                args.append("--skip-failing-tests")
            else:
                args.append("--no-build")

        if self._options.quiet:
            args.append("--quiet")

        if iterate_on_new_tests:
            new_tests = self._new_or_modified_tests()
            if not new_tests:
                _log.info("No new or modified tests")
                return
            _log.info("Touched tests are: " + str(new_tests))
            for test in new_tests:
                args.append(test)
            args.append("--iterations=%d" % iterate_on_new_tests)

        self._tool.executive.run_and_throw_if_fail(args, cwd=self._tool.scm().checkout_root)

    def _run_javascriptcore_tests(self):
        args = self._tool.deprecated_port().run_javascriptcore_tests_command(self._options.build_style)

        results_directory = self._tool.port_factory.get(options=self._options).jsc_results_directory()
        results_file_path = self._tool.filesystem.join(results_directory, "jsc_test_results.json")
        args.append("--json-output=%s" % results_file_path)
        self._tool.executive.run_and_throw_if_fail(args, cwd=self._tool.scm().checkout_root)

    def _run_bindings_tests(self):
        args = self._tool.deprecated_port().run_bindings_tests_command()
        results_directory = self._tool.port_factory.get(options=self._options).bindings_results_directory()
        self._tool.filesystem.maybe_make_directory(results_directory)
        results_file_path = self._tool.filesystem.join(results_directory, "bindings_test_results.json")
        args.append("--json-output=%s" % results_file_path)
        self._tool.executive.run_and_throw_if_fail(args, cwd=self._tool.scm().checkout_root)

    def _run_webkitpy_tests(self):
        args = self._tool.deprecated_port().run_python_unittests_command()
        results_directory = self._tool.port_factory.get(options=self._options).python_unittest_results_directory()
        self._tool.filesystem.maybe_make_directory(results_directory)
        results_file_path = self._tool.filesystem.join(results_directory, "webkitpy_test_results.json")
        args.append("--json-output={}".format(results_file_path))
        self._tool.executive.run_and_throw_if_fail(args, cwd=self._tool.scm().checkout_root)

    def _run_api_tests(self):
        args = self._tool.deprecated_port().run_api_tests_command(self._options.build_style)
        results_directory = self._tool.port_factory.get(options=self._options).api_results_directory()
        results_file_path = self._tool.filesystem.join(results_directory, "api_test_results.json")
        args.append("--json-output=%s" % results_file_path)
        self._tool.executive.run_and_throw_if_fail(args, cwd=self._tool.scm().checkout_root)