Use ServiceCollection in Unit Tests with .NET

October 10, 2024 5 min read BEN ABT

A popular unit test - and also a necessary test - is the correct registration of interfaces and their implementation with dependency injection. And a common mistake is that the associated IServiceCollection interface is used for mocks that lead to faulty tests.

The problem

Given the following code, in which an interface and an implementation are registered in a .NET application.

C#
 1using Microsoft.Extensions.DependencyInjection;
 2using System;
 3
 4public interface IMyService
 5{
 6    void DoSomething();
 7}
 8
 9public class MyService : IMyService
10{
11    public void DoSomething()
12    {
13        Console.WriteLine("Doing something...");
14    }
15}
16
17public class Startup
18{
19    public void ConfigureServices(IServiceCollection services)
20    {
21        // Registering the singleton
22        services.AddSingleton<IMyService, MyService>();
23    }
24}

An obvious test would be to check that AddSingleton of the interface is called.

C#
 1public class StartupTests
 2{
 3    [Fact]
 4    public void ConfigureServices_ShouldRegisterIMyServiceAsSingleton()
 5    {
 6        // Arrange
 7        IServiceCollection services = Substitute.For<IServiceCollection>();
 8        Startup startup = new Startup();
 9
10        // Act
11        startup.ConfigureServices(services);
12
13        // Assert
14        services.Received().AddSingleton<IMyService, MyService>();
15    }
16}

The problem is that AddSingleton is a simple extension method that itself cannot be easily mocked and thus used for mocked tests.

C#
 1// Licensed to the .NET Foundation under one or more agreements.
 2// The .NET Foundation licenses this file to you under the MIT license.
 3
 4// Microsoft.Extensions.DependencyInjection.Abstractions.dll
 5
 6public static IServiceCollection AddSingleton<TService, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] TImplementation>(this IServiceCollection services)
 7    where TService : class
 8    where TImplementation : class, TService
 9{
10    ThrowHelper.ThrowIfNull(services);
11
12    return services.AddSingleton(typeof(TService), typeof(TImplementation));
13}

A corresponding test fails with the following error message:

Message: NSubstitute.Exceptions.ReceivedCallsException : Expected to receive a call matching: Add(ServiceType: IMyService Lifetime: Singleton ImplementationType: MyService) Actually received no matching calls. Received 1 non-matching call (non-matching arguments indicated with ‘*’ characters): Add(ServiceType: IMyService Lifetime: Singleton ImplementationType: MyService)

Use of ServiceCollection

The generally recommended solution in the community is not to use the interface IServiceCollection for testing, but the implementation ServiceCollection.

C#
 1// Arrange
 2ServiceCollection services = new ServiceCollection();
 3Startup startup = new Startup();
 4
 5// Act
 6startup.ConfigureServices(services);
 7
 8// Assert
 9ServiceDescriptor? serviceDescriptor = services
10    .Where(
11        serviceDescriptor => serviceDescriptor.ServiceType == typeof(IMyService)
12        && serviceDescriptor.ImplementationType == typeof(MyService)
13        && serviceDescriptor.Lifetime == ServiceLifetime.Singleton)
14    .SingleOrDefault();
15
16Assert.NotNull(serviceDescriptor);

The enormous advantage is that I am not testing a mock, but the real implementation of ServiceCollection, which is also used at runtime. Furthermore, asserting ServiceCollection in more complex tests is much easier.

To make it even easier, you can build simple test extensions to reduce the test effort per test:

