# ---------------------------------------------------------------------------------------------------------
# Author : Ulrich Carmesin
# Source : gitea.ucarmesin.de
# ---------------------------------------------------------------------------------------------------------
import os
import basic.toolHandling
import basic.componentHandling
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 = "variant"
""" system-name for this entity """
FIELD_ID = "vrid"
FIELD_NAME = "name"
FIELD_DESCRIPTION = B.SUBJECT_DESCRIPTION
FIELD_REFERENCE = B.SUBJECT_REFERENCE
FIELD_PROJECT = B.SUBJECT_PROJECT
FIELD_COMPONENT = B.SUBJECT_COMP
FIELD_ATTRIBUTES = B.NODE_ATTRIBUTES
LIST_FIELDS = [FIELD_ID, FIELD_NAME, FIELD_DESCRIPTION, FIELD_REFERENCE, FIELD_PROJECT, FIELD_COMPONENT, FIELD_ATTRIBUTES]
""" list of object-attributes """
LIST_NODES = [B.NODE_ATTRIBUTES]
LIST_SUBTABLES = []

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


class Variant(model.entity.Entity):
    name = ""
    description = ""
    reference = ""
    attributes = ""
    project = ""
    component = ""

    def __init__(self, job, project, name=""):
        """
        to be initialized by readSpec
        project : optional
        alternative parameter
        name : name of variant or default - only from testspec
        obj  : object with main attributes
        :param job:
        """
        self.job = job
        self.project = project

    def read_unique_names(self, job, project, application, gran, args):
        """
        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_BASIC, B.SUBJECT_VARIANTS, tools.config_tool.get_plain_filename(job, ""))
        outList = list(config[B.SUBJECT_VARIANTS].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_BASIC, B.SUBJECT_VARIANTS, tools.config_tool.get_plain_filename(job, name))
        return self.setAttributes(job, config, name, LIST_FIELDS, LIST_NODES, LIST_SUBTABLES)

    def getFieldList(self):
        """
        returns a list of scalar attributes
        :return: LIST_FIELDS
        """
        return LIST_FIELDS

    def getNodeList(self):
        """
        returns a list of sub-nodes - which can be persisted in a clob-field
        :return: LIST_NODES
        """
        return LIST_NODES

    def getSubtableList(self):
        """
        returns a list of sub-tables
        :return: LIST_SUBTABLES
        """
        return LIST_SUBTABLES

    def getName(self):
        """
        returns the name - maybe build from other attributes
        :return:
        """
        return self.name

    def getIDName(self):
        """
        it returns the name as unique-id - maybe build from few attributes
        :return:
        """
        return self.name