Skip to main content

Pre-flight Audit & Diagnostics

Welcome to the Pre-flight Audit & Diagnostics documentation!

When running extensive, multi-directory test suites involving hundreds of interconnected API calls, it is critical to understand the execution topology before making destructive network calls. Rumour provides robust diagnostic flags to let you audit the dependency graph and variable resolution state.

1. Node Discovery (--list-nodes)

If you want to quickly see every request file Rumour has discovered in a directory without actually running anything, use the --list-nodes flag.

rumour run ./advanced_examples/ --list-nodes

Output Trace

Rumour parses the target directory and outputs a flat list of the detected files and their internal node names, ensuring your suite boundaries are correct.

Discovered Nodes:
• failing_node (home/bugsfounder/workspace/testing/advanced_examples/failing_node.toml)
• create_user (home/bugsfounder/workspace/testing/advanced_examples/create_user.toml)
• httpbin_data (home/bugsfounder/workspace/testing/advanced_examples/httpbin_data.toml)

2. Pre-flight Variable Report (--vars)

If you are dealing with complex inheritance from workspace.env.toml, CLI overrides, and request dependencies, it can be hard to know exactly what value a variable like {{base_url}} will resolve to.

Passing the --vars flag instructs Rumour to perform a dry-run style diagnostic variable resolution before it begins execution, and then print a detailed map of all exported variables after execution.

rumour run ./create_user.toml --vars --var base_url=http://localhost:4000/api/v2

Output Trace

The trace is split into two parts. First, the Pre-Flight Diagnostic Report tells you exactly how template variables were resolved before the request fired.

PRE-FLIGHT DIAGNOSTIC REPORT

• /home/bugsfounder/workspace/testing/advanced_examples/create_user.toml
└─ base_url RESOLVED http://localhost:4000/api/v2

Then, after the test execution finishes successfully, it outputs the Runtime Variables block showing everything extracted into global memory via [extract] blocks.

RUNTIME VARIABLES:
/home/bugsfounder/workspace/testing/advanced_examples/create_user.toml.create_user.id = 1
/home/bugsfounder/workspace/testing/advanced_examples/create_user.toml.id = 1
base_url = http://localhost:4000/api/v2
create_user.id = 1
id = 1

3. The audit Command (Planned Feature)

A dedicated rumour audit command is currently on the roadmap. It will provide deep static analysis of workflows without executing them, identifying:

  • Missing Variables: Undefined variables that will cause runtime errors.
  • Dependency Integrity: Verifying that all [dependencies] point to valid, existing .toml nodes and ensuring there are no circular dependencies.
  • Resource Topology: Analyzing URL structures to infer the RESTful resource model (e.g., mapping POST /users to GET /users/:id).