Home CLI Command

gxwf validate-tests

Validate Galaxy workflow test files and optionally cross-check labels against their workflow.

Revised
2026-05-06
Rev
3
cli gxwf validate-tests @galaxy-tool-util/cli @ 1.4.0 upstream ↗

gxwf validate-tests

Validate a workflow-test file (*-tests.yml, *.gxwf-tests.yml) against the Galaxy Tests schema

gxwf validate-tests [options] <file>

Arguments

name req variadic description
file Tests file (*-tests.yml)

Options

flag arg description
--json Output structured JSON report
--workflow <path> <path> Cross-check job inputs + output assertions against a workflow (.ga / .gxwf.yml)

gxwf validate-tests

Validate a Galaxy workflow test file (*-tests.yml or *.gxwf-tests.yml) against the Galaxy tests schema. Optionally cross-check the test file against a workflow so missing input labels, missing output labels, and type mismatches fail before a slow Planemo run.

<file> is a workflow test YAML file, usually named <workflow>-tests.yml or <workflow>.gxwf-tests.yml.

Output

Default output is human-readable validation diagnostics.

With --json, the command emits a structured report describing schema errors and, when --workflow is supplied, workflow-coherence errors such as missing labels or incompatible input values.

Examples

gxwf validate-tests workflow-tests.yml
gxwf validate-tests workflow-tests.yml --json
gxwf validate-tests workflow-tests.yml --workflow workflow.gxwf.yml --json

Gotchas

  • This is the cheap static gate before Planemo. It does not execute the workflow and does not prove assertions pass on real outputs.
  • Use --workflow whenever the workflow file is available. Schema-valid tests can still reference stale input/output labels after workflow edits.
  • Run this before planemo workflow_test_on_invocation or full planemo test; it catches authoring mistakes without starting Galaxy.
  • The assertion vocabulary itself comes from tests-format; strategy for choosing assertions lives in planemo-asserts-idioms.

Incoming References (2)

  • Planemo Asserts Idiomsrelated note— Decision and idiom guide for picking planemo workflow-test assertions: which family per output type, how to size tolerances, when to validate.
  • Galaxy workflow test formatrelated note— JSON Schema for the planemo workflow test format (`<workflow>-tests.yml`), vendored from `@galaxy-tool-util/schema`.