buildtest.config

Module Contents

Functions

check_settings(settings_path=None, executor_check=True)

Checks all keys in configuration file (settings/config.yml) are valid

load_settings(settings_path=None)

Load the default settings file if no argument is specified.

validate_lsf_executors(lsf_executors)

validate_slurm_executors(slurm_executor)

This method will validate slurm executors, we check if partition, qos,

buildtest.config.check_settings(settings_path=None, executor_check=True)

Checks all keys in configuration file (settings/config.yml) are valid keys and ensure value of each key matches expected type . For some keys special logic is taken to ensure values are correct and directory path exists.

If any error is found buildtest will terminate immediately.

Parameters:

Parameters

settings_path (str, optional) – Path to buildtest settings file

Returns

returns gracefully if all checks passes otherwise terminate immediately

Return type

exit code 1 if checks failed

buildtest.config.load_settings(settings_path=None)

Load the default settings file if no argument is specified.

Parameters:

Parameters

settings_path (str, optional) – Path to buildtest settings file

buildtest.config.logger
buildtest.config.validate_lsf_executors(lsf_executors)
buildtest.config.validate_slurm_executors(slurm_executor)

This method will validate slurm executors, we check if partition, qos, and cluster fields are valid values by retrieving details from slurm configuration. These checks are performed if partition, qos or cluster field is specified in slurm executor section.

Parameters

slurm_executor – list of slurm executors defined in settings[‘executors][‘slurm’] dictionary, where settings is loaded buildtest setting