# Source code for certbot.plugins.dns_test_common_lexicon

    """Base test class for DNS authenticators built on Lexicon."""
    import typing
    from unittest.mock import MagicMock

    import josepy as jose
    from requests.exceptions import HTTPError
    from requests.exceptions import RequestException

    from acme.challenges import Challenge
    from certbot import errors
    from certbot.plugins import dns_test_common
    from certbot.plugins.dns_common_lexicon import LexiconClient
    from certbot.plugins.dns_test_common import _AuthenticatorCallableTestCase
    from certbot.tests import util as test_util

    try:
        import mock
    except ImportError:  # pragma: no cover
        from unittest import mock  # type: ignore
    if typing.TYPE_CHECKING:
        from typing_extensions import Protocol
    else:
        Protocol = object

    DOMAIN = 'example.com'
    KEY = jose.JWKRSA.load(test_util.load_vector("rsa512_key.pem"))

    class _AuthenticatorCallableLexiconTestCase(_AuthenticatorCallableTestCase, Protocol):
        """
        Protocol describing a TestCase suitable to test challenges against
        a mocked LexiconClient instance.
        """
        mock_client: MagicMock
        achall: Challenge

    class _LexiconAwareTestCase(Protocol):
        """
        Protocol describing a TestCase suitable to test a real LexiconClient instance.
        """
        client: LexiconClient
        provider_mock: MagicMock

        record_prefix: str
        record_name: str
        record_content: str

        DOMAIN_NOT_FOUND: Exception
        GENERIC_ERROR: Exception
        LOGIN_ERROR: Exception
        UNKNOWN_LOGIN_ERROR: Exception

        def assertRaises(self, *unused_args) -> None:
            """
            See
            https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertRaises
            """
            ...

    # These classes are intended to be subclassed/mixed in, so not all members are defined.
    # pylint: disable=no-member

    class BaseLexiconAuthenticatorTest(dns_test_common.BaseAuthenticatorTest):

        @test_util.patch_display_util()
        def test_perform(self: _AuthenticatorCallableLexiconTestCase, unused_mock_get_utility):
            self.auth.perform([self.achall])

            expected = [mock.call.add_txt_record(DOMAIN, '_acme-challenge.'+DOMAIN, mock.ANY)]
            self.assertEqual(expected, self.mock_client.mock_calls)

        def test_cleanup(self: _AuthenticatorCallableLexiconTestCase):
            self.auth._attempt_cleanup = True  # _attempt_cleanup | pylint: disable=protected-access
            self.auth.cleanup([self.achall])

            expected = [mock.call.del_txt_record(DOMAIN, '_acme-challenge.'+DOMAIN, mock.ANY)]
            self.assertEqual(expected, self.mock_client.mock_calls)

    class BaseLexiconClientTest:
        DOMAIN_NOT_FOUND = Exception('No domain found')
        GENERIC_ERROR = RequestException
        LOGIN_ERROR = HTTPError('400 Client Error: ...')
        UNKNOWN_LOGIN_ERROR = HTTPError('500 Surprise! Error: ...')

        record_prefix = "_acme-challenge"
        record_name = record_prefix + "." + DOMAIN
        record_content = "bar"

        def test_add_txt_record(self: _LexiconAwareTestCase):
            self.client.add_txt_record(DOMAIN, self.record_name, self.record_content)

            self.provider_mock.create_record.assert_called_with(rtype='TXT',
                                                                name=self.record_name,
                                                                content=self.record_content)

        def test_add_txt_record_try_twice_to_find_domain(self: _LexiconAwareTestCase):
            self.provider_mock.authenticate.side_effect = [self.DOMAIN_NOT_FOUND, '']

            self.client.add_txt_record(DOMAIN, self.record_name, self.record_content)

            self.provider_mock.create_record.assert_called_with(rtype='TXT',
                                                                name=self.record_name,
                                                                content=self.record_content)

        def test_add_txt_record_fail_to_find_domain(self: _LexiconAwareTestCase):
            self.provider_mock.authenticate.side_effect = [self.DOMAIN_NOT_FOUND,
                                                           self.DOMAIN_NOT_FOUND,
                                                           self.DOMAIN_NOT_FOUND,]

            self.assertRaises(errors.PluginError,
                              self.client.add_txt_record,
                              DOMAIN, self.record_name, self.record_content)

        def test_add_txt_record_fail_to_authenticate(self: _LexiconAwareTestCase):
            self.provider_mock.authenticate.side_effect = self.LOGIN_ERROR

            self.assertRaises(errors.PluginError,
                              self.client.add_txt_record,
                              DOMAIN, self.record_name, self.record_content)

        def test_add_txt_record_fail_to_authenticate_with_unknown_error(self: _LexiconAwareTestCase):
            self.provider_mock.authenticate.side_effect = self.UNKNOWN_LOGIN_ERROR

            self.assertRaises(errors.PluginError,
                              self.client.add_txt_record,
                              DOMAIN, self.record_name, self.record_content)

        def test_add_txt_record_error_finding_domain(self: _LexiconAwareTestCase):
            self.provider_mock.authenticate.side_effect = self.GENERIC_ERROR

            self.assertRaises(errors.PluginError,
                              self.client.add_txt_record,
                              DOMAIN, self.record_name, self.record_content)

        def test_add_txt_record_error_adding_record(self: _LexiconAwareTestCase):
            self.provider_mock.create_record.side_effect = self.GENERIC_ERROR

            self.assertRaises(errors.PluginError,
                              self.client.add_txt_record,
                              DOMAIN, self.record_name, self.record_content)

        def test_del_txt_record(self: _LexiconAwareTestCase):
            self.client.del_txt_record(DOMAIN, self.record_name, self.record_content)

            self.provider_mock.delete_record.assert_called_with(rtype='TXT',
                                                                name=self.record_name,
                                                                content=self.record_content)

        def test_del_txt_record_fail_to_find_domain(self: _LexiconAwareTestCase):
            self.provider_mock.authenticate.side_effect = [self.DOMAIN_NOT_FOUND,
                                                           self.DOMAIN_NOT_FOUND,
                                                           self.DOMAIN_NOT_FOUND, ]

            self.client.del_txt_record(DOMAIN, self.record_name, self.record_content)

        def test_del_txt_record_fail_to_authenticate(self: _LexiconAwareTestCase):
            self.provider_mock.authenticate.side_effect = self.LOGIN_ERROR

            self.client.del_txt_record(DOMAIN, self.record_name, self.record_content)

        def test_del_txt_record_fail_to_authenticate_with_unknown_error(self: _LexiconAwareTestCase):
            self.provider_mock.authenticate.side_effect = self.UNKNOWN_LOGIN_ERROR

            self.client.del_txt_record(DOMAIN, self.record_name, self.record_content)

        def test_del_txt_record_error_finding_domain(self: _LexiconAwareTestCase):
            self.provider_mock.authenticate.side_effect = self.GENERIC_ERROR

            self.client.del_txt_record(DOMAIN, self.record_name, self.record_content)

        def test_del_txt_record_error_deleting_record(self: _LexiconAwareTestCase):
            self.provider_mock.delete_record.side_effect = self.GENERIC_ERROR

            self.client.del_txt_record(DOMAIN, self.record_name, self.record_content)