Skip to main content

Migrating from XUnit v2 to v3–Troubleshooting

The XUnit team decided to do a major overhaul of the XUnit libraries and created completely new V3 packages. So don't expect backwards compatibility but a significant architectural shift that brings improved performance, better isolation, and modernized APIs to .NET testing. While the migration requires some work, the benefits should make it worthwhile for most projects.

In this post I’ll share some of the migration problems I encountered and how to fix them.

XUnit.Abstractions is not recognized

This is an easy one. The XUnit.Abstractions has become an internal namespace and should no longer be referenced. Just remove any

using Xunit.Abstractions

statement from you code.

No v3 version of Serilog.Sinks.XUnit

After switching to the v3 version of the Xunit packages, I noticed that the old XUnit v2 version was still used somewhere causing the following compiler error:

The type 'FactAttribute' exists in both 'xunit.core, Version=2.4.2.0, Culture=neutral, PublicKeyToken=8d05b1bb7a6fdb6c' and 'xunit.v3.core, Version=3.0.0.0, Culture=neutral, PublicKeyToken=8d05b1bb7a6fdb6c'

The root cause turned out to be the Serilog.Sinks.XUnit NuGet package which doesn’t support xUnit.v3 yet at the moment of writing this post.

I fixed it by creating my own fork and compiling a new version of this NuGet package using xUnit.v3.

Bye, bye [UseCultureAttribute]

Before xUnit v3 I had to create my own [UseCultureAttribute] to use a different culture than the default culture to run my tests. Starting from v3, we can override the culture using either a command line switch or through our xunit.runner.json configuration file:

IAsyncLifetime changes

IAsyncLifetime now inherits from IAsyncDisposable, and the disposal behavior has changed:

Remark: Also notice the use of ValueTask instead of Task

Cancellation token warning

This last one isn’t really a show stopper (unless you have Treat warnings as errors active like me) but still useful to apply.

xUnit1051: Calls to methods which accept CancellationToken should use TestContext.Current.CancellationToken to allow test cancellation to be more responsive.

Remark: I noticed that you also have the option to inject an ITestContextAccessor instance as described here: https://anthonysimmon.com/xunit-cancellationtoken-support/

More about this new TestContext class can be found here: What's New in v3?

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