#!/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
* program - configuration for general technical variables in tools - stored in internal conf - folder
it represents the general knowledge of this test - automatism
* basic - configuration for global variables in job - stored in external conf - folder
it represents the knowledge of your test - topic
* 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
it represents the application - knowledge and the knowledge of the application - installation
* test - specification with testdata - stored in external testdata - folder
* the internal datastructure
"""
PAR_APP = ' application '
""" definition of the application which will be tested """
PAR_ENV = ' environment '
""" definition of the environment where the application runs which will be tested """
PAR_REL = ' release '
""" definition of the release of the application which will be tested """
PAR_TSDIR = ' tsdir '
""" definition of the directory of the testsuite for summaries of the testcases """
PAR_TCDIR = ' tcdir '
""" definition of the directory of the testcase for logs and results """
PAR_XPDIR = ' xpdir '
""" definition of the directory of expectation for comparing the testcase """
PAR_TDTYP = ' tdtyp '
PAR_TDSRC = ' tdsrc '
PAR_TDNAME = ' tdname '
PAR_LOG = ' loglevel '
PAR_MODUS = ' modus '
PAR_COMP = ' component '
PAR_FCT = ' function '
PAR_TOOL = ' tool '
PAR_TESTCASE = " testcase "
""" name of testcase extracted from PAR_TCDIR """
# 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 """
DATA_NODE_COMP = " comp "
""" This constant defines """
DATA_NODE_PAR = " par "
""" This constant defines """
TOPIC_NODE_DB = " db "
ATTR_DB_PARTITION = " partitioned "
""" attribute if table is partitioned - partitions are parametrized """
ATTR_DB_CONN_JAR = " conn_jar_name "
""" attribute for connection-jar-file instead of connection by ip, port """
ATTR_DB_TABNAME = " tabname "
""" attribute in order to use a different technical name for the db-table """
PAR_DB_WHERE = " dbwhere "
""" optional parameter with a where-clause """
PAR_DB_PARTITION = " dbparts "
""" optional parameter for partitions of a partitioned tables """
TOPIC_NODE_CLI = " cli "
TOPIC_NODE_API = " api "
# 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 folder in testing-filesystem for results and log of execution """
ATTR_PATH_EXPECT = " expect "
""" This constant defines the folder in testing-filesystem for test-expectation values """
ATTR_PATH_PROGRAM = " program "
""" This constant defines the program-folder in the workspace """
ATTR_PATH_ENV = " environment "
""" This constant defines the folder in testing-filesystem, used for configs related to environments """
ATTR_PATH_RELEASE = " release "
""" This constant defines the folder in testing-filesystem, used for configs related to release """
ATTR_PATH_TDATA = " testdata "
""" This constant defines the 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_INST_CNT = " count " # | | | | x | CompHanlding
ATTR_INST_SGL = " single "
ATTR_INST_SUBCOMP = " components "
SUBJECT_FCT = " function " # | | | | x | main-programs
SUBJECT_ARTS = " artifact " # | | | | x | Component
"""
in this subject - node are each kind of result of any component with the structure :
* topic ( db , cli , api , . . . )
* * general attributes - to - know : technical attributes are stored in connection - tree
* * partial - component - to - know : the existence of db - tables can be defined in the ddl - tree
* * * specific attributes - it overrides the general attributes
"""
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_TYPE = " type " # | x | x | | x | conn_tool, toolHandling, db*_tools
RULE_ACCEPTANCE = " acceptance " # | | | | x | tools_match
ATTR_STEP_ARGS = " args "
ATTR_DATA_REF = " _nr "
