oct.utilities package

Submodules

oct.utilities.configuration module

oct.utilities.configuration.cleanup_turret_config(config)[source]

Remove useless keys from turret configuration

Parameters:config (dict) – the configuration to cleanup
Returns:the cleaned configuration
Return type:dict
oct.utilities.configuration.configure(project_name, cmd_opts, config_file=None)[source]

Get the configuration of the test and return it as a config object

Returns:the configured config object
Return type:Object
oct.utilities.configuration.configure_for_turret(project_name, config_file)[source]

Load the configuration file in python dict and check for keys that will be set to default value if not present

Parameters:
  • project_name (str) – the name of the project
  • config_file (str) – the path of the configuration file
Returns:

the loaded configuration

Return type:

dict

oct.utilities.newproject module

oct.utilities.newproject.check_template(members)[source]
oct.utilities.newproject.create_project(args)[source]
oct.utilities.newproject.from_oct(args)[source]

Create a new oct project

Parameters:args (Namespace) – the command line arguments
oct.utilities.newproject.from_template(args)[source]

Create a new oct project from existing template

Parameters:args (Namespace) – command line arguments
oct.utilities.newproject.new_project(sp)[source]

oct.utilities.pack module

oct.utilities.pack.cleanup_temp_files(turret, files)[source]
oct.utilities.pack.get_files_and_content(turret, is_python=False)[source]
oct.utilities.pack.pack(args)[source]
oct.utilities.pack.pack_turret(turret, temp_files, base_config_path, path=None)[source]

pack a turret into a tar file based on the turret configuration

Parameters:
  • turret_config (dict) – the turret configuration to pack
  • tmp_config_file (str) – the path of the temp config file
  • base_config_path (str) – the base directory of the main configuration file
oct.utilities.pack.pack_turrets(sp)[source]
oct.utilities.pack.write_temp_files(turret, files)[source]

oct.utilities.run module

oct.utilities.run.run(cmd_args)[source]

Start an oct project

Parameters:cmd_args (Namespace) – the commande-line arguments
oct.utilities.run.run_command(sp)[source]

Main function to run oct tests.

Module contents