Command-Line Help for rtf

This document contains the help content for the rtf command-line program.

Command Overview:

• rtf↴
• rtf run↴
• rtf docs↴
• rtf expand-matrix↴
• rtf template↴
• rtf custom-provider↴
• rtf custom-provider template↴
• rtf custom-provider run↴
• rtf inline↴
• rtf inline all↴
• rtf inline relative-files↴
• rtf resolve↴
• rtf resolve scenario↴
• rtf resolve environment↴
• rtf completion↴
• rtf json-schemas↴
• rtf remote↴
• rtf remote prepare↴
• rtf remote request↴
• rtf remote run↴
• rtf remote run-known↴
• rtf remote ci-run↴
• rtf remote ci-run-known↴
• rtf remote execution-log↴
• rtf remote execution-output↴
• rtf remote execution-status↴
• rtf remote run-output↴
• rtf remote run-status↴
• rtf version↴

rtf

A swiss army knife for testing the Apollo Runtime

Usage: rtf [OPTIONS] <COMMAND>

Subcommands:

• run — Check and run a test plan
• docs — Open the RTF documentation in your browser
• expand-matrix — Expand a test plan matrix into JSON
• template — Template a test plan using provided variables, outputting the resulting config to stdout
• custom-provider — Work directly with custom file provider definitions
• inline — Inline file providers in a test plan. Outputs the resulting test plan to the given directory
• resolve — Resolve file providers for a config file without executing it
• completion — Write a shell completion file to STDOUT for the given shell
• json-schemas — Output json schemas for environment configuration
• remote — Interactions with the RTF Orchestrator Service
• version — Display CLI version and exit

Options:

• --var <VAR> — A single additional templating variable in the form “key=value”
• --vars <VARS> — Path to a JSON file containing additional template variables
• -v, --verbose — Flag to control logging verbosity. Default level is warn. -v sets logging level to info,-vv to debug and -vvv to trace

rtf run

Check and run a test plan

Usage: rtf run [OPTIONS] <TEST_PLAN_PATH>

Arguments:

• <TEST_PLAN_PATH> — Relative path to the test plan file that should be executed. When using –github this must be in the format ORG/REPO/PATH

Options:

• --environment-up — Only run the environment setup

• --environment-down — Only run the environment teardown

• --scenario — Only run the environment scenario

• --github — Execute a test plan file in GitHub instead of from a local path

  Default value: false

• --ref <GIT_REF> — Optional git ref to pull files from when using –github

• --outdir <OUTDIR> — Output directory for providers when they run

  Default value: output

• --force — Force removal of an existing output directory before running

  Default value: false

rtf docs

Open the RTF documentation in your browser

Usage: rtf docs [SEARCH_TERM]...

Arguments:

• <SEARCH_TERM> — An optional search term to search for within the docs

rtf expand-matrix

Expand a test plan matrix into JSON

Usage: rtf expand-matrix [OPTIONS] <TEST_PLAN_PATH>

Arguments:

• <TEST_PLAN_PATH> — Relative path to the test-plan.yaml file that should have its matrix expanded

Options:

• -c, --compact — Return the expanded matrix JSON in compact form

rtf template

Template a test plan using provided variables, outputting the resulting config to stdout

Usage: rtf template [OPTIONS] <TEST_PLAN_PATH>

Arguments:

• <TEST_PLAN_PATH> — Relative path to the test plan file that should be templated. When using –github this must be in the format ORG/REPO/PATH

Options:

• --check — Run a static check of the resulting test plan after templating

• --github — Template a test plan file from GitHub instead of from a local path

  Default value: false

• --ref <GIT_REF> — Optional git ref to pull files from when using –github

rtf custom-provider

Work directly with custom file provider definitions

Usage: rtf custom-provider <COMMAND>

Subcommands:

• template — Template a custom provider definition, outputting the resulting config to stdout
• run — Execute a custom provider definition

rtf custom-provider template

Template a custom provider definition, outputting the resulting config to stdout

Usage: rtf custom-provider template [OPTIONS] <DEFINITION_PATH>

Arguments:

• <DEFINITION_PATH> — Relative path to the custom provider definition file

Options:

• --check — Run a static check of the resulting test plan after templating

rtf custom-provider run

Execute a custom provider definition

Usage: rtf custom-provider run [OPTIONS] <DEFINITION_PATH>

Arguments:

• <DEFINITION_PATH> — Relative path to the custom provider definition file

