buildtest.cli.config

Module Contents

Functions

config_cmd(command_args, configuration, editor, system)	Entry point for buildtest config command. This method will invoke other methods depending on input argument.
handle_view_command(command_args, configuration)
handle_profiles_command(command_args, configuration)
handle_executors_command(command_args, configuration)
handle_validate_command(command_args, configuration, ...)
handle_systems_command(command_args, configuration)
handle_edit_command(command_args, configuration, editor)
handle_path_command(command_args, configuration)
edit_configuration(configuration, editor)	This method will open configuration file in editor. The preferred editor will be determined based on environment
view_system(configuration)	This method implements command buildtest config systems which displays
validate_config(configuration)	This method implements buildtest config validate which attempts to
view_path(configuration)	Display the path to configuration file regardless if file is valid. This implements command buildtest config path
view_configuration(configuration[, theme, pager])	Display content of buildtest configuration file. This implements command buildtest config view
remove_profiles(configuration, profile_name)	This method will remove profile names from configuration file given a list of profile names. This method
list_profiles(configuration[, theme, print_yaml])	Display the list of profile for buildtest configuration file. This implements command buildtest config profiles list
display_executors_in_json_format(executor_settings)
display_executors_in_yaml_format(executor_settings)
display_disabled_executors(configuration)
display_invalid_executors(configuration)
display_all_executors(configuration)
view_executors(configuration, buildexecutor[, ...])	Display executors from buildtest configuration. This implements buildtest config executors list command.
remove_executors(configuration, executor_names)	Remove executors from buildtest configuration. This implements buildtest config executors remove command.

buildtest.cli.config.config_cmd(command_args, configuration, editor, system)

Entry point for buildtest config command. This method will invoke other methods depending on input argument.

Parameters:

• command_args (dict) – Parsed arguments from ArgumentParser.parse_args

• configuration (buildtest.config.SiteConfiguration) – An instance of SiteConfiguration class

• system (buildtest.system.BuildTestSystem) – An instance of BuildTestSystem class

buildtest.cli.config.handle_view_command(command_args, configuration)

buildtest.cli.config.handle_profiles_command(command_args, configuration)

buildtest.cli.config.handle_executors_command(command_args, configuration)

buildtest.cli.config.handle_validate_command(command_args, configuration, system)

buildtest.cli.config.handle_systems_command(command_args, configuration)

buildtest.cli.config.handle_edit_command(command_args, configuration, editor)

buildtest.cli.config.handle_path_command(command_args, configuration)

buildtest.cli.config.edit_configuration(configuration, editor)

This method will open configuration file in editor. The preferred editor will be determined based on environment variable EDITOR if found otherwise will resort to vim.

Parameters:

configuration (buildtest.config.SiteConfiguration) – Instance of SiteConfiguration class used for storing buildtest configuration

buildtest.cli.config.view_system(configuration)

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)

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 or buildtest.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_path(configuration)

Display the path to configuration file regardless if file is valid. This implements command buildtest config path

Parameters:

configuration (buildtest.config.SiteConfiguration) – An instance of SiteConfiguration class

buildtest.cli.config.view_configuration(configuration, theme=None, pager=None)

Display content of buildtest configuration file. This implements command buildtest config view

Parameters:

• configuration (buildtest.config.SiteConfiguration) – An instance of SiteConfiguration class

• theme (str, optional) – Color theme to choose. This is the Pygments style (https://pygments.org/docs/styles/#getting-a-list-of-available-styles) which is specified by --theme option

buildtest.cli.config.remove_profiles(configuration, profile_name)

This method will remove profile names from configuration file given a list of profile names. This method will be invoked when user runs buildtest config profiles remove command.

Parameters:

• configuration (buildtest.config.SiteConfiguration) – An instance of SiteConfiguration class

• profile_name (list) – List of name of profile to remove

buildtest.cli.config.list_profiles(configuration, theme=None, print_yaml=None)

Display the list of profile for buildtest configuration file. This implements command buildtest config profiles list

Parameters:

• configuration (buildtest.config.SiteConfiguration) – An instance of SiteConfiguration class

• theme (str, optional) – Color theme to choose. This is the Pygments style (https://pygments.org/docs/styles/#getting-a-list-of-available-styles) which is specified by --theme option

• print_yaml (bool, optional) – Display profiles in yaml format. This is specified by --yaml option

buildtest.cli.config.display_executors_in_json_format(executor_settings)

buildtest.cli.config.display_executors_in_yaml_format(executor_settings)

buildtest.cli.config.display_disabled_executors(configuration)

buildtest.cli.config.display_invalid_executors(configuration)

buildtest.cli.config.display_all_executors(configuration)

buildtest.cli.config.view_executors(configuration, buildexecutor, display_in_json_format=False, display_in_yaml_format=False, display_disabled=False, display_invalid=False, display_all=False)

Display executors from buildtest configuration. This implements buildtest config executors list command.

Parameters:

• configuration (buildtest.config.SiteConfiguration) – An instance of SiteConfiguration class

• buildexecutor (buildtest.executors.setup.BuildExecutor) – An instance of BuildExecutor class

• display_in_json_format (bool) – Display output in json format which is specified via buildtest config executors list --json

• display_in_yaml_format (bool) – Display output in yaml format which is specified via buildtest config executors list --yaml

• display_disabled (bool) – Display list of disabled executors which is specified via buildtest config executors list --disabled

• display_invalid (bool) – Display list of invalid executors which is specified via buildtest config executors list --invalid

• display_all (bool) – Display all executors which is specified via buildtest config executors list --all

buildtest.cli.config.remove_executors(configuration, executor_names)

Remove executors from buildtest configuration. This implements buildtest config executors remove command.

Parameters:

• configuration (buildtest.config.SiteConfiguration) – An instance of SiteConfiguration class

• executor_names (list) – List of executor names to remove