SparkyTestHelpers.Mapping 1.10.1

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

// Install SparkyTestHelpers.Mapping as a Cake Tool
#tool nuget:?package=SparkyTestHelpers.Mapping&version=1.10.1                

see also:


MapTester<TSource, TDestination>

class SparkyTestHelpers.Mapping.MapTester<TSource, TDestination>

This class is for testing that properties were successfully "mapped" from one type to another, either via AutoMapper or another automatic mapping framework, or by hand-written "destination.X = source.X;" code.

See SparkyTestHelpers.AutoMapper for additional extension methods specifically for working with AutoMapper.

Methods

  • MapTester<TSource, TDestination> WithLogging(Action<String> action)
    (optional) "Callback" action to log property values when asserting. If called without an action, defaults to Console.WriteLine.
  • MapTester<TSource, TDestination> IgnoringMember(Expression<Func<TDestination, Object>> destExpression)
  • MapTester<TSource, TDestination> IgnoringMembers(params Expression<Func<TDestination, Object>>[] destExpressions)
  • MapTester<TSource, TDestination> IgnoringMemberNamesStartingWith(string prefix)
  • MapMemberTester<TSource, TDestination> WhereMember(Expression<Func<TDestination, Object>> destExpression)
  • MapMemberTester<TSource, TDestination> WhereMember(Expression<Func<TDestination, Object>> destExpression)
  • void AssertMappedValues(TSource source, TDestination dest)
    throws exception if any source/destination map validation specifications fail, or if any destination properties aren�t either tested or IgnoreMember�d.

Static Methods

  • MapTester<TSource, TDestination> ForMap()

Example

using SparkyTestHelpers.Mapping;
    Foo foo = CreateAndPopulateTestFoo();
    Bar bar = Mapper.Map<Foo, Bar>(foo); 

    MapTester.ForMap<Foo, Bar>()
        .WithLogging()
        .IgnoringMember(dest => dest.DestOnlyProperty)
        .WhereMember(dest => dest.StatusCode).ShouldEqual(src => src.Status)
        .WhereMember(dest => dest.IsValid).ShouldEqualValue(true)
        .WhereMember(dest => dest.Percent).IsTestedBy((src, dest) => 
            Assert.AreEqual(src.Rate / 100, dest.Percent))
        .AssertMappedValues(foo, bar);

You don't have to configure anything for properties with the same name/type in the source and destination instances. AssertMappedValues() considers those successful if the source/destination values match.

Use IgnoringMember, IgnoringMembers or IgnoringMemberNamesStartingWith for destination properties that are not mapped or which you need to test in another way

Use WhereMember to "dot" to the ShouldEqual, ShouldEqualValue and IsTestedBy functions.


MapMemberTester<TSource, TDestination>

class SparkyTestHelpers.Mapping.MapMemberTester<TSource, TDestination>

This class is for testing that a property was successfully "mapped" from one type to another.

Methods

  • MapTester<TSource, TDestination> ShouldEqual(Expression<Func<TSource, Object>> sourceExpression)
    use to verify destination property mapped from differently named source property(s)
  • MapTester<TSource, TDestination> ShouldBeStringMatchFor(Expression<Func<TSource, Object>> sourceExpression)
    use to verify the ".ToString()" values of the source and destination properties (useful for testing Enum mapping where the source/destination Enum types have the same names)
  • MapTester<TSource, TDestination> ShouldEqualValue(Object value)
    use to verify destination property using a constant or some other value not derived from the source
  • MapTester<TSource, TDestination> IsTestedBy(Action<TSource, TDestination> customTest)
    use for custom complex validation that doesn't fit one of the other verification methods

RandomValuesHelper

class SparkyTestHelpers.Mapping.RandomValuesHelper

Test helper for updating class instance properties with random values (so you can fill a "source" instance without writing a lot of code).

Methods

  • T CreateRandom<T>()
  • T UpdatePropertiesWithRandomValues(T instance)
  • bool RandomBool()
  • There are "Random... methods similar to RandomBool() for all .NET primitive types: (RandomInt, RandomDateTime, RandomString, etc.)

Example

using SparkyTestHelpers.Mapping;
    var randomValuesHelper = new RandomValuesHelper();

    Foo foo = randomValuesHelper().CreateRandom<Foo>();

    var bar = new Bar();
    randomValuesHelper().UpdatePropertiesWithRandomValues(bar);

    int randomInt = randomValuesHelper.RandomInt();

CreateRandom

class SparkyTestHelpers.Mapping.CreateRandom

Static methods wrapping RandomValuesHelper:

Methods

  • T InstanceOf<T>()
  • bool Bool()
  • There are methods similar to Bool() for all .NET primitive types: (Int(), DateTime(), String(), etc.)

Example

using SparkyTestHelpers.Mapping;
    Foo foo = CreateRandom.InstanceOf<Foo>();
    int randomInt = CreateRandom.Int();
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.5 is compatible.  netstandard1.6 was computed.  netstandard2.0 was computed.  netstandard2.1 was computed. 
.NET Framework net461 is compatible.  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 tizen30 was computed.  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.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on SparkyTestHelpers.Mapping:

Package Downloads
SparkyTestHelpers.AutoMapper

Additional AutoMapper extension methods for SparkyTestHelpers.Mapping (Unit test helpers for asserting public properties on class instances "mapped" from one type to another have the correct values.) Version 1.x supports .NET Standard 1.5 and .NET Framework 4.5 Version 2.x supports .NET Standard 2.0 and .NET Framework 4.6

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.12.2 9,922 6/12/2022
1.12.1 74,084 7/27/2019
1.12.0 20,288 1/15/2019
1.11.0 691 1/3/2019
1.10.2 684 12/12/2018
1.10.1 1,457 12/2/2018
1.10.0 1,507 11/22/2018
1.9.0 756 10/20/2018
1.8.0 795 7/31/2018
1.7.2 6,685 6/2/2018
1.7.1 928 5/28/2018
1.7.0 1,806 5/17/2018
1.6.2 2,411 5/14/2018
1.6.1 963 5/14/2018
1.6.0 3,229 5/11/2018
1.5.2 1,676 5/3/2018
1.5.1 1,008 5/1/2018
1.5.0 1,703 4/27/2018
1.4.0 2,214 4/21/2018
1.3.0 1,040 4/21/2018
1.2.2 48,279 3/12/2018
1.2.1 1,677 2/21/2018
1.2.0 1,788 2/14/2018
1.0.0 1,723 2/13/2018

v1.10.1 Added .NET 4.6.1 target