// 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. #if MOCK_SUPPORT using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Reflection; using System.Text; using System.Threading.Tasks; using Microsoft.AspNet.Http; using Microsoft.AspNet.Http.Internal; using Microsoft.AspNet.Mvc.Filters; using Microsoft.AspNet.Mvc.Formatters; using Microsoft.AspNet.Mvc.ModelBinding; using Microsoft.AspNet.Mvc.ModelBinding.Validation; using Microsoft.AspNet.Mvc.ViewFeatures; using Microsoft.AspNet.Routing; using Microsoft.AspNet.Testing; using Moq; using Newtonsoft.Json; using Xunit; namespace Microsoft.AspNet.Mvc.Test { public class ControllerTest { public static IEnumerable PublicNormalMethodsFromController { get { return typeof(Controller).GetTypeInfo() .DeclaredMethods .Where(method => method.IsPublic && !method.IsSpecialName && !method.Name.Equals("Dispose", StringComparison.OrdinalIgnoreCase)) .Select(method => new[] { method }); } } [Fact] public void SettingViewData_AlsoUpdatesViewBag() { // Arrange var metadataProvider = TestModelMetadataProvider.CreateDefaultProvider(); var controller = new TestableController(); var originalViewData = controller.ViewData = new ViewDataDictionary(metadataProvider); var replacementViewData = new ViewDataDictionary(metadataProvider); // Act controller.ViewBag.Hello = "goodbye"; controller.ViewData = replacementViewData; controller.ViewBag.Another = "property"; // Assert Assert.NotSame(originalViewData, controller.ViewData); Assert.Same(replacementViewData, controller.ViewData); Assert.Null(controller.ViewBag.Hello); Assert.Equal("property", controller.ViewBag.Another); Assert.Equal("property", controller.ViewData["Another"]); } [Fact] public void Redirect_WithParameterUrl_SetsRedirectResultSameUrl() { // Arrange var controller = new TestableController(); var url = "/test/url"; // Act var result = controller.Redirect(url); // Assert Assert.IsType(result); Assert.False(result.Permanent); Assert.Same(url, result.Url); } [Fact] public void RedirectPermanent_WithParameterUrl_SetsRedirectResultPermanentAndSameUrl() { // Arrange var controller = new TestableController(); var url = "/test/url"; // Act var result = controller.RedirectPermanent(url); // Assert Assert.IsType(result); Assert.True(result.Permanent); Assert.Same(url, result.Url); } [Theory] [InlineData(null)] [InlineData("")] public void Redirect_WithParameter_NullOrEmptyUrl_Throws(string url) { // Arrange var controller = new TestableController(); // Act & Assert ExceptionAssert.ThrowsArgumentNullOrEmpty( () => controller.Redirect(url: url), "url"); } [Fact] public void LocalRedirect_WithParameterUrl_SetsLocalRedirectResultWithSameUrl() { // Arrange var controller = new TestableController(); var url = "/test/url"; // Act var result = controller.LocalRedirect(url); // Assert Assert.IsType(result); Assert.False(result.Permanent); Assert.Same(url, result.Url); } [Fact] public void LocalRedirectPermanent_WithParameterUrl_SetsLocalRedirectResultPermanentWithSameUrl() { // Arrange var controller = new TestableController(); var url = "/test/url"; // Act var result = controller.LocalRedirectPermanent(url); // Assert Assert.IsType(result); Assert.True(result.Permanent); Assert.Same(url, result.Url); } [Theory] [InlineData(null)] [InlineData("")] public void LocalRedirect_WithParameter_NullOrEmptyUrl_Throws(string url) { // Arrange var controller = new TestableController(); // Act & Assert ExceptionAssert.ThrowsArgumentNullOrEmpty( () => controller.LocalRedirect(localUrl: url), "localUrl"); } [Theory] [InlineData(null)] [InlineData("")] public void RedirectPermanent_WithParameter_NullOrEmptyUrl_Throws(string url) { // Arrange var controller = new TestableController(); // Act & Assert ExceptionAssert.ThrowsArgumentNullOrEmpty( () => controller.RedirectPermanent(url: url), "url"); } [Fact] public void RedirectToAction_WithParameterActionName_SetsResultActionName() { // Arrange var controller = new TestableController(); // Act var resultTemporary = controller.RedirectToAction("SampleAction"); // Assert Assert.IsType(resultTemporary); Assert.False(resultTemporary.Permanent); Assert.Equal("SampleAction", resultTemporary.ActionName); } [Fact] public void RedirectToActionPermanent_WithParameterActionName_SetsResultActionNameAndPermanent() { // Arrange var controller = new TestableController(); // Act var resultPermanent = controller.RedirectToActionPermanent("SampleAction"); // Assert Assert.IsType(resultPermanent); Assert.True(resultPermanent.Permanent); Assert.Equal("SampleAction", resultPermanent.ActionName); } [Theory] [InlineData("")] [InlineData(null)] [InlineData("SampleController")] public void RedirectToAction_WithParameterActionAndControllerName_SetsEqualNames(string controllerName) { // Arrange var controller = new TestableController(); // Act var resultTemporary = controller.RedirectToAction("SampleAction", controllerName); // Assert Assert.IsType(resultTemporary); Assert.False(resultTemporary.Permanent); Assert.Equal("SampleAction", resultTemporary.ActionName); Assert.Equal(controllerName, resultTemporary.ControllerName); } [Theory] [InlineData("")] [InlineData(null)] [InlineData("SampleController")] public void RedirectToActionPermanent_WithParameterActionAndControllerName_SetsEqualNames( string controllerName) { // Arrange var controller = new TestableController(); // Act var resultPermanent = controller.RedirectToActionPermanent("SampleAction", controllerName); // Assert Assert.IsType(resultPermanent); Assert.True(resultPermanent.Permanent); Assert.Equal("SampleAction", resultPermanent.ActionName); Assert.Equal(controllerName, resultPermanent.ControllerName); } [Theory] [MemberData(nameof(RedirectTestData))] public void RedirectToAction_WithParameterActionControllerRouteValues_SetsResultProperties( object routeValues, IEnumerable> expected) { // Arrange var controller = new TestableController(); // Act var resultTemporary = controller.RedirectToAction("SampleAction", "SampleController", routeValues); // Assert Assert.IsType(resultTemporary); Assert.False(resultTemporary.Permanent); Assert.Equal("SampleAction", resultTemporary.ActionName); Assert.Equal("SampleController", resultTemporary.ControllerName); Assert.Equal(expected, resultTemporary.RouteValues); } [Theory] [MemberData(nameof(RedirectTestData))] public void RedirectToActionPermanent_WithParameterActionControllerRouteValues_SetsResultProperties( object routeValues, IEnumerable> expected) { // Arrange var controller = new TestableController(); // Act var resultPermanent = controller.RedirectToActionPermanent( "SampleAction", "SampleController", routeValues); // Assert Assert.IsType(resultPermanent); Assert.True(resultPermanent.Permanent); Assert.Equal("SampleAction", resultPermanent.ActionName); Assert.Equal("SampleController", resultPermanent.ControllerName); Assert.Equal(expected, resultPermanent.RouteValues); } [Theory] [MemberData(nameof(RedirectTestData))] public void RedirectToAction_WithParameterActionAndRouteValues_SetsResultProperties( object routeValues, IEnumerable> expected) { // Arrange var controller = new TestableController(); // Act var resultTemporary = controller.RedirectToAction(actionName: null, routeValues: routeValues); // Assert Assert.IsType(resultTemporary); Assert.False(resultTemporary.Permanent); Assert.Null(resultTemporary.ActionName); Assert.Equal(expected, resultTemporary.RouteValues); } [Theory] [MemberData(nameof(RedirectTestData))] public void RedirectToActionPermanent_WithParameterActionAndRouteValues_SetsResultProperties( object routeValues, IEnumerable> expected) { // Arrange var controller = new TestableController(); // Act var resultPermanent = controller.RedirectToActionPermanent(null, routeValues); // Assert Assert.IsType(resultPermanent); Assert.True(resultPermanent.Permanent); Assert.Null(resultPermanent.ActionName); Assert.Equal(expected, resultPermanent.RouteValues); } [Theory] [MemberData(nameof(RedirectTestData))] public void RedirectToRoute_WithParameterRouteValues_SetsResultEqualRouteValues( object routeValues, IEnumerable> expected) { // Arrange var controller = new TestableController(); // Act var resultTemporary = controller.RedirectToRoute(routeValues); // Assert Assert.IsType(resultTemporary); Assert.False(resultTemporary.Permanent); Assert.Equal(expected, resultTemporary.RouteValues); } [Theory] [MemberData(nameof(RedirectTestData))] public void RedirectToRoutePermanent_WithParameterRouteValues_SetsResultEqualRouteValuesAndPermanent( object routeValues, IEnumerable> expected) { // Arrange var controller = new TestableController(); // Act var resultPermanent = controller.RedirectToRoutePermanent(routeValues); // Assert Assert.IsType(resultPermanent); Assert.True(resultPermanent.Permanent); Assert.Equal(expected, resultPermanent.RouteValues); } [Fact] public void RedirectToRoute_WithParameterRouteName_SetsResultSameRouteName() { // Arrange var controller = new TestableController(); var routeName = "CustomRouteName"; // Act var resultTemporary = controller.RedirectToRoute(routeName); // Assert Assert.IsType(resultTemporary); Assert.False(resultTemporary.Permanent); Assert.Same(routeName, resultTemporary.RouteName); } [Fact] public void RedirectToRoutePermanent_WithParameterRouteName_SetsResultSameRouteNameAndPermanent() { // Arrange var controller = new TestableController(); var routeName = "CustomRouteName"; // Act var resultPermanent = controller.RedirectToRoutePermanent(routeName); // Assert Assert.IsType(resultPermanent); Assert.True(resultPermanent.Permanent); Assert.Same(routeName, resultPermanent.RouteName); } [Theory] [MemberData(nameof(RedirectTestData))] public void RedirectToRoute_WithParameterRouteNameAndRouteValues_SetsResultSameRouteNameAndRouteValues( object routeValues, IEnumerable> expected) { // Arrange var controller = new TestableController(); var routeName = "CustomRouteName"; // Act var resultTemporary = controller.RedirectToRoute(routeName, routeValues); // Assert Assert.IsType(resultTemporary); Assert.False(resultTemporary.Permanent); Assert.Same(routeName, resultTemporary.RouteName); Assert.Equal(expected, resultTemporary.RouteValues); } [Theory] [MemberData(nameof(RedirectTestData))] public void RedirectToRoutePermanent_WithParameterRouteNameAndRouteValues_SetsResultProperties( object routeValues, IEnumerable> expected) { // Arrange var controller = new TestableController(); var routeName = "CustomRouteName"; // Act var resultPermanent = controller.RedirectToRoutePermanent(routeName, routeValues); // Assert Assert.IsType(resultPermanent); Assert.True(resultPermanent.Permanent); Assert.Same(routeName, resultPermanent.RouteName); Assert.Equal(expected, resultPermanent.RouteValues); } [Fact] public void Created_WithStringParameter_SetsCreatedLocation() { // Arrange var controller = new TestableController(); var uri = "http://test/url"; // Act var result = controller.Created(uri, null); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status201Created, result.StatusCode); Assert.Same(uri, result.Location); } [Fact] public void Created_WithAbsoluteUriParameter_SetsCreatedLocation() { // Arrange var controller = new TestableController(); var uri = new Uri("http://test/url"); // Act var result = controller.Created(uri, null); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status201Created, result.StatusCode); Assert.Equal(uri.OriginalString, result.Location); } [Fact] public void Created_WithRelativeUriParameter_SetsCreatedLocation() { // Arrange var controller = new TestableController(); var uri = new Uri("/test/url", UriKind.Relative); // Act var result = controller.Created(uri, null); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status201Created, result.StatusCode); Assert.Equal(uri.OriginalString, result.Location); } [Fact] public void Created_IDisposableObject_RegistersForDispose() { // Arrange var mockHttpContext = new Mock(); mockHttpContext.Setup(x => x.Response.RegisterForDispose(It.IsAny())); var uri = new Uri("/test/url", UriKind.Relative); var controller = new TestableController(); controller.ControllerContext.HttpContext = mockHttpContext.Object; var input = new DisposableObject(); // Act var result = controller.Created(uri, input); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status201Created, result.StatusCode); Assert.Equal(uri.OriginalString, result.Location); Assert.Same(input, result.Value); mockHttpContext.Verify( x => x.Response.RegisterForDispose(It.IsAny()), Times.Once()); } [Fact] public void CreatedAtAction_WithParameterActionName_SetsResultActionName() { // Arrange var controller = new TestableController(); // Act var result = controller.CreatedAtAction("SampleAction", null); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status201Created, result.StatusCode); Assert.Equal("SampleAction", result.ActionName); } [Theory] [InlineData("")] [InlineData(null)] [InlineData("SampleController")] public void CreatedAtAction_WithActionControllerAndNullRouteValue_SetsSameValue( string controllerName) { // Arrange var controller = new TestableController(); // Act var result = controller.CreatedAtAction("SampleAction", controllerName, null, null); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status201Created, result.StatusCode); Assert.Equal("SampleAction", result.ActionName); Assert.Equal(controllerName, result.ControllerName); } [Fact] public void CreatedAtAction_WithActionControllerRouteValues_SetsSameValues() { // Arrange var controller = new TestableController(); var expected = new Dictionary { { "test", "case" }, { "sample", "route" }, }; // Act var result = controller.CreatedAtAction( "SampleAction", "SampleController", new RouteValueDictionary(expected), null); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status201Created, result.StatusCode); Assert.Equal("SampleAction", result.ActionName); Assert.Equal("SampleController", result.ControllerName); Assert.Equal(expected, result.RouteValues); } [Fact] public void CreatedAtAction_IDisposableObject_RegistersForDispose() { // Arrange var mockHttpContext = new Mock(); mockHttpContext.Setup(x => x.Response.RegisterForDispose(It.IsAny())); var controller = new TestableController(); controller.ControllerContext.HttpContext = mockHttpContext.Object; var input = new DisposableObject(); // Act var result = controller.CreatedAtAction("SampleAction", input); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status201Created, result.StatusCode); Assert.Equal("SampleAction", result.ActionName); Assert.Same(input, result.Value); mockHttpContext.Verify( x => x.Response.RegisterForDispose(It.IsAny()), Times.Once()); } [Fact] public void CreatedAtRoute_WithParameterRouteName_SetsResultSameRouteName() { // Arrange var controller = new TestableController(); var routeName = "SampleRoute"; // Act var result = controller.CreatedAtRoute(routeName, null); // Assert Assert.IsType(result); Assert.Same(routeName, result.RouteName); } [Fact] public void CreatedAtRoute_WithParameterRouteValues_SetsResultSameRouteValues() { // Arrange var controller = new TestableController(); var expected = new Dictionary { { "test", "case" }, { "sample", "route" }, }; // Act var result = controller.CreatedAtRoute(new RouteValueDictionary(expected), null); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status201Created, result.StatusCode); Assert.Equal(expected, result.RouteValues); } [Fact] public void CreatedAtRoute_WithParameterRouteNameAndValues_SetsResultSameProperties() { // Arrange var controller = new TestableController(); var routeName = "SampleRoute"; var expected = new Dictionary { { "test", "case" }, { "sample", "route" }, }; // Act var result = controller.CreatedAtRoute(routeName, new RouteValueDictionary(expected), null); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status201Created, result.StatusCode); Assert.Same(routeName, result.RouteName); Assert.Equal(expected, result.RouteValues); } [Fact] public void CreatedAtRoute_IDisposableObject_RegistersForDispose() { // Arrange var mockHttpContext = new Mock(); mockHttpContext.Setup(x => x.Response.RegisterForDispose(It.IsAny())); var controller = new TestableController(); controller.ControllerContext.HttpContext = mockHttpContext.Object; var input = new DisposableObject(); // Act var result = controller.CreatedAtRoute("SampleRoute", input); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status201Created, result.StatusCode); Assert.Equal("SampleRoute", result.RouteName); Assert.Same(input, result.Value); mockHttpContext.Verify( x => x.Response.RegisterForDispose(It.IsAny()), Times.Once()); } [Fact] public void File_WithContents() { // Arrange var controller = new TestableController(); var fileContents = new byte[0]; // Act var result = controller.File(fileContents, "application/pdf"); // Assert Assert.NotNull(result); Assert.Same(fileContents, result.FileContents); Assert.Equal("application/pdf", result.ContentType.ToString()); Assert.Equal(string.Empty, result.FileDownloadName); } [Fact] public void File_WithContentsAndFileDownloadName() { // Arrange var controller = new TestableController(); var fileContents = new byte[0]; // Act var result = controller.File(fileContents, "application/pdf", "someDownloadName"); // Assert Assert.NotNull(result); Assert.Same(fileContents, result.FileContents); Assert.Equal("application/pdf", result.ContentType.ToString()); Assert.Equal("someDownloadName", result.FileDownloadName); } [Fact] public void File_WithPath() { // Arrange var controller = new TestableController(); var path = Path.GetFullPath("somepath"); // Act var result = controller.File(path, "application/pdf"); // Assert Assert.NotNull(result); Assert.Equal(path, result.FileName); Assert.Equal("application/pdf", result.ContentType.ToString()); Assert.Equal(string.Empty, result.FileDownloadName); } [Fact] public void File_WithPathAndFileDownloadName() { // Arrange var controller = new TestableController(); var path = Path.GetFullPath("somepath"); // Act var result = controller.File(path, "application/pdf", "someDownloadName"); // Assert Assert.NotNull(result); Assert.Equal(path, result.FileName); Assert.Equal("application/pdf", result.ContentType.ToString()); Assert.Equal("someDownloadName", result.FileDownloadName); } [Fact] public void File_WithStream() { // Arrange var mockHttpContext = new Mock(); mockHttpContext.Setup(x => x.Response.RegisterForDispose(It.IsAny())); var controller = new TestableController(); controller.ControllerContext.HttpContext = mockHttpContext.Object; var fileStream = Stream.Null; // Act var result = controller.File(fileStream, "application/pdf"); // Assert Assert.NotNull(result); Assert.Same(fileStream, result.FileStream); Assert.Equal("application/pdf", result.ContentType.ToString()); Assert.Equal(string.Empty, result.FileDownloadName); } [Fact] public void File_WithStreamAndFileDownloadName() { // Arrange var mockHttpContext = new Mock(); mockHttpContext.Setup(x => x.Response.RegisterForDispose(It.IsAny())); var controller = new TestableController(); controller.ControllerContext.HttpContext = mockHttpContext.Object; var fileStream = Stream.Null; // Act var result = controller.File(fileStream, "application/pdf", "someDownloadName"); // Assert Assert.NotNull(result); Assert.Same(fileStream, result.FileStream); Assert.Equal("application/pdf", result.ContentType.ToString()); Assert.Equal("someDownloadName", result.FileDownloadName); mockHttpContext.Verify( x => x.Response.RegisterForDispose(It.IsAny()), Times.Once()); } [Fact] public void HttpUnauthorized_SetsStatusCode() { // Arrange var controller = new TestableController(); // Act var result = controller.HttpUnauthorized(); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status401Unauthorized, result.StatusCode); } [Fact] public void HttpNotFound_SetsStatusCode() { // Arrange var controller = new TestableController(); // Act var result = controller.HttpNotFound(); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status404NotFound, result.StatusCode); } [Fact] public void HttpNotFound_SetsStatusCodeAndResponseContent() { // Arrange var controller = new TestableController(); // Act var result = controller.HttpNotFound("Test Content"); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status404NotFound, result.StatusCode); Assert.Equal("Test Content", result.Value); } [Fact] public void HttpNotFound_IDisposableObject_RegistersForDispose() { // Arrange var mockHttpContext = new Mock(); mockHttpContext.Setup(x => x.Response.RegisterForDispose(It.IsAny())); var controller = new TestableController(); controller.ControllerContext.HttpContext = mockHttpContext.Object; var input = new DisposableObject(); // Act var result = controller.HttpNotFound(input); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status404NotFound, result.StatusCode); Assert.Same(input, result.Value); mockHttpContext.Verify( x => x.Response.RegisterForDispose(It.IsAny()), Times.Once()); } [Fact] public void Ok_SetsStatusCode() { // Arrange var controller = new TestableController(); // Act var result = controller.Ok(); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status200OK, result.StatusCode); } [Fact] public void Ok_WithIDisposableObject_RegistersForDispose() { // Arrange var mockHttpContext = new Mock(); mockHttpContext.Setup(x => x.Response.RegisterForDispose(It.IsAny())); var controller = new TestableController(); controller.ControllerContext.HttpContext = mockHttpContext.Object; var input = new DisposableObject(); // Act var result = controller.Ok(input); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status200OK, result.StatusCode); Assert.Same(input, result.Value); mockHttpContext.Verify( x => x.Response.RegisterForDispose(It.IsAny()), Times.Once()); } [Fact] public void BadRequest_SetsStatusCode() { // Arrange var controller = new TestableController(); // Act var result = controller.HttpBadRequest(); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status400BadRequest, result.StatusCode); } [Fact] public void BadRequest_SetsStatusCodeAndValue_Object() { // Arrange var controller = new TestableController(); var obj = new object(); // Act var result = controller.HttpBadRequest(obj); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status400BadRequest, result.StatusCode); Assert.Equal(obj, result.Value); } [Fact] public void BadRequest_IDisposableObject_RegistersForDispose() { // Arrange var mockHttpContext = new Mock(); mockHttpContext.Setup(x => x.Response.RegisterForDispose(It.IsAny())); var controller = new TestableController(); controller.ControllerContext.HttpContext = mockHttpContext.Object; var input = new DisposableObject(); // Act var result = controller.HttpBadRequest(input); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status400BadRequest, result.StatusCode); Assert.Same(input, result.Value); mockHttpContext.Verify( x => x.Response.RegisterForDispose(It.IsAny()), Times.Once()); } [Fact] public void BadRequest_SetsStatusCodeAndValue_ModelState() { // Arrange var controller = new TestableController(); // Act var result = controller.HttpBadRequest(new ModelStateDictionary()); // Assert Assert.IsType(result); Assert.Equal(StatusCodes.Status400BadRequest, result.StatusCode); var errors = Assert.IsType(result.Value); Assert.Equal(0, errors.Count); } [Theory] [MemberData(nameof(PublicNormalMethodsFromController))] public void NonActionAttribute_IsOnEveryPublicNormalMethodFromController(MethodInfo method) { // Arrange & Act & Assert Assert.True(method.IsDefined(typeof(NonActionAttribute))); } [Fact] public void Controller_View_WithoutParameter_SetsResultNullViewNameAndNullViewDataModelAndSameTempData() { // Arrange var controller = new TestableController() { ViewData = new ViewDataDictionary(new EmptyModelMetadataProvider()), TempData = new TempDataDictionary(Mock.Of(), Mock.Of()), }; // Act var actualViewResult = controller.View(); // Assert Assert.IsType(actualViewResult); Assert.Null(actualViewResult.ViewName); Assert.Same(controller.ViewData, actualViewResult.ViewData); Assert.Same(controller.TempData, actualViewResult.TempData); Assert.Null(actualViewResult.ViewData.Model); } [Fact] public void Controller_View_WithParameterViewName_SetsResultViewNameAndNullViewDataModelAndSameTempData() { // Arrange var controller = new TestableController() { ViewData = new ViewDataDictionary(new EmptyModelMetadataProvider()), TempData = new TempDataDictionary(Mock.Of(), Mock.Of()), }; // Act var actualViewResult = controller.View("CustomViewName"); // Assert Assert.IsType(actualViewResult); Assert.Equal("CustomViewName", actualViewResult.ViewName); Assert.Same(controller.ViewData, actualViewResult.ViewData); Assert.Same(controller.TempData, actualViewResult.TempData); Assert.Null(actualViewResult.ViewData.Model); } [Fact] public void Controller_View_WithParameterViewModel_SetsResultNullViewNameAndViewDataModelAndSameTempData() { // Arrange var controller = new TestableController() { ViewData = new ViewDataDictionary(new EmptyModelMetadataProvider()), TempData = new TempDataDictionary(Mock.Of(), Mock.Of()), }; var model = new object(); // Act var actualViewResult = controller.View(model); // Assert Assert.IsType(actualViewResult); Assert.Null(actualViewResult.ViewName); Assert.Same(controller.ViewData, actualViewResult.ViewData); Assert.Same(controller.TempData, actualViewResult.TempData); Assert.Same(model, actualViewResult.ViewData.Model); } [Fact] public void Controller_View_WithParameterViewNameAndViewModel_SetsResultViewNameAndViewDataModelAndSameTempData() { // Arrange var controller = new TestableController() { ViewData = new ViewDataDictionary(new EmptyModelMetadataProvider()), TempData = new TempDataDictionary(Mock.Of(), Mock.Of()), }; var model = new object(); // Act var actualViewResult = controller.View("CustomViewName", model); // Assert Assert.IsType(actualViewResult); Assert.Equal("CustomViewName", actualViewResult.ViewName); Assert.Same(controller.ViewData, actualViewResult.ViewData); Assert.Same(controller.TempData, actualViewResult.TempData); Assert.Same(model, actualViewResult.ViewData.Model); } [Fact] public void Controller_NoContent() { // Arrange var controller = new TestableController(); // Act var result = controller.NoContent(); // Assert Assert.Equal(StatusCodes.Status204NoContent, result.StatusCode); } [Fact] public void Controller_Content_WithParameterContentString_SetsResultContent() { // Arrange var controller = new TestableController(); // Act var actualContentResult = controller.Content("TestContent"); // Assert Assert.IsType(actualContentResult); Assert.Equal("TestContent", actualContentResult.Content); Assert.Null(actualContentResult.ContentType); } [Fact] public void Controller_Content_WithParameterContentStringAndContentType_SetsResultContentAndContentType() { // Arrange var controller = new TestableController(); // Act var actualContentResult = controller.Content("TestContent", "text/plain"); // Assert Assert.IsType(actualContentResult); Assert.Equal("TestContent", actualContentResult.Content); Assert.Null(actualContentResult.ContentType.Encoding); Assert.Equal("text/plain", actualContentResult.ContentType.ToString()); } [Fact] public void Controller_Content_WithParameterContentAndTypeAndEncoding_SetsResultContentAndTypeAndEncoding() { // Arrange var controller = new TestableController(); // Act var actualContentResult = controller.Content("TestContent", "text/plain", Encoding.UTF8); // Assert Assert.IsType(actualContentResult); Assert.Equal("TestContent", actualContentResult.Content); Assert.Same(Encoding.UTF8, actualContentResult.ContentType.Encoding); Assert.Equal("text/plain; charset=utf-8", actualContentResult.ContentType.ToString()); } [Fact] public void Controller_Json_WithParameterValue_SetsResultData() { // Arrange var controller = new TestableController(); var data = new object(); // Act var actualJsonResult = controller.Json(data); // Assert Assert.IsType(actualJsonResult); Assert.Same(data, actualJsonResult.Value); } [Fact] public void Controller_Json_WithParameterValue_SetsRespectiveProperty() { // Arrange var controller = new TestableController(); var data = new object(); var serializerSettings = new JsonSerializerSettings(); // Act var actualJsonResult = controller.Json(data, serializerSettings); // Assert Assert.IsType(actualJsonResult); Assert.Same(data, actualJsonResult.Value); } [Fact] public void Controller_Json_IDisposableObject_RegistersForDispose() { // Arrange var mockHttpContext = new Mock(); mockHttpContext.Setup(x => x.Response.RegisterForDispose(It.IsAny())); var controller = new TestableController(); controller.ControllerContext.HttpContext = mockHttpContext.Object; var input = new DisposableObject(); // Act var result = controller.Json(input); // Assert Assert.IsType(result); Assert.Same(input, result.Value); mockHttpContext.Verify( x => x.Response.RegisterForDispose(It.IsAny()), Times.Once()); } [Fact] public void Controller_JsonWithParameterValueAndSerializerSettings_IDisposableObject_RegistersForDispose() { // Arrange var mockHttpContext = new Mock(); mockHttpContext.Setup(x => x.Response.RegisterForDispose(It.IsAny())); var controller = new TestableController(); controller.ControllerContext.HttpContext = mockHttpContext.Object; var input = new DisposableObject(); var serializerSettings = new JsonSerializerSettings(); // Act var result = controller.Json(input, serializerSettings); // Assert Assert.IsType(result); Assert.Same(input, result.Value); mockHttpContext.Verify( x => x.Response.RegisterForDispose(It.IsAny()), Times.Once()); } public static IEnumerable RedirectTestData { get { yield return new object[] { null, Enumerable.Empty>() }; yield return new object[] { new Dictionary { { "hello", "world" } }, new[] { new KeyValuePair("hello", "world") } }; var expected2 = new Dictionary { { "test", "case" }, { "sample", "route" }, }; yield return new object[] { new RouteValueDictionary(expected2), expected2 }; } } // These tests share code with the ActionFilterAttribute tests because the various filter // implementations need to behave the same way. #if DNX451 [Fact] public async Task Controller_ActionFilter_SettingResult_ShortCircuits() { // Arrange, Act & Assert await CommonFilterTest.ActionFilter_SettingResult_ShortCircuits( new Mock()); } [Fact] public async Task Controller_ActionFilter_Calls_OnActionExecuted() { // Arrange, Act & Assert await CommonFilterTest.ActionFilter_Calls_OnActionExecuted( new Mock()); } [Fact] public async Task TryUpdateModel_FallsBackOnEmptyPrefix_IfNotSpecified() { // Arrange var metadataProvider = TestModelMetadataProvider.CreateDefaultProvider(); var valueProvider = Mock.Of(); var binder = new Mock(); binder.Setup(b => b.BindModelAsync(It.IsAny())) .Callback((ModelBindingContext context) => { Assert.Empty(context.ModelName); Assert.Same(valueProvider, Assert.IsType(context.ValueProvider)[0]); // Include and exclude should be null, resulting in property // being included. Assert.True(context.PropertyFilter(context, "Property1")); Assert.True(context.PropertyFilter(context, "Property2")); }) .Returns(ModelBindingResult.NoResultAsync) .Verifiable(); var controller = GetController(binder.Object, valueProvider); var model = new MyModel(); // Act var result = await controller.TryUpdateModelAsync(model); // Assert binder.Verify(); } [Fact] public async Task TryUpdateModel_UsesModelTypeNameIfSpecified() { // Arrange var modelName = "mymodel"; var metadataProvider = TestModelMetadataProvider.CreateDefaultProvider(); var valueProvider = Mock.Of(); var binder = new Mock(); binder.Setup(b => b.BindModelAsync(It.IsAny())) .Callback((ModelBindingContext context) => { Assert.Same(valueProvider, Assert.IsType(context.ValueProvider)[0]); // Include and exclude should be null, resulting in property // being included. Assert.True(context.PropertyFilter(context, "Property1")); Assert.True(context.PropertyFilter(context, "Property2")); }) .Returns(ModelBindingResult.NoResultAsync) .Verifiable(); var controller = GetController(binder.Object, valueProvider); var model = new MyModel(); // Act var result = await controller.TryUpdateModelAsync(model, modelName); // Assert binder.Verify(); } [Fact] public async Task TryUpdateModel_UsesModelValueProviderIfSpecified() { // Arrange var modelName = "mymodel"; var valueProvider = Mock.Of(); var binder = new Mock(); binder.Setup(b => b.BindModelAsync(It.IsAny())) .Callback((ModelBindingContext context) => { Assert.Same(valueProvider, context.ValueProvider); // Include and exclude should be null, resulting in property // being included. Assert.True(context.PropertyFilter(context, "Property1")); Assert.True(context.PropertyFilter(context, "Property2")); }) .Returns(ModelBindingResult.NoResultAsync) .Verifiable(); var controller = GetController(binder.Object, valueProvider: null); var model = new MyModel(); // Act var result = await controller.TryUpdateModelAsync(model, modelName, valueProvider); // Assert binder.Verify(); } [Fact] public async Task TryUpdateModel_PredicateOverload_UsesPassedArguments() { // Arrange var modelName = "mymodel"; Func includePredicate = (context, propertyName) => string.Equals(propertyName, "include1", StringComparison.OrdinalIgnoreCase) || string.Equals(propertyName, "include2", StringComparison.OrdinalIgnoreCase); var binder = new Mock(); var valueProvider = Mock.Of(); binder.Setup(b => b.BindModelAsync(It.IsAny())) .Callback((ModelBindingContext context) => { Assert.Same(valueProvider, Assert.IsType(context.ValueProvider)[0]); Assert.True(context.PropertyFilter(context, "include1")); Assert.True(context.PropertyFilter(context, "include2")); Assert.False(context.PropertyFilter(context, "exclude1")); Assert.False(context.PropertyFilter(context, "exclude2")); }) .Returns(ModelBindingResult.NoResultAsync) .Verifiable(); var controller = GetController(binder.Object, valueProvider); var model = new MyModel(); // Act await controller.TryUpdateModelAsync(model, modelName, includePredicate); // Assert binder.Verify(); } [Fact] public async Task TryUpdateModel_PredicateWithValueProviderOverload_UsesPassedArguments() { // Arrange var modelName = "mymodel"; Func includePredicate = (context, propertyName) => string.Equals(propertyName, "include1", StringComparison.OrdinalIgnoreCase) || string.Equals(propertyName, "include2", StringComparison.OrdinalIgnoreCase); var binder = new Mock(); var valueProvider = Mock.Of(); binder.Setup(b => b.BindModelAsync(It.IsAny())) .Callback((ModelBindingContext context) => { Assert.Same(valueProvider, context.ValueProvider); Assert.True(context.PropertyFilter(context, "include1")); Assert.True(context.PropertyFilter(context, "include2")); Assert.False(context.PropertyFilter(context, "exclude1")); Assert.False(context.PropertyFilter(context, "exclude2")); }) .Returns(ModelBindingResult.NoResultAsync) .Verifiable(); var controller = GetController(binder.Object, valueProvider: null); var model = new MyModel(); // Act await controller.TryUpdateModelAsync(model, modelName, valueProvider, includePredicate); // Assert binder.Verify(); } [Theory] [InlineData("")] [InlineData("prefix")] public async Task TryUpdateModel_IncludeExpressionOverload_UsesPassedArguments(string prefix) { // Arrange var valueProvider = new Mock(); valueProvider .Setup(v => v.ContainsPrefix(prefix)) .Returns(true); var binder = new Mock(); binder.Setup(b => b.BindModelAsync(It.IsAny())) .Callback((ModelBindingContext context) => { Assert.Same( valueProvider.Object, Assert.IsType(context.ValueProvider)[0]); Assert.True(context.PropertyFilter(context, "Property1")); Assert.True(context.PropertyFilter(context, "Property2")); Assert.False(context.PropertyFilter(context, "exclude1")); Assert.False(context.PropertyFilter(context, "exclude2")); }) .Returns(ModelBindingResult.NoResultAsync) .Verifiable(); var controller = GetController(binder.Object, valueProvider.Object); var model = new MyModel(); // Act await controller.TryUpdateModelAsync(model, prefix, m => m.Property1, m => m.Property2); // Assert binder.Verify(); } [Theory] [InlineData("")] [InlineData("prefix")] public async Task TryUpdateModel_IncludeExpressionWithValueProviderOverload_UsesPassedArguments(string prefix) { // Arrange var valueProvider = new Mock(); valueProvider .Setup(v => v.ContainsPrefix(prefix)) .Returns(true); var binder = new Mock(); binder.Setup(b => b.BindModelAsync(It.IsAny())) .Callback((ModelBindingContext context) => { Assert.Same(valueProvider.Object, context.ValueProvider); Assert.True(context.PropertyFilter(context, "Property1")); Assert.True(context.PropertyFilter(context, "Property2")); Assert.False(context.PropertyFilter(context, "exclude1")); Assert.False(context.PropertyFilter(context, "exclude2")); }) .Returns(ModelBindingResult.NoResultAsync) .Verifiable(); var controller = GetController(binder.Object, valueProvider: null); var model = new MyModel(); // Act await controller.TryUpdateModelAsync(model, prefix, valueProvider.Object, m => m.Property1, m => m.Property2); // Assert binder.Verify(); } [Fact] public async Task TryUpdateModelNonGeneric_PredicateWithValueProviderOverload_UsesPassedArguments() { // Arrange var modelName = "mymodel"; Func includePredicate = (context, propertyName) => string.Equals(propertyName, "include1", StringComparison.OrdinalIgnoreCase) || string.Equals(propertyName, "include2", StringComparison.OrdinalIgnoreCase); var valueProvider = Mock.Of(); var binder = new Mock(); binder.Setup(b => b.BindModelAsync(It.IsAny())) .Callback((ModelBindingContext context) => { Assert.Same(valueProvider, context.ValueProvider); Assert.True(context.PropertyFilter(context, "include1")); Assert.True(context.PropertyFilter(context, "include2")); Assert.False(context.PropertyFilter(context, "exclude1")); Assert.False(context.PropertyFilter(context, "exclude2")); }) .Returns(ModelBindingResult.NoResultAsync) .Verifiable(); var controller = GetController(binder.Object, valueProvider: null); var model = new MyModel(); // Act await controller.TryUpdateModelAsync(model, model.GetType(), modelName, valueProvider, includePredicate); // Assert binder.Verify(); } [Fact] public async Task TryUpdateModelNonGeneric_ModelTypeOverload_UsesPassedArguments() { // Arrange var modelName = "mymodel"; var metadataProvider = TestModelMetadataProvider.CreateDefaultProvider(); var valueProvider = Mock.Of(); var binder = new Mock(); binder.Setup(b => b.BindModelAsync(It.IsAny())) .Callback((ModelBindingContext context) => { Assert.Same(valueProvider, Assert.IsType(context.ValueProvider)[0]); // Include and exclude should be null, resulting in property // being included. Assert.True(context.PropertyFilter(context, "Property1")); Assert.True(context.PropertyFilter(context, "Property2")); }) .Returns(ModelBindingResult.NoResultAsync) .Verifiable(); var controller = GetController(binder.Object, valueProvider); var model = new MyModel(); // Act var result = await controller.TryUpdateModelAsync(model, model.GetType(), modelName); // Assert binder.Verify(); } [Fact] public async Task TryUpdateModelNonGeneric_BindToBaseDeclaredType_ModelTypeOverload() { // Arrange var modelName = "mymodel"; var metadataProvider = TestModelMetadataProvider.CreateDefaultProvider(); var valueProvider = Mock.Of(); var binder = new Mock(); binder.Setup(b => b.BindModelAsync(It.IsAny())) .Callback((ModelBindingContext context) => { Assert.Same(valueProvider, Assert.IsType(context.ValueProvider)[0]); // Include and exclude should be null, resulting in property // being included. Assert.True(context.PropertyFilter(context, "Property1")); Assert.True(context.PropertyFilter(context, "Property2")); }) .Returns(ModelBindingResult.NoResultAsync) .Verifiable(); var controller = GetController(binder.Object, valueProvider); MyModel model = new MyDerivedModel(); // Act var result = await controller.TryUpdateModelAsync(model, model.GetType(), modelName); // Assert binder.Verify(); } #endif [Fact] public void ControllerExposes_RequestServices() { // Arrange var controller = new TestableController(); var serviceProvider = Mock.Of(); var httpContext = new Mock(); httpContext.Setup(c => c.RequestServices) .Returns(serviceProvider); controller.ControllerContext.HttpContext = httpContext.Object; // Act var innerServiceProvider = controller.Resolver; // Assert Assert.Same(serviceProvider, innerServiceProvider); } [Fact] public void ControllerExposes_Request() { // Arrange var controller = new TestableController(); var request = Mock.Of(); var httpContext = new Mock(); httpContext.Setup(c => c.Request) .Returns(request); controller.ControllerContext.HttpContext = httpContext.Object; // Act var innerRequest = controller.Request; // Assert Assert.Same(request, innerRequest); } [Fact] public void ControllerExposes_Response() { // Arrange var controller = new TestableController(); var response = Mock.Of(); var httpContext = new Mock(); httpContext.Setup(c => c.Response) .Returns(response); controller.ControllerContext.HttpContext = httpContext.Object; // Act var innerResponse = controller.Response; // Assert Assert.Same(response, innerResponse); } [Fact] public void ControllerExposes_RouteData() { // Arrange var controller = new TestableController(); var routeData = Mock.Of(); controller.ControllerContext.RouteData = routeData; // Act var innerRouteData = controller.RouteData; // Assert Assert.Same(routeData, innerRouteData); } [Fact] public void ControllerDispose_CallsDispose() { // Arrange var controller = new DisposableController(); // Act controller.Dispose(); // Assert Assert.True(controller.DisposeCalled); } [Fact] public void TryValidateModelWithValidModel_ReturnsTrue() { // Arrange var binder = new Mock(); var controller = GetController(binder.Object, valueProvider: null); controller.ControllerContext.ValidatorProviders = new List() { Mock.Of(), }; var model = new TryValidateModelModel(); // Act var result = controller.TryValidateModel(model); // Assert Assert.True(result); Assert.True(controller.ModelState.IsValid); } [Fact] public void TryValidateModelWithInvalidModelWithPrefix_ReturnsFalse() { // Arrange var model = new TryValidateModelModel(); var validationResult = new[] { new ModelValidationResult(string.Empty, "Out of range!") }; var validator1 = new Mock(); validator1.Setup(v => v.Validate(It.IsAny())) .Returns(validationResult); var provider = new Mock(); provider.Setup(v => v.GetValidators(It.IsAny())) .Callback(c => c.Validators.Add(validator1.Object)); var binder = new Mock(); var controller = GetController(binder.Object, valueProvider: null); controller.ControllerContext.ValidatorProviders = new List() { provider.Object, }; // Act var result = controller.TryValidateModel(model, "Prefix"); // Assert Assert.False(result); Assert.Equal(1, controller.ModelState.Count); var error = Assert.Single(controller.ModelState["Prefix.IntegerProperty"].Errors); Assert.Equal("Out of range!", error.ErrorMessage); } [Fact] public void TryValidateModelWithInvalidModelNoPrefix_ReturnsFalse() { // Arrange var model = new TryValidateModelModel(); var validationResult = new[] { new ModelValidationResult(string.Empty, "Out of range!") }; var validator1 = new Mock(); validator1.Setup(v => v.Validate(It.IsAny())) .Returns(validationResult); var provider = new Mock(); provider.Setup(v => v.GetValidators(It.IsAny())) .Callback(c => c.Validators.Add(validator1.Object)); var binder = new Mock(); var controller = GetController(binder.Object, valueProvider: null); controller.ControllerContext.ValidatorProviders = new List() { provider.Object, }; // Act var result = controller.TryValidateModel(model); // Assert Assert.False(result); Assert.Equal(1, controller.ModelState.Count); var error = Assert.Single(controller.ModelState["IntegerProperty"].Errors); Assert.Equal("Out of range!", error.ErrorMessage); } [Fact] public void TryValidateModel_Succeeds_WithoutValidatorMetadata() { // Arrange // Do not add a Mock validator provider to this test. Test is intended to demonstrate ease of unit testing // and exercise DataAnnotationsModelValidatorProvider, avoiding #3586 regressions. var model = new TryValidateModelModel(); var controller = GetController(binder: null, valueProvider: null); // Act var result = controller.TryValidateModel(model); // Assert Assert.True(controller.ModelState.IsValid); } public void TempData_CanSetAndGetValues() { // Arrange var controller = GetController(null, null); var input = "Foo"; // Act controller.TempData["key"] = input; var result = controller.TempData["key"]; // Assert Assert.Equal(input, result); } private static Controller GetController(IModelBinder binder, IValueProvider valueProvider) { var metadataProvider = TestModelMetadataProvider.CreateDefaultProvider(); var httpContext = new DefaultHttpContext(); var viewData = new ViewDataDictionary(metadataProvider, new ModelStateDictionary()); var tempData = new TempDataDictionary(Mock.Of(), Mock.Of()); var controllerContext = new ControllerContext() { HttpContext = httpContext, ModelBinders = new[] { binder, }, ValueProviders = new[] { valueProvider, }, ValidatorProviders = new [] { new DataAnnotationsModelValidatorProvider(options: null, stringLocalizerFactory: null), }, }; var controller = new TestableController() { ControllerContext = controllerContext, MetadataProvider = metadataProvider, ObjectValidator = new DefaultObjectValidator(new IExcludeTypeValidationFilter[0], metadataProvider), TempData = tempData, ViewData = viewData, }; return controller; } private class MyModel { public string Property1 { get; set; } public string Property2 { get; set; } } private class MyDerivedModel : MyModel { public string Property3 { get; set; } } private class User { public User(int id) { Id = id; } public int Id { get; set; } public string Name { get; set; } public Address Address { get; set; } } private class Address { public string Street { get; set; } public string City { get; set; } public int Zip { get; set; } } private class TryValidateModelModel { public int IntegerProperty { get; set; } } private class DisposableController : Controller { public bool DisposeCalled { get; private set; } protected override void Dispose(bool disposing) { DisposeCalled = true; } } private class TestableController : Controller { } private class DisposableObject : IDisposable { public void Dispose() { throw new NotImplementedException(); } } } } #endif