Skip to main content

XUnit - Make your tests more readible

One of the neat tricks that you can do in XUnit is to make your test more readible.

Here is one of my unit tests:

And here is how this looks by default in the Test Explorer:

Adding a configuration file

Let’s now add a configuration file to improve the default behavior.

  • Add a new JSON file to the root of your test project. Name the file xunit.runner.json.

  • Add a schema reference to get autocomplete behavior while editing the file:

    • Remark: In case of Visual Studio, this is not really necessary as it will recognize the file name and apply the correct schema automatically. 

  • Tell the build system to copy the file into the build output directory. Edit your .csproj file and add the following:

    <ItemGroup>
  <Content Include="xunit.runner.json" CopyToOutputDirectory="PreserveNewest" />
</ItemGroup>

Update the configuration

Let’s now tweak the behavior by changing some settings in the configuration file:

This will make our test list already more readable:

Remark: If you don’t see anything happening, check that you have the latest version of XUnit and XUnit.Runner.VisualStudio installed.

I invite you to check out the documentation for some other options you can tweak: https://xunit.net/docs/configuration-files

Labels:

Popular posts from this blog

.NET 8–Keyed/Named Services

A feature that a lot of IoC container libraries support but that was missing in the default DI container provided by Microsoft is the support for Keyed or Named Services. This feature allows you to register the same type multiple times using different names, allowing you to resolve a specific instance based on the circumstances. Although there is some controversy if supporting this feature is a good idea or not, it certainly can be handy. To support this feature a new interface IKeyedServiceProvider got introduced in .NET 8 providing 2 new methods on our ServiceProvider instance: object? GetKeyedService(Type serviceType, object? serviceKey); object GetRequiredKeyedService(Type serviceType, object? serviceKey); To use it, we need to register our service using one of the new extension methods: Resolving the service can be done either through the FromKeyedServices attribute: or by injecting the IKeyedServiceProvider interface and calling the GetRequiredKeyedServic...
Read more

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.
Read more

Kubernetes–Limit your environmental impact

Reducing the carbon footprint and CO2 emission of our (cloud) workloads, is a responsibility of all of us. If you are running a Kubernetes cluster, have a look at Kube-Green . kube-green is a simple Kubernetes operator that automatically shuts down (some of) your pods when you don't need them. A single pod produces about 11 Kg CO2eq per year( here the calculation). Reason enough to give it a try! Installing kube-green in your cluster The easiest way to install the operator in your cluster is through kubectl. We first need to install a cert-manager: kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.5/cert-manager.yaml Remark: Wait a minute before you continue as it can take some time before the cert-manager is up & running inside your cluster. Now we can install the kube-green operator: kubectl apply -f https://github.com/kube-green/kube-green/releases/latest/download/kube-green.yaml Now in the namespace where we want t...
Read more