majuna/app/terraform/__init__.py

import os
from typing import Tuple

from app import app


class BaseAutomation:
    short_name: str = "base"
    description: str = "Abstract base automation."
    frequency: int

    """
    The short name of the automation provider. This is used as an opaque token throughout
    the portal system.
    """

    def automate(self, full: bool = False) -> Tuple[bool, str]:
        raise NotImplementedError()

    def working_directory(self, filename=None) -> str:
        """
        Provides a filesystem path that can be used during the automation run.
        This is currently a persistent path, but this should not be relied upon
        as future versions may use disposable temporary paths instead. State that
        is needed in subsequent runs should be stored elsewhere.

        :param filename: the filename inside the working directory to create a path for
        :return: filesystem path for that filename
        """
        return os.path.join(
            app.config['TERRAFORM_DIRECTORY'],
            self.short_name or self.__class__.__name__.lower(),
            filename or ""
        )