C# Tip: Use TestCase to run similar unit tests with NUnit

2023-11-28 3 min read CSharp Tips

Just a second!
If you are here, it means that you are a software developer. So, you know that storage, networking, and domain management have a cost .

If you want to support this blog, please ensure that you have disabled the adblocker for this site. I configured Google AdSense to show as few ADS as possible - I don't want to bother you with lots of ads, but I still need to add some to pay for the resources for my site.

Thank you for your understanding.
- Davide

In my opinion, Unit tests should be well structured and written even better than production code.

In fact, Unit Tests act as a first level of documentation of what your code does and, if written properly, can be the key to fixing bugs quickly and without adding regressions.

One way to improve readability is by grouping similar tests that only differ by the initial input but whose behaviour is the same.

Let’s use a dummy example: some tests on a simple Calculator class that only performs sums on int values.

public static class Calculator
{
    public static int Sum(int first, int second) => first + second;
}

One way to create tests is by creating one test for each possible combination of values:

public class SumTests
{

    [Test]
    public void SumPositiveNumbers()
    {
        var result = Calculator.Sum(1, 5);
        Assert.That(result, Is.EqualTo(6));
    }

    [Test]
    public void SumNegativeNumbers()
    {
        var result = Calculator.Sum(-1, -5);
        Assert.That(result, Is.EqualTo(-6));
    }

    [Test]
    public void SumWithZero()
    {
        var result = Calculator.Sum(1, 0);
        Assert.That(result, Is.EqualTo(1));
    }
}

However, it’s not a good idea: you’ll end up with lots of identical tests (DRY, remember?) that add little to no value to the test suite. Also, this approach forces you to add a new test method to every new kind of test that pops into your mind.

When possible, we should generalize it. With NUnit, we can use the TestCase attribute to specify the list of parameters passed in input to our test method, including the expected result.

We can then simplify the whole test class by creating only one method that accepts the different cases in input and runs tests on those values.

[Test]
[TestCase(1, 5, 6)]
[TestCase(-1, -5, -6)]
[TestCase(1, 0, 1)]
public void SumWorksCorrectly(int first, int second, int expected)
{
    var result = Calculator.Sum(first, second);
    Assert.That(result, Is.EqualTo(expected));
}

By using TestCase, you can cover different cases by simply adding a new case without creating new methods.

Clearly, don’t abuse it: use it only to group methods with similar behaviour - and don’t add if statements in the test method!

There is a more advanced way to create a TestCase in NUnit, named TestCaseSource - but we will talk about it in a future C# tip 😉

Wrapping up

I hope you enjoyed this article! Let’s keep in touch on Twitter or LinkedIn! 🤜🤛

Happy coding!

🐧

Code4IT

C# Tip: Use TestCase to run similar unit tests with NUnit

Further readings

Wrapping up