Output Dev Scenario File

作者 growthxaia4f6bd40ab0e无许可证440 个星标收录于 2026年10月8日更新于 2026年10月8日仓库今天更新

Create test scenario JSON files for Output SDK workflows. Use when creating test inputs, documenting expected behaviors, or setting up workflow testing.

仅含说明Software DevelopmentAI & Agents
AI 生成的概览

说明如何为 Output SDK 工作流创建测试场景 JSON 文件，并使其匹配工作流的输入 schema。

功能
讲解如何为 Output SDK 工作流编写测试场景 JSON 文件，涵盖存放目录、snake_case 命名以及与工作流 Zod inputSchema 的匹配。给出基础、完整、边界和错误场景示例，并说明如何按子目录组织以及核对清单。还列出用场景文件运行工作流、查看状态和结果的 CLI 命令。
适用场景
适用于为新 Output SDK 工作流创建测试输入、记录用例、搭建回归测试，或用特定输入调试工作流行为时。
运行要求
需要 Output SDK CLI（npx output）才能用场景文件运行工作流；可选使用 jq 校验 JSON。仅为说明文档，不含脚本。

Creating Scenario Files

Overview

This skill documents how to create test scenario JSON files for Output SDK workflows. Scenarios provide predefined inputs for testing workflows during development and validation.

When to Use This Skill

  • Creating test inputs for a new workflow
  • Documenting different use cases
  • Setting up regression tests
  • Debugging workflow behavior with specific inputs

Location Convention

Scenario files are stored INSIDE the workflow folder:

src/workflows/{workflow-name}/├── workflow.ts├── steps.ts├── types.ts└── scenarios/    ├── basic_input.json    ├── complex_input.json    └── edge_case_empty.json

Important: Scenarios are workflow-specific and live inside the workflow folder.

File Naming Convention

Use snake_case for scenario file names:

{description}_input.json

Examples:

  • basic_input.json
  • test_input_solar_panels.json
  • edge_case_empty_content.json
  • complex_with_references.json

Naming patterns:

  • basic_* - Minimal valid input
  • complex_* - Full-featured input with all options
  • edge_case_* - Boundary conditions and edge cases
  • error_* - Inputs expected to produce errors

Basic Structure

A scenario file is a JSON file that matches the workflow's inputSchema:

json
{  "fieldName": "value",  "optionalField": "optional value",  "numericField": 42,  "arrayField": ["item1", "item2"]}

Matching inputSchema

The scenario JSON must match the Zod schema defined in types.ts:

Example Schema (types.ts)

typescript
export const WorkflowInputSchema = z.object({  content: z.string().describe('Text content to process'),  numberOfIdeas: z.number().min(1).max(10).default(1),  colorPalette: z.string().optional(),  aspectRatio: z.enum(['1:1', '16:9', '9:16']).default('1:1'),  referenceUrls: z.array(z.string()).optional()});

Corresponding Scenarios

basic_input.json (minimal required fields)

json
{  "content": "This is sample content for testing the workflow."}

complete_input.json (all fields specified)

json
{  "content": "This is sample content for testing the workflow.",  "numberOfIdeas": 3,  "colorPalette": "blue and green tones",  "aspectRatio": "16:9",  "referenceUrls": [    "https://example.com/image1.jpg",    "https://example.com/image2.jpg"  ]}

Real-World Example

Based on image_infographic_nano workflow:

test_input_solar_panels.json

json
{  "content": "Solar panels work by converting sunlight into electricity through the photovoltaic effect. The process begins when photons from sunlight strike the silicon cells in the panel, knocking electrons loose from their atoms. These free electrons flow through the semiconductor material, creating an electric current. The panels contain multiple layers: a protective glass covering, anti-reflective coating to maximize light absorption, silicon cells (both n-type and p-type layers forming a junction), and a backing material. The DC electricity generated by the panels flows through an inverter, which converts it to AC electricity suitable for home use or feeding back into the power grid. Modern solar panels achieve 15-20% efficiency, meaning they convert that percentage of sunlight into usable electricity. The entire system includes mounting hardware, wiring, inverters, and often battery storage for excess energy.",  "numberOfIdeas": 3,  "aspectRatio": "16:9",  "resolution": "2K",  "numberOfGenerations": 1}

test_input_complex.json

json
{  "content": "Detailed explanation of the topic...",  "numberOfIdeas": 5,  "colorPalette": "warm earth tones with orange accents",  "artDirection": "minimalist corporate style",  "aspectRatio": "1:1",  "resolution": "4K",  "numberOfGenerations": 2,  "referenceImageUrls": [    "https://storage.example.com/style-guide.png"  ],  "storageNamespace": "test/infographics"}

Running Scenarios

Using CLI

bash
# Run with scenario filenpx output workflow run workflowName --input path/to/scenarios/basic_input.json
# Run with inline JSONnpx output workflow run workflowName --input '{"content": "test"}'

Example Commands

bash
# Basic scenarionpx output workflow run contentUtilsImageInfographicNano --input src/workflows/content_utils/image_infographic_nano/scenarios/test_input_solar_panels.json
# Complex scenarionpx output workflow run contentUtilsImageInfographicNano --input src/workflows/content_utils/image_infographic_nano/scenarios/test_input_complex.json

Related Skill: output-workflow-run for detailed CLI usage

Scenario Categories

1. Basic/Happy Path

Minimal valid input to verify the workflow works:

json
{  "content": "Simple test content",  "numberOfIdeas": 1}

2. Complete/Full-Featured

All optional fields populated:

json
{  "content": "Detailed content...",  "numberOfIdeas": 5,  "colorPalette": "custom palette",  "artDirection": "specific style",  "aspectRatio": "16:9",  "resolution": "4K",  "numberOfGenerations": 3,  "referenceImageUrls": ["https://example.com/ref.jpg"],  "storageNamespace": "test/folder"}

3. Edge Cases

Test boundary conditions:

edge_case_min_values.json

json
{  "content": "x",  "numberOfIdeas": 1}

edge_case_max_values.json

json
{  "content": "Very long content string...",  "numberOfIdeas": 10}

4. Error Cases (for validation testing)

error_missing_required.json

json
{  "numberOfIdeas": 3}

Note: Error scenarios won't pass validation but are useful for testing error handling.

Best Practices

1. Document the Purpose

Add a comment field (if supported) or create a companion README:

json
{  "_comment": "Tests workflow with multiple reference images",  "content": "...",  "referenceImageUrls": ["url1", "url2", "url3"]}

2. Use Realistic Data

json
{  "content": "Actual representative content that matches real use cases..."}

Not:

json
{  "content": "test"}

3. Cover All Enum Values

If schema has enums, create scenarios for each:

json
// scenario_aspect_1x1.json{ "aspectRatio": "1:1", ... }
// scenario_aspect_16x9.json{ "aspectRatio": "16:9", ... }
// scenario_aspect_9x16.json{ "aspectRatio": "9:16", ... }

4. Include Optional Field Variations

json
// without_optional_fields.json{ "content": "..." }
// with_all_optional_fields.json{ "content": "...", "colorPalette": "...", "artDirection": "..." }
// with_some_optional_fields.json{ "content": "...", "colorPalette": "..." }

5. Create Regression Test Scenarios

Save inputs from bug reports:

json
// regression_issue_123.json{  "_issue": "https://github.com/org/repo/issues/123",  "content": "Input that caused the bug..."}

Scenario Organization

For workflows with many scenarios, organize into subfolders:

scenarios/├── basic/│   └── minimal_input.json├── complete/│   └── all_options.json├── edge_cases/│   ├── empty_array.json│   └── max_length.json└── regression/    └── issue_123.json

Verification Checklist

  • Scenario file located in scenarios/ folder inside workflow directory
  • File uses .json extension
  • File name uses snake_case
  • JSON is valid and parseable
  • All required fields from inputSchema are present
  • Field types match schema (strings, numbers, arrays, etc.)
  • Enum values are valid options from schema
  • Numbers are within min/max constraints
  • At least one basic scenario exists
  • Workflow runs successfully with the scenario

Testing Scenarios

Validate JSON Syntax

bash
# Check JSON is validcat scenarios/basic_input.json | jq .

Run and Verify

bash
# Run workflow with scenarionpx output workflow run workflowName --input scenarios/basic_input.json
# Check status if asyncnpx output workflow status <workflowId>
# Get resultnpx output workflow result <workflowId>

Related Skills

  • output-dev-types-file - Defining inputSchema that scenarios must match
  • output-dev-folder-structure - Understanding scenarios folder location
  • output-workflow-run - Running workflows with scenario files
  • output-workflow-list - Finding available workflows

来源与署名

来源：growthxai/output位于coding_assistants/claude/plugins/outputai/skills/output-dev-scenario-file提交a4f6bd4

许可证： 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架

更多来自 growthxai/output 的技能

Output Workflow Trace File

growthxai

将本地 Output SDK 工作流追踪文件的最终输出渲染为易读的 Markdown。

Productivity & Workflow440今天更新

Output Plan Workflow

growthxai

引导智能体为新的 Output.ai 工作流生成一份 Markdown 实施计划。

AI & Agents440今天更新

Output Meta Post Flight

growthxai

用于 Output SDK 工作流执行后的校验清单，涵盖步骤完成、规范遵循、质量与交付物验证。

AI & Agents440今天更新

Output Dev Types File

growthxai

说明如何为 Output SDK 工作流编写包含 Zod 模式的 types.ts 文件。

Software Development440今天更新

Output Dev Step Function

growthxai

说明如何在 Output SDK 工作流的 steps.ts 中编写步骤函数，涵盖 I/O、HTTP、LLM 调用与错误处理。

Software Development440今天更新

Output Dev Llm Streaming

growthxai

指导在 Output 工作流步骤中实现 LLM 文本流式输出，涵盖流式 API、回调与错误处理。

Software Development440今天更新

更多Software Development技能

Playground

anthropics

精选

构建自包含的交互式 HTML 演练场，包含控件、实时预览和可复制的提示词输出。

Software Development37K今天更新

M5 Onboard

anthropics

精选

通过 USB 检测 M5Stack ESP32 开发板，刷写 UIFlow 2.0 固件并安装 MicroPython 应用包。

Software Development37K今天更新

Cardputer Buddy

anthropics

精选

指导迭代 Cardputer-Adv 的 MicroPython 应用包：添加应用、通过 USB 串口推送文件、查看日志并运行 REPL 命令。

Software Development37K今天更新

Dpop Adoption

google

精选

指导为 Google OAuth 平台实现 OAuth 2.0 DPoP（RFC 9449）发送方约束刷新令牌。

Software Development21K今天更新

Gemini Live Api

google

精选

生成 Gemini Live API WebSocket 客户端类、测试、文档和用于双向流式传输的演示界面。

Software Development21K今天更新

Gemini Api

google

精选

指导如何在 Google Agent Platform 上使用 Gen AI SDK 调用 Gemini API，涵盖多语言与多项能力。

Software Development21K今天更新