# Copyright (c) 2008-2012 testtools developers. See LICENSE for details.

"""Tests for matchers."""

from testtools import (
    Matcher,  # check that Matcher is exposed at the top level for docs.
    TestCase,
)
from testtools.compat import (
    text_repr,
)
from testtools.matchers import (
    Equals,
    MatchesException,
    Raises,
)
from testtools.matchers._impl import (
    Mismatch,
    MismatchDecorator,
    MismatchError,
)
from testtools.tests.helpers import FullStackRunTest

# Silence pyflakes.
Matcher


class TestMismatch(TestCase):
    run_tests_with = FullStackRunTest

    def test_constructor_arguments(self):
        mismatch = Mismatch("some description", {"detail": "things"})
        self.assertEqual("some description", mismatch.describe())
        self.assertEqual({"detail": "things"}, mismatch.get_details())

    def test_constructor_no_arguments(self):
        mismatch = Mismatch()
        self.assertThat(
            mismatch.describe, Raises(MatchesException(NotImplementedError))
        )
        self.assertEqual({}, mismatch.get_details())


class TestMismatchError(TestCase):
    def test_is_assertion_error(self):
        # MismatchError is an AssertionError, so that most of the time, it
        # looks like a test failure, rather than an error.
        def raise_mismatch_error():
            raise MismatchError(2, Equals(3), Equals(3).match(2))

        self.assertRaises(AssertionError, raise_mismatch_error)

    def test_default_description_is_mismatch(self):
        mismatch = Equals(3).match(2)
        e = MismatchError(2, Equals(3), mismatch)
        self.assertEqual(mismatch.describe(), str(e))

    def test_default_description_unicode(self):
        matchee = "\xa7"
        matcher = Equals("a")
        mismatch = matcher.match(matchee)
        e = MismatchError(matchee, matcher, mismatch)
        self.assertEqual(mismatch.describe(), str(e))

    def test_verbose_description(self):
        matchee = 2
        matcher = Equals(3)
        mismatch = matcher.match(2)
        e = MismatchError(matchee, matcher, mismatch, True)
        expected = (
            f"Match failed. Matchee: {matchee!r}\nMatcher: {matcher}\n"
            f"Difference: {matcher.match(matchee).describe()}\n"
        )
        self.assertEqual(expected, str(e))

    def test_verbose_unicode(self):
        # When assertThat is given matchees or matchers that contain non-ASCII
        # unicode strings, we can still provide a meaningful error.
        matchee = "\xa7"
        matcher = Equals("a")
        mismatch = matcher.match(matchee)
        expected = (
            f"Match failed. Matchee: {text_repr(matchee)}\nMatcher: {matcher}\n"
            f"Difference: {mismatch.describe()}\n"
        )
        e = MismatchError(matchee, matcher, mismatch, True)
        self.assertEqual(expected, str(e))


class TestMismatchDecorator(TestCase):
    run_tests_with = FullStackRunTest

    def test_forwards_description(self):
        x = Mismatch("description", {"foo": "bar"})
        decorated = MismatchDecorator(x)
        self.assertEqual(x.describe(), decorated.describe())

    def test_forwards_details(self):
        x = Mismatch("description", {"foo": "bar"})
        decorated = MismatchDecorator(x)
        self.assertEqual(x.get_details(), decorated.get_details())

    def test_repr(self):
        x = Mismatch("description", {"foo": "bar"})
        decorated = MismatchDecorator(x)
        self.assertEqual(
            f"<testtools.matchers.MismatchDecorator({x!r})>", repr(decorated)
        )


def test_suite():
    from unittest import TestLoader

    return TestLoader().loadTestsFromName(__name__)
