# ---------------------------------------------------------------------------------------------------------
# Author : Ulrich Carmesin
# Source : gitea.ucarmesin.de
# ---------------------------------------------------------------------------------------------------------
import basic.constants as B
import model.entity
import tools.path_const as P
import tools.data_const as D
import tools.config_tool
import tools.file_tool
import tools.git_tool

TABLE_NAME = "story"
""" system-name for this entity """
FIELD_ID = "stid"
""" list of object-attributes """

FILE_EXTENSION = D.DFILE_TYPE_CSV
UNIQUE_FIELDS = [D.FIELD_NAME]
""" unique business field as human identifer """
IDENTIFYER_FIELDS = [FIELD_ID]
""" unique technical field as technical identifer """

class Story(model.entity.Entity):
    FIELD_ID = "stid"
    LIST_FIELDS = [FIELD_ID, D.FIELD_NAME, B.SUBJECT_DESCRIPTION, B.SUBJECT_REFERENCE, B.SUBJECT_PROJECT]
    """ list of object-attributes """
    LIST_NODES = [B.NODE_ATTRIBUTES]
    LIST_SUBTABLES = [B.SUBJECT_RELS]
    PREFIX_SUBTABLE = "st"

    stid = 0
    story = ""
    project = ""
    description = ""
    reference = ""

    def read_unique_names(self, job, project, application, gran, args, ttype: str=""):
        """
        reads the entity-names from file-storage
        :param job:
        :param opt. project: select-criteria if used and defined
        :param opt. application: select-criteria if used and defined
        :param opt. gran: granularity values testcase / testsuite / testplan
        :param opt. args additional args
        :return: list of entity-names
        """
        config = self.getConfig(job, P.KEY_CATALOG, B.SUBJECT_STORIES,
                                tools.config_tool.get_plain_filename(job, ""), ttype=D.CSV_SPECTYPE_CTLG)
        outList = list(config[B.SUBJECT_STORIES][B.DATA_NODE_KEYS].keys())
        return outList

    def read_entity(self, job, name):
        """
        reads the entity from the file-system
        :param job:
        :param name:
        :return:
        """
        config = self.getConfig(job, P.KEY_CATALOG, B.SUBJECT_STORIES,
                                tools.config_tool.get_plain_filename(job, name), ttype=D.CSV_SPECTYPE_CTLG)
        return self.setAttributes(job, config, name, self.LIST_FIELDS, self.LIST_NODES, self.LIST_SUBTABLES)