Module Contents



This class is an interface to buildtest configuration



class buildtest.config.SiteConfiguration(settings_file=None)[source]

This class is an interface to buildtest configuration

The initializer will declare class variables in its initial state and resolve path to configuration file. Once file is resolved we will load the configuration using load().


settings_file (str, optional) – path to buildtest configuration file

property file

Loads configuration file


This method will resolve path to configuration file. The order of precedence is as follows:

  1. command line argument via buildtest --config <path>

  2. User Configuration: $HOME/.buildtest/config.yml

  3. Default Configuration: $BUILDTEST_ROOT/buildtest/settings/config.yml


Return name of matched system from configuration file


This method detects which system configuration to use by checking target hostname with list of hostname entries defined in hostnames property. If there is a match we set self._name to map to system name and load the target configuration by setting self.target_config to the desired system configuration.

If no system is found we raise an exception.


ConfigurationError – If there is no matching system

validate(validate_executors=True, moduletool=None)[source]

This method validates the site configuration with schema and checks executor setting.

  • validate_executors (bool) – Check executor settings. This is the default behavior but can be disabled

  • moduletool (bool, optional) – Check whether module system (Lmod, environment-modules) match what is specified in configuration file. Valid options are Lmod, environment-modules


Validate executors


Check local executor by verifying the ‘shell’ types are valid


This method validates all LSF executors. We check if queue is available and in Open:Active state.


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 on fields partition, qos or cluster if specified in executor section.


Validate cobalt queue property by running `qstat -Ql <queue>. If its a non-zero exit code then queue doesn’t exist otherwise it is a valid queue.


Validate pbs queue property by running by checking if queue is found and queue is ‘enabled’ and ‘started’ which are two properties found in pbs queue configuration that can be retrieved using qstat -Q -f -F json. The output is in the following format

$ qstat -Q -f -F json
             "state_count":"Transit:0 Queued:0 Held:0 Waiting:0 Running:0 Exiting:0 Begun:0 ",