VerifyTests/Verify中的组合测试功能详解
组合测试概述
VerifyTests/Verify框架提供了一项强大的组合测试(Combinations)功能,它允许开发者对给定的输入列表进行全组合测试,并将所有测试结果输出到单个文件中。这种测试方式特别适合需要验证多种输入组合的场景,能显著提高测试覆盖率和效率。
基本使用示例
被测方法示例
假设我们有一个构建地址的方法:
public static string BuildAddress(string prefix, string name, int number)
{
return $"{prefix} {name} {number}";
}
组合测试编写
我们可以这样编写组合测试:
[Test]
public Task BuildAddressTest()
{
var prefixes = new[] {"Mr", "Ms"};
var names = new[] {"John", "Jane"};
var numbers = new[] {1, 2};
return Verify(Combination.BuildAddress(prefixes, names, numbers))
.UseMethodName("BuildAddressTest");
}
测试结果输出
测试结果会以整齐的表格形式呈现:
{
Cases: [
{
Input: {
prefix: Mr,
name: John,
number: 1
},
Result: Mr John 1
},
{
Input: {
prefix: Mr,
name: John,
number: 2
},
Result: Mr John 2
},
// 其他组合...
]
}
列对齐规则
框架会自动根据数据类型进行列对齐:
- 数值类型(int, double, float等):右对齐
- 其他所有类型:左对齐
这种对齐方式使输出结果更易读,特别是当数据量较大时。
异常捕获处理
默认行为
默认情况下,如果被测方法抛出异常,测试会直接失败并抛出该异常。
启用异常捕获
可以通过captureExceptions = true
参数捕获异常,将异常信息作为测试结果的一部分:
[Test]
public Task BuildAddressExceptionsTest()
{
var prefixes = new[] {"Mr", "Invalid"};
var names = new[] {"John", null};
var numbers = new[] {1, 999};
return Verify(Combination.BuildAddress(prefixes, names, numbers))
.UseMethodName("BuildAddressExceptionsTest")
.CaptureExceptions();
}
全局异常捕获设置
可以在全局范围内启用异常捕获:
VerifySettings.Initialize(settings =>
{
settings.UseCombinationCaptureExceptions();
});
如需在特定测试中禁用全局设置,可使用captureExceptions: false
参数。
结果序列化定制
默认序列化器
框架使用CombinationResultsConverter
进行结果序列化,它提供了灵活的定制能力。
自定义序列化器
开发者可以通过继承CombinationResultsConverter
来定制序列化行为:
public class CustomCombinationConverter : CombinationResultsConverter
{
protected override string BuildPropertyName(string name)
{
// 自定义属性名生成逻辑
return name.ToUpper();
}
}
对于需要完全控制的情况,可以直接继承WriteOnlyJsonConverter<CombinationResults>
。
注册自定义序列化器
通过模块初始化器注册自定义序列化器:
[ModuleInitializer]
public static void Init()
{
VerifierSettings.ModifySerialization(settings =>
{
settings.Converters.Insert(0, new CustomCombinationConverter());
});
}
表头控制
默认无表头
默认情况下,结果输出不包含表头。
启用表头
通过header: true
参数可以启用表头显示:
[Test]
public Task BuildAddressWithHeaderTest()
{
var prefixes = new[] {"Mr", "Ms"};
var names = new[] {"John", "Jane"};
var numbers = new[] {1, 2};
return Verify(Combination.BuildAddress(prefixes, names, numbers))
.UseMethodName("BuildAddressWithHeaderTest")
.UseCombinationHeader();
}
表头将使用输入集合的变量名。
自定义表头名称
可以覆盖默认的表头名称:
[Test]
public Task BuildAddressWithHeaderOverridesTest()
{
var prefixes = new[] {"Mr", "Ms"};
var names = new[] {"John", "Jane"};
var numbers = new[] {1, 2};
return Verify(Combination.BuildAddress(prefixes, names, numbers))
.UseMethodName("BuildAddressWithHeaderOverridesTest")
.UseCombinationHeader("Title", "FirstName", "HouseNumber");
}
全局表头设置
可以在全局范围内启用表头:
VerifySettings.Initialize(settings =>
{
settings.UseCombinationHeader();
});
最佳实践建议
- 合理控制组合规模:全组合测试可能导致组合爆炸,对于大型输入集考虑使用抽样策略
- 善用异常捕获:对于预期会抛出异常的场景,启用异常捕获可以更清晰地展示测试结果
- 自定义序列化:针对复杂类型,定制序列化逻辑可以提高结果可读性
- 表头使用:当测试组合较多时,启用表头可以显著提高结果可读性
VerifyTests/Verify的组合测试功能为开发者提供了一种高效验证多种输入组合的方式,通过灵活的参数配置和定制能力,可以适应各种复杂的测试场景。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考