PrimAITE/src/primaite/simulator/system/services/database.py

from typing import Dict

from primaite.simulator.file_system.file_type import FileType
from primaite.simulator.network.hardware.base import Node
from primaite.simulator.system.services.service import Service


class DatabaseService(Service):
    """A generic SQL Server Service."""

    def __init__(self, **kwargs):
        super().__init__(**kwargs)

    def describe_state(self) -> Dict:
        """
        Produce a dictionary describing the current state of this object.

        Please see :py:meth:`primaite.simulator.core.SimComponent.describe_state` for a more detailed explanation.

        :return: Current state of this object and child objects.
        :rtype: Dict
        """
        return super().describe_state()

    @classmethod
    def install(cls, node: Node):


    def uninstall(self) -> None:
        """
        Undo installation procedure.

        This method deletes files created when installing the database, and the database folder if it is empty.
        """
        super().uninstall()
        node: Node = self.parent
        node.file_system.delete_file(self.primary_store)
        node.file_system.delete_file(self.transaction_log)
        if self.secondary_store:
            node.file_system.delete_file(self.secondary_store)
        if len(self.folder.files) == 0:
            node.file_system.delete_folder(self.folder)

    def install(self) -> None:
        """Perform first time install on a node, creating necessary files."""
        super().install()
        assert isinstance(self.parent, Node), "Database install can only happen after the db service is added to a node"
        self._setup_files()

    def _setup_files(
        self,
        folder_name: str = "database",
    ):
        """Set up files that are required by the database on the parent host.

        :param folder_name: Name of the folder which will be setup to hold the db files, defaults to "database"
        :type folder_name: str, optional
        """
        # note that this parent.file_system.create_folder call in the future will be authenticated by using permissions
        # handler. This permission will be granted based on service account given to the database service.
        self.parent: Node
        self.folder = self.parent.file_system.create_folder(folder_name)
        self.primary_store = self.parent.file_system.create_file(
            "db_primary_store", db_size, FileType.MDF, folder=self.folder
        )
        self.transaction_log = self.parent.file_system.create_file(
            "db_transaction_log", "1", FileType.LDF, folder=self.folder
        )
        if use_secondary_db_file:
            self.secondary_store = self.parent.file_system.create_file(
                "db_secondary_store", secondary_db_size, FileType.NDF, folder=self.folder
            )
        else:
            self.secondary_store = None