Home CLI Command

planemo workflow_test_on_invocation

Run defined tests against existing workflow invocation.

Revised
2026-05-11
Rev
1
cli planemo workflow_test_on_invocation
No CLI metadata registered for planemo/workflow_test_on_invocation. The note body below remains the source of truth until the upstream package's meta subpath is wired into this site.

planemo workflow_test_on_invocation

Run defined tests against existing workflow invocation.

Synopsis

planemo workflow_test_on_invocation [OPTIONS] TEST.YML INVOCATION_ID

Arguments

ArgumentTypeRequiredHelp
TEST.YMLpathyes
INVOCATION_IDtextyes

Options

OptionTypeDefaultRequiredHelp
—galaxy_urltextyesRemote Galaxy URL to use with external Galaxy engine.
—galaxy_user_keytextyesUser key to use with external Galaxy engine.
—test_indexinteger1Select which test to check. Counting starts at 1
—update_test_dataflagfalseUpdate test-data directory with job outputs (normally written to directory —job_output_files if specified.)
—test_outputpathtool_test_output.htmlOutput test report (HTML - for humans) defaults to tool_test_output.html.
—test_output_textpathOutput test report (Basic text - for display in CI)
—test_output_markdownpathOutput test report (Markdown style - for humans & computers)
—test_output_markdown_minimalpathOutput test report (Minimal markdown style - jost the table)
—test_output_xunitpathOutput test report (xunit style - for CI systems
—test_output_junitpathOutput test report (jUnit style - for CI systems
—test_output_alluredirectoryOutput test allure2 framework resutls
—test_output_jsonpathtool_test_output.jsonOutput test report (planemo json) defaults to tool_test_output.json.
—job_output_filesdirectoryWrite job outputs to specified directory.
—summarychoiceminimalSummary style printed to planemo’s standard output (see output reports for more complete summary). Set to ‘none’ to disable completely.
—test_timeoutinteger86400Maximum runtime of a single test in seconds.

Output

Describe stdout/stderr shape, exit-code contract, and any JSON-report flags here.

Examples

Add canonical invocations here.

Gotchas

Document non-obvious behavior and common failure modes here.