datestex/model/environment.py

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

TABLE_NAME = "environment"
""" system-name for this entity """
FIELD_ID = "enid"
FIELD_NAME = "name"
FIELD_DESCRIPTION = B.SUBJECT_DESCRIPTION
FIELD_REFERENCE = B.SUBJECT_REFERENCE
FIELD_PROJECT = B.SUBJECT_PROJECT
FIELD_ATTRIBUTES = B.NODE_ATTRIBUTES
LIST_FIELDS = [FIELD_ID, FIELD_NAME, FIELD_DESCRIPTION, FIELD_REFERENCE, FIELD_PROJECT, FIELD_ATTRIBUTES]
""" list of object-attributes """
LIST_SUBTABLES = [B.SUBJECT_COMPS, B.SUBJECT_PROJECTS]

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 """

TABLE_NAMES = ["environment", "en_project", "en_component"]
DEFAULT_SYNC = model.entity.SYNC_FULL_GIT2DB

def select_environments(job, projectList):
    """
    searches and gets environments in which the applications of the project are declared that these are installed
    filtered by parameter --environment
    :param job:
    :return:
    """
    environments = {}
    path = job.conf[B.SUBJECT_PATH][B.ATTR_PATH_ENV]
    if not os.path.exists(path):
        raise Exception("Umgebungsverzeichnis existiert nicht "+path)
    for envdir in os.listdir(path):
        if not os.path.isdir(os.path.join(path, envdir)):
            continue
        if envdir[0:1] == "_":
            continue
        try:
            pathname = tools.config_tool.select_config_path(job, P.KEY_TOOL, "conn", envdir)
            doc = tools.file_tool.read_file_dict(job, pathname, job.m)
            for proj in doc[B.SUBJECT_ENV][B.CONF_NODE_GENERAL][B.SUBJECT_PROJECTS]:
                if proj in projectList:
                    environments[envdir] = doc[B.SUBJECT_ENV][B.CONF_NODE_GENERAL]
                elif len(projectList) == 1 and projectList[0] == "ALL":
                    environments[envdir] = doc[B.SUBJECT_ENV][B.CONF_NODE_GENERAL]
        except:
            continue
    return environments


class Environment(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
        if project != "":
            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
        """
        path = os.path.join(job.conf[B.SUBJECT_PATH][B.ATTR_PATH_ENV])
        outList = self.getDirlist(job, path, "")
        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_ENV, name, tools.config_tool.get_plain_filename(job, name))
        return self.setAttributes(config, name, LIST_FIELDS, LIST_SUBTABLES)