DependencyModules.SourceGenerator 1.6.1

DependencyModules

DependencyModules is a source generator for Microsoft.Extensions.DependencyInjection. You put attributes on your classes. When you compile the project, the generator writes the code that registers these classes in an IServiceCollection. The generated code does not use reflection to find services at run time.

A module is a partial class that registers the services of a project. A module can use other modules. The test packages build a service provider from your modules for each xUnit or NUnit test.

Documentation: ipjohnson.github.io/DependencyModules

Packages

The target frameworks of the runtime package, DependencyModules.Testing, the test packages, and the mock packages are net8.0 and net10.0. The generator is compatible with Roslyn 4.10 and all subsequent versions.

Install

dotnet add package DependencyModules.Runtime
dotnet add package DependencyModules.SourceGenerator

Register services

Put a service attribute on each class. The attribute sets the lifetime.

using DependencyModules.Runtime.Attributes;

namespace Shop;

public interface IPriceCalculator
{
    decimal Total(decimal price, int quantity);
}

[SingletonService]
public class PriceCalculator : IPriceCalculator
{
    public decimal Total(decimal price, int quantity) => price * quantity;
}

[DependencyModule]
public partial class ShopModule;

The generator registers PriceCalculator as IPriceCalculator. ShopModule registers all services of the project.

Load the module

using DependencyModules.Runtime;
using Microsoft.Extensions.DependencyInjection;
using Shop;

var services = new ServiceCollection();

services.AddModule<ShopModule>();

var provider = services.BuildServiceProvider();

var calculator = provider.GetRequiredService<IPriceCalculator>();

Tests with modules

using DependencyModules.xUnit.Attributes;
using Shop;
using Xunit;

namespace Shop.Tests;

public class PriceCalculatorTests
{
    [ModuleTest(typeof(ShopModule))]
    public void Multiplies(IPriceCalculator calculator)
    {
        Assert.Equal(10m, calculator.Total(2.5m, 4));
    }
}

The test gets its parameters from a new service provider. After the test, the test package disposes the service provider.

Features

• Services: lifetimes, keyed services, registration types, cross-wired services, and factory methods.
• Modules: module dependencies, realms, module parameters, and the generated ApplicationModule.
• Conventions: registrations for all classes that implement an interface.
• Decorators and interception: code around services.
• Environments: registrations that occur only in some environments.
• Testing: xUnit and NUnit tests with modules, mocks, and more service providers in a test.
• Native AOT: generated factories and trimming.

Sample projects

The integ-tests folder contains projects that reference the source projects of the solution. The solution builds them, and the build workflow runs their tests:

• SutProject and SecondarySutProject: modules and services.
• SutProject.Tests: xUnit tests of these modules.
• SutProject.NUnitTests: NUnit tests of these modules.
• ConsoleTestProject: a console application.
• web/WebApiApp and web/WebApiApp.Tests: an ASP.NET Core application and its tests.

License

DependencyModules has the MIT license.