Neovolve.Streamline 1.3.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Neovolve.Streamline --version 1.3.0                
NuGet\Install-Package Neovolve.Streamline -Version 1.3.0                
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="Neovolve.Streamline" Version="1.3.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Neovolve.Streamline --version 1.3.0                
#r "nuget: Neovolve.Streamline, 1.3.0"                
#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.
// Install Neovolve.Streamline as a Cake Addin
#addin nuget:?package=Neovolve.Streamline&version=1.3.0

// Install Neovolve.Streamline as a Cake Tool
#tool nuget:?package=Neovolve.Streamline&version=1.3.0                

Neovolve.Streamline

Neovolve.Streamline provides NuGet packages to simplify the unit testing setup (Arrange in AAA unit testing) of classes and their dependencies. The Neovolve.Streamline package provides the base logic to creating a SUT (System Under Test) along with any service dependencies that it requires. Other packages (such as Neovolve.Streamline.NSubstitute) provide the bridge between Neovolve.Streamline and another tool that creates the service dependencies.

GitHub license Actions Status

Package NuGet
Neovolve.Streamline Nuget Nuget
Neovolve.Streamline.NSubstitute Nuget Nuget

Use Case

Consider the following class and the setup required to unit test it.

public class Something
{
    public Something(
        IFirst first,
        ISecond second,
        IThird third,
        IFourth fourth,
        IFifth fifth)
    {
    }

    public void FirstAction()
    {
    }

    public void SecondAction()
    {
    }

    public void ThirdAction()
    {
    }

    public void FourthAction()
    {
    }

    public void FifthAction()
    {
    }
}

There are five dependencies to this test class and five members to unit test. A test Arrange for any of these unit tests may look something like the following (using NSubstitute as the mocking library).

using NSubstitute;

public class SomethingTests
{
    [Fact]
    public void FirstActionDoesXYZWhenABC()
    {
        var first = Substitute.For<IFirst>();
        var second = Substitute.For<ISecond>();
        var third = Substitute.For<IThird>();
        var fourth = Substitute.For<IFourth>();
        var fifth = Substitute.For<IFifth>();

        // Continue Arrange to configure these service for their behaviours

        var sut = new Something(first, second, third, fourth, fifth);

        // Act
        sut.FirstAction();

        // Assert
        first.Received().FirstAction();
    }
}

If you consider that each one of the actions has five business scenarios to validate, that is at least 25 unit test methods that duplicate the above Arrange code. The Neovolve.Streamline.NSubstitute package can simplify this by automatically creating both the service depedencies and the SUT itself.

For example, the above Arrange can be reduced to just the following:

using NSubstitute;

public class SomethingTests : Tests<Something>
{
    [Fact]
    public void FirstActionDoesXYZWhenABC()
    {
        // Configure these service for their behaviours

        // Act
        SUT.FirstAction();

        // Assert
        Service<IFirst>().Received().FirstAction();
    }
}

Advantages

This package brings several advantages.

  • Service dependencies are automatically created
  • The SUT instance is automatically created with any required service dependencies
  • Adding, removing or re-ordering constructor parameters have limited or no impact on existing unit tests

Examples using NSubstitute

SUT with multiple parameters
SUT with single parameter
SUT with no constructor parameters
SUT with custom services
SUT using keyed services
SUT declared as internal having public interface
SUT declared as internal via proxy
Using test class constructor parameters
SUT as partial mock
SUT as full mock
SUT as abstract class

Supporters

This project is supported by JetBrains

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.
  • .NETStandard 2.1

    • No dependencies.
  • net6.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Neovolve.Streamline:

Package Downloads
Neovolve.Streamline.NSubstitute

Provides streamlined SUT creation

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.4.1 959 5/10/2024
2.4.1-beta0001 118 5/10/2024
2.4.0 174 4/21/2024
2.4.0-beta0002 118 4/21/2024
2.3.1 393 2/17/2024
2.3.1-beta0001 102 2/17/2024
2.3.0 147 2/17/2024
2.2.1-beta0001 114 2/17/2024
2.2.0 134 2/17/2024
2.1.1-beta0001 108 2/17/2024
2.1.0 899 9/22/2023
2.0.1-beta0001 142 9/22/2023
2.0.0 240 8/28/2023
2.0.0-beta0009 164 8/28/2023
2.0.0-beta0008 172 8/28/2023
2.0.0-beta0007 168 8/28/2023
1.3.0 479 7/27/2023
1.2.1-beta0001 186 7/27/2023
1.2.0 6,064 5/11/2022
1.2.0-beta0003 230 5/11/2022
1.1.2 2,105 4/2/2022
1.1.2-beta0001 188 4/2/2022
1.1.1 2,522 9/18/2021
1.1.1-beta0001 320 9/18/2021
1.1.0 478 9/16/2021
1.0.1-beta0003 314 9/16/2021
1.0.1-beta0001 308 1/19/2021
1.0.0 948 1/18/2021
0.1.0-beta0009 314 1/18/2021
0.1.0-beta0005 309 1/18/2021
0.1.0-beta0002 317 1/17/2021