<reponame>kyleam/niceman<gh_stars>10-100
# ex: set sts=4 ts=4 sw=4 noet:
# ## ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
#
#   See COPYING file distributed along with the reproman package for the
#   copyright and license terms.
#
# ## ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
""" Protocolling  command calls.
"""

import abc
from os import linesep
import logging
import time


lgr = logging.getLogger('reproman.protocol')


class ProtocolInterface(object, metaclass=abc.ABCMeta):
    """Interface class for protocols used by the Runner.

    Implementations of this interface are supposed to store one section per
    recorded command call in `self._sections` as a dictionary. Default
    implementation of __str__ has to be overridden otherwise.

    ProtocolInterface is iterable as a list of sections.
    """

    def __init__(self):
        self._sections = []
        self._title = ''

    def __iter__(self):
        return self._sections.__iter__()

    def __getitem__(self, item):
        return self._sections.__getitem__(item)

    def __len__(self):
        return len(self._sections)

    def __str__(self):
        protocol_str = self._title
        for section in self._sections:
            protocol_str += linesep
            for key in section.keys():
                protocol_str += "%s: %s" % (key, section[key]) + linesep

        return protocol_str

    @abc.abstractmethod
    def start_section(self, cmd):
        """Starts a new section of the protocol.

        To call before the command call to be recorded.
        To be used with a corresponding call of end_section().

        Parameters
        ----------
        cmd: list
         The actual command and its options/arguments as a list

        Returns
        -------
        int
          An id of the started section to be used as argument of the
          corresponding call of end_section().
        """
        return

    @abc.abstractmethod
    def end_section(self, id_, exception):
        """Ends the section `id`.

        To call after the command call to be recorded.
        This ends the section defined by `id` as returned by start_section().

        Parameters
        ----------
        id: int
        exception: Exception
          The exception raised by the command if any or None otherwise.

        Raises:
        -------
        IndexError
          in case `id` is invalid.
        """
        return

    @abc.abstractmethod
    def add_section(self, cmd, exception):
        """Adds a section to the protocol.

        This is an alternative to the use of start_section() and end_section().
        In opposition to start_section, this one can be called anytime.

        Parameters
        ----------
        cmd: list
          The actual command and its options/arguments as a list
        exception: Exception
          The exception raised by the command if any or None otherwise.
        """
        return

    @abc.abstractproperty
    def records_ext_commands(self):
        """Indicates whether or not the protocol is supposed to include
        external command calls.

        Returns
        -------
        bool
        """
        return

    @abc.abstractproperty
    def records_callables(self):
        """Indicates whether or not the protocol is supposed to include
        calls of python callables.

        Returns
        -------
        bool
        """
        return

    @abc.abstractproperty
    def do_execute_ext_commands(self):
        """Indicates whether or not the called commands are
        supposed to actually be executed.

        Returns
        -------
        bool
        """
        return

    @abc.abstractproperty
    def do_execute_callables(self):
        """Indicates whether or not the callables are supposed to actually
        be executed.

        Returns
        -------
        bool
        """
        return

    def write_to_file(self, file_):
        """Writes the protocol to file.

        Parameters
        ----------
        file_: str
          path of the file, the protocol is written to.
        """
        # TODO: separate protocolling data from presentation since we might want
        # to dump as json
        with open(file_, 'w') as f:
            f.write(self.__str__())


class NullProtocol(ProtocolInterface):
    """No protocolling is done at all.

    Records nothing and all calls are executed.
    This provides the default value for the Runner.
    """

    def __init__(self):
        super(NullProtocol, self).__init__()
        self._title = "No protocol available." + linesep

    def start_section(self, cmd):
        self._sections = [{}]
        return 0

    def end_section(self, id_, exception):
        if id_ != 0:
            raise IndexError("NullProtocol has no entry %d" % id_)

    def add_section(self, cmd, exception):
        pass

    @property
    def records_ext_commands(self):
        return False

    @property
    def records_callables(self):
        return False

    @property
    def do_execute_ext_commands(self):
        return True

    @property
    def do_execute_callables(self):
        return True


class DryRunProtocol(ProtocolInterface):
    """Protocol for dry runs.

    Neither callables nor external commands are executed, when using this
    protocol. Each recorded call results in a section, which is a dictionary
    containing only the key 'command'. Its value is the list passed to
    start_section() or add_section() respectively.
    """
    def __init__(self):
        super(DryRunProtocol, self).__init__()
        self._title = "Dry run protocol:" + linesep

    def start_section(self, cmd):
        id_ = len(self._sections)
        self._sections.append({'command': cmd})
        # TODO: it somewhat duplicates how currently all the dry running is
        # reported... but without it I seems to have no dry run logging at
        # all for e.g. "reproman crawl" command
        # lgr.info("DRY: %s" % cmd)
        return id_

    def end_section(self, id_, exception):
        pass

    def add_section(self, cmd, exception):
        self.start_section(cmd)

    @property
    def records_callables(self):
        return True

    @property
    def records_ext_commands(self):
        return True

    @property
    def do_execute_callables(self):
        return False

    @property
    def do_execute_ext_commands(self):
        return False


class DryRunExternalsProtocol(DryRunProtocol):
    """Protocol for dry runs of external commands only.

    Same as DryRunProtocol, but only affects (and records) external command
    calls.
    """
    def __init__(self):
        super(DryRunExternalsProtocol, self).__init__()

    @property
    def records_callables(self):
        return False

    @property
    def do_execute_callables(self):
        return True


class ExecutionTimeProtocol(ProtocolInterface):
    """Protocol to record execution times of callables as well as of external
    commands.

    Each recorded call results in a section, which is a dictionary
    containing the keys 'command', 'start', 'end', 'duration' and 'exception'.
    The value of 'command' is the list passed to start_section() or
    add_section() respectively. The value of 'exception' is the instance of the
    exception raised by the call or `None`. Times are stored as floating point
    value in seconds.
    """

    def __init__(self):
        super(ExecutionTimeProtocol, self).__init__()
        self._title = "Execution time protocol:" + linesep

    def start_section(self, cmd):
        t_start = time.time()
        id_ = len(self._sections)
        self._sections.append({'command': cmd, 'start': t_start})
        return id_

    def end_section(self, id_, exception):
        t_end = time.time()
        self._sections[id_]['end'] = t_end
        self._sections[id_]['duration'] = t_end - self._sections[id_]['start']
        self._sections[id_]['exception'] = exception

    def add_section(self, cmd, exception):
        self._sections.append({'command': cmd, 'start': None, 'end': None,
                               'duration': None, 'exception': exception})

    @property
    def records_ext_commands(self):
        return True

    @property
    def records_callables(self):
        return True

    @property
    def do_execute_ext_commands(self):
        return True

    @property
    def do_execute_callables(self):
        return True


class ExecutionTimeExternalsProtocol(ExecutionTimeProtocol):
    """Protocol to record execution time of external commands only.

    Same as ExecutionTimeProtocol, but only affects (and records) external
    command calls.
    """

    @property
    def records_callables(self):
        return False
