class ProcessManager(object):
r"""
valf internal class to provide essential processing for observers
- initialize
- start logger
- initialize data_manager
- search classes based on class BaseComponentInterface
- load configuration
- import declared observer modules
- set data ports
- run validation
- call all methods of all observers sequentially
- use bpl_reader or similar to run through all recordings
This class also is responsible to read out configuration and interpretation from config file.
general used ports on bus ``Global``:
- set "ConfigFileVersions"
dict with file name as key and version as value for each loaded config file
- read "FileCount"
to show progress bar
- read "IsFinished"
to continue with next state when all sections of a recording are validated (set by `SignalExtractor`)
Also setting ports as defined in ``InputData`` for the named bus.
"""
def __init__(self, plugin_dir, fail_on_error=False):
"""init essencials
:param plugin_dir: path or list of paths where to start search for observers
:type plugin_dir: string or list of strings
:param fail_on_error: flag to break immediately if an exception is found
:type fail_on_error: boolean
"""
self._logger = Logger(self.__class__.__name__)
self._logger.debug()
self._component_list = []
self._version = "$Revision: 1.11 $"
self._progressbar = None
self._file_count = 0
self._object_map_list = []
self._config_file_loaded = False
self._fail_on_error = fail_on_error
self._configfiles = [] # used as stack to load configs recursively
self._config_file_versions = {}
self._uncrepl = UncRepl()
plugin_dir.extend([
self._uncrepl(dir_) for dir_ in OBS_DIRS if dir_ not in plugin_dir
])
self._logger.info("Searching for plug-ins. Please wait...")
class_map_list, self._plugin_error_list = find_class(
bci, plugin_dir, with_error_list=True)
if class_map_list is None:
self._logger.error("No plug-ins found.")
return
self._logger.debug("%d plug-ins found: %s." %
(len(class_map_list), ", ".join(
[i['name'] for i in class_map_list])))
self._plugin_map = {
plugin['name']: plugin["type"]
for plugin in class_map_list
}
# Create data manager object
try:
self._data_manager = DataManager()
except:
self._logger.exception("Couldn't instantiate 'DataManager' class.")
if self._fail_on_error:
raise
sexit(bci.RET_VAL_ERROR)
def _initialize(self):
"""calls initialize and post_initialize of ordered observers
"""
self._logger.debug()
# Calls Initialize for each component in the list
for component in self._component_list:
try:
if component.Initialize() != bci.RET_VAL_OK:
self._logger.error(
"Class '%s' returned with error from Initialize() method."
% component.__class__.__name__)
return bci.RET_VAL_ERROR
except:
self._logger.exception(
'EXCEPTION during Initialize of %s:\n%s' %
(component.__class__.__name__, format_exc()))
if self._fail_on_error:
raise
return bci.RET_VAL_ERROR
# Calls PostInitialize for each component in the list
for component in self._component_list:
try:
if component.PostInitialize() != bci.RET_VAL_OK:
self._logger.error(
"Class '%s' returned with error from PostInitialize() method."
% component.__class__.__name__)
return bci.RET_VAL_ERROR
except:
self._logger.exception(
'EXCEPTION during PostInitialize of %s:\n%s' %
(component.__class__.__name__, format_exc()))
if self._fail_on_error:
raise
return bci.RET_VAL_ERROR
self._file_count = self.get_data_port("FileCount")
if self._file_count > 0:
self._progressbar = ProgressBar(0,
self._file_count,
multiline=True)
else:
self._file_count = 0
self._logger.debug("all components ready to run!")
self._logger.mem_usage()
return bci.RET_VAL_OK
def _process_data(self):
"""calls load_data, process_data as well as post_process_data of ordered observers
"""
self._logger.debug()
if self._file_count == 0:
self._logger.debug(
str(_getframe().f_code.co_name) + "No files to process.")
return RET_VAL_OK
ret = bci.RET_VAL_ERROR
counter = 0
while not self.get_data_port("IsFinished"):
# update progressbar position
self._progressbar(counter)
counter += 1
# Calls LoadData for each component in the list
for component in self._component_list:
try:
ret = component.LoadData()
if ret is bci.RET_VAL_ERROR:
self._logger.error(
"Class '%s' returned with error from LoadData() method, "
"continue with next sim file." %
component.__class__.__name__)
break
except:
self._logger.exception(
'exception raised during LoadData of %s:\n%s, '
'continue with next sim file.' %
(component.__class__.__name__, format_exc()))
ret = bci.RET_VAL_ERROR
if self._fail_on_error:
raise
break
if ret is bci.RET_VAL_ERROR:
continue
# Calls ProcessData for each component in the list
for component in self._component_list:
try:
ret = component.ProcessData()
if ret is bci.RET_VAL_ERROR:
self._logger.error(
"Class '%s' returned with error from ProcessData() method, "
"continue with next sim file." %
component.__class__.__name__)
break
except:
self._logger.exception(
'EXCEPTION during ProcessData of %s:\n%s, '
'continue with next sim file.' %
(component.__class__.__name__, format_exc()))
ret = bci.RET_VAL_ERROR
if self._fail_on_error:
raise
break
if ret is bci.RET_VAL_ERROR:
continue
# Calls PostProcessData for each component in the list
for component in self._component_list:
try:
ret = component.PostProcessData()
if ret is bci.RET_VAL_ERROR:
self._logger.error(
"Class '%s' returned with error from PostProcessData() method, "
"continue with next sim file." %
component.__class__.__name__)
break
except:
self._logger.exception(
'EXCEPTION during PostProcessData of %s:\n%s, '
'continue with next sim file.' %
(component.__class__.__name__, format_exc()))
ret = bci.RET_VAL_ERROR
if self._fail_on_error:
raise
break
if ret is bci.RET_VAL_ERROR:
continue
# we have processed correctly at least a file,
# set _process_data return value to OK in order to finish it's process
self._logger.mem_usage()
ret = bci.RET_VAL_OK
if counter > 0:
self._progressbar(counter)
return ret
def _terminate(self):
"""calls pre_terminate and terminate of ordered observers
"""
self._logger.debug()
# Calls PreTerminate for each component in the list
for component in self._component_list:
try:
if component.PreTerminate() != bci.RET_VAL_OK:
self._logger.error(
"Class '%s' returned with error from PreTerminate() method."
% component.__class__.__name__)
return bci.RET_VAL_ERROR
except Exception:
self._logger.exception(
'EXCEPTION during PreTerminate of observer %s:\n%s' %
(component.__class__.__name__, format_exc()))
if self._fail_on_error:
raise
return bci.RET_VAL_ERROR
# Calls Terminate for each component in the list
for component in self._component_list:
try:
if component.Terminate() != bci.RET_VAL_OK:
self._logger.exception(
"Class '%s' returned with error from Terminate() method."
% component.__class__.__name__)
return bci.RET_VAL_ERROR
except:
self._logger.exception(
'EXCEPTION during Terminate of observer %s:\n%s' %
(component.__class__.__name__, format_exc()))
if self._fail_on_error:
raise
return bci.RET_VAL_ERROR
return bci.RET_VAL_OK
def get_data_port(self, port_name, bus_name="Global"):
"""gets data from a bus/port
:param port_name: port name to use
:param bus_name: bus name to use
:return: data from bus/port
"""
return self._data_manager.get_data_port(port_name, bus_name)
def set_data_port(self, port_name, port_value, bus_name="Global"):
"""sets data to a bus/port
:param port_name: port name to use
:param port_value: data value to be set
:param bus_name: bus name to use
:return: data from bus/port
"""
self._data_manager.set_data_port(port_name, port_value, bus_name)
def _get_err_trace(self):
"""returns error trace from error list
"""
if self._plugin_error_list:
err_trace = '\n'.join('++ file: {0}.py -- {1}\n'.format(
e[0], e[1].replace('\n', '\n--> '))
for e in self._plugin_error_list)
else:
err_trace = 'no detailed info about failure'
return err_trace
def load_configuration(self, configfile):
"""loads configuration from cfg-file
see more details in `Valf.LoadConfig`
:param configfile: path/to/file.cfg
:return: success (bool)
"""
configfile = self._uncrepl(configfile)
cls_obj = None
if not opath.exists(configfile):
raise ValfError(
"Configuration file '%s' doesn't exist or is invalid." %
configfile)
# self._logger.error("Configuration file '%s' doesn't exist or is invalid." % configfile)
# return False
self.set_data_port(CFG_FILE_VERSION_PORT_NAME,
self._config_file_versions)
autoorder = [-1]
component_map = self._read_config(configfile)
self._logger.info(
"loading version: '%s' of config file '%s'" %
(self._config_file_versions.get(configfile, ""), configfile))
for componentname in component_map:
try: # retrieve details
class_name = eval(component_map[componentname].get(
"ClassName", "None"))
# port_in_list = component_map[componentname].get("PortIn")
port_out_list = eval(component_map[componentname].get(
"PortOut", "[]"))
input_data_list = eval(component_map[componentname].get(
"InputData", "[]"))
connect_bus_list = eval(component_map[componentname].get(
"ConnectBus", "Bus#1"))
order = component_map[componentname].get(
"Order",
max(autoorder) + 1)
if order in autoorder:
self._logger.info(
"order %d for component %s already in use!" %
(order, componentname))
autoorder.append(order)
# check them, they should be there all!
if (componentname != "Global" and
(class_name is None or port_out_list is None
or input_data_list is None or connect_bus_list is None)):
msg = "Invalid port value or syntax wrong on component: '%s' with parsed settings\n" \
"ClassName: %s, PortOut: %s,\n" \
"InputData: %s, \n" \
"ConnectBus: %s\n"\
" only ClassName for 'Global' can be None, compare parsed settings with defines in config." \
% (componentname, class_name, port_out_list, input_data_list, connect_bus_list)
raise ValueError(msg)
except Exception, err:
self._logger.error(err)
if self._fail_on_error:
raise
continue
if type(connect_bus_list) not in (list, tuple):
connect_bus_list = [connect_bus_list]
if class_name in self._plugin_map:
# Observer can be loaded -> Everything fine.
# self._logger.debug("Loading plug-in: '%s'." % componentname)
cls_obj = self._plugin_map[class_name](self._data_manager,
componentname,
connect_bus_list)
elif componentname != "Global":
# Observer can NOT be loaded -> Create Log Entry and raise Exception !
err_trace = self._get_err_trace()
# Create Log Entry
self._logger.error('some python modules have coding errors')
self._logger.error(
'Please check following list for more details:')
self._logger.error(err_trace)
msg = "Observer with ClassName %s not found, please check log for more info!" % class_name
self._logger.error(msg)
self._logger.error("File: \"valf.log\"")
raise ValfError(msg, ValfError.ERR_OBSERVER_CLASS_NOT_FOUND)
for port_out in port_out_list:
for bus_name in connect_bus_list:
tmp = "Register port: Provider="
tmp += "'%s', PortName='%s', Bus='%s'." % (
componentname, port_out, bus_name)
self._logger.debug(tmp)
self.set_data_port(port_out, None, bus_name)
if type(input_data_list) == list: # do it the usual way
for input_data in input_data_list:
param_name = input_data[0]
param_value = input_data[1]
for bus_name in connect_bus_list:
tmp = "Setting input data.[Component='%s', " % componentname
tmp += "Bus='%s', PortName='%s', " % (bus_name,
param_name)
tmp += "PortValue=%s]" % str(param_value)
self._logger.debug(tmp)
self.set_data_port(param_name, param_value, bus_name)
elif type(input_data_list
) == dict: # we've got key value pairs already
for param_name, param_value in input_data_list.iteritems():
for bus_name in connect_bus_list:
tmp = "Setting input data.[Component='%s', " % componentname
tmp += "Bus='%s', PortName='%s', " % (bus_name,
param_name)
tmp += "PortValue=%s]" % str(param_value)
self._logger.debug(tmp)
self.set_data_port(param_name, param_value, bus_name)
if componentname != "Global":
self._object_map_list.append({
"Order": order,
"ComponentName": componentname,
"ClsObj": cls_obj
})
# If whole Observer loading is done successfully,
# we write anyway all found coding errors into the Log File as warnings
if self._plugin_error_list:
err_trace = self._get_err_trace()
self._logger.warning('some python modules have coding errors')
self._logger.warning(
'Please check following list for more details:')
self._logger.warning(err_trace)
self._component_list = []
if len(self._object_map_list):
self._object_map_list.sort(key=lambda x: x["Order"])
for object_map in self._object_map_list:
self._component_list.append(object_map["ClsObj"])
if not self._component_list:
self._logger.error(
"No component loaded. Please check config file '%s'." %
str(configfile))
return False
self._config_file_loaded = True
return True
class Valf(object):
"""
class defining methods to easily start validation suites
by calling a python script without additional option settings (double click in win)
mandatory settings:
- outputpath (as instantiation parameter)
- config file with `LoadConfig`
- sw version of sw under test with `SetSwVersion`
see `__init__` for additional options
returns error level::
RET_VAL_OK = 0 suite returned without error
RET_GEN_ERROR = -1 general error
RET_SYS_EXIT = -2 sys.exit called
RET_CFG_ERROR = -3 error in direct settings or configuration file
**Example:**
.. python::
# Import valf module
from stk.valf import valf
# set output path for logging ect., logging level and directory of plugins (if not subdir of current HEADDIR):
vsuite = valf.Valf(getenv('HPCTaskDataFolder'), 10) # logging level DEBUG, default level: INFO
# mandatory: set config file and version of sw under test
vsuite.LoadConfig(r'demo\\cfg\\bpl_demo.cfg')
vsuite.SetSwVersion('AL_STK_V02.00.06')
# additional defines not already set in config files or to be overwritten:
vsuite.SetBplFile(r'cfg\\bpl.ini')
vsuite.SetSimPath(r'\\\\Lifs010.cw01.contiwan.com\\data\\MFC310\\SOD_Development')
# start validation:
vsuite.Run()
:author: Joachim Hospes
:date: 29.05.2013
"""
def __init__(self, outpath, *args, **kwargs):
"""
initialise all needed variables and settings
- creates/cleans output folder
- start process manager
- start logging of all events, therefore the output path must be given
:param outpath: path to output directory, can be relative to calling script
:type outpath: str
:param args: additional argument list which are also covered by keywords in order of occurrence
:keyword logging_level: level of details to be displayed. default: info
(10=debug, 20=info, 30=warning, 40=error, 50=critical, 60=exception)
:type logging_level: int [10|20|30|40|50]
:keyword plugin_search_path: default: parent dir of stk folder, normally parallel to validation scripts
:type plugin_search_path: str
:keyword clean_folder: default ``True``, set to ``False`` if the files in output folder should not be deleted
during instantiation of Valf
:type clean_folder: bool
:keyword logger_name: name of logger is used for logfile name and printed in log file as base name,
if not set name/filename of calling function/module is used
:type logger_name: str
:keyword fail_on_error: Switch to control exception behaviour, if set
exceptions will be re-thrown rather than omitted or logged.
:type fail_on_error: bool
:keyword deprecations: set me to False to remove any deprecation warning outputs inside log
:type deprecations: bool
"""
self.__version = "$Revision: 1.6 $"
self._uncrepl = UncRepl()
self.__data_bus_names = [
] # store all names of generated data busses like bus#0
self.__process_mgr = None
opts = arg_trans(
[['logging_level', INFO], ['plugin_search_path', None],
['clean_folder', True], ['logger_name', None],
['fail_on_error', False], ['deprecations', True]], *args,
**kwargs)
self._fail_on_error = opts['fail_on_error']
# prep output directory: create or clear content
outpath = self._uncrepl(opath.abspath(outpath))
clear_folder(outpath, opts['clean_folder'])
logger_name = opts['logger_name']
if logger_name is None:
# get name of calling module
frm = currentframe().f_back # : disable=W0212
if frm.f_code.co_filename:
logger_name = opath.splitext(
opath.basename(frm.f_code.co_filename))[0]
else:
logger_name = 'Valf'
# start logger, first with default level, idea for extension: can be changed later
self.__logger = Logger(logger_name,
opts['logging_level'],
filename=opath.join(outpath,
logger_name + ".log"))
self.__logger.info("Validation started at %s." %
strftime('%H:%M:%S', localtime(time())))
self.__logger.info("Validation based on %s STK %s-%s of %s, CP: %s." %
("original" if stk_checksum(True) else "adapted",
RELEASE, INTVERS, RELDATE, MKS_CP))
self.__logger.info("Logging level is set to %s." % next(
i
for i, k in LEVEL_CALL_MAP.items() if k == opts['logging_level']))
self.__logger.info("Validation arguments have been:")
for k, v in opts.iteritems():
self.__logger.info(" %s: %s" % (k, str(v)))
if not opts['deprecations']:
self.__logger.warning(
"Deprecation warnings have been switched off!")
DeprecationUsage().status = False
# find all observers down current path
plugin_search_path = opts['plugin_search_path']
plugin_folder_list = []
if plugin_search_path is None:
plugin_search_path = [HEAD_DIR]
# take care of fast connections
plugin_search_path = [self._uncrepl(i) for i in plugin_search_path]
for spath in plugin_search_path:
plugin_folder_list.extend([
dirPath for dirPath in list_folders(spath)
if "\\stk\\" not in dirPath
])
# left over from testing??? found in vers.1.14, introduced in 1.6
# else:
# print folder_path
self.__logger.info('added to plugin search path:' + spath)
# and add all observers down calling script's path
stk_plugins = [
opath.join(HEAD_DIR, "stk", "valf"),
opath.join(HEAD_DIR, "stk", "valf", "obs"),
opath.join(HEAD_DIR, "stk", "val")
]
plugin_folder_list.extend(plugin_search_path)
for spath in stk_plugins:
plugin_folder_list.append(spath)
self.__logger.debug('added to plugin search path:' + spath)
# start process manager
try:
self.__process_mgr = ProcessManager(plugin_folder_list,
self._fail_on_error)
except: # pylint: disable=W0702
self.__logger.exception(
"Couldn't instantiate 'ProcessManager' class.")
if self._fail_on_error:
raise
sys.exit(RET_GEN_ERROR)
self.__process_mgr.set_data_port(OUTPUTDIRPATH_PORT_NAME, outpath)
self.__logger.debug("OutputDirPath: '%s'" % outpath)
# set still needed default settings as have been in valf.main
self.SetMasterDbPrefix(DEFAULT_MASTER_SCHEMA_PREFIX)
self.SetErrorTolerance(ERROR_TOLERANCE_NONE)
# should be activated some day, for now not all validation suites can be parallelised
# if set on default we should invent a method DeactivateHpcAutoSplit to run the remaining or old suites
# self.SetDataPort("HpcAutoSplit", True, "Global")
def _check_mandatory_settings(self):
""" private method
check if additional mandatory settings are done
does not run complete sanity check for config, here we just check additional mandatory settings
that do not prevent the validation to run if they are missing
e.g. no test if db connection is defined for cat reader, if not set cat reader will stop the initialisation
:return: number of missing settings, 0 if settings completed
:rtype: integer
"""
error_cnt = 0
if self.GetDataPort("SWVersion", "Global") is None:
self.__logger.error("version of test sw not defined!")
error_cnt += 1
if (self.GetDataPort("HpcAutoSplit", "Global") is True
and self.GetDataPort("SimSelection", "Global") is not None):
self.__logger.error(
"DataPort 'SimSelection' used by HPC, not available if 'HpcAutoSplit' is active!"
)
self.__logger.error(
"Set either 'HpcAutoSplit' to False or don't set 'SimSelection'!"
)
error_cnt += 1
return error_cnt
def _set_hpc_selection(self):
""" private method
if the start script is running as HPC task on an HPC machine then
set SimSelection to use only the entry given by the task number.
e.g. for HPC task003: set SimSelection to [2]
"""
# check HPC usage
if self.GetDataPort("HpcAutoSplit", "Global") is True:
task_name = getenv("TaskName")
try:
# T0000x task ids start with 1, bpl list index with 0
task_id = int(match(r'T(\d+)', str(task_name)).group(1)) - 1
except AttributeError:
self.__logger.exception(
"can't set Hpc Auto Split value as HPC environment variable Task Id"
" is empty or not valid: %s" % task_name)
if self._fail_on_error:
raise
sys.exit(RET_CFG_ERROR)
self.__logger.info(
"HpcAutoSplit: using entry %d of the sim collection" % task_id)
self.SetDataPort("SimSelection", "[%d]" % task_id, "Global")
def LoadConfig(self, filepath): # pylint: disable=C0103
"""
load configuration from path/filename, path can be relative to calling script
Valid configuration properties are:
- version: string defining version of config file, added to dict on port "ConfigFileVersions"
- ClassName: quoted string to determine observer class to include in run (not in section "Global")
- PortOut: list of port values (quoted strings) which should be exported to given bus name
- InputData: pythonic list of tuples/lists which are taken and given as input for observer to be configured
- ConnectBus: list of bus names to connect / register observer to (first one is taken actually)
- Active: True/False value weather observer should be enabled or not
- include: file (quoted) to include herein, chapter should be repeated there,
if include is used within global scope, all chapters from included file are used
config file example::
# valf_basic.cfg
# config for testing Valf class, based on valf_demo settings,
[Global]
; version string will be added to dict on port "ConfigFileVersions":
version="$Revision: 1.6 $"
;PortOut: Informs the name of the port that are set by the component
PortOut=["ProjectName", "SWVersion", "FunctionName", "Device_Prefix"]
;InputData: Declares all input parameters
InputData=[('ProjectName', 'VALF-test'),
('FunctionName', 'STK_moduletest'),
('SimName', 'N/A'),
('Multiprocess', True ),
('ValName', 'N/A')]
;ConnectBus: Specifies the bus connect to the component
ConnectBus=["Global"]
; db connection is needed for the catalog reader only, **deactivated** here!!
; connection parameters passed to validation_main.py as options because it will differ for projects
[DBConnector]
ClassName="DBConnector"
InputData=[("UseAllConnections", "True")]
PortOut=[ "DataBaseObjects"]
ConnectBus=["DBBus#1"]
Active=False
;Order: Specifies the calling order
Order=0
; bpl reader can be used to read simulation results, but in future the cat_reader should be used
; to test the difference switch Activate setting for BPLReader and CATReader
[VALF_BPL_test]
ClassName="BPLReader"
PortOut=["CurrentMeasFile", "CurrentSimFile"]
InputData=[("SimFileExt", "bin")]
ConnectBus=["bus#1"]
; read additional config file data for this section, can overwrite complete setting before
; so e.g. InputData needs to list all input values,
; the values from include-cfg are not added but replace former set!
Include="..\..\..\04_Test_Data\01a_Input\valf\valf_include_VALF_BPL_test.cfg"
Active=True
;Order: Specifies the calling order
Order=1
; cat reader needs db connector to setup connection to catalog db!
[VALF_CAT_REF]
ClassName="CATReader"
PortOut=[ "CurrentMeasFile", "CurrentSimFile"]
InputData=[("SimFileExt", "bsig"),("SimFileBaseName", "") ]
ConnectBus=["Bus#1"]
Active=False
Order=1
general used ports on bus ``Global`` (set by `ProjectManager`):
- set "ConfigFileVersions"
dict with file name as key and version as value for each loaded config file
- read "FileCount"
to show progress bar
- read "IsFinished"
to continue with next state when all sections of a recording are validated (set by `SignalExtractor`)
Also setting ports as defined in ``InputData`` for the named bus.
usage (example):
.. python::
from stk.valf import Valf
vrun = stk.valf.Valf()
vrun.load_config(r'conf/validation.cfg')
:param filepath: path and filename of the config file to load
:type filepath: string
"""
absfile = self._uncrepl(opath.abspath(filepath))
# preset of port ConfigFileName currently not supported!!! what was it used for??
# config_filename = self.__process_mgr.get_data_port(CFG_FILE_PORT_NAME)
# if config_filename is None:
# config_filename = absfile
# else:
# config_filename += ', ' + absfile
self.__process_mgr.set_data_port(CFG_FILE_PORT_NAME, absfile)
if self.__logger is not None:
self.__logger.info("Using configuration file: '%s'" % absfile)
try:
if not self.__process_mgr.load_configuration(absfile):
sys.exit(RET_CFG_ERROR)
except ValfError:
msg = 'Validation error during configuration load'
if self.__process_mgr.last_config is not None:
msg += (" (%s)" % self.__process_mgr.last_config)
self.__logger.exception(msg)
if self._fail_on_error:
raise
sys.exit(RET_SYS_EXIT)
except SystemExit:
msg = 'system exit by one module during configuration load'
if self.__process_mgr.last_config is not None:
msg += (" (%s)" % self.__process_mgr.last_config)
self.__logger.exception(msg)
self.__logger.error(msg)
if self._fail_on_error:
raise
sys.exit(RET_SYS_EXIT)
except:
msg = "unexpected error (%s) during configuration load" % str(
sys.exc_info)
if self.__process_mgr.last_config is not None:
msg += (" (%s)" % self.__process_mgr.last_config)
self.__logger.exception(msg)
self.__logger.exception(msg)
if self._fail_on_error:
raise
sys.exit(RET_GEN_ERROR)
def SetBplFile(self, filepath): # pylint: disable=C0103
"""
set data port ``BplFilePath`` to path/filename of bpl file (.ini or .bpl)
path can be relative to starting script, checks existence of file and stops in case of errors
:param filepath: path/filename of batch play list
:type filepath: string
"""
absfilepath = self._uncrepl(opath.abspath(filepath))
self.__logger.debug("BplFilePath: '%s'" % absfilepath)
if filepath is not None and opath.isfile(absfilepath):
self.__process_mgr.set_data_port(PLAY_LIST_FILE_PORT_NAME,
absfilepath)
else:
self.__logger.error(
"Missing mts batch play list: can not open bpl file '%s'" %
absfilepath)
sys.exit(RET_CFG_ERROR)
def SetCollectionName(self, collection_name): # pylint: disable=C0103
"""
set data port ``RecCatCollectionName`` giving the collection name of rec files in catalog db
used by the cat reader to select the recording list for a project
:param collection_name: name of the collection
:type collection_name: string
"""
self.__process_mgr.set_data_port(COLLECTION_NAME_PORT_NAME,
collection_name)
self.__logger.debug("Rec file cataloge collection name is: '%s'" %
collection_name)
def SetDataPort(self, port_name, value, bus_name='Global'): # pylint: disable=C0103
"""
set named valf data port at named bus with given value,
can be repeated for different ports and bus names
in general these ports should be set using the config file ``InputData`` entry!
:param port_name: valf data port name, not case sensitiv
:type port_name: string
:param value: port value, type depends on port usage
:type value: user defined
:param bus_name: valf data bus name, default: ``Global``, not case sensitiv
:type bus_name: string
"""
self.__process_mgr.set_data_port(port_name, value, bus_name)
self.__logger.debug('valf script setting port "%s" :' % port_name +
str(value))
def SetDbFile(self, filepath): # pylint: disable=C0103
"""
set data port ``dbfile`` to define name of sqlite data base file to be used instead of oracle db
checks existence of the file and raises an error if it's not readable
:param filepath: path/name of the database file
:type filepath: string
"""
database_filename = self._uncrepl(opath.abspath(filepath))
if not opath.exists(database_filename):
self.__logger.error("defined db file '%s' not found" %
database_filename)
sys.exit(RET_CFG_ERROR)
self.__process_mgr.set_data_port(DB_FILE_PORT_NAME, database_filename,
'DBBus#1')
def SetErrorTolerance(self, tolerance): # pylint: disable=C0103
"""
set data port ``ErrorTolerance`` to a value as defined in `db_commmon`
:param tolerance: error tolerance value
:type tolerance: integer
"""
self.__process_mgr.set_data_port(ERROR_TOLERANCE_PORT_NAME, tolerance,
"Bus#1")
@deprecated()
def SetMasterDbDbq(self, dbq): # pylint: disable=C0103
"""
set data port "masterdbdbq" (name defined in `valf.db_connector`) to given name
default value defined in db.db_common by DEFAULT_MASTER_DBQ
:param dbq: data base qualifier for oracle data bases
:type dbq: string
:note: don't use together with DSN setting
"""
self.__process_mgr.set_data_port(MASTER_DB_DBQ_PORT_NAME, dbq,
"DBBus#1")
@deprecated()
def SetMasterDbDsn(self, dsn): # pylint: disable=C0103
"""
set data port ``masterdbdsn`` (name defined in `valf.db_connector`) to given name
default value defined in db.db_common by DEFAULT_MASTER_DSN
:param dsn: data source name for odbc interface connections
:type dsn: string
:note: don't use together with DBQ setting
"""
self.__process_mgr.set_data_port(MASTER_DB_DSN_PORT_NAME, dsn,
"DBBus#1")
def SetMasterDbUser(self, user): # pylint: disable=C0103
"""
set data port ``masterdbuser`` (name defined in `valf.db_connector`) to given name
:param user: name of data base user
:type user: string
"""
self.__process_mgr.set_data_port(MASTER_DB_USR_PORT_NAME, user,
"DBBus#1")
def SetMasterDbPwd(self, passwd): # pylint: disable=C0103
"""
set data port ``masterdbpassword`` (name defined in `valf.db_connector`) to given name
:param passwd: password for data base user
:type passwd: string
"""
self.__process_mgr.set_data_port(MASTER_DB_PW_PORT_NAME, passwd,
"DBBus#1")
def SetMasterDbPrefix(self, prefix): # pylint: disable=C0103
"""
set data port ``masterdbschemaprefix`` (name defined in `valf.db_connector`) to given name
:param prefix: schema prefix for data base table
:type prefix: string
"""
self.__process_mgr.set_data_port(MASTER_DB_SPX_PORT_NAME, prefix,
"DBBus#1")
def SetSimPath(self, pathname, bus_name="Bus#1"): # pylint: disable=C0103
"""
set data port ``SimOutputPath`` at named bus (default:``Bus#0``) to given path
where measurement files are stored
checks if path exists and raises an `ValfError` if not
for historical reasons the bus_name is set as default to ``bus#0``
make sure your config sets the similar busses for bpl/cat reader(s)!
:param pathname: absolute path where simulation result files are stored
:type pathname: string
:param bus_name: data bus name of the bpl/cat reader, default ``bus#0``, not case sensitiv
:type bus_name: string
"""
pathname = self._uncrepl(pathname)
if opath.exists(pathname):
self.__process_mgr.set_data_port(SIM_PATH_PORT_NAME, pathname,
bus_name)
self.__logger.debug(
"Setting input data. [ Bus='{0}', "
"PortName='SimOutputPath', PortValue={1}]".format(
bus_name, pathname))
if bus_name not in self.__data_bus_names:
self.__data_bus_names.append(bus_name)
self.__process_mgr.set_data_port(DATA_BUS_NAMES,
self.__data_bus_names)
else:
exception_msg = "Sim Output folder providing bsig/csv files does not exist:\n" +\
"{}\nPlease check your setup".format(pathname)
self.__logger.exception(exception_msg)
raise ValfError(exception_msg)
def SetSwVersion(self, version): # pylint: disable=C0103
"""
set data port ``SWVersion`` to given value
currently mandatory setting!!
:param version: sw version of sw under test
:type version: string
"""
self.__process_mgr.set_data_port(SWVERSION_PORT_NAME, version)
def SetRefSwVersion(self, version): # pylint: disable=C0103
"""
set data port ``SWVersion_REG`` to given value (optional)
:param version: sw version of regression sw under test
:type version: string
"""
self.__process_mgr.set_data_port(SWVERSION_REG_PORT_NAME, version)
def SetSaveResults(self, saveit=True): # pylint: disable=C0103
"""
set data port ``SaveResultInDB`` to given value (optional)
:param saveit: Save the results into the database, default = True
:type saveit: boolean
"""
self.__process_mgr.set_data_port(SAVE_RESULT_IN_DB, saveit)
def GetDataPort(self, port_name, bus_name='Global'): # pylint: disable=C0103
"""
get named valf data port at named bus,
can be repeated for different ports and bus names
:param port_name: valf data port name, not case sensitiv
:type port_name: string
:param bus_name: valf data bus name, default: ``Global``, not case sensitiv
:type bus_name: string
:return: port data
:rtype: undefined
"""
return self.__process_mgr.get_data_port(port_name, bus_name)
def ActivateHpcAutoSplit(self): # pylint: disable=C0103
r"""
activate auto splitting of bpl/cat list on HPC
Running on HPC a validation can run in parallel on several tasks. This method sets data port ``HpcAutoSplit``
to ``True`` so each validation suite running on one task/machine only reads the sim results of one recording::
bpl / cat list HPC TaskID
---------------------- ----------
recording_entry_0.rec T00001
recording_entry_1.rec T00002
recording_entry_2.rec T00003
... ...
**The tasks must be created during job submit,** this is not done by Valf!!
Example to create an own task for each bpl entry:
.. python::
# Create the Validation Tasks
reclist = bpl.Bpl(BPL_FILE).read()
task = hpc.TaskFactory(job)
for rec in reclist:
task.create_task(r"D:\data\%JobName%\1_Input\valf_tests\custom\demo\run_valf_demo_bpl.py")
"""
self.SetDataPort(HPC_AUTO_SPLIT_PORT_NAME, True, 'global')
def Run(self):
""" start the validation after all needed preparations
:return: success or error value during validation run
:rtype: error codes:
RET_VAL_OK = 0
RET_GEN_ERROR = -1
RET_SYS_EXIT = -2
RET_CFG_ERROR = -3
"""
if LooseVersion(sqlite_version) <= LooseVersion(MIN_SQLITE_VERSION):
self.__logger.error(
"error in setup: please update your sqlite3.dll!\n"
"Just call batch script listed on Validation wiki -> needed tools."
)
sys.exit(RET_CFG_ERROR)
if self._check_mandatory_settings() is not 0:
self.__logger.error("error in setup: mandatory settings missing")
sys.exit(RET_CFG_ERROR)
tstart = time()
self._set_hpc_selection()
try:
ret_val = self.__process_mgr.run()
except Exception:
self.__logger.exception("unexpected runtime error")
if self._fail_on_error:
raise
sys.exit(RET_GEN_ERROR)
if ret_val is not RET_VAL_OK:
self.__logger.error(
"runtime error in validation suite, error level %d" % ret_val)
self.__logger.info("Test duration(hh:mm:ss): " +
strftime('%H:%M:%S', gmtime(time() - tstart)))
self.__logger.info("Logging statistics: " + ", ".join([
"%s: %d" % (k, v)
for k, v in self.__logger.get_statistics().items() if v > 0
]))
print('val run ended with result', ret_val)
return ret_val