XMapper.Testing 3.0.1

.NET 6.0
There is a newer version of this package available.
See the version list below for details.
dotnet add package XMapper.Testing --version 3.0.1
NuGet\Install-Package XMapper.Testing -Version 3.0.1
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="XMapper.Testing" Version="3.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add XMapper.Testing --version 3.0.1
#r "nuget: XMapper.Testing, 3.0.1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install XMapper.Testing as a Cake Addin
#addin nuget:?package=XMapper.Testing&version=3.0.1

// Install XMapper.Testing as a Cake Tool
#tool nuget:?package=XMapper.Testing&version=3.0.1

XMapper.Testing

Automate the testing of all your object-to-object mappers with one line of unit test code. <p align="center"> <img src="https://avatars.githubusercontent.com/u/103217522?s=150&v=4" alt="XMapper logo"/> </p>

Available via NuGet.

For more information about creating and using a mapper, see XMapper.

Example

  1. Assign your mappers to static fields or static properties:
using XMapper;

namespace DummyAssembly1;

public class Class1 // An example of an incomplete setup: DummyB.XStringB has no match.
{ 
    public static readonly XMapper<DummyA, DummyB> MapperField =
        new XMapper<DummyA, DummyB>(PropertyList.Target)
        .IgnoreTargetProperty(x => x.XStringA);
}

public class DummyA
{
    public int XInt { get; set; } = 1;
}

public class DummyB
{
    public int XInt { get; set; } = 2;
    public string XStringA { get; set; } = "A";
    public string XStringB { get; set; } = "B";
}
  1. Test all mappers via a single method call inside a unit test:
using XMapper.Testing;
using Xunit;
using Xunit.Abstractions;

public class MyXMapperTests
{
    private readonly ITestOutputHelper _testOutputHelper;
    public MyXMapperTests(ITestOutputHelper testOutputHelper)
    {
        _testOutputHelper = testOutputHelper;
    }

    [Fact]
    public void AllAreValid()
    {
        new XMapperValidator(_testOutputHelper.WriteLine).AllAreValidInAssembly("DummyAssembly1", TestCases.All);
    }
}

In case the unit test passes, the Standard Output in Visual Studio's Test Explorer will show something like:

Start collecting XMapper instance storage locations (static fields/properties).
Found 2 XMapper instance storage locations to test.
Validating 'DummyAssembly4.Class1.MyValidMapper1'.
Test case: AppDefaults
Test case: NotNullDefaults
Test case: TargetNullDefaults
Test case: NullDefaults
Validating 'DummyAssembly4.Class1.MyValidMapper2'.
Test case: AppDefaults
Test case: NotNullDefaults
Test case: TargetNullDefaults
Test case: NullDefaults
Finished validating all XMapper instances.

All assert options


AllAreValidInAssembly("Project1", TestCases.All);

AllAreValidInAssemblies(new [] { "MyProject1", "MyProject2" }, TestCases.All);

AllAreValidInAssembly(Assembly.Load("AnotherAssembly"), TestCases.All); 

AllAreValidInAssemblies(new [] { Assembly.Load("MyAssembly1"), Assembly.Load("MyAssembly2") }, TestCases.All);


// or only validate specific mappers:
IsValid(mapper, TestCases.All);


// or specify only specific test cases from the TestCases flags enum:
AllAreValidInAssembly("Project1", TestCases.NotNullDefaults | TestCases.TargetNullDefaults);

Hovering over methods and TestCases enum values in your editor will provide guiding documentation.

Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.4 183 4/24/2022
3.0.3 180 4/23/2022
3.0.2 187 4/20/2022
3.0.1 188 4/19/2022
3.0.0 179 4/17/2022
2.0.2 173 4/16/2022
2.0.1 177 4/16/2022
2.0.0 186 4/13/2022
1.0.0 181 4/11/2022

IMPORTANT: major and minor version are a copy of the `XMapper` package's major and minor version.
     Only the revision number of `XMapper.Testing` is independent of `XMapper`.
     See https://github.com/XMapper/XMapper.Testing/blob/main/CHANGELOG.md for release notes.