CLI¶
Hint
To run tests:
$ cd qa/e2e_tests
$ waft run pytest [-@ "configured test system or group name"]
waft¶
WAFT CLI - Warp Automated Framework for Testing’s Command Line Interface
Usage:
$ waft [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help: Show this message and exit.
Commands:
config: Manage configured test systems and groups…download: Download applications to the local system.install: Install WAFT components on test systems.keys: Configure SSH key(s) for WAFT test systems…run: Run tests using WAFT.sftp: Manage files on WAFT test systems via SFTP.show: Display WAFT components and documentation.ssh: Connect to a WAFT test system via SSH.system: Command WAFT test systems.update: Update WAFT components.warp: Perform WARP client actions.vm: Configure cloud virtual machines as WAFT…
waft config¶
Manage configured test systems and groups in the waft config file.
Usage:
$ waft config [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
where: Print the path to the current config file…show: Show systems and groups currently defined…add-system: Add a system to the config.add-proxy: Add a proxy to the config.remove-system: Remove a system from the config.remove-proxy: Remove a proxy from the config.create-group: Create a group of systems in the config.remove-group: Delete a group from the config.
waft config where¶
Print the path to the current config file and open the folder in the default file manager.
Usage:
$ waft config where [OPTIONS]
Options:
--help: Show this message and exit.
waft config show¶
Show systems and groups currently defined in config.
Usage:
$ waft config show [OPTIONS]
Options:
--json: Output config as JSON instead of table.-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
waft config add-system¶
Add a system to the config.
Usage:
$ waft config add-system [OPTIONS] NAME USERNAME HOSTNAME
Arguments:
NAME: Name of system to add [required]USERNAME: Username for logging in [required]HOSTNAME: Hostname or IP address [required]
Options:
-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
waft config add-proxy¶
Add a proxy to the config.
Usage:
$ waft config add-proxy [OPTIONS] NAME USERNAME HOSTNAME
Arguments:
NAME: Name of the proxy system to add [required]USERNAME: Username for logging into the proxy system [required]HOSTNAME: Hostname or IP address for the proxy system [required]
Options:
-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
waft config remove-system¶
Remove a system from the config.
Usage:
$ waft config remove-system [OPTIONS] NAME
Arguments:
NAME: Name of system to remove [required]
Options:
-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
waft config remove-proxy¶
Remove a proxy from the config.
Usage:
$ waft config remove-proxy [OPTIONS] NAME
Arguments:
NAME: Name of proxy to remove [required]
Options:
-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
waft config create-group¶
Create a group of systems in the config.
Usage:
$ waft config create-group [OPTIONS] NAME
Arguments:
NAME: Name of group to create [required]
Options:
-@, --system TEXT: Select WAFT test system(s) to execute commands against. Repeat option to specify multiple systems. [required]-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
waft config remove-group¶
Delete a group from the config.
Usage:
$ waft config remove-group [OPTIONS] NAME
Arguments:
NAME: Name of group to delete [required]
Options:
-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
waft download¶
Download applications to the local system.
Usage:
$ waft download [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
warp: Download WARP clients to the local system.
waft download warp¶
Download WARP clients to the local system.
Usage:
$ waft download warp [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
info: Display release details of (published)…client: Download WARP client to local WAFT client…clients: Download WARP clients to the local system…
waft download warp info¶
Display release details of (published) WARP clients available for download.
Usage:
$ waft download warp info [OPTIONS] PLATFORM:{windows|macos|rhel|almalinux|ubuntu24|ubuntu22|ubuntu20|debian10|debian11|debian12|fedora34|fedora35|centos8|noble|jammy|focal|buster|bullseye|bookworm} ARCHITECTURE:{arm|intel} RELEASE:{nightly|beta|ga}
Arguments:
PLATFORM:{windows|macos|rhel|almalinux|ubuntu24|ubuntu22|ubuntu20|debian10|debian11|debian12|fedora34|fedora35|centos8|noble|jammy|focal|buster|bullseye|bookworm}: Client platform alias [required]ARCHITECTURE:{arm|intel}: Client architecture [required]RELEASE:{nightly|beta|ga}: Client release track [required]
Options:
--help: Show this message and exit.
waft download warp client¶
Download WARP client to local WAFT client installs folder.
Usage:
$ waft download warp client [OPTIONS] PLATFORM:{windows|macos|rhel|almalinux|ubuntu24|ubuntu22|ubuntu20|debian10|debian11|debian12|fedora34|fedora35|centos8|noble|jammy|focal|buster|bullseye|bookworm} ARCHITECTURE:{arm|intel} RELEASE:{nightly|beta|ga}
Arguments:
PLATFORM:{windows|macos|rhel|almalinux|ubuntu24|ubuntu22|ubuntu20|debian10|debian11|debian12|fedora34|fedora35|centos8|noble|jammy|focal|buster|bullseye|bookworm}: Client platform alias [required]ARCHITECTURE:{arm|intel}: Client architecture [required]RELEASE:{nightly|beta|ga}: Client release track [required]
Options:
--version TEXT: Client build version [default: (latest)]--previous INTEGER: Previous released build relative to the version given [default: 0]--clear / --no-clear: Clear the install path [default: no-clear]--help: Show this message and exit.
waft download warp clients¶
Download WARP clients to the local system for any given system/group(s) defined in the config
Usage:
$ waft download warp clients [OPTIONS] RELEASE:{nightly|beta|ga}
Arguments:
RELEASE:{nightly|beta|ga}: Client release track [required]
Options:
--version TEXT: Client build version [default: (latest)]--previous INTEGER: Previous released build relative to the version given [default: 0]--clear / --no-clear: Clear the install path [default: no-clear]-@, --system TEXT: Select WAFT test system(s) to execute commands against. Repeat option to specify multiple systems. [default: “default” | ALL]-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
waft install¶
Install WAFT components on test systems.
Usage:
$ waft install [OPTIONS] COMMAND [ARGS]...
Options:
-@, --system TEXT: Select WAFT test system(s) to execute commands against. Repeat option to specify multiple systems. [default: “default” | ALL]-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
Commands:
warp: Install WARP client on test system(s).python: Install Python on test system(s).package: Install Python package on test system(s).waft: Install WAFT on test system(s).
waft install warp¶
Install WARP client on test system(s).
Usage:
$ waft install warp [OPTIONS]
Options:
--version TEXT: Client build version [default: (latest)]--help: Show this message and exit.
waft install python¶
Install Python on test system(s).
Usage:
$ waft install python [OPTIONS]
Options:
--version TEXT: Python version to install [default: 3.11.9]--help: Show this message and exit.
waft install package¶
Install Python package on test system(s).
Usage:
$ waft install package [OPTIONS] NAME
Arguments:
NAME: Module name [required]
Options:
--version TEXT: Module version [default: (latest)]--help: Show this message and exit.
waft install waft¶
Install WAFT on test system(s).
Usage:
$ waft install waft [OPTIONS]
Options:
--version TEXT: Client build version [default: (latest)]--help: Show this message and exit.
waft keys¶
Configure SSH key(s) for WAFT test systems (all, by default, unless specified).
Usage:
$ waft keys [OPTIONS] COMMAND [ARGS]...
Options:
-@, --system TEXT: Select WAFT test system(s) to execute commands against. Repeat option to specify multiple systems. [default: “default” | ALL]-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
Commands:
generate: Generate new SSH key, deploy, and/or…deploy: Deploy existing SSH key to WAFT test…disable: Disable existing SSH key for WAFT test…
waft keys generate¶
Generate new SSH key, deploy, and/or rotate to WAFT test system(s).
Usage:
$ waft keys generate [OPTIONS]
Options:
--help: Show this message and exit.
waft keys deploy¶
Deploy existing SSH key to WAFT test system(s).
Usage:
$ waft keys deploy [OPTIONS]
Options:
--help: Show this message and exit.
waft keys disable¶
Disable existing SSH key for WAFT test system(s).
Usage:
$ waft keys disable [OPTIONS]
Options:
--help: Show this message and exit.
waft run¶
Run tests using WAFT.
Usage:
$ waft run [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
pytest: Run Python E2E tests on WAFT test system(s).
waft run pytest¶
Run Python E2E tests on WAFT test system(s).
This command targets WAFT test system(s) given as either command line option(s), a pre-configured system or group named “default”, or the “local” system, by default.
Usage:
$ waft run pytest [OPTIONS]
Options:
-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]-@, --system TEXT: Select WAFT test system(s) to execute commands against. Repeat option to specify multiple systems. [default: “default” | “local”]--prompt / --no-prompt: Whether to prompt for confirmation. [default: prompt]--limit INTEGER: Limit the number of systems to test in parallel.--capture-timing: Capture timing at the WAFT Actions layer and generate reports.--help: Show this message and exit.
waft sftp¶
Manage files on WAFT test systems via SFTP.
Usage:
$ waft sftp [OPTIONS] COMMAND [ARGS]...
Options:
-@, --system TEXT: Select WAFT test system(s) to execute commands against. Repeat option to specify multiple systems. [required]-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
Commands:
pwd: Display remote working directory.get: Download the remote-path to the local…put: Upload local-path to the remote machine(s).ls: Display a remote directory listing.read: Display contents of a file on the remote…rename: Rename the path of a remote file or folder.rm: Delete remote file.rmdir: Remove remote directory.mkdir: Create remote directory.stat: Displays file status information on the…lstat: Displays file status information on the…ln: Create a symbolic link on the remote system.chmod: Change remote file modes/permissions.chown: Change remote file owner and/or group ID.
waft sftp pwd¶
Display remote working directory.
Usage:
$ waft sftp pwd [OPTIONS]
Options:
--help: Show this message and exit.
waft sftp get¶
Download the remote-path to the local machine.
Usage:
$ waft sftp get [OPTIONS] REMOTEPATH LOCALPATH
Arguments:
REMOTEPATH: remote file to copy [required]LOCALPATH: local destination file path [required]
Options:
--help: Show this message and exit.
waft sftp put¶
Upload local-path to the remote machine(s).
Usage:
$ waft sftp put [OPTIONS] LOCALPATH REMOTEPATH
Arguments:
LOCALPATH: local file to copy [required]REMOTEPATH: remote destination path. Specifying a directory without the filename may result in an error. [required]
Options:
--help: Show this message and exit.
waft sftp ls¶
Display a remote directory listing.
Usage:
$ waft sftp ls [OPTIONS] [PATH]
Arguments:
[PATH]: directory path [default: .]
Options:
-l: list file attributes--help: Show this message and exit.
waft sftp read¶
Display contents of a file on the remote server.
Usage:
$ waft sftp read [OPTIONS] FILENAME
Arguments:
FILENAME: file path [required]
Options:
--help: Show this message and exit.
waft sftp rename¶
Rename the path of a remote file or folder.
Usage:
$ waft sftp rename [OPTIONS] OLDPATH NEWPATH
Arguments:
OLDPATH: existing file or folder path [required]NEWPATH: new file or folder path, will be overwritten if exists [required]
Options:
--help: Show this message and exit.
waft sftp rm¶
Delete remote file.
Usage:
$ waft sftp rm [OPTIONS] PATH
Arguments:
PATH: path (absolute or relative) of the file to remove [required]
Options:
--help: Show this message and exit.
waft sftp rmdir¶
Remove remote directory.
Usage:
$ waft sftp rmdir [OPTIONS] PATH
Arguments:
PATH: directory to remove [required]
Options:
--help: Show this message and exit.
waft sftp mkdir¶
Create remote directory.
Usage:
$ waft sftp mkdir [OPTIONS] PATH [MODE]
Arguments:
PATH: directory path to create [required][MODE]: (posix-style) permissions to apply [default: 777]
Options:
--help: Show this message and exit.
waft sftp stat¶
Displays file status information on the remote system; resolves symbolic links to status the file it references.
Usage:
$ waft sftp stat [OPTIONS] PATH
Arguments:
PATH: path to status [required]
Options:
--help: Show this message and exit.
waft sftp lstat¶
Displays file status information on the remote system; does not resolve symbolic links.
Usage:
$ waft sftp lstat [OPTIONS] PATH
Arguments:
PATH: path to status [required]
Options:
--help: Show this message and exit.
waft sftp ln¶
Create a symbolic link on the remote system.
Usage:
$ waft sftp ln [OPTIONS] SOURCE TARGET
Arguments:
SOURCE: source file path [required]TARGET: target link path [required]
Options:
--help: Show this message and exit.
waft sftp chmod¶
Change remote file modes/permissions.
Usage:
$ waft sftp chmod [OPTIONS] PATH MODE
Arguments:
PATH: path to modify [required]MODE: absolute, numeric, octal mode [required]
Options:
--help: Show this message and exit.
waft sftp chown¶
Change remote file owner and/or group ID.
Usage:
$ waft sftp chown [OPTIONS] PATH
Arguments:
PATH: path to modify [required]
Options:
--uid INTEGER: new owner id--gid INTEGER: new group id--help: Show this message and exit.
waft show¶
Display WAFT components and documentation.
Usage:
$ waft show [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
docs: Display WAFT documentation.clients: Display local WAFT client installs folder.logs: Display local WAFT test logs folder.commands: Display WAFT command manual.
waft show docs¶
Display WAFT documentation.
Usage:
$ waft show docs [OPTIONS]
Options:
--debug / --no-debug: Enable verbose output for debugging. [default: no-debug]--help: Show this message and exit.
waft show clients¶
Display local WAFT client installs folder.
Usage:
$ waft show clients [OPTIONS]
Options:
--help: Show this message and exit.
waft show logs¶
Display local WAFT test logs folder.
Usage:
$ waft show logs [OPTIONS]
Options:
--help: Show this message and exit.
waft show commands¶
Display WAFT command manual.
Usage:
$ waft show commands [OPTIONS]
Options:
--help: Show this message and exit.
waft ssh¶
Connect to a WAFT test system via SSH.
Usage:
$ waft ssh [OPTIONS] SYSTEM COMMAND [ARGS]...
Arguments:
SYSTEM: WAFT test system to execute commands against. [required]
Options:
-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
waft system¶
Command WAFT test systems.
Usage:
$ waft system [OPTIONS] COMMAND [ARGS]...
Options:
-@, --system TEXT: Select WAFT test system(s) to execute commands against. Repeat option to specify multiple systems. [required]-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
Commands:
os: Display operating system version of WAFT…ip: Display public network address of WAFT…exec: Execute a command on remote WAFT test…restart: Restart WAFT test system(s).
waft system os¶
Display operating system version of WAFT test system(s).
Usage:
$ waft system os [OPTIONS]
Options:
--help: Show this message and exit.
waft system ip¶
Display public network address of WAFT test system(s).
Usage:
$ waft system ip [OPTIONS]
Options:
--help: Show this message and exit.
waft system exec¶
Execute a command on remote WAFT test system(s).
Usage:
$ waft system exec [OPTIONS]
Options:
--help: Show this message and exit.
waft system restart¶
Restart WAFT test system(s).
Usage:
$ waft system restart [OPTIONS]
Options:
--help: Show this message and exit.
waft update¶
Update WAFT components.
Usage:
$ waft update [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
waft warp¶
Perform WARP client actions.
Usage:
$ waft warp [OPTIONS] COMMAND [ARGS]...
Options:
-@, --system TEXT: Select WAFT test system(s) to execute commands against. Repeat option to specify multiple systems. [required]-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
Commands:
warp-ver: Display WARP client version installed on…warp-cli: Execute warp-cli command on WAFT test…warp-diag: Execute warp-diag command on WAFT test…mdm: Configure WARP mobile device management…
waft warp warp-ver¶
Display WARP client version installed on WAFT test system(s).
Usage:
$ waft warp warp-ver [OPTIONS]
Options:
--help: Show this message and exit.
waft warp warp-cli¶
Execute warp-cli command on WAFT test system(s).
Usage:
$ waft warp warp-cli [OPTIONS]
Options:
--help: Show this message and exit.
waft warp warp-diag¶
Execute warp-diag command on WAFT test system(s) and transfer archive(s) to local system.
Usage:
$ waft warp warp-diag [OPTIONS]
Options:
-v: Set verbosity level of warp-diag logging. Repeat v’s to increment. [default: 0]--help: Show this message and exit.
waft warp mdm¶
Configure WARP mobile device management (MDM) for WAFT test system(s).
Usage:
$ waft warp mdm [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
get-configs: Show information about current MDM…set-config: Apply MDM configuration (by name) on WAFT…names: List MDM configuration names currently…add: Add an MDM configuration (by name) to WAFT…set: Set MDM configuration value(s) on WAFT…unset: Unset MDM configuration option(s) (by…show: Display contents of MDM configurations on…remove: Remove MDM configuration (by name) from…reset: Reset MDM configuration on WAFT test…
waft warp mdm get-configs¶
Show information about current MDM configurations on WAFT test system(s).
Usage:
$ waft warp mdm get-configs [OPTIONS]
Options:
--help: Show this message and exit.
waft warp mdm set-config¶
Apply MDM configuration (by name) on WAFT test system(s).
Usage:
$ waft warp mdm set-config [OPTIONS] CONFIG_NAME
Arguments:
CONFIG_NAME: WARP client configuration name [required]
Options:
--help: Show this message and exit.
waft warp mdm names¶
List MDM configuration names currently available on WAFT test system(s).
Usage:
$ waft warp mdm names [OPTIONS]
Options:
--help: Show this message and exit.
waft warp mdm add¶
Add an MDM configuration (by name) to WAFT test system(s).
Usage:
$ waft warp mdm add [OPTIONS] ORGANIZATION DISPLAY_NAME
Arguments:
ORGANIZATION: Zero Trust organization name [required]DISPLAY_NAME: WARP client configuration name [required]
Options:
--help: Show this message and exit.
waft warp mdm set¶
Set MDM configuration value(s) on WAFT test system(s).
Usage:
$ waft warp mdm set [OPTIONS] CONFIG_NAME
Arguments:
CONFIG_NAME: WARP client configuration name [required]
Options:
--help: Show this message and exit.
waft warp mdm unset¶
Unset MDM configuration option(s) (by name) on WAFT test system(s).
Usage:
$ waft warp mdm unset [OPTIONS] CONFIG_NAME
Arguments:
CONFIG_NAME: WARP client configuration name [required]
Options:
--help: Show this message and exit.
waft warp mdm show¶
Display contents of MDM configurations on WAFT test system(s).
Usage:
$ waft warp mdm show [OPTIONS]
Options:
--help: Show this message and exit.
waft warp mdm remove¶
Remove MDM configuration (by name) from WAFT test system(s).
Usage:
$ waft warp mdm remove [OPTIONS] CONFIG_NAME
Arguments:
CONFIG_NAME: WARP client configuration name [required]
Options:
--help: Show this message and exit.
waft warp mdm reset¶
Reset MDM configuration on WAFT test system(s).
Usage:
$ waft warp mdm reset [OPTIONS]
Options:
--help: Show this message and exit.
waft vm¶
Configure cloud virtual machines as WAFT test systems.
Usage:
$ waft vm [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
create: Create a new VM system.redeploy: Redeploy VMs for multiple systems.destroy: Destroy one or more WAFT configured VM…inspect: Test the SSH connection to a VM.images: List available VM images that can be used…
waft vm create¶
Create a new VM system.
Only a VM image name is required. All other options have sensible defaults for typical usage but can be overridden.
System Name Auto-Generation:
If –system/-@ is not provided, the image name will be used as the system name
If a system with that name already exists in the config, an error will be raised
Use –system/-@ to specify a custom name when creating multiple VMs of the same image
Use –force to overwrite an existing system with the same name
Examples: waft vm create ubuntu_22_04_multiarch_intel # Auto-names system as image name waft vm create ubuntu_22_04_multiarch_intel -@ my-test-vm # Creates system named “my-test-vm” waft vm create windows_11_intel –system my-windows-vm # Creates system named “my-windows-vm”
Usage:
$ waft vm create [OPTIONS] IMAGE
Arguments:
IMAGE: VM image name (e.g., ubuntu_22_04_multiarch_intel, windows_11_intel) [required]
Options:
-@, --system TEXT: Name for the new system (defaults to image name if not provided)--cloud-provider [azure]: Cloud provider [default: azure]--username TEXT: Username for the VM [default: waft-admin]--resource-group TEXT: Azure resource group for the VM [env var: RESOURCE_GROUP; default: waft-vms]--force / --no-force: Force creation even if system exists in config [default: no-force]-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
waft vm redeploy¶
Redeploy VMs for multiple systems.
Usage:
$ waft vm redeploy [OPTIONS]
Options:
-@, --system TEXT: Select WAFT test system(s) to execute commands against. Repeat option to specify multiple systems. [default: “default” | None]-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
waft vm destroy¶
Destroy one or more WAFT configured VM systems.
If no systems are specified, will prompt to destroy all VMs with hostnames. You can specify individual systems or groups. When a group is specified, all systems in that group will be destroyed.
Examples: waft vm destroy -@ system1 waft vm destroy -@ system1 -@ system2 waft vm destroy -@ groupA # Destroys all systems in groupA waft vm destroy # Prompts to destroy all VMs with hostnames
Usage:
$ waft vm destroy [OPTIONS]
Options:
-@, --system TEXT: Select WAFT test system(s) to execute commands against. Repeat option to specify multiple systems. [default: “default” | ALL]-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
waft vm inspect¶
Test the SSH connection to a VM.
The system must be specified with -@/–system flags.
Example: waft vm inspect my-system
Usage:
$ waft vm inspect [OPTIONS] SYSTEM
Arguments:
SYSTEM: WAFT test system to execute commands against. [required]
Options:
-cf, --config FILE: Path to WAFT configuration file. [default: (~/.waft/config/waft_config.json)]--help: Show this message and exit.
waft vm images¶
List available VM images that can be used with –vm-spec.
Usage:
$ waft vm images [OPTIONS]
Options:
--help: Show this message and exit.