Specflow ExternalData使用Excel数据源时如何生成易读唯一测试名？

问题现象 #

• 使用SpecFlow ExternalData（Excel等外部数据源）时，生成的测试名称会包含所有列参数，可读性极差，示例：

  OMS_CRD_Workflow_SecTypes_ValueExists("COMBB_GLOBAL_ID","COM","BB_xxxx_ID","BBGXXXXXX","True","True","","","True","","","","","","","False","","","","","","True","","","","","True","True","","True","","","","True","")
  

• 尝试将首列设为example testId_identifier并填充唯一值，仍无法仅用该列值作为测试名；但在.specflow文件内直接编写Examples时，首列可正常作为测试名称标识。
• 本地Scenario Outline也存在相同问题：
  原Scenario Outline代码：

  Scenario Outline: Example
      Given I am a user
      When I enter <x> as an amount
      Then the result should be <result>
      Examples:
          | example description   | x | result |
          | Example Description 1 | 3 | 3      |
          | Example Description 2 | 1 | 1      |
  

  期望生成测试名：

  Example_ExampleDescription1
  Example_ExampleDescription2
  

  实际生成测试名：

  Example("Example Description 1","3","3",null)
  Example("Example Description 2","1","1",null)
  

• 该功能在旧版SpecFlow中正常可用，当前使用NUnit运行器。

解决方法 #

1. 自定义测试名称生成器（推荐）

创建实现ITestNameGenerator接口的自定义类，指定仅提取首列或特定列值作为测试名称：

using TechTalk.SpecFlow;
using TechTalk.SpecFlow.Generator;
using TechTalk.SpecFlow.Generator.TestFramework;
using TechTalk.SpecFlow.Plugins;

[GeneratorPlugin]
public class CustomTestNameGeneratorPlugin : IGeneratorPlugin
{
    public void Initialize(GeneratorPluginEvents events, GeneratorPluginParameters parameters)
    {
        events.CustomizeTestName += Events_CustomizeTestName;
    }

    private void Events_CustomizeTestName(object sender, CustomizeTestNameEventArgs e)
    {
        if (e.TestCase.Arguments.Any())
        {
            // 提取首列值，去除空格后拼接为测试名
            var targetArg = e.TestCase.Arguments.First().Value;
            e.TestName = $"{e.ScenarioInfo.Title}_{targetArg.Replace(" ", "")}";
        }
    }
}

在specflow.json中配置该插件：

{
  "generator": {
    "plugins": [
      {
        "name": "CustomTestNameGeneratorPlugin"
      }
    ]
  }
}

2. 使用[TestName]特性指定目标列

在Scenario Outline上添加[TestName]特性，明确指定用哪一列的值作为测试名称：

• 本地Examples场景：

@TestName("<example description>")
Scenario Outline: Example
    Given I am a user
    When I enter <x> as an amount
    Then the result should be <result>
    Examples:
        | example description   | x | result |
        | Example Description 1 | 3 | 3      |
        | Example Description 2 | 1 | 1      |

• ExternalData（Excel）场景：

@TestName("<testId_identifier>")
@ExternalData(DataSource="TestData.xlsx", DataTable="Sheet1")
Scenario Outline: OMS_CRD_Workflow_SecTypes_ValueExists
    Given ...
    When ...
    Then ...

3. 检查版本适配与配置

确保SpecFlow版本与NUnit运行器兼容，建议升级到最新稳定版的SpecFlow.NUnit，同时在specflow.json中确认测试框架配置：

{
  "testFramework": {
    "name": "nunit",
    "version": "3"
  }
}

4. 清理缓存重新生成

清理项目的bin/obj目录，重新生成解决方案，避免旧的测试代码缓存影响新逻辑生效。

内容的提问来源于stack exchange，提问作者makil