Options:

• --outdir <OUTDIR> — Output directory for provider execution

  Default value: output

• --force — Force removal of an existing output directory before running

  Default value: false

rtf inline

Inline file providers in a test plan. Outputs the resulting test plan to the given directory

Usage: rtf inline <COMMAND>

Subcommands:

• all — Inline all file providers
• relative-files — Inline only relative file providers

rtf inline all

Inline all file providers

Usage: rtf inline all [OPTIONS] <TEST_PLAN_PATH>

Arguments:

• <TEST_PLAN_PATH> — Relative path to the test-plan.yaml file that should be inlined. When using –github this must be in the format ORG/REPO/PATH

Options:

• --outdir <OUTDIR> — Output directory for inlined test plan

  Default value: output

• --force — Force removal of an existing output directory before running

  Default value: false

• --github — Inline a test plan file from GitHub instead of from a local path

  Default value: false

• --ref <GIT_REF> — Optional git ref to pull files from when using –github

rtf inline relative-files

Inline only relative file providers

Usage: rtf inline relative-files [OPTIONS] <TEST_PLAN_PATH>

Arguments:

• <TEST_PLAN_PATH> — Relative path to the test-plan.yaml file that should be inlined. When using –github this must be in the format ORG/REPO/PATH

Options:

• --outdir <OUTDIR> — Output directory for inlined test plan

  Default value: output

• --force — Force removal of an existing output directory before running

  Default value: false

• --github — Inline a test plan file from GitHub instead of from a local path

  Default value: false

• --ref <GIT_REF> — Optional git ref to pull files from when using –github

rtf resolve

Resolve file providers for a config file without executing it

Usage: rtf resolve <COMMAND>

Subcommands:

• scenario — Resolve file providers for a standalone scenario config
• environment — Resolve file providers for a standalone environment config

rtf resolve scenario

Resolve file providers for a standalone scenario config

Usage: rtf resolve scenario [OPTIONS] <SCENARIO_PATH>

Arguments:

• <SCENARIO_PATH> — Relative path to the scenario.yaml file

Options:

• --outdir <OUTDIR> — Output directory for resolved providers and scenario.env

  Default value: output

• --force — Force removal of an existing output directory before running

  Default value: false

rtf resolve environment

Resolve file providers for a standalone environment config

Usage: rtf resolve environment [OPTIONS] <ENVIRONMENT_PATH>

Arguments:

• <ENVIRONMENT_PATH> — Relative path to the environment.yaml file

Options:

• --outdir <OUTDIR> — Output directory for resolved providers and env files

  Default value: output

• --force — Force removal of an existing output directory before running

  Default value: false

rtf completion

Write a shell completion file to STDOUT for the given shell

Usage: rtf completion [OPTIONS]

Options:

• -s, --shell <SHELL> — The shell to generate completions for (defaults to identifying from the environment)

  Possible values: bash, elvish, fish, powershell, zsh

rtf json-schemas

Output json schemas for environment configuration

Usage: rtf json-schemas <CONFIG>

Arguments:

• <CONFIG>

  Possible values: test-plan, environment, scenario

rtf remote

Interactions with the RTF Orchestrator Service.

Set the RTF_ORCHESTRATOR_URL environment variable to override the Orchestrator base URL used by these subcommands; it defaults to the production Orchestrator when unset.

Usage: rtf remote <COMMAND>

Subcommands:

• prepare — Prepare a test plan for remote execution by the Orchestrator. Outputs an Orchestrator-compatible JSON payload with inlined relative files and custom providers
• request — Send an IAP-authenticated HTTP request to the Orchestrator
• run — Trigger a test run using the Orchestrator
• run-known — Trigger a test run of a known test plan using the Orchestrator
• ci-run — Trigger a test run using the Orchestrator and poll for the result
• ci-run-known — Trigger a test run of a known test plan using the Orchestrator and poll for the result
• execution-log — View the scenario log for a single test execution
• execution-output — Pull all output for a single test execution (log, output.zip & status)
• execution-status — View the status summary for a single test execution
• run-output — Pull output for all executions within a given test run
• run-status — View the status summary for a test run

rtf remote prepare

Prepare a test plan for remote execution by the Orchestrator. Outputs an Orchestrator-compatible JSON payload with inlined relative files and custom providers

Usage: rtf remote prepare [OPTIONS] <TEST_PLAN_PATH>

Arguments:

