// Copyright (c) Microsoft Open Technologies, Inc. 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.Linq; using System.Text; using System.Threading.Tasks; using System.Reflection; using Microsoft.AspNet.Http; using Microsoft.AspNet.Mvc.ModelBinding; using Microsoft.AspNet.Mvc.Rendering; using Microsoft.AspNet.Routing; using Microsoft.AspNet.Testing; #if ASPNET50 using Moq; #endif using Xunit; namespace Microsoft.AspNet.Mvc.Test { public class ControllerTests { public static IEnumerable PublicNormalMethodsFromController { get { return typeof(Controller).GetTypeInfo() .DeclaredMethods .Where(method => method.IsPublic && !method.IsSpecialName) .Select(method => new[] { method }); } } [Fact] public void SettingViewData_AlsoUpdatesViewBag() { // Arrange var metadataProvider = new DataAnnotationsModelMetadataProvider(); var controller = new Controller(); 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 Controller(); 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 Controller(); 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 Controller(); // Act & Assert ExceptionAssert.ThrowsArgument( () => controller.Redirect(url: url), "url", "The value cannot be null or empty"); } [Theory] [InlineData(null)] [InlineData("")] public void RedirectPermanent_WithParameter_NullOrEmptyUrl_Throws(string url) { // Arrange var controller = new Controller(); // Act & Assert ExceptionAssert.ThrowsArgument( () => controller.RedirectPermanent(url: url), "url", "The value cannot be null or empty"); } [Fact] public void RedirectToAction_WithParameterActionName_SetsResultActionName() { // Arrange var controller = new Controller(); // 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 Controller(); // 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 Controller(); // 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 Controller(); // 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 Controller(); // 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 Controller(); // 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 Controller(); // 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 Controller(); // 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 Controller(); // 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 Controller(); // 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 Controller(); 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 Controller(); 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 Controller(); 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 Controller(); 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 File_WithContents() { // Arrange var controller = new Controller(); var fileContents = new byte[0]; // Act var result = controller.File(fileContents, "someContentType"); // Assert Assert.NotNull(result); Assert.Same(fileContents, result.FileContents); Assert.Equal("someContentType", result.ContentType); Assert.Equal(string.Empty, result.FileDownloadName); } [Fact] public void File_WithContentsAndFileDownloadName() { // Arrange var controller = new Controller(); var fileContents = new byte[0]; // Act var result = controller.File(fileContents, "someContentType", "someDownloadName"); // Assert Assert.NotNull(result); Assert.Same(fileContents, result.FileContents); Assert.Equal("someContentType", result.ContentType); Assert.Equal("someDownloadName", result.FileDownloadName); } [Fact] public void File_WithPath() { // Arrange var controller = new Controller(); var path = Path.GetFullPath("somepath"); // Act var result = controller.File(path, "someContentType"); // Assert Assert.NotNull(result); Assert.Equal(path, result.FileName); Assert.Equal("someContentType", result.ContentType); Assert.Equal(string.Empty, result.FileDownloadName); } [Fact] public void File_WithPathAndFileDownloadName() { // Arrange var controller = new Controller(); var path = Path.GetFullPath("somepath"); // Act var result = controller.File(path, "someContentType", "someDownloadName"); // Assert Assert.NotNull(result); Assert.Equal(path, result.FileName); Assert.Equal("someContentType", result.ContentType); Assert.Equal("someDownloadName", result.FileDownloadName); } [Fact] public void File_WithStream() { // Arrange var controller = new Controller(); var fileStream = Stream.Null; // Act var result = controller.File(fileStream, "someContentType"); // Assert Assert.NotNull(result); Assert.Same(fileStream, result.FileStream); Assert.Equal("someContentType", result.ContentType); Assert.Equal(string.Empty, result.FileDownloadName); } [Fact] public void File_WithStreamAndFileDownloadName() { // Arrange var controller = new Controller(); var fileStream = Stream.Null; // Act var result = controller.File(fileStream, "someContentType", "someDownloadName"); // Assert Assert.NotNull(result); Assert.Same(fileStream, result.FileStream); Assert.Equal("someContentType", result.ContentType); Assert.Equal("someDownloadName", result.FileDownloadName); } [Fact] public void HttpNotFound_SetsStatusCode() { // Arrange var controller = new Controller(); // Act var result = controller.HttpNotFound(); // Assert Assert.IsType(result); Assert.Equal(404, result.StatusCode); } [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_SetsResultNullViewNameAndNullViewDataModel() { // Arrange var controller = new Controller() { ViewData = new ViewDataDictionary(new EmptyModelMetadataProvider()), }; // Act var actualViewResult = controller.View(); // Assert Assert.IsType(actualViewResult); Assert.Null(actualViewResult.ViewName); Assert.Same(controller.ViewData, actualViewResult.ViewData); Assert.Null(actualViewResult.ViewData.Model); } [Fact] public void Controller_View_WithParameterViewName_SetsResultViewNameAndNullViewDataModel() { // Arrange var controller = new Controller() { ViewData = new ViewDataDictionary(new EmptyModelMetadataProvider()), }; // Act var actualViewResult = controller.View("CustomViewName"); // Assert Assert.IsType(actualViewResult); Assert.Equal("CustomViewName", actualViewResult.ViewName); Assert.Same(controller.ViewData, actualViewResult.ViewData); Assert.Null(actualViewResult.ViewData.Model); } [Fact] public void Controller_View_WithParameterViewModel_SetsResultNullViewNameAndViewDataModel() { // Arrange var controller = new Controller() { ViewData = new ViewDataDictionary(new EmptyModelMetadataProvider()), }; 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(model, actualViewResult.ViewData.Model); } [Fact] public void Controller_View_WithParameterViewNameAndViewModel_SetsResultViewNameAndViewDataModel() { // Arrange var controller = new Controller() { ViewData = new ViewDataDictionary(new EmptyModelMetadataProvider()), }; 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(model, actualViewResult.ViewData.Model); } [Fact] public void Controller_Content_WithParameterContentString_SetsResultContent() { // Arrange var controller = new Controller(); // Act var actualContentResult = controller.Content("TestContent"); // Assert Assert.IsType(actualContentResult); Assert.Equal("TestContent", actualContentResult.Content); Assert.Null(actualContentResult.ContentEncoding); Assert.Null(actualContentResult.ContentType); } [Fact] public void Controller_Content_WithParameterContentStringAndContentType_SetsResultContentAndContentType() { // Arrange var controller = new Controller(); // Act var actualContentResult = controller.Content("TestContent", "text/plain"); // Assert Assert.IsType(actualContentResult); Assert.Equal("TestContent", actualContentResult.Content); Assert.Null(actualContentResult.ContentEncoding); Assert.Equal("text/plain", actualContentResult.ContentType); } [Fact] public void Controller_Content_WithParameterContentAndTypeAndEncoding_SetsResultContentAndTypeAndEncoding() { // Arrange var controller = new Controller(); // Act var actualContentResult = controller.Content("TestContent", "text/plain", Encoding.UTF8); // Assert Assert.IsType(actualContentResult); Assert.Equal("TestContent", actualContentResult.Content); Assert.Same(Encoding.UTF8, actualContentResult.ContentEncoding); Assert.Equal("text/plain", actualContentResult.ContentType); } [Fact] public void Controller_Json_WithParameterValue_SetsResultData() { // Arrange var controller = new Controller(); var data = new object(); // Act var actualJsonResult = controller.Json(data); // Assert Assert.IsType(actualJsonResult); Assert.Same(data, actualJsonResult.Value); } 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 ASPNET50 [Fact] public async Task Controller_ActionFilter_SettingResult_ShortCircuits() { await ActionFilterAttributeTests.ActionFilter_SettingResult_ShortCircuits( new Mock()); } [Fact] public async Task Controller_ActionFilter_Calls_OnActionExecuted() { await ActionFilterAttributeTests.ActionFilter_Calls_OnActionExecuted( new Mock()); } [Fact] public async Task TryUpdateModel_UsesModelTypeNameIfNotSpecified() { var metadataProvider = new DataAnnotationsModelMetadataProvider(); var valueProvider = Mock.Of(); var binder = new Mock(); binder.Setup(b => b.BindModelAsync(It.IsAny())) .Callback((ModelBindingContext b) => { Assert.Equal(typeof(MyModel).Name, b.ModelName); Assert.Same(valueProvider, b.ValueProvider); }) .Returns(Task.FromResult(false)) .Verifiable(); var model = new MyModel(); var actionContext = new ActionContext(Mock.Of(), new RouteData(), new ActionDescriptor()); var bindingContext = new ActionBindingContext(actionContext, metadataProvider, binder.Object, valueProvider, Mock.Of(), Mock.Of()); var bindingContextProvider = new Mock(); bindingContextProvider.Setup(b => b.GetActionBindingContextAsync(actionContext)) .Returns(Task.FromResult(bindingContext)); var viewData = new ViewDataDictionary(metadataProvider, new ModelStateDictionary()); var controller = new Controller { ActionContext = actionContext, BindingContextProvider = bindingContextProvider.Object, ViewData = viewData }; // Act var result = await controller.TryUpdateModelAsync(model); // Assert binder.Verify(); } [Fact] public async Task TryUpdateModel_UsesModelTypeNameIfSpecified() { var metadataProvider = new DataAnnotationsModelMetadataProvider(); var valueProvider = Mock.Of(); var binder = new Mock(); var modelName = "mymodel"; binder.Setup(b => b.BindModelAsync(It.IsAny())) .Callback((ModelBindingContext b) => { Assert.Equal(modelName, b.ModelName); Assert.Same(valueProvider, b.ValueProvider); }) .Returns(Task.FromResult(false)) .Verifiable(); var model = new MyModel(); var actionContext = new ActionContext(Mock.Of(), new RouteData(), new ActionDescriptor()); var bindingContext = new ActionBindingContext(actionContext, metadataProvider, binder.Object, valueProvider, Mock.Of(), Mock.Of()); var bindingContextProvider = new Mock(); bindingContextProvider.Setup(b => b.GetActionBindingContextAsync(actionContext)) .Returns(Task.FromResult(bindingContext)); var viewData = new ViewDataDictionary(metadataProvider, new ModelStateDictionary()); var controller = new Controller { ActionContext = actionContext, BindingContextProvider = bindingContextProvider.Object, ViewData = viewData }; // Act var result = await controller.TryUpdateModelAsync(model, modelName); // Assert binder.Verify(); } [Fact] public async Task TryUpdateModel_UsesModelValueProviderIfSpecified() { var metadataProvider = new DataAnnotationsModelMetadataProvider(); var valueProvider = Mock.Of(); var binder = new Mock(); var modelName = "mymodel"; binder.Setup(b => b.BindModelAsync(It.IsAny())) .Callback((ModelBindingContext b) => { Assert.Equal(modelName, b.ModelName); Assert.Same(valueProvider, b.ValueProvider); }) .Returns(Task.FromResult(false)) .Verifiable(); var model = new MyModel(); var actionContext = new ActionContext(Mock.Of(), new RouteData(), new ActionDescriptor()); var bindingContext = new ActionBindingContext(actionContext, metadataProvider, binder.Object, Mock.Of(), Mock.Of(), Mock.Of()); var bindingContextProvider = new Mock(); bindingContextProvider.Setup(b => b.GetActionBindingContextAsync(actionContext)) .Returns(Task.FromResult(bindingContext)); var viewData = new ViewDataDictionary(metadataProvider, new ModelStateDictionary()); var controller = new Controller { ActionContext = actionContext, BindingContextProvider = bindingContextProvider.Object, ViewData = viewData }; // Act var result = await controller.TryUpdateModelAsync(model, modelName, valueProvider); // Assert binder.Verify(); } #endif [Fact] public void ControllerExposes_RequestServices() { // Arrange var controller = new Controller(); var serviceProvider = Mock.Of(); var httpContext = new Mock(); httpContext.Setup(c => c.RequestServices) .Returns(serviceProvider); controller.ActionContext = new ActionContext(httpContext.Object, Mock.Of(), new ActionDescriptor()); // Act var innerServiceProvider = controller.Resolver; // Assert Assert.Same(serviceProvider, innerServiceProvider); } [Fact] public void ControllerExposes_Request() { // Arrange var controller = new Controller(); var request = Mock.Of(); var httpContext = new Mock(); httpContext.Setup(c => c.Request) .Returns(request); controller.ActionContext = new ActionContext(httpContext.Object, Mock.Of(), new ActionDescriptor()); // Act var innerRequest = controller.Request; // Assert Assert.Same(request, innerRequest); } [Fact] public void ControllerExposes_Response() { // Arrange var controller = new Controller(); var response = Mock.Of(); var httpContext = new Mock(); httpContext.Setup(c => c.Response) .Returns(response); controller.ActionContext = new ActionContext(httpContext.Object, Mock.Of(), new ActionDescriptor()); // Act var innerResponse = controller.Response; // Assert Assert.Same(response, innerResponse); } [Fact] public void ControllerExposes_RouteData() { // Arrange var controller = new Controller(); var routeData = Mock.Of(); controller.ActionContext = new ActionContext(Mock.Of(), routeData, new ActionDescriptor()); // 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 ControllerExpose_ViewEngine() { // Arrange var controller = new Controller(); var viewEngine = Mock.Of(); var serviceProvider = new Mock(); serviceProvider .Setup(s => s.GetService(It.Is(t => t == typeof(ICompositeViewEngine)))) .Returns(viewEngine); var httpContext = new Mock(); httpContext .Setup(c => c.RequestServices) .Returns(serviceProvider.Object); controller.ActionContext = new ActionContext(httpContext.Object, Mock.Of(), new ActionDescriptor()); // Act var innerViewEngine = controller.ViewEngine; // Assert Assert.Same(viewEngine, innerViewEngine); } [Fact] public void ControllerView_UsesControllerViewEngine() { // Arrange var controller = new Controller(); var viewEngine = Mock.Of(); var serviceProvider = new Mock(); serviceProvider .Setup(s => s.GetService(It.Is(t => t == typeof(ICompositeViewEngine)))) .Returns(viewEngine); var httpContext = new Mock(); httpContext .Setup(c => c.RequestServices) .Returns(serviceProvider.Object); controller.ActionContext = new ActionContext(httpContext.Object, Mock.Of(), new ActionDescriptor()); // Act var unsused = controller.ViewEngine; var result = controller.View(); // Assert Assert.Same(viewEngine, result.ViewEngine); } private class MyModel { public string Foo { get; set; } } private class DisposableController : Controller { public bool DisposeCalled { get; private set; } protected override void Dispose(bool disposing) { DisposeCalled = true; } } } }