COT.submodule module

Parent classes for implementing COT subcommands.

Classes

COTGenericSubmodule	Abstract interface for COT command submodules.
COTReadOnlySubmodule	Class for submodules that do not modify the OVF, such as ‘deploy’.
COTSubmodule	Class for submodules that read and write the OVF.

class COTGenericSubmodule(ui)

Bases: object

Abstract interface for COT command submodules.

Attributes: vm, ui

Note

Generally a command should not inherit directly from this class, but should instead subclass COTReadOnlySubmodule or COTSubmodule as appropriate.

__init__(ui)

Instantiate this submodule with the given UI.

Parameters:ui (UI) – User interface instance.

create_subparser()

Add subparser for the CLI of this submodule.

destroy()

Destroy any VM associated with this submodule.

finished()

Do any final actions before being destroyed.

This class does nothing; subclasses may choose to do things like write their VM state out to a file.

ready_to_run()

Check whether the module is ready to run().

Returns:tuple – (True, ready_message) or (False, reason_why_not)

run()

Do the actual work of this submodule.

Raises:InvalidInputError – if ready_to_run() reports False

ui = None

User interface instance (UI or subclass).

vm = None

Virtual machine description (VMDescription).

class COTReadOnlySubmodule(ui)

Bases: COT.submodule.COTGenericSubmodule

Class for submodules that do not modify the OVF, such as ‘deploy’.

Inherited attributes: vm, ui

Attributes: package

__init__(ui)

Instantiate this submodule with the given UI.

Parameters:ui (UI) – User interface instance.

ready_to_run()

Check whether the module is ready to run().

Returns:tuple – (True, ready_message) or (False, reason_why_not)

package

VM description file to read from.

Calls COT.vm_factory.VMFactory.create() to instantiate self.vm from the provided file.

Raises:InvalidInputError – if the file does not exist.

class COTSubmodule(ui)

Bases: COT.submodule.COTGenericSubmodule

Class for submodules that read and write the OVF.

Inherited attributes: vm, ui

Attributes: package, output

__init__(ui)

Instantiate this submodule with the given UI.

Parameters:ui (UI) – User interface instance.

finished()

Write the current VM state out to disk if requested.

ready_to_run()

Check whether the module is ready to run().

Returns:tuple – (True, ready_message) or (False, reason_why_not)

run()

Do the actual work of this submodule.

If output was not previously set, automatically sets it to the value of PACKAGE.

Raises:InvalidInputError – if ready_to_run() reports False

output

Output file for this submodule.

If the specified file already exists, will prompt the user (confirm_or_die()) to confirm overwriting the existing file.

package

VM description file to read (and possibly write).

Calls COT.vm_factory.VMFactory.create() to instantiate self.vm from the provided file.

Raises:InvalidInputError – if the file does not exist.