DependencyModules.xUnit 1.0.0-RC9047

This is a prerelease version of DependencyModules.xUnit.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package DependencyModules.xUnit --version 1.0.0-RC9047
                    
NuGet\Install-Package DependencyModules.xUnit -Version 1.0.0-RC9047
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="DependencyModules.xUnit" Version="1.0.0-RC9047" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DependencyModules.xUnit" Version="1.0.0-RC9047" />
                    
Directory.Packages.props
<PackageReference Include="DependencyModules.xUnit" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add DependencyModules.xUnit --version 1.0.0-RC9047
                    
#r "nuget: DependencyModules.xUnit, 1.0.0-RC9047"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package DependencyModules.xUnit@1.0.0-RC9047
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=DependencyModules.xUnit&version=1.0.0-RC9047&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=DependencyModules.xUnit&version=1.0.0-RC9047&prerelease
                    
Install as a Cake Tool

DependencyModules

DependencyModules is a C# source generator package that uses attributes to create dependency injection registration modules. These packages can then be used to populate an IServiceCollection instance.

Installation

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

Service Attributes

  • [DependencyModule] - used to attribute class that will become dependency module (must be partial)
  • [SingletonService] - registers service as AddSingleton
  • [ScopedService] - registers service as AdddScoped
  • [TransientService] - registers service as AddTransient
// Registration example
[DependencyModule]
public partial class MyModule { }

// registers SomeClass implementation for ISomeService
[SingletonService]
public class SomeClass : ISomeService 
{
  public string SomeProp => "SomeString";
}

// registers OtherSerice implementation
[TransientService]
public class OtherService
{
  public OtherService(ISomeService service)
  { 
    SomeProp = service.SomeProp;
  }
  public string SomeProp { get; }
}

Container Instantiation

AddModule - method adds modules to service collection

var serviceCollection = new ServiceCollection();

serviceCollection.AddModule<MyModule>();

var provider = serviceCollection.BuildServiceProvider();

var service = provider.GetService<OtherService>();

Module Re-use

DependencyModules creates an Attribute class that can be used to apply sub dependencies.

// Modules can be re-used with the generated attributes
[DependencyModule]
[MyModule.Attribute]
public partial class AnotherModule { }

Parameters

Sometimes you want to provide extra registration for your module. This can be achieved by adding a constructor to your module or optional properties. Note these parameters and properties will be correspondingly implemented in the module attribute.

[DependencyModule]
public partial class SomeModule : IServiceCollectionConfiguration 
{
  private bool _someFlag;
  public SomeModule(bool someFlag = false)
  {
    _someFlag = someFlag;
  }
  
  public string OptionalString { get; set; } = "";
  
  public void ConfigureServices(IServiceCollection services) 
  {
    if (_someFlag) 
    {
      // custom registration
    } 
  }
}

[DependencyModule]
[SomeModule.Attribute(true, OptionalString = "otherString")]
public partial class SomeOtherModule 
{

}

Realm

By default, all dependencies are registered in all modules within the same assembly. The realm allows the developer to scope down the registration within a given module.

// register only dependencies specifically marked for this realm
[DependencyModule(OnlyRealm = true)]
public partial class AnotherModule { }

[SingletonService(ServiceType = typeof(ISomeInterface), 
  Realm = typeof(AnotherModule))]
public class SomeDep : ISomeInterface { }

Unit testing & Mocking

DependencyModules provides an xUnit extension to make testing much easier. It handles the population and construction of a service provider using specified modules.

> dotnet add package DependencyModules.xUnit
> dotnet add package DependencyModules.xUnit.NSubstitute

// applies module & nsubstitute support to all tests.
// test attributes can be applied at the assembly, class, and test method level
[assemlby: MyModule.Attribute]
[assembly: NSubstituteSupport]

public class OtherServiceTests 
{
  [ModuleTest]
  public void SomeTest(OtherService test, [Mock]ISomeService service)
  {
     service.SomeProp.Returns("some mock value");
     Assert.Equals("some mock value", test.SomeProp);
  }
}
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on DependencyModules.xUnit:

Package Downloads
DependencyModules.xUnit.NSubstitute

Package Description

SimpleRequest.Testing

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0-RC9148 60 5/10/2025
1.0.0-RC9145 46 5/10/2025
1.0.0-RC9141 144 4/24/2025
1.0.0-RC9138 148 4/22/2025
1.0.0-RC9137 165 4/17/2025
1.0.0-RC9136 159 4/13/2025
1.0.0-RC9135 147 4/13/2025
1.0.0-RC9133 63 4/12/2025
1.0.0-RC9131 76 4/11/2025
1.0.0-RC9130 140 3/31/2025
1.0.0-RC9128 128 3/31/2025
1.0.0-RC9127 125 3/31/2025
1.0.0-RC9126 115 3/30/2025
1.0.0-RC9125 78 3/29/2025
1.0.0-RC9124 103 3/28/2025
1.0.0-RC9123 98 3/28/2025
1.0.0-RC9122 102 3/28/2025
1.0.0-RC9121 258 3/23/2025
1.0.0-RC9120 146 3/23/2025
1.0.0-RC9119 132 3/22/2025
1.0.0-RC9118 132 3/22/2025
1.0.0-RC9117 134 3/22/2025
1.0.0-RC9116 138 3/22/2025
1.0.0-RC9115 136 3/22/2025
1.0.0-RC9112 131 3/19/2025
1.0.0-RC9111 79 3/14/2025
1.0.0-RC9110 62 3/14/2025
1.0.0-RC9109 61 3/14/2025
1.0.0-RC9108 74 3/14/2025
1.0.0-RC9107 132 3/13/2025
1.0.0-RC9106 131 3/13/2025
1.0.0-RC9105 121 3/13/2025
1.0.0-RC9104 159 3/11/2025
1.0.0-RC9103 136 3/9/2025
1.0.0-RC9102 101 3/9/2025
1.0.0-RC9100 182 3/6/2025
1.0.0-RC9099 202 3/5/2025
1.0.0-RC9098 176 3/5/2025
1.0.0-RC9096 65 2/26/2025
1.0.0-RC9094 64 2/25/2025
1.0.0-RC9092 63 2/24/2025
1.0.0-RC9091 65 2/23/2025
1.0.0-RC9090 64 2/23/2025
1.0.0-RC9086 69 2/22/2025
1.0.0-RC9083 67 2/22/2025
1.0.0-RC9082 64 2/22/2025
1.0.0-RC9078 74 2/17/2025
1.0.0-RC9077 64 2/17/2025
1.0.0-RC9076 94 2/16/2025
1.0.0-RC9075 76 2/16/2025
1.0.0-RC9074 84 2/16/2025
1.0.0-RC9072 86 2/14/2025
1.0.0-RC9071 64 2/14/2025
1.0.0-RC9070 78 2/13/2025
1.0.0-RC9069 74 2/13/2025
1.0.0-RC9068 63 2/13/2025
1.0.0-RC9066 68 2/8/2025
1.0.0-RC9059 90 2/6/2025
1.0.0-RC9058 63 2/6/2025
1.0.0-RC9048 80 2/2/2025
1.0.0-RC9047 72 2/2/2025
1.0.0-RC9045 72 2/2/2025