当您与它[Theory]
一起使用时[InlineData]
,将为提供的每个内联数据项创建一个测试。但是,如果您使用[MemberData]
它,它只会显示为一项测试。
有没有办法让[MemberData]
测试显示为多个测试?
当您与它[Theory]
一起使用时[InlineData]
,将为提供的每个内联数据项创建一个测试。但是,如果您使用[MemberData]
它,它只会显示为一项测试。
有没有办法让[MemberData]
测试显示为多个测试?
我花了很多时间试图在我的项目中解决这个问题。@NPadrutt 本人的这个相关的 Github 讨论帮助很大,但仍然令人困惑。
tl;dr 是这样的:[MemberInfo]
将报告单个组测试,除非为每个测试提供的对象可以通过实现完全序列化和反序列化IXunitSerializable
。
背景
我自己的测试设置是这样的:
public static IEnumerable<object[]> GetClients()
{
yield return new object[] { new Impl.Client("clientType1") };
yield return new object[] { new Impl.Client("clientType2") };
}
[Theory]
[MemberData(nameof(GetClients))]
public void ClientTheory(Impl.Client testClient)
{
// ... test here
}
[MemberData]
正如预期的那样,测试运行了两次,对来自 的每个对象运行一次。正如@NPadrutt 所经历的那样,测试资源管理器中只显示了一项,而不是两项。这是因为提供的对象Impl.Client
不能被 xUnit 支持的任何一个接口序列化(稍后会详细介绍)。
就我而言,我不想将测试问题渗透到我的主代码中。我以为我可以围绕我的真实课程编写一个瘦代理,这会欺骗 xUnit 跑步者认为它可以序列化它,但是在与它战斗的时间比我愿意承认的要长之后,我意识到我不理解的部分是:
对象不仅在发现过程中被序列化以计算排列;在测试开始时,每个对象也会在测试运行时反序列化。
因此,您提供的任何对象都[MemberData]
必须支持完整的往返(反)序列化。现在这对我来说似乎很明显,但是当我试图弄清楚时我找不到任何文档。
解决方案
确保每个对象(以及它可能包含的任何非原始对象)都可以完全序列化和反序列化。实现 xUnitIXunitSerializable
告诉 xUnit 它是一个可序列化的对象。
如果像我的情况一样,您不想向主代码添加属性,一种解决方案是制作一个用于测试的可序列化的瘦构建器类,它可以表示重新创建实际类所需的一切。这是上面的代码,在我开始工作后:
测试客户端生成器
public class TestClientBuilder : IXunitSerializable
{
private string type;
// required for deserializer
public TestClientBuilder()
{
}
public TestClientBuilder(string type)
{
this.type = type;
}
public Impl.Client Build()
{
return new Impl.Client(type);
}
public void Deserialize(IXunitSerializationInfo info)
{
type = info.GetValue<string>("type");
}
public void Serialize(IXunitSerializationInfo info)
{
info.AddValue("type", type, typeof(string));
}
public override string ToString()
{
return $"Type = {type}";
}
}
测试
public static IEnumerable<object[]> GetClients()
{
yield return new object[] { new TestClientBuilder("clientType1") };
yield return new object[] { new TestClientBuilder("clientType2") };
}
[Theory]
[MemberData(nameof(GetClients))]
private void ClientTheory(TestClientBuilder clientBuilder)
{
var client = clientBuilder.Build();
// ... test here
}
我不再注入目标对象有点烦人,但这只是调用我的构建器的一行额外代码。而且,我的测试通过了(并且出现了两次!),所以我没有抱怨。
MemberData 可以使用返回对象 [] 的 IEnumerable 的属性或方法。在这种情况下,您将看到每个产量的单独测试结果:
public class Tests
{
[Theory]
[MemberData("TestCases", MemberType = typeof(TestDataProvider))]
public void IsLargerTest(string testName, int a, int b)
{
Assert.True(b>a);
}
}
public class TestDataProvider
{
public static IEnumerable<object[]> TestCases()
{
yield return new object[] {"case1", 1, 2};
yield return new object[] {"case2", 2, 3};
yield return new object[] {"case3", 3, 4};
}
}
但是,只要您需要传递复杂的自定义对象,无论您有多少测试用例,测试输出窗口都将只显示一个测试。这不是理想的行为,并且在调试哪个测试用例失败时确实非常不方便。解决方法是创建您自己的包装器,该包装器将派生自 IXunitSerializable。
public class MemberDataSerializer<T> : IXunitSerializable
{
public T Object { get; private set; }
public MemberDataSerializer()
{
}
public MemberDataSerializer(T objectToSerialize)
{
Object = objectToSerialize;
}
public void Deserialize(IXunitSerializationInfo info)
{
Object = JsonConvert.DeserializeObject<T>(info.GetValue<string>("objValue"));
}
public void Serialize(IXunitSerializationInfo info)
{
var json = JsonConvert.SerializeObject(Object);
info.AddValue("objValue", json);
}
}
现在,您可以将自定义对象作为 Xunit Theories 的参数,并且仍然可以在测试运行器窗口中将它们作为独立结果查看/调试:
public class UnitTest1
{
[Theory]
[MemberData("TestData", MemberType = typeof(TestDataProvider))]
public void Test1(string testName, MemberDataSerializer<TestData> testCase)
{
Assert.Equal(1, testCase.Object.IntProp);
}
}
public class TestDataProvider
{
public static IEnumerable<object[]> TestData()
{
yield return new object[] { "test1", new MemberDataSerializer<TestData>(new TestData { IntProp = 1, StringProp = "hello" }) };
yield return new object[] { "test2", new MemberDataSerializer<TestData>(new TestData { IntProp = 2, StringProp = "Myro" }) };
}
}
public class TestData
{
public int IntProp { get; set; }
public string StringProp { get; set; }
}
希望这可以帮助。
在我最近的项目中,我遇到了同样的问题,经过一些研究,我提出的解决方案如下:
实现您的自定义 MyTheoryAttribute 扩展 FactAttribute 以及 MyTheoryDiscoverer 实现 IXunitTestCaseDiscoverer 和几个自定义 MyTestCases 扩展 TestMethodTestCase 并根据您的喜好实现 IXunitTestCase。您的自定义测试用例应该被 MyTheoryDiscoverer 识别并用于以 Xunit 框架可见的形式封装您的枚举理论测试用例,即使传递的值没有被 Xunit 本地序列化并且不实现 IXunitSerializable。
最重要的是无需更改您宝贵的被测代码!
这需要做一些工作,但因为它已经由我完成并且在 MIT 许可下可用,所以请随意使用它。它是托管在 GitHub 上的DjvuNet项目的一部分。
Xunit 支持代码的相关文件夹的直接链接如下:
要使用它,可以使用此文件创建单独的程序集,也可以将它们直接包含到您的测试项目中。
用法与 Xunit TheoryAttribute 完全相同,同时支持 ClassDataAttribute 和 MemberDataAttribute,即:
[DjvuTheory]
[ClassData(typeof(DjvuJsonDataSource))]
public void InfoChunk_Theory(DjvuJsonDocument doc, int index)
{
// Test code goes here
}
[DjvuTheory]
[MemberData(nameof(BG44TestData))]
public void ProgressiveDecodeBackground_Theory(BG44DataJson data, long length)
{
// Test code goes here
}
另一个开发者的信用也很好,但不幸的是我在 github 上找不到他的 repo
目前,当您的自定义类覆盖时,ReSharper 可以使用自定义参数显示所有 MemberData 测试ToString()
。
例如 :
public static TheoryData<Permission, Permission, Permission> GetAddRuleData()
{
var data = new TheoryData<Permission, Permission, Permission>
{
{
new Permission("book", new[] {"read"}, null),
new Permission("book", new[] {"delete"}, new[] {"2333"}),
new Permission("book", new[] {"delete", "read"}, new[] {"*", "2333"})
},
{
new Permission("book", new[] {"read"}, null),
new Permission("music", new[] {"read"}, new[] {"2333"}), new Permission
{
Resources = new Dictionary<string, ResourceRule>
{
["book"] = new ResourceRule("book", new[] {"read"}, null),
["music"] = new ResourceRule("music", new[] {"read"}, new[] {"2333"}),
}
}
}
};
return data;
}
Permission
overrides ToString()
,然后在 ReSharper 测试会话资源管理器中:
一个简单的替代方法是,如果您使用的是 .net 核心项目,而不是使用 vstest 资源管理器,您可以使用“dotnet test”在命令行中运行测试
结果是:
对于失败的成员数据测试,您将获得每个失败的成员数据测试的关联参数值