build_test_suite
Generate a Robot Framework test suite from previously executed steps, with options for BDD style, data-driven mode, tags, and documentation.
Instructions
Generate a Robot Framework test suite from previously executed steps.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tags | No | Optional test tags. | |
| bdd_style | No | Generate BDD-style suite with a Keywords section. When True, steps are grouped into behavioral keywords (Given/When/Then) and a ``*** Keywords ***`` section is appended to the generated .robot content. | |
| test_name | Yes | Name for the generated test case. | |
| session_id | No | Session containing executed steps; auto-resolves if empty/invalid. | |
| output_path | No | Optional absolute path to persist the generated .robot suite to disk directly (UTF-8; parent directories created). ALWAYS use this to save a suite — do NOT write ``rf_text`` via the ``Create File`` keyword: Robot Framework resolves ``${variables}`` and interprets ``\n``/``\t`` escapes inside the argument, which silently corrupts the suite content (assigned vars collapse to their runtime values, escaped newlines become raw line breaks). Writing here goes through plain file I/O and preserves the generated text byte-for-byte. When set, the response includes ``output_path`` and ``output_bytes`` (or ``output_error`` on a write failure — the build still succeeds). | |
| documentation | No | Optional test case documentation. | |
| data_driven_mode | No | How to render data-driven (template) test cases. "auto" (default) — auto-detect: named rows → suite_template, else per_test. "per_test" — [Template] per test case with data rows (current behavior). "suite_template" — Test Template in Settings, each named row is a separate test case with individual pass/fail in reports. | auto |
| include_pre_start | No | Whether to adopt exploratory steps executed BEFORE start_test into the generated test body. Default False excludes them (the response reports ``excluded_pre_start_count`` + a summary) so the suite reflects only intended in-test interactions. Set True to preserve the prior adoption behavior. | |
| remove_library_prefixes | No | Whether to strip library prefixes from keywords. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||