aspnetcore/test/Microsoft.AspNet.Mvc.ViewFeatures.Test/Rendering/HtmlHelperPartialExtensionsTest.cs

// 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.Linq;
using System.Threading.Tasks;
using Microsoft.AspNet.Html.Abstractions;
using Microsoft.AspNet.Mvc.ModelBinding;
using Microsoft.AspNet.Mvc.TestCommon;
using Microsoft.AspNet.Mvc.ViewEngines;
using Microsoft.AspNet.Mvc.ViewFeatures;
using Moq;
using Xunit;

namespace Microsoft.AspNet.Mvc.Rendering
{
    public class HtmlHelperPartialExtensionsTest
    {
        public static TheoryData<Func<IHtmlHelper, IHtmlContent>> PartialExtensionMethods
        {
            get
            {
                var vdd = new ViewDataDictionary(new EmptyModelMetadataProvider());
                return new TheoryData<Func<IHtmlHelper, IHtmlContent>>
                {
                    helper => helper.Partial("test"),
                    helper => helper.Partial("test", new object()),
                    helper => helper.Partial("test", vdd),
                    helper => helper.Partial("test", new object(), vdd)
                };
            }
        }

        [Theory]
        [MemberData(nameof(PartialExtensionMethods))]
        public void PartialMethods_DoesNotWrapThrownException(Func<IHtmlHelper, IHtmlContent> partialMethod)
        {
            // Arrange
            var expected = new InvalidOperationException();
            var helper = new Mock<IHtmlHelper>();
            helper.Setup(h => h.PartialAsync("test", It.IsAny<object>(), It.IsAny<ViewDataDictionary>()))
                  .Callback(() =>
                  {
                      // Workaround for compilation issue with Moq.
                      helper.ToString();
                      throw expected;
                  });
            helper.SetupGet(h => h.ViewData)
                  .Returns(new ViewDataDictionary(new EmptyModelMetadataProvider()));

            // Act and Assert
            var actual = Assert.Throws<InvalidOperationException>(() => partialMethod(helper.Object));
            Assert.Same(expected, actual);
        }

        [Fact]
        public void Partial_InvokesPartialAsyncWithCurrentModel()
        {
            // Arrange
            var expected = new HtmlString("value");
            var model = new object();
            var viewData = new ViewDataDictionary(new EmptyModelMetadataProvider())
            {
                Model = model
            };
            var helper = new Mock<IHtmlHelper>(MockBehavior.Strict);
            helper.Setup(h => h.PartialAsync("test", model, null))
                  .Returns(Task.FromResult((IHtmlContent)expected))
                  .Verifiable();
            helper.SetupGet(h => h.ViewData)
                  .Returns(viewData);

            // Act
            var actual = helper.Object.Partial("test");

            // Assert
            Assert.Same(expected, actual);
            helper.Verify();
        }

        [Fact]
        public void PartialWithModel_InvokesPartialAsyncWithPassedInModel()
        {
            // Arrange
            var expected = new HtmlString("value");
            var model = new object();
            var helper = new Mock<IHtmlHelper>(MockBehavior.Strict);
            helper.Setup(h => h.PartialAsync("test", model, null))
                  .Returns(Task.FromResult((IHtmlContent)expected))
                  .Verifiable();

            // Act
            var actual = helper.Object.Partial("test", model);

            // Assert
            Assert.Same(expected, actual);
            helper.Verify();
        }

        [Fact]
        public void PartialWithViewData_InvokesPartialAsyncWithPassedInViewData()
        {
            // Arrange
            var expected = new HtmlString("value");
            var model = new object();
            var passedInViewData = new ViewDataDictionary(new EmptyModelMetadataProvider());
            var viewData = new ViewDataDictionary(new EmptyModelMetadataProvider())
            {
                Model = model
            };
            var helper = new Mock<IHtmlHelper>(MockBehavior.Strict);
            helper.Setup(h => h.PartialAsync("test", model, passedInViewData))
                  .Returns(Task.FromResult((IHtmlContent)expected))
                  .Verifiable();
            helper.SetupGet(h => h.ViewData)
                  .Returns(viewData);

            // Act
            var actual = helper.Object.Partial("test", passedInViewData);

            // Assert
            Assert.Same(expected, actual);
            helper.Verify();
        }

        [Fact]
        public void PartialWithViewDataAndModel_InvokesPartialAsyncWithPassedInViewDataAndModel()
        {
            // Arrange
            var expected = new HtmlString("value");
            var passedInModel = new object();
            var passedInViewData = new ViewDataDictionary(new EmptyModelMetadataProvider());
            var helper = new Mock<IHtmlHelper>(MockBehavior.Strict);
            helper.Setup(h => h.PartialAsync("test", passedInModel, passedInViewData))
                  .Returns(Task.FromResult((IHtmlContent)expected))
                  .Verifiable();

            // Act
            var actual = helper.Object.Partial("test", passedInModel, passedInViewData);

            // Assert
            Assert.Same(expected, actual);
            helper.Verify();
        }

