ModelValidation.Test 1.0.0

dotnet add package ModelValidation.Test --version 1.0.0
NuGet\Install-Package ModelValidation.Test -Version 1.0.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="ModelValidation.Test" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ModelValidation.Test --version 1.0.0
#r "nuget: ModelValidation.Test, 1.0.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 ModelValidation.Test as a Cake Addin
#addin nuget:?package=ModelValidation.Test&version=1.0.0

// Install ModelValidation.Test as a Cake Tool
#tool nuget:?package=ModelValidation.Test&version=1.0.0

ModelValidation.Test

Small Framework to check that models are validated properly.

I can be also useful for a TDD (test driven development) approach to model development.

It works virtually with any testing framework!

Install it from NuGet: https://www.nuget.org/packages/ModelValidation.Test

Main features

  • Checks that model validation actually fails with wrong values.
  • Checks that all properties are tested.
  • Checks that all class level validation attributes are tested.
  • Checks that all property level validation attributes are tested.
  • Checks that error messages are actually correct.

Example

C# query example:

[YoungSkywalker] // Surname == Skywalker && Age < 25
public class Rebel
{
    [Required]
    [MaxLength(10)]
    public string Name { get; set; }

    [Required]
    public string Surname { get; set; }

    [Range(10, 900)]
    public int Age { get; set; }

    [RebelWeapon] // Color == "Green"
    public Weapon Weapon { get; set; }
}

public class Weapon
{
    public string Color { get; set; }
}

[Fact]
public void Test_Luke()
{
    ModelValidator.Test(
        () => new Rebel
        {
            Name = "Luke",
            Surname = "Skywalker",
            Age = 18,
            Weapon = new Weapon
            {
                Color = "Green"
            }
        },
        modelSetup => 
        {
            modelSetup.CheckClass(os => os.IsInvalidWith(r => r.Surname, "Organa"));
            modelSetup.CheckClass(os => os.IsInvalidWith(r => r.Age, 42));

            modelSetup.CheckProperty(r => r.Name, ps => ps.IsInvalidWith(null).IsInvalidWith("Lukelongname"));
            modelSetup.CheckProperty(r => r.Surname, ps => ps.IsInvalidWith(null));
            modelSetup.CheckProperty(r => r.Age, ps => ps.IsInvalidWith(901).IsInvalidWith(9));

            modelSetup.CheckProperty(r => r.Weapon, ps => ps.IsInvalidWithTransform(w =>
            {
                w.Color = "Red";
                return w;
            }));
        });
}

// Test that validation attributes return the correct message
[Fact]
public void Test_Stormtrooper()
{
    ModelValidator.Test(
        () => new Stormtrooper
        {
            IsCloned = true,
            Leader = "Palpatine"
        },
        modelSetup =>
        {
            modelSetup.CheckObject(os => os.IsInvalidWith(r => r.IsCloned, false), "Trooper must be a clone.");

            modelSetup.CheckProperty(r => r.Leader, ps => ps.IsInvalidWith(null, "Sith leader is required."));
        });
}

Built-in extensions methods

There are a some built-in extension methods to help writing properties tests faster:

  • ps.IsRequired()
  • ps.HasMaxLenght(int)
  • ps.HasMinLenght(int)
  • ps.HasMinValue(int)
  • ps.HasMaxValue(int)
  • ps.InRange(int, int)
  • ps.HasMinValue(double)
  • ps.HasMaxValue(double)
  • ps.InRange(double, double)
// Example
[Fact]
ModelValidator.Test(
    () => new Stormtrooper
    {
        IsCloned = true,
        Leader = "Palpatine"
    },
    modelSetup =>
    {
        modelSetup.CheckProperty(r => r.Leader, ps => ps.IsRequired());
    });

Options

The Test method accept an option object as third parameter.

  • CheckPropertiesCoverage: (default: true) Checks that all properties are tested.
  • CheckClassAttributesCoverage: (default: true) Checks that all class level attributes are tested.
  • ServiceProviderSetupAction: Use this function to add services to using during validation.
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 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 was computed. 
.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.

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
1.0.0 1,404 7/30/2019
0.1.0 506 6/14/2019