buildtest.cli.config
¶
Module Contents¶
Functions¶
|
Entry point for |
|
This method implements command |
|
This method implements |
|
Display content of buildtest configuration file. This implements command |
|
Display executors from buildtest configuration. This implements |
|
This method implements |
- buildtest.cli.config.config_cmd(args, configuration)[source]¶
Entry point for
buildtest config
command. This method will invoke other methods depending on input argument.- Parameters
args (dict) – Parsed arguments from ArgumentParser.parse_args
configuration (buildtest.config.SiteConfiguration) – An instance of SiteConfiguration class
- buildtest.cli.config.view_system(configuration)[source]¶
This method implements command
buildtest config systems
which displays system details from configuration file in table format.- Parameters
configuration (buildtest.config.SiteConfiguration) – An instance of SiteConfiguration class
- buildtest.cli.config.validate_config(configuration)[source]¶
This method implements
buildtest config validate
which attempts to validate buildtest schema file settings.schema.json. If it’s not validate an exception is raised which could be jsonschema.exceptions.ValidationError orbuildtest.exceptions.ConfigurationError
.If configuration is valid buildtest print something as follows.
bash-3.2$ buildtest config validate /Users/siddiq90/Documents/GitHubDesktop/buildtest/buildtest/settings/config.yml is valid
If there is an error validating configuration file, buildtest will print error message reported by exception
- Parameters
configuration (buildtest.config.SiteConfiguration) – An instance of SiteConfiguration class
- Raises
SystemExit – If exception is raised during validating configuration file.
- buildtest.cli.config.view_configuration(configuration)[source]¶
Display content of buildtest configuration file. This implements command
buildtest config view
- buildtest.cli.config.view_executors(configuration, buildexecutor, json_format=False, yaml_format=False, disabled=False, invalid=False)[source]¶
Display executors from buildtest configuration. This implements
buildtest config executors
command.- Parameters
configuration (buildtest.config.SiteConfiguration) – An instance of SiteConfiguration class
buildexecutor (buildtest.executors.setup.BuildExecutor) – An instance of BuildExecutor class
json_format (bool) – Display output in json format which is specified via
buildtest config executors --json
yaml_format (bool) – Display output in yaml format which is specified via
buildtest config executors --yaml
disabled (bool) – Display list of disabled executors which is specified via
buildtest config executors --disabled
invalid (bool) – Display list of invalid executors which is specified via
buildtest config executors --invalid
- buildtest.cli.config.view_summary(configuration, buildtestsystem=None)[source]¶
This method implements
buildtest config summary
option. In this method we will display a summary of System Details, Buildtest settings, Schemas, Repository details, Buildspecs files and test names.- Parameters
configuration (buildtest.config.SiteConfiguration) – An instance of SiteConfiguration class
buildexecutor (buildtest.executors.setup.BuildExecutor) – An instance of BuildExecutor class