"""Let's Encrypt compatibility test interfaces"""
import zope.interface

import letsencrypt.interfaces


class IPluginProxy(zope.interface.Interface):
    """Wraps a Let's Encrypt plugin"""
    def add_parser_arguments(cls, parser): # pylint: disable=no-self-argument
        """Adds command line arguments needed by the parser"""

    def __init__(self, args):
        """Initializes the plugin with the given command line args"""

    def cleanup_from_tests(self):
        """Performs any necessary cleanup from running plugin tests.

        This is guarenteed to be called before the program exits.

        """

    def has_more_configs(self):
        """Returns True if there are more configs to test"""

    def load_config(self):
        """Loads the next config and returns its name"""


class IConfiguratorBaseProxy(IPluginProxy):
    """Common functionality for authenticator/installer tests"""
    http_port = zope.interface.Attribute(
        "The port to connect to on localhost for HTTP traffic")

    https_port = zope.interface.Attribute(
        "The port to connect to on localhost for HTTPS traffic")

    def get_testable_domain_names(self):
        """Returns the domain names that can be used in testing"""


class IAuthenticatorProxy(
        IConfiguratorBaseProxy, letsencrypt.interfaces.IAuthenticator):
    """Wraps a Let's Encrypt authenticator"""


class IInstallerProxy(
        IConfiguratorBaseProxy, letsencrypt.interfaces.IInstaller):
    """Wraps a Let's Encrypt installer"""

    def get_all_names_answer(self):
        """Returns all names that should be found by the installer"""


class IConfiguratorProxy(IAuthenticatorProxy, IInstallerProxy):
    """Wraps a Let's Encrypt configurator"""