SparkyTestHelpers.AspNetMvc.Core
1.0.1
.NET Unit test helpers for asserting that ASP.NET MVC Core controller actions return expected results
See the version list below for details.
Install-Package SparkyTestHelpers.AspNetMvc.Core -Version 1.0.1
dotnet add package SparkyTestHelpers.AspNetMvc.Core --version 1.0.1
<PackageReference Include="SparkyTestHelpers.AspNetMvc.Core" Version="1.0.1" />
paket add SparkyTestHelpers.AspNetMvc.Core --version 1.0.1
#r "nuget: SparkyTestHelpers.AspNetMvc.Core, 1.0.1"
// Install SparkyTestHelpers.AspNetMvc.Core as a Cake Addin
#addin nuget:?package=SparkyTestHelpers.AspNetMvc.Core&version=1.0.1
// Install SparkyTestHelpers.AspNetMvc.Core as a Cake Tool
#tool nuget:?package=SparkyTestHelpers.AspNetMvc.Core&version=1.0.1
see also:
- SparkyTestHelpers.AspNetMvc - the .NET Framework version of this package
- the rest of the "Sparky suite" of .NET utilities and 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, 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:
- SparkyTestHelpers.AspNetMvc - the .NET Framework version of this package
- the rest of the "Sparky suite" of .NET utilities and 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, 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.1: Updated icon
Dependencies
-
.NETStandard 2.0
- Microsoft.AspNetCore.Mvc.Core (>= 2.0.2)
- Microsoft.AspNetCore.Mvc.ViewFeatures (>= 2.0.2)
- Newtonsoft.Json (>= 11.0.1)
- SparkyTestHelpers (>= 1.2.2)
- SparkyTestHelpers.AspNetMvc.Common (>= 1.0.0)
Used By
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.