// Copyright (c) .NET Foundation. All rights reserved. // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. using System; using System.Collections.Generic; using System.IO; using System.Text; using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Mvc.Controllers; using Microsoft.AspNetCore.Mvc.Formatters; using Microsoft.AspNetCore.Routing; using Moq; using Newtonsoft.Json; using Xunit; namespace Microsoft.AspNetCore.Mvc { // Tests Controller for the unit testability with which users can simply instantiate controllers for unit tests public class ControllerUnitTestabilityTests { [Theory] [MemberData(nameof(TestabilityViewTestData))] public void ControllerView_InvokedInUnitTests(object model, string viewName) { // Arrange var controller = new TestabilityController(); // Act var result = controller.View_Action(viewName, model); // Assert Assert.NotNull(result); var viewResult = Assert.IsType(result); Assert.Equal(viewName, viewResult.ViewName); Assert.NotNull(viewResult.ViewData); Assert.Same(model, viewResult.Model); Assert.Same(model, viewResult.ViewData.Model); Assert.Same(controller.ViewData, viewResult.ViewData); Assert.Same(controller.TempData, viewResult.TempData); } [Theory] [MemberData(nameof(TestabilityViewTestData))] public void ControllerPartialView_InvokedInUnitTests(object model, string viewName) { // Arrange var controller = new TestabilityController(); // Act var result = controller.PartialView_Action(viewName, model); // Assert Assert.NotNull(result); var viewResult = Assert.IsType(result); Assert.Equal(viewName, viewResult.ViewName); Assert.NotNull(viewResult.ViewData); Assert.Same(model, viewResult.Model); Assert.Same(model, viewResult.ViewData.Model); Assert.Same(controller.ViewData, viewResult.ViewData); Assert.Same(controller.TempData, viewResult.TempData); } [Fact] public void ControllerContent_InvokedInUnitTests() { // Arrange var content = "Content_1"; var contentType = "text/asp"; var encoding = Encoding.ASCII; var controller = new TestabilityController(); // Act var result = controller.Content_Action(content, contentType, encoding); // Assert Assert.NotNull(result); var contentResult = Assert.IsType(result); Assert.Equal(content, contentResult.Content); Assert.Equal("text/asp; charset=us-ascii", contentResult.ContentType.ToString()); Assert.Equal(encoding, MediaType.GetEncoding(contentResult.ContentType)); } [Theory] [InlineData("/Created_1", "CreatedBody")] [InlineData("/Created_2", null)] public void ControllerCreated_InvokedInUnitTests(string uri, string content) { // Arrange var controller = new TestabilityController(); // Act var result = controller.Created_Action(uri, content); // Assert Assert.NotNull(result); var createdResult = Assert.IsType(result); Assert.Equal(uri, createdResult.Location); Assert.Equal(content, createdResult.Value); Assert.Equal(StatusCodes.Status201Created, createdResult.StatusCode); } [Theory] [InlineData("/Accepted_1", "AcceptedBody")] [InlineData("/Accepted_2", null)] public void ControllerAccepted_InvokedInUnitTests(string uri, string content) { // Arrange var controller = new TestabilityController(); // Act var result = controller.Accepted_Action(uri, content); // Assert Assert.NotNull(result); var acceptedResult = Assert.IsType(result); Assert.Equal(uri, acceptedResult.Location); Assert.Equal(content, acceptedResult.Value); Assert.Equal(StatusCodes.Status202Accepted, acceptedResult.StatusCode); } [Fact] public void ControllerFileContent_InvokedInUnitTests() { // Arrange var content = "CreatedBody"; var contentType = "text/html"; var fileName = "Created.html"; var controller = new TestabilityController(); // Act var result = controller.FileContent_Action(content, contentType, fileName); // Assert Assert.NotNull(result); var fileContentResult = Assert.IsType(result); Assert.Equal(contentType, fileContentResult.ContentType.ToString()); Assert.Equal(fileName ?? string.Empty, fileContentResult.FileDownloadName); if (content == null) { Assert.Null(fileContentResult.FileContents); } else { Assert.Equal(content, Encoding.UTF8.GetString(fileContentResult.FileContents)); } } [Fact] public void ControllerFileStream_InvokedInUnitTests() { // Arrange var content = "CreatedBody"; var contentType = "text/html"; var fileName = "Created.html"; var mockHttpContext = new Mock(); mockHttpContext.Setup(x => x.Response.RegisterForDispose(It.IsAny())); var controller = new TestabilityController(); controller.ControllerContext.HttpContext = mockHttpContext.Object; // Act var result = controller.FileStream_Action(content, contentType, fileName); // Assert Assert.NotNull(result); var fileStreamResult = Assert.IsType(result); Assert.Equal(contentType, fileStreamResult.ContentType.ToString()); Assert.Equal(fileName ?? string.Empty, fileStreamResult.FileDownloadName); if (content == null) { Assert.Null(fileStreamResult.FileStream); } else { using (var stream = new StreamReader(fileStreamResult.FileStream, Encoding.UTF8)) { Assert.Equal(content, stream.ReadToEnd()); } } } [Fact] public void ControllerJson_InvokedInUnitTests() { // Arrange var controller = new TestabilityController(); var model = new MyModel() { Property1 = "Property_1" }; // Act var result = controller.Json_Action(model); // Assert Assert.NotNull(result); var jsonResult = Assert.IsType(result); Assert.NotNull(jsonResult.Value); Assert.Same(model, jsonResult.Value); Assert.IsType(jsonResult.Value); // Arrange controller = new TestabilityController(); // Act result = controller.Json_Action(null); // Assert Assert.NotNull(result); jsonResult = Assert.IsType(result); Assert.Null(jsonResult.Value); } [Fact] public void ControllerJsonWithSerializerSettings_InvokedInUnitTests() { // Arrange var controller = new TestabilityController(); var model = new MyModel() { Property1 = "Property_1" }; var serializerSettings = new JsonSerializerSettings(); // Act var result = controller.JsonWithSerializerSettings_Action(model, serializerSettings); // Assert Assert.NotNull(result); var jsonResult = Assert.IsType(result); Assert.NotNull(jsonResult.Value); Assert.Same(model, jsonResult.Value); Assert.IsType(jsonResult.Value); } [Fact] public void ControllerHttpNotFound_InvokedInUnitTests() { // Arrange var controller = new TestabilityController(); // Act var result = controller.HttpNotFound_Action(); // Assert Assert.NotNull(result); var httpNotFoundResult = Assert.IsType(result); Assert.Equal(StatusCodes.Status404NotFound, httpNotFoundResult.StatusCode); } [Fact] public void ControllerHttpNotFoundObject_InvokedInUnitTests() { // Arrange var controller = new TestabilityController(); // Act var result = controller.HttpNotFoundObject_Action("Test Content"); // Assert Assert.NotNull(result); var httpNotFoundObjectResult = Assert.IsType(result); Assert.Equal(StatusCodes.Status404NotFound, httpNotFoundObjectResult.StatusCode); Assert.Equal("Test Content", httpNotFoundObjectResult.Value); } [Fact] public void ControllerHttpBadRequest_InvokedInUnitTests() { // Arrange var controller = new TestabilityController(); // Act var result = controller.HttpBadRequest_Action(); // Assert Assert.NotNull(result); var httpBadRequest = Assert.IsType(result); Assert.Equal(StatusCodes.Status400BadRequest, httpBadRequest.StatusCode); } [Fact] public void ControllerHttpBadRequestObject_InvokedInUnitTests() { // Arrange var controller = new TestabilityController(); var error = new { Error = "Error Message" }; // Act var result = controller.HttpBadRequestObject_Action(error); // Assert Assert.NotNull(result); var httpBadRequest = Assert.IsType(result); Assert.Equal(StatusCodes.Status400BadRequest, httpBadRequest.StatusCode); Assert.Same(error, httpBadRequest.Value); // Arrange controller = new TestabilityController(); // Act result = controller.HttpBadRequestObject_Action(null); // Assert Assert.NotNull(result); httpBadRequest = Assert.IsType(result); Assert.Equal(StatusCodes.Status400BadRequest, httpBadRequest.StatusCode); Assert.Null(httpBadRequest.Value); } [Fact] public void ControllerCreatedAtRoute_InvokedInUnitTests() { // Arrange var controller = new TestabilityController(); var routeName = "RouteName_1"; var routeValues = new Dictionary() { { "route", "sample" } }; var value = new { Value = "Value_1" }; // Act var result = controller.CreatedAtRoute_Action(routeName, routeValues, value); // Assert Assert.NotNull(result); var createdAtRouteResult = Assert.IsType(result); Assert.Equal(routeName, createdAtRouteResult.RouteName); Assert.Single(createdAtRouteResult.RouteValues); Assert.Equal("sample", createdAtRouteResult.RouteValues["route"]); Assert.Same(value, createdAtRouteResult.Value); // Arrange controller = new TestabilityController(); // Act result = controller.CreatedAtRoute_Action(null, null, null); // Assert Assert.NotNull(result); createdAtRouteResult = Assert.IsType(result); Assert.Null(createdAtRouteResult.RouteName); Assert.Null(createdAtRouteResult.RouteValues); Assert.Null(createdAtRouteResult.Value); } [Fact] public void ControllerAcceptedAtRoute_InvokedInUnitTests() { // Arrange var controller = new TestabilityController(); var routeName = "RouteName_1"; var routeValues = new Dictionary() { { "route", "sample" } }; var value = new { Value = "Value_1" }; // Act var result = controller.AcceptedAtRoute_Action(routeName, routeValues, value); // Assert Assert.NotNull(result); var acceptedAtRouteResult = Assert.IsType(result); Assert.Equal(routeName, acceptedAtRouteResult.RouteName); Assert.Single(acceptedAtRouteResult.RouteValues); Assert.Equal("sample", acceptedAtRouteResult.RouteValues["route"]); Assert.Same(value,acceptedAtRouteResult.Value); // Arrange controller = new TestabilityController(); // Act result = controller.AcceptedAtRoute_Action(null, null, null); // Assert Assert.NotNull(result); acceptedAtRouteResult = Assert.IsType(result); Assert.Null(acceptedAtRouteResult.RouteName); Assert.Null(acceptedAtRouteResult.RouteValues); Assert.Null(acceptedAtRouteResult.Value); } [Fact] public void ControllerCreatedAtAction_InvokedInUnitTests() { // Arrange var controller = new TestabilityController(); var actionName = "ActionName_1"; var controllerName = "ControllerName_1"; var routeValues = new Dictionary() { { "route", "sample" } }; var value = new { Value = "Value_1" }; // Act var result = controller.CreatedAtAction_Action(actionName, controllerName, routeValues, value); // Assert Assert.NotNull(result); var createdAtActionResult = Assert.IsType(result); Assert.Equal(actionName, createdAtActionResult.ActionName); Assert.Equal(controllerName, createdAtActionResult.ControllerName); Assert.Single(createdAtActionResult.RouteValues); Assert.Equal("sample", createdAtActionResult.RouteValues["route"]); Assert.Same(value, createdAtActionResult.Value); // Arrange controller = new TestabilityController(); // Act result = controller.CreatedAtAction_Action(null, null, null, null); // Assert Assert.NotNull(result); createdAtActionResult = Assert.IsType(result); Assert.Null(createdAtActionResult.ActionName); Assert.Null(createdAtActionResult.ControllerName); Assert.Null(createdAtActionResult.Value); Assert.Null(createdAtActionResult.RouteValues); } [Fact] public void ControllerAcceptedAtAction_InvokedInUnitTests() { // Arrange var controller = new TestabilityController(); var actionName = "ActionName_1"; var controllerName = "ControllerName_1"; var routeValues = new Dictionary() { { "route", "sample" } }; var value = new { Value = "Value_1" }; // Act var result = controller.AcceptedAtAction_Action(actionName, controllerName, routeValues, value); // Assert Assert.NotNull(result); var acceptedAtActionResult = Assert.IsType(result); Assert.Equal(actionName, acceptedAtActionResult.ActionName); Assert.Equal(controllerName, acceptedAtActionResult.ControllerName); Assert.Single(acceptedAtActionResult.RouteValues); Assert.Equal("sample", acceptedAtActionResult.RouteValues["route"]); Assert.Same(value, acceptedAtActionResult.Value); // Arrange controller = new TestabilityController(); // Act result = controller.AcceptedAtAction_Action(null, null, null, null); // Assert Assert.NotNull(result); acceptedAtActionResult = Assert.IsType(result); Assert.Null(acceptedAtActionResult.ActionName); Assert.Null(acceptedAtActionResult.ControllerName); Assert.Null(acceptedAtActionResult.Value); Assert.Null(acceptedAtActionResult.RouteValues); } [Fact] public void ControllerRedirectToRoute_InvokedInUnitTests() { // Arrange var controller = new TestabilityController(); var routeName = "RouteName_1"; var routeValues = new Dictionary() { { "route", "sample" } }; // Act var result = controller.RedirectToRoute_Action(routeName, routeValues); // Assert Assert.NotNull(result); var redirectToRouteResult = Assert.IsType(result); Assert.Equal(routeName, redirectToRouteResult.RouteName); Assert.Single(redirectToRouteResult.RouteValues); Assert.Equal("sample", redirectToRouteResult.RouteValues["route"]); // Arrange controller = new TestabilityController(); // Act result = controller.RedirectToRoute_Action(null, null); // Assert Assert.NotNull(result); redirectToRouteResult = Assert.IsType(result); Assert.Null(redirectToRouteResult.RouteName); Assert.Null(redirectToRouteResult.RouteValues); } [Fact] public void ControllerRedirectToAction_InvokedInUnitTests() { // Arrange var controller = new TestabilityController(); var controllerName = "ControllerName_1"; var actionName = "ActionName_1"; var routeValues = new Dictionary() { { "route", "sample" } }; // Act var result = controller.RedirectToAction_Action(actionName, controllerName, routeValues); // Assert Assert.NotNull(result); var redirectToActionResult = Assert.IsType(result); Assert.Equal(actionName, redirectToActionResult.ActionName); Assert.Equal(controllerName, redirectToActionResult.ControllerName); Assert.Single(redirectToActionResult.RouteValues); Assert.Equal("sample", redirectToActionResult.RouteValues["route"]); // Arrange controller = new TestabilityController(); // Act result = controller.RedirectToAction_Action(null, null, null); // Assert Assert.NotNull(result); redirectToActionResult = Assert.IsType(result); Assert.Null(redirectToActionResult.ControllerName); Assert.Null(redirectToActionResult.ActionName); Assert.Null(redirectToActionResult.RouteValues); } [Fact] public void ControllerRedirect_InvokedInUnitTests() { // Arrange var controller = new TestabilityController(); var url = "http://contoso.com"; // Act var result = controller.Redirect_Action(url); // Assert Assert.NotNull(result); var redirectResult = Assert.IsType(result); Assert.Equal(url, redirectResult.Url); // Arrange controller = new TestabilityController(); // Act && Assert Assert.Throws(() => controller.Redirect_Action(null)); } [Fact] public void ControllerActionContext_ReturnsNotNull() { // Arrange && Act var controller = new TestabilityController(); // Assert Assert.NotNull(controller.ControllerContext); Assert.NotNull(controller.ControllerContext.ModelState); Assert.Null(controller.ControllerContext.ActionDescriptor); Assert.Null(controller.ControllerContext.HttpContext); Assert.Null(controller.ControllerContext.RouteData); } [Fact] public void ContextDefaultConstructor_CanBeUsedForControllerContext() { // Arrange var controllerContext = new ControllerContext(); var controller = new TestabilityController(); // Act controller.ControllerContext = controllerContext; // Assert Assert.Equal(controllerContext.HttpContext, controller.HttpContext); Assert.Equal(controllerContext.RouteData, controller.RouteData); Assert.Equal(controllerContext.ModelState, controller.ModelState); } [Fact] public void ControllerContextSetter_CanBeUsedWithControllerActionContext() { // Arrange var actionDescriptor = new ControllerActionDescriptor(); var httpContext = new DefaultHttpContext(); var routeData = new RouteData(); var controllerContext = new ControllerContext() { ActionDescriptor = actionDescriptor, HttpContext = httpContext, RouteData = routeData, }; var controller = new TestabilityController(); // Act controller.ControllerContext = controllerContext; // Assert Assert.Same(httpContext, controller.HttpContext); Assert.Same(routeData, controller.RouteData); Assert.Equal(controllerContext.ModelState, controller.ModelState); Assert.Same(actionDescriptor, controllerContext.ActionDescriptor); } [Fact] public void ContextModelState_ShouldBeSameAsViewDataAndControllerModelState() { // Arrange var controller1 = new TestabilityController(); var controller2 = new TestabilityController(); // Act controller2.ControllerContext = new ControllerContext(); // Assert Assert.Equal(controller1.ModelState, controller1.ControllerContext.ModelState); Assert.Equal(controller1.ModelState, controller1.ViewData.ModelState); Assert.Equal(controller1.ControllerContext.ModelState, controller2.ModelState); Assert.Equal(controller1.ControllerContext.ModelState, controller2.ControllerContext.ModelState); Assert.Equal(controller1.ControllerContext.ModelState, controller2.ViewData.ModelState); } [Fact] public void ViewComponent_WithName() { // Arrange var controller = new TestabilityController(); // Act var result = controller.ViewComponent("TagCloud"); // Assert Assert.NotNull(result); Assert.Equal("TagCloud", result.ViewComponentName); } [Fact] public void ViewComponent_WithType() { // Arrange var controller = new TestabilityController(); // Act var result = controller.ViewComponent(typeof(TagCloudViewComponent)); // Assert Assert.NotNull(result); Assert.Equal(typeof(TagCloudViewComponent), result.ViewComponentType); } [Fact] public void ViewComponent_WithArguments() { // Arrange var controller = new TestabilityController(); // Act var result = controller.ViewComponent(typeof(TagCloudViewComponent), new { Arg1 = "Hi", Arg2 = "There" }); // Assert Assert.NotNull(result); Assert.Equal(typeof(TagCloudViewComponent), result.ViewComponentType); Assert.Equal(new { Arg1 = "Hi", Arg2 = "There" }, result.Arguments); } public static IEnumerable TestabilityViewTestData { get { yield return new object[] { null, null }; yield return new object[] { new MyModel { Property1 = "Property_1", Property2 = "Property_2" }, "ViewName_1" }; } } private class TestabilityController : Controller { public IActionResult View_Action(string viewName, object data) { return View(viewName, data); } public IActionResult PartialView_Action(string viewName, object data) { return PartialView(viewName, data); } public IActionResult Content_Action(string content, string contentType, Encoding encoding) { return Content(content, contentType, encoding); } public IActionResult Created_Action(string uri, object data) { return Created(uri, data); } public IActionResult Accepted_Action(string uri, object data) { return Accepted(uri, data); } public IActionResult FileContent_Action(string content, string contentType, string fileName) { var contentArray = Encoding.UTF8.GetBytes(content); return File(contentArray, contentType, fileName); } public IActionResult FileStream_Action(string content, string contentType, string fileName) { var memoryStream = new MemoryStream(Encoding.UTF8.GetBytes(content)); return File(memoryStream, contentType, fileName); } public IActionResult Json_Action(object data) { return Json(data); } public IActionResult JsonWithSerializerSettings_Action(object data, JsonSerializerSettings serializerSettings) { return Json(data, serializerSettings); } public IActionResult Redirect_Action(string url) { return Redirect(url); } public IActionResult RedirectToAction_Action(string actionName, string controllerName, object routeValues) { return RedirectToAction(actionName, controllerName, routeValues); } public IActionResult RedirectToRoute_Action(string routeName, object routeValues) { return RedirectToRoute(routeName, routeValues); } public IActionResult CreatedAtAction_Action(string actionName, string controllerName, object routeValues, object value) { return CreatedAtAction(actionName, controllerName, routeValues, value); } public IActionResult CreatedAtRoute_Action(string routeName, object routeValues, object value) { return CreatedAtRoute(routeName, routeValues, value); } public IActionResult AcceptedAtAction_Action(string actionName, string controllerName, object routeValues, object value) { return AcceptedAtAction(actionName, controllerName, routeValues, value); } public IActionResult AcceptedAtRoute_Action(string routeName, object routeValues, object value) { return AcceptedAtRoute(routeName, routeValues, value); } public IActionResult HttpBadRequest_Action() { return BadRequest(); } public IActionResult HttpBadRequestObject_Action(object error) { return BadRequest(error); } public IActionResult HttpNotFound_Action() { return NotFound(); } public IActionResult HttpNotFoundObject_Action(object value) { return NotFound(value); } } private class MyModel { public string Property1 { get; set; } public string Property2 { get; set; } } private class TagCloudViewComponent { } } }