##############################################################################
#
# Copyright (c) 2001, 2002 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""This is an 'abstract' test for the IMessageCatalog interface.
"""
import unittest

from zope.interface.verify import verifyObject
from zope.schema import getValidationErrors

from zope.i18n.interfaces import IMessageCatalog


class TestIMessageCatalog(unittest.TestCase):

    # This should be overridden by every class that inherits this test
    def _getMessageCatalog(self):
        raise NotImplementedError()

    def _getUniqueIndentifier(self):
        raise NotImplementedError()

    def setUp(self):
        self._catalog = self._getMessageCatalog()

    def testInterface(self):
        verifyObject(IMessageCatalog, self._catalog)
        errors = getValidationErrors(IMessageCatalog, self._catalog)
        self.assertFalse(errors)

    def testGetMessage(self):
        catalog = self._catalog
        self.assertEqual(catalog.getMessage('short_greeting'), 'Hello!')
        self.assertRaises(KeyError, catalog.getMessage, 'foo')

    def testQueryMessage(self):
        catalog = self._catalog
        self.assertEqual(catalog.queryMessage('short_greeting'), 'Hello!')
        self.assertEqual(catalog.queryMessage('foo'), None)
        self.assertEqual(catalog.queryMessage('foo', 'bar'), 'bar')

    def testGetLanguage(self):
        catalog = self._catalog
        self.assertEqual(catalog.language, 'en')

    def testGetDomain(self):
        catalog = self._catalog
        self.assertEqual(catalog.domain, 'default')

    def testGetIdentifier(self):
        catalog = self._catalog
        self.assertEqual(catalog.getIdentifier(), self._getUniqueIndentifier())


def test_suite():
    return unittest.TestSuite()  # Deliberately empty