# 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 unittest

from webkitpy.layout_tests.models.test_failures import *

try:
    import cPickle as pickle
except ImportError:
    import pickle


class TestFailuresTest(unittest.TestCase):
    def assert_pickle_roundtrip(self, cls):
        failure_obj = cls()
        s = pickle.dumps(failure_obj)  # multiprocessing uses the default protocol version
        new_failure_obj = pickle.loads(s)
        self.assertIsInstance(new_failure_obj, cls)

        self.assertEqual(failure_obj, new_failure_obj)

        # Also test that != is implemented.
        self.assertFalse(failure_obj != new_failure_obj)

    def test_unknown_failure_type(self):
        class UnknownFailure(TestFailure):
            def message(self):
                return ''

        failure_obj = UnknownFailure()
        self.assertRaises(ValueError, determine_result_type, [failure_obj])

    def test_message_is_virtual(self):
        failure_obj = TestFailure()
        self.assertRaises(NotImplementedError, failure_obj.message)

    def test_pickle_roundtrip(self):
        for c in ALL_FAILURE_CLASSES:
            self.assert_pickle_roundtrip(c)

    def test_all_failure_classes(self):
        failure_classes = (
            FailureTimeout,
            FailureCrash,
            FailureMissingResult,
            FailureNoOutput,
            FailureTextMismatch,
            FailureMissingImageHash,
            FailureMissingImage,
            FailureImageHashMismatch,
            FailureImageHashIncorrect,
            FailureReftestMismatch,
            FailureReftestMismatchDidNotOccur,
            FailureReftestNoImagesGenerated,
            FailureMissingAudio,
            FailureAudioMismatch,
            FailureDocumentLeak,
            FailureEarlyExit)
        self.assertEqual(failure_classes, ALL_FAILURE_CLASSES)

    def test_equals(self):
        self.assertEqual(FailureCrash(), FailureCrash())
        self.assertNotEqual(FailureCrash(), FailureTimeout())
        crash_set = set([FailureCrash(), FailureCrash()])
        self.assertEqual(len(crash_set), 1)
        # The hash happens to be the name of the class, but sets still work:
        crash_set = set([FailureCrash(), "FailureCrash"])
        self.assertEqual(len(crash_set), 2)

    def test_crashes(self):
        self.assertEqual(FailureCrash().message(), 'DumpRenderTree crashed')
        self.assertEqual(FailureCrash(process_name='foo', pid=1234).message(), 'foo crashed [pid=1234]')
