Pass complex parameters to [Theory]

by

There are many xxxxData attributes in XUnit. Check out for example the MemberData attribute.

You can implement a property that returns IEnumerable<object[]>. Each object[] that this method generates will be then “unpacked” as a parameters for a single call to your [Theory] method.

See i.e. these examples from here

Here are some examples, just for a quick glance.

MemberData Example: just here at hand

public class StringTests2
{
    [Theory, MemberData(nameof(SplitCountData))]
    public void SplitCount(string input, int expectedCount)
    {
        var actualCount = input.Split(' ').Count();
        Assert.Equal(expectedCount, actualCount);
    }
 
    public static IEnumerable<object[]> SplitCountData => 
        new List<object[]>
        {
            new object[] { "xUnit", 1 },
            new object[] { "is fun", 2 },
            new object[] { "to test with", 3 }
        };
}

XUnit < 2.0: Another option is ClassData, which works the same, but allows to easily share the ‘generators’ between tests in different classes/namespaces, and also separates the ‘data generators’ from the actual test methods.

ClassData Example

public class StringTests3
{
    [Theory, ClassData(typeof(IndexOfData))]
    public void IndexOf(string input, char letter, int expected)
    {
        var actual = input.IndexOf(letter);
        Assert.Equal(expected, actual);
    }
}
 
public class IndexOfData : IEnumerable<object[]>
{
    private readonly List<object[]> _data = new List<object[]>
    {
        new object[] { "hello world", 'w', 6 },
        new object[] { "goodnight moon", 'w', -1 }
    };
 
    public IEnumerator<object[]> GetEnumerator()
    { return _data.GetEnumerator(); }
 
    IEnumerator IEnumerable.GetEnumerator()
    { return GetEnumerator(); }
}

XUnit >= 2.0: Instead of ClassData, now there’s an ‘overload’ of [MemberData] that allows to use static members from other classes. Examples below have been updated to use it, since XUnit < 2.x is pretty ancient now.
Another option is ClassData, which works the same, but allows to easily share the ‘generators’ between tests in different classes/namespaces, and also separates the ‘data generators’ from the actual test methods.

MemberData Example: look there to another type

public class StringTests3
{
    [Theory, MemberData(nameof(IndexOfData.SplitCountData), MemberType = typeof(IndexOfData))]
    public void IndexOf(string input, char letter, int expected)
    {
        var actual = input.IndexOf(letter);
        Assert.Equal(expected, actual);
    }
}
 
public class IndexOfData : IEnumerable<object[]>
{
    public static IEnumerable<object[]> SplitCountData => 
        new List<object[]>
        {
            new object[] { "hello world", 'w', 6 },
            new object[] { "goodnight moon", 'w', -1 }
        };
}

Disclaimer 🙂

Last time checked @20210903 with dotnetfiddle.net on C# 5.0 and xunit 2.4.1 .. and failed. I couldn’t mix-in a test-runner into that fiddle. But at least it compiled fine. Note that this was originally written years ago, things changed a little. I fixed them according to my hunch and comments. So.. it may contain inobvious typos, otherwise obvious bugs that would instantly pop up at runtime, and traces of milk & nuts.

More Related Contents:

  1. Mocking IPrincipal in ASP.NET Core
  2. Execute unit tests serially (rather than in parallel)
  3. Assert an Exception using XUnit
  4. Mock HttpContext.Current in Test Init Method
  5. Unit testing void methods?
  6. Mocking Static Methods
  7. C# “internal” access modifier when doing unit testing
  8. How to mock static methods in c# using MOQ framework?
  9. How to check if a list is ordered?
  10. Run code once before and after ALL tests in xUnit.net
  11. Unit testing and checking private variable value
  12. Mock static property with moq
  13. How to mock the new HttpClientFactory in .NET Core 2.1 using Moq
  14. How do I ignore the UTF-8 Byte Order Marker in String comparisons?
  15. Mock HttpContext for unit testing a .NET core MVC controller?
  16. Mock Verify() Invocation
  17. Using Moq to mock an asynchronous method for a unit test
  18. Visual Studio 2013 doesn’t discover unit tests
  19. MSTest Equivalent for NUnit’s Parameterized Tests?
  20. C# – Asserting two objects are equal in unit tests
  21. Moq + Unit Testing – System.Reflection.TargetParameterCountException: Parameter count mismatch
  22. How to unit test with ILogger in ASP.NET Core
  23. Dependency injection with a static logger, static helper class
  24. Looking for an example of a custom SynchronizationContext (Required for unit testing)
  25. Unit Testing File I/O
  26. How do I mock User.Identity.GetUserId()?
  27. How do I Moq a method that has an optional argument in its signature without explicitly specifying it or using an overload?
  28. Error while executing test, if using CreateResponse extention method to return Azure Function HttpResonseMessage
  29. Is it a good way of unit testing to use another, tested function to make preparations for the actual test?
  30. How do you unit test ASP.NET Core MVC Controllers that return anonymous objects?

Leave a Comment