SparkyTestHelpers 1.2.2

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

// Install SparkyTestHelpers as a Cake Tool
#tool nuget:?package=SparkyTestHelpers&version=1.2.2                
  • SparkyTestHelpers.Exceptions: for testing exception expectations
  • SparkyTestHelpers.Scenarios: for testing a method with a variety of different input scenarios

see also:


AssertExceptionNotThrown

Assert exception is not thrown when an action is executed. This method doesn't do much, but clarifies the intent of tests that wish to show that an action works correctly.

Static Methods

  • void WhenExecuting(Action action)

Example

using SparkyTestHelpers.Exceptions;
. . .
AssertExceptionNotThrown.WhenExecuting(() => foo.Bar(baz));

AssertExceptionThrown

Used to assert than an expected exception is thrown when a test action is executed.

Why use this instead of something like the VisualStudio TestTools ExpectedExceptionAttribute?

  • It lets you to check the exception message.
  • It lets you assert the exception is thrown for a specific statement, not just anywhere in the code under test.

There is no public constructor for this class. It's constructed using the "fluent" static factory method AssertExceptionThrown.OfType<TException>().

Example

using SparkyTestHelpers.Exceptions;
. . .
AssertExceptionThrown
    .OfType<ArgumentOutOfRangeException>()
    .WithMessage("Limit cannot be greater than 10.")
    .WhenExecuting(() => { var foo = new Foo(limit: 11); });

Methods

  • AssertExceptionThrown WithMessage (String expected)
    Set up to test that the action under test throws an exception where the message exactly matche.
  • AssertExceptionThrown WithMessageStartingWith (String expected)
    Set up to test that the action under test throws an exception where the message starts with expected string.
  • AssertExceptionThrown WithMessageContaining (String expected)
    Set up to test that the action under test throws an exception where the message contains substring.
  • AssertExceptionThrown WithMessageMatching (String regExPattern)
    Set up to test that the action under test throws an exception where the message matches RegEx pattern.
  • Exception WhenExecuting (Action action)
    Call action that should throw an exception, and assert that the exception was thrown.

Static Methods

  • AssertExceptionThrown.OfType<TException>()
    Set up to test that the action under test throws an exception of this specific type.

  • AssertExceptionThrown.OfTypeOrSubclassOfType<TException>()
    Set up to test that the action under test throws an exception of this type of a subclass of this type.


ScenarioTester<TScenario>

VisualStudio.TestTools now has "DataMemberTest" and "DataRow" attributes, but they didn't when I started using the framework, so I wrote my own "scenerio testing" tool based my experience with NUnit "TestCase" attributes. This class provides the ability to execute the same test code for multiple test cases and, after all test cases have been executed, fail the unit test if any of the test cases failed.

Even if your test framework has attribute-based scenario testing, these helpers provide an alternative syntax that you might find useful.

This class is rarely used directly. It's easier to use with IEnumerable<TScenario>.TestEach or ForTest.Scenarios (see below).

When one or more of the scenarios fails, the failure exception shows which were unsuccessful, for example, this scenario test:

ForTest.Scenarios
(
    new { DateString = "1/31/2023", IsGoodDate = true },
    new { DateString = "2/31/2023", IsGoodDate = true },
    new { DateString = "6/31/2023", IsGoodDate = false }
)
.TestEach(scenario =>
{
    DateTime dt;
    Assert.AreEqual(scenario.IsGoodDate, DateTime.TryParse(scenario.DateString, out dt));
});

...throws this exception:

Test method SparkyTestHelpers.UnitTests.DateTests threw exception:
SparkyTestHelpers.Scenarios.ScenarioTestFailureException: Scenario[1] (2 of 3) - Assert.AreEqual failed. Expected:<True>. Actual:<False>.

Scenario data - anonymousType: {"DateString":"2/31/2023","IsGoodDate":true}

Scenario[2] (3 of 3) - Assert.AreEqual failed. Expected:<True>. Actual:<False>.

Scenario data - anonymousType: {"DateString":"4/31/2023","IsGoodDate":true}

Public Methods

  • ScenarioTester BeforeEachTest(Action<TScenario>)

    Defines action to called before each scenario is tested.

Example

