BDDfy 技术文档

1. 安装指南

BDDfy 是一个简单易用的 BDD（行为驱动开发）框架，支持自定义和扩展。要使用 BDDfy，您需要先安装 TestStack.BDDfy NuGet 包。在您的项目中选择“管理 NuGet 包”，然后搜索并安装 TestStack.BDDfy。

安装命令如下：

Install-Package TestStack.BDDfy

如果您是第一次使用 BDDfy，可以安装示例 NuGet 包来查看完整的示例项目：

Install-Package TestStack.BDDfy.Samples

2. 项目的使用说明

BDDfy 的使用非常灵活，可以与任何测试框架配合使用，甚至可以完全不使用测试框架，直接应用于 POCO（普通类）。

下面是一个使用 BDDfy 的基本示例：

[Story(
    AsA = "账户持有者",
    IWant = "我想从 ATM 取款",
    SoThat = "这样我可以在银行关闭时取钱")]
public class AccountHasInsufficientFund
{
    private Card _card;
    private Atm _atm;

    [Given(StepText = "账户余额为 $10")]
    void GivenAccountHasEnoughBalance()
    {
        _card = new Card(true, 10);
    }

    void AndGivenTheCardIsValid()
    {
    }

    void AndGivenTheMachineContainsEnoughMoney()
    {
        _atm = new Atm(100);
    }

    void WhenTheAccountHolderRequests20()
    {
        _atm.RequestMoney(_card, 20);
    }

    void ThenTheAtmShouldNotDispenseAnyMoney()
    {
        Assert.AreEqual(0, _atm.DispenseValue);
    }

    void AndTheAtmShouldSayThereAreInsufficientFunds()
    {
        Assert.AreEqual(DisplayMessage.InsufficientFunds, _atm.Message);
    }

    void AndTheCardShouldBeReturned()
    {
        Assert.IsFalse(_atm.CardIsRetained);
    }

    [Fact]
    public void Execute()
    {
        this.BDDfy();
    }
}

执行上述代码后，会在控制台和输出文件夹中生成一个 HTML 格式的报告。

3. 项目API使用文档

BDDfy 提供了丰富的 API 以支持定制和扩展。以下是一个使用 Fluent API 的例子：

[Fact]
public void CardHasBeenDisabled()
{
    this.Given(s => s.GivenTheCardIsDisabled())
        .When(s => s.WhenTheAccountHolderRequests(20))
        .Then(s => s.CardIsRetained(true), "ATM 应该保留卡片")
            .And(s => s.AndTheAtmShouldSayTheCardHasBeenRetained())
        .BDDfy(htmlReportName: "ATM");
}

以上代码生成报告如下：

场景：卡片已被禁用
给定卡片已被禁用
当账户持有者请求 20
那么ATM应该保留卡片
并且ATM应显示卡片已被保留

BDDfy 的所有操作都是可扩展和可定制的。

4. 项目安装方式

项目的安装方式已在“安装指南”中详细说明，主要通过 NuGet 包管理器进行安装。