Storyteller项目入门指南：从零开始搭建行为驱动开发环境

前言

Storyteller是一个功能强大的行为驱动开发(BDD)框架，它允许开发团队通过可执行的规范文档来定义和验证系统行为。本文将详细介绍如何在不同环境中配置Storyteller项目，帮助开发者快速上手这个强大的工具。

环境支持概览

Storyteller目前支持多种运行环境：

1. 跨平台支持：Storyteller 4.0及以上版本基于CoreCLR，可在Mac OSX等任何支持CoreCLR的操作系统上运行
2. 项目类型支持：
   • 新版dotnet CLI项目
   • 传统csproj项目
   • .NET 4.6项目

Storyteller 5.0配置指南（推荐）

对于使用Visual Studio 2017和dotnet cli的Netstandard 2项目，强烈推荐使用Storyteller 5.0。

基础配置步骤

1. 创建项目配置文件MYPROJECT.csproj，内容如下：

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netcoreapp2.0</TargetFramework>
    <OutputType>EXE</OutputType>
  </PropertyGroup>
  <ItemGroup>
    <DotNetCliToolReference Include="dotnet-storyteller" Version="5.0.0" />
  </ItemGroup>
  <ItemGroup>
    <PackageReference Include="StoryTeller" Version="5.0.0" />
  </ItemGroup>
</Project>

2. 在项目目录下执行命令：
   • dotnet restore：恢复依赖包
   • dotnet run：在控制台运行所有规范（适用于持续集成）
   • dotnet storyteller：打开Storyteller规范编辑器

Storyteller 4.0配置指南

新版dotnet CLI项目配置

1. 创建控制台应用程序项目
2. 添加NuGet包依赖：
   • Storyteller：主库
   • dotnet-storyteller：CLI工具扩展
3. 在Program.Main()中配置系统连接：

public static int Main(string[] args)
{
    return StorytellerAgent.Run(args);
}

对于复杂系统，可以使用自定义ISystem实现：

public static int Main(string[] args)
{
    return StorytellerAgent.Run<MySystem>(args);
}

传统csproj项目配置

1. 创建类库项目
2. 添加Storyteller NuGet包
3. 在解决方案中安装StorytellerRunnerCsproj包
4. 添加执行脚本（推荐）：

packages\StorytellerRunnerCsproj.4.0.0.463\tools\StorytellerRunner.exe %* --app-domain

注意：使用--app-domain标志是必须的。

Storyteller 3.0配置指南

适用于传统.NET 4.6项目：

1. 创建类库项目
2. 添加Storyteller 3.0 NuGet包
3. 可选添加自定义ISystem实现
4. 添加执行脚本：

packages\Storyteller.3.0.1\tools\ST.exe %*

命令行工具使用

Storyteller命令行工具遵循Unix风格语法：

1. 基本命令结构：

   • dotnet storyteller [command] [options]

2. 常用命令：

   • open：打开规范编辑器
   • run：运行测试套件
   • ?或help：查看帮助

3. 查询特定命令用法：

   • dotnet storyteller ? run：查看run命令帮助

规范持久化机制

Storyteller 4.0+使用Markdown格式存储规范：

1. 规范存储在项目根目录下的/Specs文件夹中
2. 子文件夹表示套件结构
3. 首次需要时会自动创建目录

最佳实践建议

1. 项目结构：为规范创建独立项目，保持与生产代码分离
2. 版本选择：新项目优先使用Storyteller 5.0
3. 开发流程：
   • 本地开发使用Debug配置
   • 持续集成使用Release配置
4. 规范管理：利用Markdown格式的优势，保持规范可读性

通过本文的指导，开发者可以快速搭建Storyteller环境，开始编写可执行的规范文档，实现真正的行为驱动开发。