ForTest.Scenarios(*array*)
.BeforeEachTest(scenario => 
{
    // do something, e.g. reset mocks, log scenario details
});
.TestEach(scenario =>
{
    DateTime dt;
    Assert.AreEqual(scenario.IsGoodDate, DateTime.TryParse(scenario.DateString, out dt));
});
  • ScenarioTester AfterEachTest(Action<TScenario>)

    Defines function called after each scenario is tested. The function receives the scenario and the exception (if any) caught by the test. If the function returns true, the scenario test is "passed". If false, exception is thrown to fail the test.

Example

ForTest.Scenarios(*array*)
.AfterEachTest((scenario, ex) => 
{
    // do something, e.g. log scenario details, 
    // decide if scenario with exception should be passed
    return ex == null;
});
.TestEach(scenario =>
{
    DateTime dt;
    Assert.AreEqual(scenario.IsGoodDate, DateTime.TryParse(scenario.DateString, out dt));
});

ScenarioTesterExtension

ScenarioTester<TScenario> extension methods.

Static Methods

  • ScenarioTester<TScenario> TestEach(IEnumerable<TScenario> enumerable, Action<TScenario> test)

Example

using SparkyTestHelpers.Scenarios;
. . .
new []
{
    new { DateString = "1/31/2023", IsGoodDate = true },  
    new { DateString = "2/31/2023", IsGoodDate = false } 
}
.TestEach(scenario =>
{
    DateTime dt;
    Assert.AreEqual(scenario.IsGoodDate, DateTime.TryParse(scenario.DateString, out dt));  
});  

ForTest

"Syntactic sugar" methods for working with ScenarioTester<TScenario>

Static Methods

  • ForTest.Scenarios(TScenario[] scenarios) - creates array of scenarios that can be "dotted" to the TestEach extension method:

Example

using SparkyTestHelpers.Scenarios;
. . .
ForTest.Scenarios
(
    new { DateString = "1/31/2023", IsGoodDate = true },  
    new { DateString = "2/31/2023", IsGoodDate = false }
)
.TestEach(scenario =>
{
    DateTime dt;
    Assert.AreEqual(scenario.IsGoodDate, DateTime.TryParse(scenario.DateString, out dt));  
});  
  • IEnumerable<TEnum> EnumValues() - tests each value in an enum.

Example

using SparkyTestHelpers.Scenarios;
. . .
ForTest.EnumValues<OrderStatus>()
    .TestEach(orderStatus => foo.Bar(orderStatus));
  • IEnumerable<TEnum> ExceptFor(IEnumerable<TEnum> values, TEnum[] valuesToExclude) - Exclude enum values from test scenarios.

Example

using SparkyTestHelpers.Scenarios;
. . .
ForTest.EnumValues<OrderStatus>()
    .ExceptFor(OrderStatus.Cancelled)
    .TestEach(orderStatus => foo.Bar(orderStatus));
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.3 is compatible.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 was computed.  netstandard2.0 was computed.  netstandard2.1 was computed. 
.NET Framework net46 was computed.  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 tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 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 (5)

Showing the top 5 NuGet packages that depend on SparkyTestHelpers:

Package Downloads
SparkyTestHelpers.Mapping

Unit test helpers for asserting public properties on class instances "mapped" from one type to another (via AutoMapper, another tool, or hand-written code) have the correct values.

SparkyTestHelpers.Moq

Unit test helpers providing alternate syntax for testing with Moq

SparkyTestHelpers.Scenarios.MsTest

MSTest implementation of SparkyTestHelpers.Scenarios

SparkyTestHelpers.AppSettings

Helpers for testing code that uses ConfigurationManager.AppSettings

SparkyTestHelpers.Xml

Helpers to perform .config file XML transformations, and to test the resulting transformed XML (or actually any XML, whether it's .config format or not).

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.5.4 7,956 8/13/2019
1.5.3 87,883 3/18/2019
1.5.2 23,781 12/2/2018
1.5.1 6,076 6/2/2018
1.5.0 816 5/20/2018
1.4.0 4,924 5/10/2018
1.2.2 45,697 2/21/2018
1.2.1 947 2/20/2018
1.2.0 2,348 2/14/2018
1.1.0 2,174 2/12/2018
1.0.0 1,988 2/9/2018

v1.2.2: Upgrade to Newtonsoft.Json 11