#!/usr/bin/python
# -*- coding: utf-8 -*-
# ---------------------------------------------------------------------------------------------------------
# Author : Ulrich Carmesin
# Source : gitea.ucarmesin.de
# ---------------------------------------------------------------------------------------------------------
"""
The constants desribes the keywords of the main datastructures, these are
* the configurations of
  * basic-configuration for global variables in job - stored in external conf-folder
  * comp-configuration for component-attributes  - stored in internal component-folder in
    + ddl-configuration of an entity of the component as attributes - stored in internal component-folder
    + environment-config for connection-attributes of the component - stored in external environment-folder
  * tool-configuration
  * test-specification with testdata - stored in external testdata-folder
* the internal datastructure

"""
# the internal datastructure is a tree with this design:
# root {                  : constant
# + option {              : constant
# + steps
# + comp {                : variable component-name
#   + substructure {      : variable maybe scheme, table of a database-component
#   + + _header    [      : constant
#       - fields          : variable field-name
DATA_NODE_HEADER = "_header"
""" This constant defines a subnode of a table for the column-names """
DATA_NODE_DATA   = "_data"
""" This constant defines a subnode of a table for the data which are set as key-value-pair with the column-names as key """
DATA_NODE_STEPS  = "_steps"
""" This constant defines the main node in the testdata for the steps to execute """
DATA_NODE_OPTION = "_option"
""" This constant defines main node in the testdata for testcase specific parameters """
DATA_NODE_DDL  = "ddl"
""" This constant defines """

# the configuration of a component or tool
# entity {              : variable name of the group, basic, component-name or tool-name
# + subject       {     : variable subject-name - it correspondends to a tool
# + + sub-subject {     : variable subject-name - it correspondends to a tool
#     + attributes      : constant of the tool in which the attribute ist implemented

# the main subjects            # prog basic envir tool comp testcase main implentation module
SUBJECT_PATH = "paths"         #     | x   |     | x  |    |         path_tool, config_tool
""" This constant defines the subject in order to define paths of filesystem of any testuse """
ATTR_PATH_MODE = "mode"
""" This constant defines the home-folder in filesystem of test """
ATTR_PATH_HOME = "home"
""" This constant defines the home-folder in testing-filesystem  """
ATTR_PATH_DEBUG = "debugs"
""" This constant defines the debug-folder in testing-filesystem  """
ATTR_PATH_ARCHIV = "archiv"
""" This constant defines the archiv-folder in testing-filesystem  """
ATTR_PATH_SPECIAL = "results"
""" This constant defines the debug-folder in testing-filesystem  """
ATTR_PATH_PROGRAM = "program"
""" This constant defines the program-folder in testing-filesystem  """
ATTR_PATH_ENV = "environment"
""" This constant defines the environment-folder in testing-filesystem, used for configs related to environments """
ATTR_PATH_RELEASE = "release"
""" This constant defines the release-folder in testing-filesystem, used for configs related to release """
ATTR_PATH_TDATA = "testdata"
""" This constant defines the testdata-folder in testing-filesystem with the testcase-specifications """
ATTR_PATH_PATTN = "pattern"
""" This constant defines the debug-folder in testing-filesystem  """
SUBJECT_APPS = "applications"  #     | x   |     |    |    |         CompHandling

SUBJECT_INST = "instance"      #     |     |     |    | x  |         CompHanlding
ATTR_COUNT   = "count"         #     |     |     |    | x  |         CompHanlding

SUBJECT_FCT  = "function"      #     |     |     |    | x  |         main-programs

SUBJECT_ARTS = "artifact"      #     |     |     |    | x  |         Component
ATTR_ARTS_DB = "db"
ATTR_ARTS_LOG = "log"
ATTR_ARTS_LOB = "lob"
SUBJECT_DB   = "databases"     #     |     |     |    | #  |         db*_tools, match_tool

SUBJECT_CONN = "conn"          #     |     | x   |    |    |         conn_tool, db*_tools, cli*_toold
ATTR_CONN_DBTYPE = "dbtype"    #     | x   | x   |    | x  |         conn_tool, toolHandling, db*_tools
ATTR_CONN_CLITYPE = "clitype"  #     | x   | x   |    | x  |         conn_tool, toolHandling, cli*_tools

RULE_ACCEPTANCE = "acceptance" #     |     |     |    | x  |         tools_match