SparkyTestHelpers.AspNetMvc.Core 1.0.2

.NET Unit test helpers for asserting that ASP.NET MVC Core controller actions return expected results

There is a newer version of this package available.
See the version list below for details.
Install-Package SparkyTestHelpers.AspNetMvc.Core -Version 1.0.2
dotnet add package SparkyTestHelpers.AspNetMvc.Core --version 1.0.2
<PackageReference Include="SparkyTestHelpers.AspNetMvc.Core" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SparkyTestHelpers.AspNetMvc.Core --version 1.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SparkyTestHelpers.AspNetMvc.Core, 1.0.2"
#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 SparkyTestHelpers.AspNetMvc.Core as a Cake Addin
#addin nuget:?package=SparkyTestHelpers.AspNetMvc.Core&version=1.0.2

// Install SparkyTestHelpers.AspNetMvc.Core as a Cake Tool
#tool nuget:?package=SparkyTestHelpers.AspNetMvc.Core&version=1.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

see also:


ControllerTester<TController>

Instantiation:

using SparkyTestHelpers.AspNetMvc
    var homeController = new HomeController(/* with test dependencies */);
    var controllerTester = new ControllerTester<HomeController>(homeController);

It doesn't do anything on its own - just provides an Action(actionDefinitionExpression) method that's used to create a...

ControllerActionTester

    var controllerActionTester = 
        new ControllerTester<HomeController>(homeController).Action(x => x.Index);

ControllerActionTester has several .Test... methods used to assert that the controller action returns the expected IActionResult implementation. There are methods for all of the standard result types, plus the generic TestResult<TActionResultType> method:

  • .TestContent(Action<ContentResult> validate)
  • .TestEmpty(Action<EmptyResult> validate)
  • .TestFile(Action<FileResult> validate)
  • .TestJson(Action<JsonResult> validate)
  • .TestPartialView(Action<PartialViewResult> validate)
  • .TestRedirectToAction(string expecteActionName, Action<RedirectToRouteResult> validate)
  • .TestRedirectToPage(string expectedPageName, Action<RedirectToPageResult> validate)
  • .TestRedirectToRoute(string expectedRoute, Action<RedirectToRouteResult> validate)
  • .TestView(Action<ViewResult> validate)
  • .TestResult<TActionResultType>(Action<TActionResultType> validate)

Additional methods:

  • .ExpectingViewName(string expectedViewName) - used with .TestView and .TestPartialView
  • .ExpectingModel<TModelType>(Action<TModelType> validate) - using with .TestView and .TestJson
  • WhenModelStateIsValidEquals(bool isValid) - used to test conditional logic based on ModelState.IsValid

All validate "callback" actions shown above are optional.

Examples

    var homeController = new HomeController(/* with test dependencies */);
    var controllerTester = new ControllerTester<HomeController>(homeController);

    controllerTester.Action(x => x.Index).TestView();

    controllerTester
        .Action(x => () => x.Details(3))
        .ExpectingViewName("Details")
        .ExpectingModel<Foo>(foo => Assert.IsTrue(foo.IsValid))
        .TestView();

    controllerTester
        .Action(x => () => x.Edit(updateModel))
        .WhenModelStateIsValidEquals(false)
        .TestRedirectToAction("Errors");

    controllerTester
        .Action(x => () => x.Edit(updateModel))
        .WhenModelStateIsValidEquals(true)
        .ExpectingViewName("UpdateSuccessful")
        .TestRedirectToRoute("Home/UpdateSuccessful");

see also:


ControllerTester<TController>

Instantiation:

using SparkyTestHelpers.AspNetMvc
    var homeController = new HomeController(/* with test dependencies */);
    var controllerTester = new ControllerTester<HomeController>(homeController);

It doesn't do anything on its own - just provides an Action(actionDefinitionExpression) method that's used to create a...

ControllerActionTester

    var controllerActionTester = 
        new ControllerTester<HomeController>(homeController).Action(x => x.Index);

ControllerActionTester has several .Test... methods used to assert that the controller action returns the expected IActionResult implementation. There are methods for all of the standard result types, plus the generic TestResult<TActionResultType> method:

  • .TestContent(Action<ContentResult> validate)
  • .TestEmpty(Action<EmptyResult> validate)
  • .TestFile(Action<FileResult> validate)
  • .TestJson(Action<JsonResult> validate)
  • .TestPartialView(Action<PartialViewResult> validate)
  • .TestRedirectToAction(string expecteActionName, Action<RedirectToRouteResult> validate)
  • .TestRedirectToPage(string expectedPageName, Action<RedirectToPageResult> validate)
  • .TestRedirectToRoute(string expectedRoute, Action<RedirectToRouteResult> validate)
  • .TestView(Action<ViewResult> validate)
  • .TestResult<TActionResultType>(Action<TActionResultType> validate)

Additional methods:

  • .ExpectingViewName(string expectedViewName) - used with .TestView and .TestPartialView
  • .ExpectingModel<TModelType>(Action<TModelType> validate) - using with .TestView and .TestJson
  • WhenModelStateIsValidEquals(bool isValid) - used to test conditional logic based on ModelState.IsValid

All validate "callback" actions shown above are optional.

Examples

    var homeController = new HomeController(/* with test dependencies */);
    var controllerTester = new ControllerTester<HomeController>(homeController);

    controllerTester.Action(x => x.Index).TestView();

    controllerTester
        .Action(x => () => x.Details(3))
        .ExpectingViewName("Details")
        .ExpectingModel<Foo>(foo => Assert.IsTrue(foo.IsValid))
        .TestView();

    controllerTester
        .Action(x => () => x.Edit(updateModel))
        .WhenModelStateIsValidEquals(false)
        .TestRedirectToAction("Errors");

    controllerTester
        .Action(x => () => x.Edit(updateModel))
        .WhenModelStateIsValidEquals(true)
        .ExpectingViewName("UpdateSuccessful")
        .TestRedirectToRoute("Home/UpdateSuccessful");

Release Notes

v1.0.2: simplified dependencies

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
2.2.3 32 3/5/2021
2.2.2 272 9/2/2019
2.2.1.1 205 9/2/2019
2.2.1 362 5/18/2019
2.2.0 246 5/15/2019
2.1.0 1,781 3/31/2018
2.0.1 484 3/27/2018
2.0.0 489 3/27/2018
1.0.2 495 3/22/2018
1.0.1 508 3/22/2018
1.0.0 566 3/22/2018
Show less