使用 SpecFlow + LivingDoc’s Test Report 產生活文件/測試報表

SpecFlow + LivingDoc’s 使用起來友善度很高,測試報告的呈現也相當得清楚,甚至支援嵌入圖片、Markdown

開發環境

  • Windows 11
  • .NET 6
  • Rider 2022.2.4

實作

先依照以下步驟準備測試專案的環境

新增一個測試專案

dotnet new mstest --language "C#" --framework "net6.0" -o Lab.LivingDocs.Test 

 

安裝套件

dotnet add package SpecFlow.MsTest --version 3.9.74
dotnet add package SpecFlow.Plus.LivingDocPlugin --version 3.9.57

 

隨便加個測試案例

Feature: 計算機
Simple calculator for adding two numbers

    Scenario: 相加兩個數字
        Given 第一個數字為 50
        And 第二個數字為 70
        When 兩個數字相加
        Then 結果應該為 120

    Scenario Outline: 相加兩個數字(Examples)
        Given 第一個數字為 <First>
        And 第二個數字為 <Second>
        When 兩個數字相加
        Then 結果應該為 <Result>

        Examples:
            | First | Second | Result |
            | 50    | 70     | 120    |
            | 30    | 40     | 70     |
            | 60    | 30     | 90     |

 

完整內容請參考

sample.dotblog/Test/Specflow3/Lab.LivingDocs/Lab.LivingDocs.Test at master · yaochangyu/sample.dotblog (github.com)

 

安裝 Command Tool

dotnet tool install --global SpecFlow.Plus.LivingDoc.CLI

 

查看一下版本 

livingdoc --version

SpecFlow.Plus.LivingDoc.CLI 和 SpecFlow.Plus.LivingDocPlugin 兩者的版本號需要一樣

 

更多的參數請參考

Installing the CLI tool — SpecFlow+ LivingDoc documentation

產生文件

livingdoc test-assembly Lab.LivingDocs.Test.dll -t TestExecution.json

TestExecution.json 是測試結果,必須要安裝 SpecFlow.Plus.LivingDocPlugin 套件並執行測試,如果檔案沒有產生出來可以看看 這裡

執行結果如下:

 

更多的指令請參考

Using the CLI tool — SpecFlow+ LivingDoc documentation

 

最後執行的結果如下:

 

SpecFlow+ LivingDoc’s 提供了很多的功能,測試報告的產生方式比較友善,內容也更加豐富,更多的內容可以參考

Welcome to SpecFlow+ LivingDoc’s documentation! — SpecFlow+ LivingDoc documentation

 

延伸閱讀

使用 Specflow+Allure Test Report 產生活文件/測試報表 | 余小章 @ 大內殿堂 - 點部落 (dotblogs.com.tw)

[TFS 2015] 實作 Build vNext 自動部署 SpecFlow 和 Pickles 測試報表 | 余小章 @ 大內殿堂 - 點部落 (dotblogs.com.tw)

[SpecFlow] SpecFlow Report and Pickles via Command Line | 余小章 @ 大內殿堂 - 點部落 (dotblogs.com.tw)

[Pickles] SpecFlow 整合 Pickles 產生活文件 | 余小章 @ 大內殿堂 - 點部落 (dotblogs.com.tw)

[SpecFlow] 使用 SpecRun 產生測試報表 | 余小章 @ 大內殿堂 - 點部落 (dotblogs.com.tw)

 

範例位置

sample.dotblog/Test/Specflow3/Lab.LivingDocs at master · yaochangyu/sample.dotblog (github.com)

若有謬誤,煩請告知,新手發帖請多包涵


Microsoft MVP Award 2010~2017 C# 第四季
Microsoft MVP Award 2018~2022 .NET

Image result for microsoft+mvp+logo