// 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.Collections.Generic; using System.IO; using System.Linq; using System.Threading.Tasks; using Microsoft.AspNetCore.Html; using Microsoft.AspNetCore.Mvc.Rendering; using Microsoft.Extensions.WebEncoders.Testing; using Moq; using Xunit; namespace Microsoft.AspNetCore.Mvc.ViewFeatures.Internal { public class ViewBufferTest { [Fact] public void Append_AddsEncodingWrapper() { // Arrange var buffer = new ViewBuffer(new TestViewBufferScope(), "some-name", pageSize: 32); // Act buffer.Append("Hello world"); // Assert Assert.Equal(1, buffer.Count); var page = buffer[0]; Assert.Equal(1, page.Count); Assert.IsAssignableFrom(page.Buffer[0].Value); } [Fact] public void AppendHtml_AddsHtmlContentRazorValue() { // Arrange var buffer = new ViewBuffer(new TestViewBufferScope(), "some-name", pageSize: 32); var content = new HtmlString("hello-world"); // Act buffer.AppendHtml(content); // Assert Assert.Equal(1, buffer.Count); var page = buffer[0]; Assert.Equal(1, page.Count); Assert.Same(content, page.Buffer[0].Value); } [Fact] public void AppendHtml_AddsString() { // Arrange var buffer = new ViewBuffer(new TestViewBufferScope(), "some-name", pageSize: 32); var value = "Hello world"; // Act buffer.AppendHtml(value); // Assert Assert.Equal(1, buffer.Count); var page = buffer[0]; Assert.Equal(1, page.Count); Assert.Equal("Hello world", Assert.IsType(page.Buffer[0].Value)); } [Fact] public void Append_CreatesOnePage() { // Arrange var buffer = new ViewBuffer(new TestViewBufferScope(), "some-name", pageSize: 32); var expected = Enumerable.Range(0, 32).Select(i => i.ToString()); // Act foreach (var item in expected) { buffer.AppendHtml(item); } // Assert Assert.Equal(1, buffer.Count); Assert.Equal(expected, buffer[0].Buffer.Select(v => v.Value)); } [Fact] public void Append_CreatesTwoPages() { // Arrange var buffer = new ViewBuffer(new TestViewBufferScope(), "some-name", pageSize: 32); var expected = Enumerable.Range(0, 32).Select(i => i.ToString()); // Act foreach (var item in expected) { buffer.AppendHtml(item); } buffer.AppendHtml("Hello"); buffer.AppendHtml("world"); // Assert Assert.Equal(2, buffer.Count); Assert.Collection(new[] { buffer[0], buffer[1] }, page => Assert.Equal(expected, page.Buffer.Select(v => v.Value)), page => { var array = page.Buffer; Assert.Equal("Hello", array[0].Value); Assert.Equal("world", array[1].Value); }); } [Fact] public void Append_CreatesManyPages() { // Arrange var buffer = new ViewBuffer(new TestViewBufferScope(), "some-name", pageSize: 32); var expected0 = Enumerable.Range(0, 32).Select(i => i.ToString()); var expected1 = Enumerable.Range(32, 32).Select(i => i.ToString()); // Act foreach (var item in expected0) { buffer.AppendHtml(item); } foreach (var item in expected1) { buffer.AppendHtml(item); } buffer.AppendHtml("Hello"); buffer.AppendHtml("world"); // Assert Assert.Equal(3, buffer.Count); Assert.Collection(new[] { buffer[0], buffer[1], buffer[2] }, page => Assert.Equal(expected0, page.Buffer.Select(v => v.Value)), page => Assert.Equal(expected1, page.Buffer.Select(v => v.Value)), page => { var array = page.Buffer; Assert.Equal("Hello", array[0].Value); Assert.Equal("world", array[1].Value); }); } [Theory] [InlineData(1)] // Create one page before clear [InlineData(35)] // Create two pages before clear [InlineData(65)] // Create many pages before clear public void Clear_ResetsBackingBufferAndIndex(int valuesToWrite) { // Arrange var buffer = new ViewBuffer(new TestViewBufferScope(), "some-name", pageSize: 32); // Act for (var i = 0; i < valuesToWrite; i++) { buffer.AppendHtml("Hello"); } buffer.Clear(); buffer.AppendHtml("world"); // Assert Assert.Equal(1, buffer.Count); var page = buffer[0]; Assert.Equal(1, page.Count); Assert.Equal("world", page.Buffer[0].Value); } [Fact] public void WriteTo_WritesRazorValues_ToTextWriter() { // Arrange var buffer = new ViewBuffer(new TestViewBufferScope(), "some-name", pageSize: 32); var writer = new StringWriter(); // Act buffer.Append("Hello"); buffer.AppendHtml(new HtmlString(" world")); buffer.AppendHtml(" 123"); buffer.WriteTo(writer, new HtmlTestEncoder()); // Assert Assert.Equal("HtmlEncode[[Hello]] world 123", writer.ToString()); } [Theory] [InlineData(9)] [InlineData(10)] [InlineData(11)] [InlineData(23)] public void WriteTo_WritesRazorValuesFromAllBuffers(int valuesToWrite) { // Arrange var buffer = new ViewBuffer(new TestViewBufferScope(), "some-name", pageSize: 4); var writer = new StringWriter(); var expected = string.Join("", Enumerable.Range(0, valuesToWrite).Select(_ => "abc")); // Act for (var i = 0; i < valuesToWrite; i++) { buffer.AppendHtml("abc"); } buffer.WriteTo(writer, new HtmlTestEncoder()); // Assert Assert.Equal(expected, writer.ToString()); } [Fact] public async Task WriteToAsync_WritesRazorValues_ToTextWriter() { // Arrange var buffer = new ViewBuffer(new TestViewBufferScope(), "some-name", pageSize: 128); var writer = new StringWriter(); // Act buffer.Append("Hello"); buffer.AppendHtml(new HtmlString(" world")); buffer.AppendHtml(" 123"); await buffer.WriteToAsync(writer, new HtmlTestEncoder()); // Assert Assert.Equal("HtmlEncode[[Hello]] world 123", writer.ToString()); } [Theory] [InlineData(9)] [InlineData(10)] [InlineData(11)] [InlineData(23)] public async Task WriteToAsync_WritesRazorValuesFromAllBuffers(int valuesToWrite) { // Arrange var buffer = new ViewBuffer(new TestViewBufferScope(), "some-name", pageSize: 4); var writer = new StringWriter(); var expected = string.Join("", Enumerable.Range(0, valuesToWrite).Select(_ => "abc")); // Act for (var i = 0; i < valuesToWrite; i++) { buffer.AppendHtml("abc"); } await buffer.WriteToAsync(writer, new HtmlTestEncoder()); // Assert Assert.Equal(expected, writer.ToString()); } [Fact] public void CopyTo_Flattens() { // Arrange var buffer = new ViewBuffer(new TestViewBufferScope(), "some-name", pageSize: 4); var nestedItems = new List(); var nested = new HtmlContentBuilder(nestedItems); nested.AppendHtml("Hello"); buffer.AppendHtml(nested); var destinationItems = new List(); var destination = new HtmlContentBuilder(destinationItems); // Act buffer.CopyTo(destination); // Assert Assert.Same(nested, buffer[0].Buffer[0].Value); Assert.Equal("Hello", Assert.IsType(nestedItems[0]).Value); Assert.Equal("Hello", Assert.IsType(destinationItems[0]).Value); } [Fact] public void MoveTo_FlattensAndClears() { // Arrange var buffer = new ViewBuffer(new TestViewBufferScope(), "some-name", pageSize: 4); var nestedItems = new List(); var nested = new HtmlContentBuilder(nestedItems); nested.AppendHtml("Hello"); buffer.AppendHtml(nested); var destinationItems = new List(); var destination = new HtmlContentBuilder(destinationItems); // Act buffer.MoveTo(destination); // Assert Assert.Empty(nestedItems); Assert.Equal(0, buffer.Count); Assert.Equal("Hello", Assert.IsType(destinationItems[0]).Value); } [Fact] public void MoveTo_ViewBuffer_TakesPage_IfOriginalIsEmpty() { // Arrange var scope = new TestViewBufferScope(); var original = new ViewBuffer(scope, "original", pageSize: 4); var other = new ViewBuffer(scope, "other", pageSize: 4); other.AppendHtml("Hi"); var page = other[0]; // Act other.MoveTo(original); // Assert Assert.Equal(0, other.Count); // Page was taken Assert.Equal(1, original.Count); Assert.Same(page, original[0]); } [Fact] public void MoveTo_ViewBuffer_TakesPage_IfCurrentPageInOriginalIsFull() { // Arrange var scope = new TestViewBufferScope(); var original = new ViewBuffer(scope, "original", pageSize: 4); var other = new ViewBuffer(scope, "other", pageSize: 4); for (var i = 0; i < 4; i++) { original.AppendHtml($"original-{i}"); } other.AppendHtml("Hi"); var page = other[0]; // Act other.MoveTo(original); // Assert Assert.Equal(0, other.Count); // Page was taken Assert.Equal(2, original.Count); Assert.Same(page, original[1]); } [Fact] public void MoveTo_ViewBuffer_TakesPage_IfCurrentPageDoesNotHaveCapacity() { // Arrange var scope = new TestViewBufferScope(); var original = new ViewBuffer(scope, "original", pageSize: 4); var other = new ViewBuffer(scope, "other", pageSize: 4); for (var i = 0; i < 3; i++) { original.AppendHtml($"original-{i}"); } // With two items, we'd try to copy the items, but there's no room in the current page. // So we just take over the page. for (var i = 0; i < 2; i++) { other.AppendHtml($"other-{i}"); } var page = other[0]; // Act other.MoveTo(original); // Assert Assert.Equal(0, other.Count); // Page was taken Assert.Equal(2, original.Count); Assert.Same(page, original[1]); } [Fact] public void MoveTo_ViewBuffer_CopiesItems_IfCurrentPageHasRoom() { // Arrange var scope = new TestViewBufferScope(); var original = new ViewBuffer(scope, "original", pageSize: 4); var other = new ViewBuffer(scope, "other", pageSize: 4); for (var i = 0; i < 2; i++) { original.AppendHtml($"original-{i}"); } // With two items, this is half full so we try to copy the items. for (var i = 0; i < 2; i++) { other.AppendHtml($"other-{i}"); } var page = other[0]; // Act other.MoveTo(original); // Assert Assert.Equal(0, other.Count); // Other is cleared Assert.Contains(page.Buffer, scope.ReturnedBuffers); // Buffer was returned Assert.Equal(1, original.Count); Assert.Collection( original[0].Buffer, item => Assert.Equal("original-0", item.Value), item => Assert.Equal("original-1", item.Value), item => Assert.Equal("other-0", item.Value), item => Assert.Equal("other-1", item.Value)); } [Fact] public void MoveTo_ViewBuffer_CanAddToTakenPage() { // Arrange var scope = new TestViewBufferScope(); var original = new ViewBuffer(scope, "original", pageSize: 4); var other = new ViewBuffer(scope, "other", pageSize: 4); for (var i = 0; i < 3; i++) { original.AppendHtml($"original-{i}"); } // More than half full, so we take the page for (var i = 0; i < 3; i++) { other.AppendHtml($"other-{i}"); } var page = other[0]; other.MoveTo(original); // Act original.AppendHtml("after-merge"); // Assert Assert.Equal(0, other.Count); // Other is cleared Assert.Equal(2, original.Count); Assert.Collection( original[0].Buffer, item => Assert.Equal("original-0", item.Value), item => Assert.Equal("original-1", item.Value), item => Assert.Equal("original-2", item.Value), item => Assert.Null(item.Value)); Assert.Collection( original[1].Buffer, item => Assert.Equal("other-0", item.Value), item => Assert.Equal("other-1", item.Value), item => Assert.Equal("other-2", item.Value), item => Assert.Equal("after-merge", item.Value)); } [Fact] public void MoveTo_ViewBuffer_MultiplePages() { // Arrange var scope = new TestViewBufferScope(); var original = new ViewBuffer(scope, "original", pageSize: 4); var other = new ViewBuffer(scope, "other", pageSize: 4); for (var i = 0; i < 2; i++) { original.AppendHtml($"original-{i}"); } for (var i = 0; i < 9; i++) { other.AppendHtml($"other-{i}"); } var pages = new List(); for (var i = 0; i < other.Count; i++) { pages.Add(other[i]); } // Act other.MoveTo(original); // Assert Assert.Equal(0, other.Count); // Other is cleared Assert.Equal(4, original.Count); Assert.Collection( original[0].Buffer, item => Assert.Equal("original-0", item.Value), item => Assert.Equal("original-1", item.Value), item => Assert.Null(item.Value), item => Assert.Null(item.Value)); Assert.Collection( original[1].Buffer, item => Assert.Equal("other-0", item.Value), item => Assert.Equal("other-1", item.Value), item => Assert.Equal("other-2", item.Value), item => Assert.Equal("other-3", item.Value)); Assert.Collection( original[2].Buffer, item => Assert.Equal("other-4", item.Value), item => Assert.Equal("other-5", item.Value), item => Assert.Equal("other-6", item.Value), item => Assert.Equal("other-7", item.Value)); Assert.Collection( original[3].Buffer, item => Assert.Equal("other-8", item.Value), item => Assert.Null(item.Value), item => Assert.Null(item.Value), item => Assert.Null(item.Value)); } } }