What are Tests?
Tests are reusable checks for individual workflow blocks. They let you freeze a real or hand-written set of block inputs, run that block again against the current workflow draft, and verify the output with an assertion. Use tests when you want to answer questions like:- Does this Extract block still return the expected invoice total?
- Does this Function block still compute the validation flag correctly?
- Does this Split block still assign pages to the right subdocuments?
- Does this Classifier block still route a file to the expected category?
Testable Blocks
Tests are supported for:| Block | What you usually assert |
|---|---|
| Extract | Extracted JSON fields |
| Function | Returned JSON fields from the function output schema |
| Split | Split manifest quality or produced subdocument file handles |
| Classifier | Produced category file handles |
What a Test Stores
A workflow test definition stores three things:- The block to test - the block id and block type.
- The block inputs - JSON and file handle inputs captured from a workflow run or entered explicitly.
- One assertion - the expected condition for one declared output handle.
handle_inputs from that run into the test. If the inputs include files, Retab
materializes durable file references for the test so future runs do not depend
on the original browser session.
You can also provide explicit inputs manually. JSON handles store raw JSON data,
and file handles store a document reference.
Assertions
An assertion targets a declared output handle and, optionally, a path inside that handle’s JSON payload. Common targets include:| Block | Output target examples |
|---|---|
| Extract | output-json-0.total, output-json-0.vendor.name |
| Function | output-json-0.is_valid, output-json-0.error_message |
| Split | output-json-splits or a subdocument file handle |
| Classifier | A category file handle |
output-json-0.totalis equal to1234.56output-json-0.is_validis trueoutput-json-0.vendor.namecontains"Acme"output-json-splitshas Split IOU greater than or equal to0.95output-json-0.summarymatches an LLM rubric
Running Tests
You can run one test from its detail page, run tests for a block, or run all tests in a workflow from the Tests page. When a test runs, Retab:- Loads the current workflow draft and the current block configuration.
- Rebuilds the saved handle inputs into normal workflow runtime inputs.
- Executes only the selected block.
- Collects the raw output, declared handle outputs, routing decision, warnings, and duration.
- Resolves the assertion target from the block outputs.
- Evaluates the assertion and records a run result.
run_id, then read results under /v1/workflows/tests/results?run_id={run_id}.
Results
A parent test run uses the shared run lifecycle:| Status | Meaning |
|---|---|
| pending | The run has been scheduled but has not started yet. |
| running | One or more test results are still executing. |
| completed | The run finished; inspect result verdicts for pass/fail detail. |
| error | The parent run failed before all results could be recorded. |
| cancelled | The run was cancelled. |
| Status | Meaning |
|---|---|
| passed | The block ran successfully and the assertion passed. |
| failed | The block ran successfully, but the assertion did not pass. |
| blocked | The assertion could not be evaluated against the selected target. |
| error | The block replay failed or another execution error occurred. |
Staleness and Schema Drift
Tests are tied to the block inputs and output schema that existed when the test was created or last updated. If the workflow draft changes, Retab compares the saved fingerprints and schema dependencies against the current block. In the dashboard, the staleness badge tells you whether a test is:| Badge | Meaning |
|---|---|
| not run | The test has not produced a run record yet. |
| up to date | The latest run still matches the current block schema. |
| stale | The block schema or relevant assertion dependency changed. Run the test again or update the assertion. |
| unknown | Retab could not determine staleness for this test. |
Recommended Workflow
- Run the workflow on a representative document.
- Open the Tests page and create a workflow test from that completed run.
- Pick the block output field or handle you want to protect.
- Define one assertion for the expected behavior.
- Run the test after changing schemas, prompts, code, categories, or split definitions.
- Use stale tests as a review queue before publishing workflow changes.