waft.actions.warp_actions.install_actions module

class waft.actions.warp_actions.install_actions.InstallActions(cli_actions: CliActions)

Bases: Actions

Actions that manage the installation lifecycle of the Warp client

install(install_params: WarpParams | None = None, installer: str | None = None, version: str | None = None, cleanup: bool = True, use_flutter: bool = False) → None

Installs the WARP client, verifies a successful installation, and then registers uninstall as the cleanup action.

Parameters:

• install_params (Optional[WarpParams]) – Configuration parameters for the installation.

• installer (Optional[str]) – Path of the installer file.

• version (Optional[str]) – Version of the installer.

• cleanup (bool) – Specifies whether or not to perform cleanup actions.

• use_flutter (bool) – Specifies whether or not to use the flutter build of the installer.

Returns:

None

install_if_not_installed(install_params: WarpParams | None = None, installer: str | None = None, version: str | None = None, cleanup: bool = True, use_flutter: bool = False) → None

Installs the WARP client if it is not already installed, verifies successful installation, and registers uninstall as the cleanup action.

Parameters:

• install_params (Optional[WarpParams]) – Configuration parameters for the installation.

• installer (Optional[str]) – Path of the installer file.

• version (Optional[str]) – Version of the installer.

• cleanup (bool) – Specifies whether or not to perform cleanup actions.

• use_flutter (bool) – Specifies whether or not to use the flutter build of the installer.

Returns:

None

parse_version

alias of Version

reinstall(install_params: WarpParams | None = None, installer: str | None = None, version: str | None = None, cleanup: bool = True, use_flutter: bool = False) → None

Reinstalls the WARP client, verifies a successful installation and registering uninstall as the cleanup action.

Parameters:

• install_params (Optional[WarpParams]) – Configuration parameters for the installation.

• installer (Optional[str]) – Path of the installer file.

• version (Optional[str]) – Version of the installer.

• cleanup (bool) – Specifies whether or not to perform cleanup actions.

• use_flutter (bool) – Specifies whether or not to use the flutter build of the installer.

Returns:

None

released_version(release_track: Literal['ga', 'beta', 'nightly'], previous: int = 0)

Return version number of a released version of the WARP client

Parameters:

• release_track – Release track of the WARP client

• previous – How many releases prior to the most recent version to return

uninstall() → None

Uninstalls the WARP client from the system if it is installed.

Returns:

None

upgrade() → None

Upgrades the WARP client to the latest version.

Raises:

NotImplementedError – This method is not yet implemented.

verify_install_successful() → None

Verifies that the WARP client has been successfully installed.

Raises:

NotImplementedError – This method is not yet implemented.

verify_installed_version_is(version_number: str) → None

Verifies that the installed version of the WARP client matches the specified version.

Parameters:

version_number (str) – The version number to verify against.

Raises:

ValueError – When the version number parameter does not match the reported version number installed

verify_installer_presence(version: str | None = None, use_flutter: bool = False)

Verify the presence of the installer file. This is used mostly as a health check method to prevent attempts to run tests when no installer file is found.

Parameters:

• version – Optional Version of the warp installer file

• use_flutter – Whether to use the flutter build of the installer

verify_uninstall() → None

Verifies that the WARP client has been successfully uninstalled.

Raises:

NotImplementedError – This method is not yet implemented.

verify_upgrade() → None

Verifies that the WARP client has been successfully upgraded.

Raises:

NotImplementedError – This method is not yet implemented.

version_under_test: Version