#!/usr/bin/python
# -*- coding: utf-8 -*-
# ---------------------------------------------------------------------------------------------------------
# Author : Ulrich Carmesin
# Source : gitea.ucarmesin.de
# ---------------------------------------------------------------------------------------------------------
import basic.toolHandling
import tools.data_const as D
import basic.constants as B
import model.entity
import tools.config_tool

FIELD_ID = "tcid"
FIELD_NAME = D.FIELD_NAME
FIELD_DESCRIPTION = B.SUBJECT_DESCRIPTION
FIELD_REFERENCE = B.SUBJECT_REFERENCE
FIELD_PROJECT = B.SUBJECT_PROJECT
FIELD_RELEASE = B.SUBJECT_REL
LIST_FIELDS = [FIELD_ID, FIELD_NAME, FIELD_DESCRIPTION, FIELD_REFERENCE, FIELD_PROJECT, FIELD_RELEASE]
""" list of object-attributes """
LIST_NODES = [B.NODE_ATTRIBUTES]

LIST_SUBTABLES = {
    B.SUBJECT_STEPS: [],
    B.SUBJECT_TESTSUITES: []
}

class Testplan(model.entity.Entity):
    name = ""
    description = ""
    release = ""
    testsuites = {}
    steps = []

    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