        [Fact]
        public void Partial_InvokesAndRendersPartialAsyncOnHtmlHelperOfT()
        {
            // Arrange
            var model = new TestModel();
            var helper = DefaultTemplatesUtilities.GetHtmlHelper(model);
            var expected = DefaultTemplatesUtilities.FormatOutput(helper, model);

            // Act
            var actual = helper.Partial("some-partial");

            // Assert
            Assert.Equal(expected, HtmlContentUtilities.HtmlContentToString(actual));
        }

        [Fact]
        public void PartialWithModel_InvokesAndRendersPartialAsyncOnHtmlHelperOfT()
        {
            // Arrange
            var model = new TestModel();
            var helper = DefaultTemplatesUtilities.GetHtmlHelper();
            var expected = DefaultTemplatesUtilities.FormatOutput(helper, model);

            // Act
            var actual = helper.Partial("some-partial", model);

            // Assert
            Assert.Equal(expected, HtmlContentUtilities.HtmlContentToString(actual));
        }

        [Fact]
        public void PartialWithViewData_InvokesAndRendersPartialAsyncOnHtmlHelperOfT()
        {
            // Arrange
            var model = new TestModel();
            var helper = DefaultTemplatesUtilities.GetHtmlHelper(model);
            var viewData = new ViewDataDictionary(helper.MetadataProvider);
            var expected = DefaultTemplatesUtilities.FormatOutput(helper, model);

            // Act
            var actual = helper.Partial("some-partial", viewData);

            // Assert
            Assert.Equal(expected, HtmlContentUtilities.HtmlContentToString(actual));
        }

        [Fact]
        public async Task PartialAsync_Throws_IfViewNotFound_MessageUsesGetViewLocations()
        {
            // Arrange
            var expected = "The partial view 'test-view' was not found. The following locations were searched:" +
                Environment.NewLine +
                "location1" + Environment.NewLine +
                "location2";

            var model = new TestModel();
            var viewEngine = new Mock<ICompositeViewEngine>(MockBehavior.Strict);
            viewEngine
                .Setup(v => v.GetView(/*executingFilePath*/ null, It.IsAny<string>(), /*isPartial*/ true))
                .Returns(ViewEngineResult.NotFound("test-view", new[] { "location1", "location2" }))
                .Verifiable();
            viewEngine
                .Setup(v => v.FindView(It.IsAny<ActionContext>(), It.IsAny<string>(), /*isPartial*/ true))
                .Returns(ViewEngineResult.NotFound("test-view", Enumerable.Empty<string>()))
                .Verifiable();

            var helper = DefaultTemplatesUtilities.GetHtmlHelper(model, viewEngine.Object);
            var viewData = helper.ViewData;

            // Act & Assert
            var exception = await Assert.ThrowsAsync<InvalidOperationException>(
                () => helper.PartialAsync("test-view", model, viewData));
            Assert.Equal(expected, exception.Message);
        }

        [Fact]
        public async Task PartialAsync_Throws_IfViewNotFound_MessageUsesFindViewLocations()
        {
            // Arrange
            var expected = "The partial view 'test-view' was not found. The following locations were searched:" +
                Environment.NewLine +
                "location1" + Environment.NewLine +
                "location2";

            var model = new TestModel();
            var viewEngine = new Mock<ICompositeViewEngine>(MockBehavior.Strict);
            viewEngine
                .Setup(v => v.GetView(/*executingFilePath*/ null, It.IsAny<string>(), /*isPartial*/ true))
                .Returns(ViewEngineResult.NotFound("test-view", Enumerable.Empty<string>()))
                .Verifiable();
            viewEngine
                .Setup(v => v.FindView(It.IsAny<ActionContext>(), It.IsAny<string>(), /*isPartial*/ true))
                .Returns(ViewEngineResult.NotFound("test-view", new[] { "location1", "location2" }))
                .Verifiable();

            var helper = DefaultTemplatesUtilities.GetHtmlHelper(model, viewEngine.Object);
            var viewData = helper.ViewData;

            // Act & Assert
            var exception = await Assert.ThrowsAsync<InvalidOperationException>(
                () => helper.PartialAsync("test-view", model, viewData));
            Assert.Equal(expected, exception.Message);
        }