• <TEST_PLAN_PATH> — Relative path to the test plan file. When using –github this must be in the format ORG/REPO/PATH

Options:

• --github — Prepare a test plan file from GitHub instead of from a local path

  Default value: false

• --ref <GIT_REF> — Optional git ref to pull files from when using –github

rtf remote request

Send an IAP-authenticated HTTP request to the Orchestrator.

The response body is written to stdout on success.

Usage: rtf remote request [OPTIONS] <PATH>

Arguments:

• <PATH> — Path on the Orchestrator to request (e.g. /health)

Options:

• -X, --method <METHOD> — HTTP method

  Default value: GET

• -d, --body <BODY> — Request body as a literal string

• --plain-text — Skip setting a content type on POST/PUT requests

  Default value: false

rtf remote run

Trigger a test run using the Orchestrator.

The output of this command will be the test run id and a link to the RTF UI to view the status

Usage: rtf remote run [OPTIONS] <TEST_PLAN_PATH>

Arguments:

• <TEST_PLAN_PATH> — Relative path to the test plan file. When using –github this must be in the format ORG/REPO/PATH

Options:

• --github — Prepare a test plan file from GitHub instead of from a local path

  Default value: false

• --ref <GIT_REF> — Optional git ref to pull files from when using –github

rtf remote run-known

Trigger a test run of a known test plan using the Orchestrator.

The output of this command will be the test run id and a link to the RTF UI to view the status

Usage: rtf remote run-known [OPTIONS] <TEST_PLAN_ID>

Arguments:

• <TEST_PLAN_ID> — Relative path to the test plan file. When using –github this must be in the format ORG/REPO/PATH

Options:

• --ref <GIT_REF> — Optional git ref to pull files from when using –github

rtf remote ci-run

Trigger a test run using the Orchestrator and poll for the result.

The output of this command is aimed at being usable in CI runs and is non-interactive.

Usage: rtf remote ci-run [OPTIONS] <TEST_PLAN_PATH>

Arguments:

• <TEST_PLAN_PATH> — Known Test Plan ID from the Orchestrator.

  You can find this on the UI page providing your known Test Plan’s details.

Options:

• --github — Prepare a test plan file from GitHub instead of from a local path

  Default value: false

• --ref <GIT_REF> — Optional git ref to pull files from when using –github

• --poll-interval-seconds <POLL_INTERVAL_SECONDS>

  Default value: 10

rtf remote ci-run-known

Trigger a test run of a known test plan using the Orchestrator and poll for the result.

The output of this command is aimed at being usable in CI runs and is non-interactive.

Usage: rtf remote ci-run-known [OPTIONS] <TEST_PLAN_ID>

Arguments:

• <TEST_PLAN_ID> — Known Test Plan ID from the Orchestrator.

  You can find this on the UI page providing your known Test Plan’s details.

Options:

• --ref <GIT_REF> — Optional git ref to pull the test plan from

• --poll-interval-seconds <POLL_INTERVAL_SECONDS>

  Default value: 10

rtf remote execution-log

View the scenario log for a single test execution

Usage: rtf remote execution-log <ID>

Arguments:

• <ID> — ID of the Orchestrator test execution you wish to view the log of

rtf remote execution-output

Pull all output for a single test execution (log, output.zip & status)

Usage: rtf remote execution-output [OPTIONS] <ID>

Arguments:

• <ID> — ID of the Orchestrator test execution you wish to pull output for

Options:

• --outdir <OUTDIR> — Directory to place output in

  Default value: output

• --force — Force removal of an existing output directory before running

  Default value: false

rtf remote execution-status

View the status summary for a single test execution

Usage: rtf remote execution-status <ID>

Arguments:

• <ID> — ID of the Orchestrator test execution you wish to view the status of

rtf remote run-output

Pull output for all executions within a given test run

Usage: rtf remote run-output [OPTIONS] <ID>

Arguments:

• <ID> — ID of the Orchestrator test run you wish to pull output for

Options:

• --outdir <OUTDIR> — Directory to place output in

  Default value: output

• --force — Force removal of an existing output directory before running

  Default value: false

rtf remote run-status

View the status summary for a test run

Usage: rtf remote run-status [OPTIONS] <ID>

Arguments:

• <ID> — ID of the Orchestrator test run you wish to view the status of

Options:

• --with-executions — Whether or not details of the underlying test executions should be included

  Default value: false

rtf version

Display CLI version and exit

Usage: rtf version