saturdaymp - SaturdayMP.NConstraints 1.1.0-alpha0003

Custom constraints for NUnit.

PM> Install-Package SaturdayMP.NConstraints -Version 1.1.0-alpha0003 -Source https://www.myget.org/F/saturdaymp/api/v3/index.json

Copy to clipboard

> nuget.exe install SaturdayMP.NConstraints -Version 1.1.0-alpha0003 -Source https://www.myget.org/F/saturdaymp/api/v3/index.json

Copy to clipboard

> dotnet add package SaturdayMP.NConstraints --version 1.1.0-alpha0003 --source https://www.myget.org/F/saturdaymp/api/v3/index.json

Copy to clipboard
<PackageReference Include="SaturdayMP.NConstraints" Version="1.1.0-alpha0003" />
Copy to clipboard
source https://www.myget.org/F/saturdaymp/api/v3/index.json

nuget SaturdayMP.NConstraints  ~> 1.1.0-alpha0003
Copy to clipboard

> choco install SaturdayMP.NConstraints --version 1.1.0-alpha0003 --source https://www.myget.org/F/saturdaymp/api/v2

Copy to clipboard
Import-Module PowerShellGet
Register-PSRepository -Name "saturdaymp" -SourceLocation "https://www.myget.org/F/saturdaymp/api/v2"
Install-Module -Name "SaturdayMP.NConstraints" -RequiredVersion "1.1.0-alpha0003" -Repository "saturdaymp" -AllowPreRelease
Copy to clipboard

NConstraints

Adds additional constraints to NUnit such as comparing all the property values on two objects.

Installing

You can find the latest stable NuGet package at here. If you want the live on the wild side you can find the developer NuGet packages on MyGet.

If you have any issues with the installation please let me know by opening an issue or pull request.

Quickstart

The additional constraints can be used when using Assert.That and extend the Is helper class. For example:

Assert.That(expected, SaturdayMP.NConstraints.Is.EquivalentPropertyWiseTo(actual);

If you don't want to prifix the additional constratins with the SaturdayMP.NConstraints namespace then add the following to the top your test file:

using NUnit.Framework; // Assume you already added this
using SaturdayMP.NConstraints;  // Add this statement.
using Is = SaturdayMP.NConstraints.Is; // Add this statement.

Now you can write:

Assert.That(expected, Is.EquivalentPropertyWiseTo(actual);

The complete file of this example looks like:

using NUnit.Framework;
using SaturdayMP.NConstraints;
using Is = SaturdayMP.NConstraints.Is;

namespace MyTestNamespace
{
  [TestFixture]
  public class MyTests
  {
    [Test]
    public void PropertiesAreTheSame()
    {
      var expected = new TestClass() { IntegerProperty = 1 };
      var actual = new TestClass() {IntegerProperty = expected.IntegerProperty};

      Assert.That(expected, Is.EquivalentPropertyWiseTo(actual));
    }
  }
}

Notice that the using statement set the Is object. If you try:

using NUnit.Framework; 
using SaturdayMP.NConstraints;

You will get compile errors because there are two Is classes, one in the NUnit.Framework namespace and one in SaturdayMP.NConstraints.

Finally some code analyizers, like ReSharper, will raise warnings like "Access to a static member or a type via a dirvied type". You can safely ignore these warnings, I don't know a good way to remove these warnings. If you do please open an issue or pull request.

Constraints

This project adds the following constraints to NUnit:

Constraint Name Description
EquivalentPropertyWiseTo Asserts that the property values of expected object are the same on the actual object.

EquivalentPropertyWiseTo

Asserts that the property values of expected object are the same on the actual object. The objects don't have to be the same class but if a property exists on the expected object but not on the actual object then the assert fails.

/// <summary>
///     Properties don't match up.
/// </summary>
[Test]
public void PropertiesNotTheSame()
{
  var expected = new TestClass() {IntegerProperty = 1};
  var actual = new TestClass();

  Assert.That(expected, NUnit.Framework.Is.Not.EquivalentPropertyWiseTo(actual));
}

/// <summary>
///     Properties match.
/// </summary>
[Test]
public void PropertiesTheSame()
{
  var expected = new TestClass() { IntegerProperty = 1 };
  var actual = new TestClass() {IntegerProperty = expected.IntegerProperty};

  Assert.That(expected, Is.EquivalentPropertyWiseTo(actual));
}

Contributing

If you have any questions, notice a bug, or have a suggestion/enhancment please let me know by:

Acknowledgements

Thanks to the NUnit team for creating NUnit and continuing to support it. I’ve used NUnit for most of my career to properly test and improve my code.

  • .NETStandard 1.6: 1.6.0.0

Owners

Christopher Cumming

Authors

SaturdayMP

Project URL

https://github.com/saturdaymp/NConstraints

License

MIT

Tags

nunit testing tdd unit-testing nunit-custom-constraints saturdaymp

Info

0 total downloads
0 downloads for version 1.1.0-alpha0003
Download (4.56 KB)
Found on the current feed only

Package history

Version Size Last updated Downloads Mirrored?
1.1.0-alpha0003 4.56 KB Thu, 26 Oct 2017 17:26:00 GMT 0
1.1.0-alpha0001 4.56 KB Mon, 16 Oct 2017 21:20:21 GMT 0
1.0.0 4.54 KB Mon, 16 Oct 2017 19:58:53 GMT 0
0.1.0-alpha0010 4.56 KB Fri, 13 Oct 2017 23:09:37 GMT 0
0.1.0-alpha0009 4.56 KB Fri, 13 Oct 2017 20:56:00 GMT 0
0.1.0-alpha0008 4.56 KB Fri, 13 Oct 2017 20:51:17 GMT 0