        [Fact]
        public async Task PartialAsync_Throws_IfViewNotFound_MessageUsesAllLocations()
        {
            // Arrange
            var expected = "The partial view 'test-view' was not found. The following locations were searched:" +
                Environment.NewLine +
                "location1" + Environment.NewLine +
                "location2" + Environment.NewLine +
                "location3" + Environment.NewLine +
                "location4";

            var model = new TestModel();
            var viewEngine = new Mock<ICompositeViewEngine>(MockBehavior.Strict);
            viewEngine
                .Setup(v => v.GetView(/*executingFilePath*/ null, It.IsAny<string>(), /*isPartial*/ true))
                .Returns(ViewEngineResult.NotFound("test-view", new[] { "location1", "location2" }))
                .Verifiable();
            viewEngine
                .Setup(v => v.FindView(It.IsAny<ActionContext>(), It.IsAny<string>(), /*isPartial*/ true))
                .Returns(ViewEngineResult.NotFound("test-view", new[] { "location3", "location4" }))
                .Verifiable();

            var helper = DefaultTemplatesUtilities.GetHtmlHelper(model, viewEngine.Object);
            var viewData = helper.ViewData;

            // Act & Assert
            var exception = await Assert.ThrowsAsync<InvalidOperationException>(
                () => helper.PartialAsync("test-view", model, viewData));
            Assert.Equal(expected, exception.Message);
        }

        [Fact]
        public async Task RenderPartialAsync_Throws_IfViewNotFound_MessageUsesGetViewLocations()
        {
            // Arrange
            var expected = "The partial view 'test-view' was not found. The following locations were searched:" +
                Environment.NewLine +
                "location1" + Environment.NewLine +
                "location2";

            var model = new TestModel();
            var viewEngine = new Mock<ICompositeViewEngine>(MockBehavior.Strict);
            viewEngine
                .Setup(v => v.GetView(/*executingFilePath*/ null, It.IsAny<string>(), /*isPartial*/ true))
                .Returns(ViewEngineResult.NotFound("test-view", new[] { "location1", "location2" }))
                .Verifiable();
            viewEngine
                .Setup(v => v.FindView(It.IsAny<ActionContext>(), It.IsAny<string>(), /*isPartial*/ true))
                .Returns(ViewEngineResult.NotFound("test-view", Enumerable.Empty<string>()))
                .Verifiable();

            var helper = DefaultTemplatesUtilities.GetHtmlHelper(model, viewEngine.Object);
            var viewData = helper.ViewData;

            // Act & Assert
            var exception = await Assert.ThrowsAsync<InvalidOperationException>(
                () => helper.RenderPartialAsync("test-view", model, viewData));
            Assert.Equal(expected, exception.Message);
        }

        [Fact]
        public async Task RenderPartialAsync_Throws_IfViewNotFound_MessageUsesFindViewLocations()
        {
            // Arrange
            var expected = "The partial view 'test-view' was not found. The following locations were searched:" +
                Environment.NewLine +
                "location1" + Environment.NewLine +
                "location2";

            var model = new TestModel();
            var viewEngine = new Mock<ICompositeViewEngine>(MockBehavior.Strict);
            viewEngine
                .Setup(v => v.GetView(/*executingFilePath*/ null, It.IsAny<string>(), /*isPartial*/ true))
                .Returns(ViewEngineResult.NotFound("test-view", Enumerable.Empty<string>()))
                .Verifiable();
            viewEngine
                .Setup(v => v.FindView(It.IsAny<ActionContext>(), It.IsAny<string>(), /*isPartial*/ true))
                .Returns(ViewEngineResult.NotFound("test-view", new[] { "location1", "location2" }))
                .Verifiable();

            var helper = DefaultTemplatesUtilities.GetHtmlHelper(model, viewEngine.Object);
            var viewData = helper.ViewData;

            // Act & Assert
            var exception = await Assert.ThrowsAsync<InvalidOperationException>(
                () => helper.RenderPartialAsync("test-view", model, viewData));
            Assert.Equal(expected, exception.Message);
        }

        [Fact]
        public async Task RenderPartialAsync_Throws_IfViewNotFound_MessageUsesAllLocations()
        {
            // Arrange
            var expected = "The partial view 'test-view' was not found. The following locations were searched:" +
                Environment.NewLine +
                "location1" + Environment.NewLine +
                "location2" + Environment.NewLine +
                "location3" + Environment.NewLine +
                "location4";

            var model = new TestModel();
            var viewEngine = new Mock<ICompositeViewEngine>(MockBehavior.Strict);
            viewEngine
                .Setup(v => v.GetView(/*executingFilePath*/ null, It.IsAny<string>(), /*isPartial*/ true))
                .Returns(ViewEngineResult.NotFound("test-view", new[] { "location1", "location2" }))
                .Verifiable();
            viewEngine
                .Setup(v => v.FindView(It.IsAny<ActionContext>(), It.IsAny<string>(), /*isPartial*/ true))
                .Returns(ViewEngineResult.NotFound("test-view", new[] { "location3", "location4" }))
                .Verifiable();

            var helper = DefaultTemplatesUtilities.GetHtmlHelper(model, viewEngine.Object);
            var viewData = helper.ViewData;

            // Act & Assert
            var exception = await Assert.ThrowsAsync<InvalidOperationException>(
                () => helper.RenderPartialAsync("test-view", model, viewData));
            Assert.Equal(expected, exception.Message);
        }

        private sealed class TestModel
        {
            public override string ToString()
            {
                return "test-model-content";
            }
        }
    }
}
#endif