SparkyTestHelpers.AspNetMvc.Core 2.0.1

.NET Unit test helpers for asserting that ASP.NET MVC Core controller / Razor Page 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 2.0.1
dotnet add package SparkyTestHelpers.AspNetMvc.Core --version 2.0.1
<PackageReference Include="SparkyTestHelpers.AspNetMvc.Core" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SparkyTestHelpers.AspNetMvc.Core --version 2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SparkyTestHelpers.AspNetMvc.Core, 2.0.1"
#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=2.0.1

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

see also:


Controller Action test helpers

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, string expectedControllerName, object expectedRouteValues, 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) - used 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");

Razor Page test helpers

PageModelTester<TPageModel>

ASP.NET MVC Razor Page PageModels have a lot in common with Controllers (they kind of combine the "C" and "M" of MVC), so the tester classes are pretty similar to ControllerTester and ControllerActionTester...

PageModelTester Instantiation:

using SparkyTestHelpers.AspNetMvc
    var homeModel = new HomeModel(/* with test dependencies */);
    var pageTester = new PageModelTester<HomeModel>(homeModel);

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

PageModelActionTester<TPageModel>

    var actionTester = 
        new PageModelTester<HomeModel>(homeModel).Action(x => x.OnGet);

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

  • .TestContent((optional) Action<ContentResult> validate)
  • .TestFile((optional) Action<FileResult> validate)
  • .TestJsonResult((optional) Action<JsonResult> validate)
  • .TestPage((optional) Action<PageResult> validate)
  • .TestRedirectToAction(string expecteActionName, string expectedControllerName, object expectedRouteValues, (optional) Action<RedirectToRouteResult> validate)
  • .TestRedirectToPage(string expectedPageName, (optional) Action<RedirectToPageResult> validate)
  • .TestRedirectToRoute(string expectedRoute, (optional) Action<RedirectToRouteResult> validate)
  • .TestResult<TActionResultType>((optional) Action<TActionResultType> validate)

Additional methods:

  • .ExpectingModel<TModelType>((optional) Action<TModelType> validate) - used with .TestJson. Can also be used with .TestPage, but it's more efficient to use...
  • .ExpectingModel(Action<TPageModel> validate) - used with .TestPage to perform validation PageModel property validation
  • WhenModelStateIsValidEquals(bool isValid) - used to test conditional logic based on ModelState.IsValid
    var homeModel = new HomeModel(/* with test dependencies */);
    var pageTester = new PageModelTester<HomeModel>(homeModel);

    pageTester
        .Action(x => x.OnGet)
        .ExpectingModel(model => Assert.IsTrue(model.Foo))
        .TestPage();

    pageTester
        .Action(x => x.OnPost)
        .WhenModelStateIsValidEquals(false)
        .ExpectingModel(model => Assert.AreEqual(expectedErrorMessage, model.ErrorMessage))
        .TestPage();

    pageTester
        .Action(x => x.Post)
        .WhenModelStateIsValidEquals(true)
        .TestRedirectToPage("UpdateSuccessful");

see also:


Controller Action test helpers

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, string expectedControllerName, object expectedRouteValues, 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) - used 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");

Razor Page test helpers

PageModelTester<TPageModel>

ASP.NET MVC Razor Page PageModels have a lot in common with Controllers (they kind of combine the "C" and "M" of MVC), so the tester classes are pretty similar to ControllerTester and ControllerActionTester...

PageModelTester Instantiation:

using SparkyTestHelpers.AspNetMvc
    var homeModel = new HomeModel(/* with test dependencies */);
    var pageTester = new PageModelTester<HomeModel>(homeModel);

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

PageModelActionTester<TPageModel>

    var actionTester = 
        new PageModelTester<HomeModel>(homeModel).Action(x => x.OnGet);

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

  • .TestContent((optional) Action<ContentResult> validate)
  • .TestFile((optional) Action<FileResult> validate)
  • .TestJsonResult((optional) Action<JsonResult> validate)
  • .TestPage((optional) Action<PageResult> validate)
  • .TestRedirectToAction(string expecteActionName, string expectedControllerName, object expectedRouteValues, (optional) Action<RedirectToRouteResult> validate)
  • .TestRedirectToPage(string expectedPageName, (optional) Action<RedirectToPageResult> validate)
  • .TestRedirectToRoute(string expectedRoute, (optional) Action<RedirectToRouteResult> validate)
  • .TestResult<TActionResultType>((optional) Action<TActionResultType> validate)

Additional methods:

  • .ExpectingModel<TModelType>((optional) Action<TModelType> validate) - used with .TestJson. Can also be used with .TestPage, but it's more efficient to use...
  • .ExpectingModel(Action<TPageModel> validate) - used with .TestPage to perform validation PageModel property validation
  • WhenModelStateIsValidEquals(bool isValid) - used to test conditional logic based on ModelState.IsValid
    var homeModel = new HomeModel(/* with test dependencies */);
    var pageTester = new PageModelTester<HomeModel>(homeModel);

    pageTester
        .Action(x => x.OnGet)
        .ExpectingModel(model => Assert.IsTrue(model.Foo))
        .TestPage();

    pageTester
        .Action(x => x.OnPost)
        .WhenModelStateIsValidEquals(false)
        .ExpectingModel(model => Assert.AreEqual(expectedErrorMessage, model.ErrorMessage))
        .TestPage();

    pageTester
        .Action(x => x.Post)
        .WhenModelStateIsValidEquals(true)
        .TestRedirectToPage("UpdateSuccessful");

Release Notes

v2.0: Added RazorPages testing, Replaced ControllerTestException with ActionTestException

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