C#
 1/// <summary>
 2/// Provides extension methods for verifying the registration of services in a <see cref="ServiceCollection"/>.
 3/// </summary>
 4public static class ServiceCollectionExtensions
 5{
  /// <summary>
  /// Verifies that a specific service and its implementation are registered in the <see cref="ServiceCollection"/> 
  /// with the <see cref="ServiceLifetime.Singleton"/> lifetime the specified number of times.
  /// </summary>
  /// <typeparam name="TService">The service type to verify.</typeparam>
  /// <typeparam name="TImplementation">The implementation type of the service to verify.</typeparam>
  /// <param name="collection">The <see cref="ServiceCollection"/> to check.</param>
  /// <param name="times">The expected number of times the service and its implementation are registered.</param>
  public static void VerifyAddSingleton<TService, TImplementation>(this ServiceCollection collection, int times = 1)
      where TImplementation : class, TService
  {
      VerifyAdd<TService, TImplementation>(collection, ServiceLifetime.Singleton, times);
  }
19
  /// <summary>
  /// Verifies that a specific service and its implementation are registered in the <see cref="ServiceCollection"/> 
  /// with the specified lifetime the specified number of times.
  /// </summary>
  /// <typeparam name="TService">The service type to verify.</typeparam>
  /// <typeparam name="TImplementation">The implementation type of the service to verify.</typeparam>
  /// <param name="collection">The <see cref="ServiceCollection"/> to check.</param>
  /// <param name="lifetime">The expected lifetime of the service.</param>
  /// <param name="times">The expected number of times the service and its implementation are registered.</param>
  public static void VerifyAdd<TService, TImplementation>(this ServiceCollection collection, ServiceLifetime lifetime, int times)
      where TImplementation : class, TService
  {
      // Arrange
      Type serviceType = typeof(TService);
      Type implementationType = typeof(TImplementation);
35
      // Act
      List<ServiceDescriptor> items = collection
          .Where(
              serviceDescriptor => serviceDescriptor.ServiceType == typeof(TService)
              && serviceDescriptor.ImplementationType == typeof(TImplementation)
              && serviceDescriptor.Lifetime == lifetime)
          .ToList();
43
      // Assert
      Assert.Equal(times, items.Count);
  }
47
  /// <summary>
  /// Verifies that a specific service is registered in the <see cref="ServiceCollection"/> 
  /// with the specified lifetime the specified number of times.
  /// </summary>
  /// <typeparam name="TService">The service type to verify.</typeparam>
  /// <param name="collection">The <see cref="ServiceCollection"/> to check.</param>
  /// <param name="lifetime">The expected lifetime of the service.</param>
  /// <param name="times">The expected number of times the service is registered.</param>
  public static void VerifyAdd<TService>(this ServiceCollection collection, ServiceLifetime lifetime, int times)
  {
      // Arrange
      Type serviceType = typeof(TService);
60
      // Act
      List<ServiceDescriptor> items = collection
          .Where(
              serviceDescriptor => serviceDescriptor.ServiceType == typeof(TService)
              && serviceDescriptor.Lifetime == lifetime)
          .ToList();
67
      // Assert
      Assert.Equal(times, items.Count);
  }
71}

The test looks correspondingly slimmer:

C#
1// Arrange
2ServiceCollection services = new ServiceCollection();
3Startup startup = new Startup();
4
5// Act
6startup.ConfigureServices(services);
7
8// Assert
9services.VerifyAddSingleton<IMyService, MyService>();

Using NSubstitute

A potential further solution with NSubstitute is to mock the base method Add and check whether it has been called with the appropriate parameters.

C#
 1// Arrange
 2IServiceCollection services = Substitute.For<IServiceCollection>();
 3Startup startup = new Startup();
 4
 5// Act
 6startup.ConfigureServices(services);
 7
 8// Assert
 9services.Received().Add(Arg.Is<ServiceDescriptor>(descriptor =>
10    descriptor.ServiceType == typeof(IMyService) &&
11    descriptor.ImplementationType == typeof(MyService) &&
12    descriptor.Lifetime == ServiceLifetime.Singleton));

Conclusion

Simpler and better quality tests can be achieved when verifying dependency injection with ServiceCollection.

Use ServiceCollection in Unit Tests with .NET

The problem

Use of ServiceCollection

Using NSubstitute

Conclusion

Containerizing .NET in 2026 Without a Dockerfile

Problem Details in ASP.NET Core and .NET 11

Resilience in .NET with Microsoft.Extensions.Resilience

BEN ABT

Let's Work Together

New Platforms

Modernization

Training & Consulting

Use ServiceCollection in Unit Tests with .NET

The problem

Use of ServiceCollection

Using NSubstitute

Conclusion

Related articles

Let's Work Together

New Platforms

Modernization

Training & Consulting