在 xUnit 中验证集合大小的惯用方法是什么？

Question

I have in my test suite a test that goes something like this:

[Fact]
public void VerifySomeStuff()
{
    var stuffCollection = GetSomeStuff();

    Assert.Equal(1, stuffCollection.Count());
}

This test works as I expect, but when I run it xUnit prints a warning:

warning xUnit2013: Do not use Assert.Equal() to check for collection size.

However, no alternative is suggested in the warning, and a google search takes me to the source code in xUnit for the test that verifies this warning is printed.

If Assert.Equal() isn't the correct way to verify the length of a collection, what is?

---

To clarify: I realize that I could "trick" xUnit into not emitting this warning by eg extracting a variable or using Assert.True(stuff.Count() == 1) instead. The latter is just hacky, and the former feels like if xUnit is eg trying to avoid multiple iterations of an IEnumerable<T> , then this is the wrong way to go (because I'll get compiler hints about that separately if it's an issue), and xUnit itself should never have to evaluate the input more than once (in fact it probably will get the same input regardless of variable extraction, because of how C# function calling works).

So, I'm not just interested in removing that warning from my output. An answer to my question also explains why that warning is included in the library in the first place and why whatever approach I should use instead is better.

Answer 1

Xunit offers quick fixes for most of its warnings, so you should be able to see what it thinks is "right".

In your case, it wants you to use Assert.Single since you are expecting exactly one item. If you were asserting an arbitrary number, like 412, then it would not give you a warning about using Count . It will only suggest using Single if you are expecting one item, or Empty if you are expecting no items.

Answer 2

If you have more than one item, you can't use Assert.Single.

The expectation seems to be that you should use Assert.Collection :

var stuffCollection = GetSomeStuff();

Assert.Collection(stuffCollection, 
    item => true, // this lambda verifies the first item
    item => true, // second item
);

The assertion above verifies that there are exactly two items in the collection. You can provide stricter lambdas (such as item => item.property1 == 7 ) for each item if you want.

Personally, I'm not a fan; this seems like a very verbose way of saying how long you want the collection to be.

Answer 3

I found this give me the same error:

Assert.Equal(2, vm.Errors.Count());

And casting it stopped the error from appearing.

Assert.Equal(2, (int)vm.Errors.Count());

Answer 4

I had same issue when I used Count property as below in xUnit.

After, I use Count() function on collection, it fixed my issue.

Answer 5

对于列表中的单个元素，最好改用它： Assert.Single(resultList);

Answer 6

Look I won't tell anyone if you just ignore the warning. Personally I think its more hassle than its worth. If you have an.editorconfig:

[*.cs]
dotnet_diagnostic.xUnit2013.severity = none # warning xUnit2013: Do not use Assert.Equal() to check for collection size.

Answer 7

The rule only applies when testing for 0 or 1 items in collection.

Assert.Equal(0, result.Length) // rule warning, use .Empty
Assert.Equal(1, result.Length) // rule warning, use .Single
Assert.Equal(2, result.Length) // ok

To satisy rule:

Assert.Empty(result); // for 0 items
Assert.Single(result); // for 1 item
Assert.NotEmpty(result); // for 2 or more items

When using Assert.NotEmpty we may as well be precise with a count

Assert.Equal(2, result.Length) // Does not violate rule xUnit2013

https://xunit.net/xunit.analyzers/rules/xUnit2013

Answer 8

To check the length of a collection with one element, you can use:

Assert.Single(yourCollection)