// 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 Microsoft.AspNetCore.Blazor.Components; using Microsoft.AspNetCore.Blazor.Rendering; using Microsoft.AspNetCore.Blazor.RenderTree; using Microsoft.AspNetCore.Blazor.Test.Helpers; using System; using System.Linq; using Xunit; namespace Microsoft.AspNetCore.Blazor.Test { public class RenderTreeBuilderTest { [Fact] public void RequiresNonnullRenderer() { Assert.Throws(() => { new RenderTreeBuilder(null); }); } [Fact] public void StartsEmpty() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); // Assert var frames = builder.GetFrames(); Assert.NotNull(frames.Array); Assert.Empty(frames); } [Fact] public void CanAddText() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); var nullString = (string)null; // Act builder.AddContent(0, "First item"); builder.AddContent(0, nullString); builder.AddContent(0, "Second item"); // Assert var frames = builder.GetFrames(); Assert.Collection(frames, frame => AssertFrame.Text(frame, "First item"), frame => AssertFrame.Text(frame, string.Empty), frame => AssertFrame.Text(frame, "Second item")); } [Fact] public void CanAddNonStringValueAsText() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); var nullObject = (object)null; // Act builder.AddContent(0, 1234); builder.AddContent(0, nullObject); // Assert var frames = builder.GetFrames(); Assert.Collection(frames, frame => AssertFrame.Text(frame, "1234"), frame => AssertFrame.Text(frame, string.Empty)); } [Fact] public void UnclosedElementsHaveNoSubtreeLength() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); // Act builder.OpenElement(0, "my element"); // Assert var frame = builder.GetFrames().Single(); AssertFrame.Element(frame, "my element", 0); } [Fact] public void ClosedEmptyElementsHaveSubtreeLengthOne() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); // Act builder.AddContent(0, "some frame so that the element isn't at position zero"); builder.OpenElement(0, "my element"); builder.CloseElement(); // Assert var frames = builder.GetFrames(); Assert.Equal(2, frames.Count); AssertFrame.Element(frames.Array[1], "my element", 1); } [Fact] public void ClosedElementsHaveCorrectSubtreeLength() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); // Act builder.OpenElement(0, "my element"); builder.AddContent(0, "child 1"); builder.AddContent(0, "child 2"); builder.CloseElement(); builder.AddContent(0, "unrelated item"); // Assert var frames = builder.GetFrames(); Assert.Equal(4, frames.Count); AssertFrame.Element(frames.Array[0], "my element", 3); } [Fact] public void CanNestElements() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); // Act builder.AddContent(0, "standalone text 1"); // 0: standalone text 1 builder.OpenElement(0, "root"); // 1: builder.AddContent(0, "root text 1"); // 2: root text 1 builder.AddContent(0, "root text 2"); // 3: root text 2 builder.OpenElement(0, "child"); // 4: builder.AddContent(0, "child text"); // 5: child text builder.OpenElement(0, "grandchild"); // 6: builder.AddContent(0, "grandchild text 1"); // 7: grandchild text 1 builder.AddContent(0, "grandchild text 2"); // 8: grandchild text 2 builder.CloseElement(); // builder.CloseElement(); // builder.AddContent(0, "root text 3"); // 9: root text 3 builder.OpenElement(0, "child 2"); // 10: builder.CloseElement(); // builder.CloseElement(); // builder.AddContent(0, "standalone text 2"); // 11: standalone text 2 // Assert Assert.Collection(builder.GetFrames(), frame => AssertFrame.Text(frame, "standalone text 1"), frame => AssertFrame.Element(frame, "root", 10), frame => AssertFrame.Text(frame, "root text 1"), frame => AssertFrame.Text(frame, "root text 2"), frame => AssertFrame.Element(frame, "child", 5), frame => AssertFrame.Text(frame, "child text"), frame => AssertFrame.Element(frame, "grandchild", 3), frame => AssertFrame.Text(frame, "grandchild text 1"), frame => AssertFrame.Text(frame, "grandchild text 2"), frame => AssertFrame.Text(frame, "root text 3"), frame => AssertFrame.Element(frame, "child 2", 1), frame => AssertFrame.Text(frame, "standalone text 2")); } [Fact] public void CanAddAttributes() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); UIEventHandler eventHandler = eventInfo => { }; // Act builder.OpenElement(0, "myelement"); // 0: builder.OpenElement(0, "child"); // 3: builder.AddContent(0, "some text"); // 5: some text builder.CloseElement(); // builder.CloseElement(); // // Assert Assert.Collection(builder.GetFrames(), frame => AssertFrame.Element(frame, "myelement", 6), frame => AssertFrame.Attribute(frame, "attribute1", "value 1"), frame => AssertFrame.Attribute(frame, "attribute2", "123"), frame => AssertFrame.Element(frame, "child", 3), frame => AssertFrame.Attribute(frame, "childevent", eventHandler), frame => AssertFrame.Text(frame, "some text")); } [Fact] public void CannotAddAttributeAtRoot() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); // Act/Assert Assert.Throws(() => { builder.AddAttribute(0, "name", "value"); }); } [Fact] public void CannotAddEventHandlerAttributeAtRoot() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); // Act/Assert Assert.Throws(() => { builder.AddAttribute(0, "name", eventInfo => { }); }); } [Fact] public void CannotAddAttributeToText() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); // Act/Assert Assert.Throws(() => { builder.OpenElement(0, "some element"); builder.AddContent(1, "hello"); builder.AddAttribute(2, "name", "value"); }); } [Fact] public void CannotAddEventHandlerAttributeToText() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); // Act/Assert Assert.Throws(() => { builder.OpenElement(0, "some element"); builder.AddContent(1, "hello"); builder.AddAttribute(2, "name", eventInfo => { }); }); } [Fact] public void CannotAddAttributeToRegion() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); // Act/Assert Assert.Throws(() => { builder.OpenRegion(0); builder.AddAttribute(1, "name", "value"); }); } [Fact] public void CanAddChildComponentsUsingGenericParam() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); // Act builder.OpenElement(10, "parent"); // 0: builder.OpenComponent(11); // 1: builder.CloseComponent(); // builder.OpenComponent(14); // 4: builder.CloseComponent(); // builder.CloseElement(); // // Assert Assert.Collection(builder.GetFrames(), frame => AssertFrame.Element(frame, "parent", 6), frame => AssertFrame.Component(frame), frame => AssertFrame.Attribute(frame, "child1attribute1", "A"), frame => AssertFrame.Attribute(frame, "child1attribute2", "B"), frame => AssertFrame.Component(frame), frame => AssertFrame.Attribute(frame, "child2attribute", "C")); } [Fact] public void CanAddChildComponentsUsingTypeArgument() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); // Act var componentType = typeof(TestComponent); builder.OpenElement(10, "parent"); // 0: builder.OpenComponent(11, componentType); // 1: builder.CloseComponent(); // builder.OpenComponent(14, componentType); // 4: builder.CloseComponent(); // builder.CloseElement(); // // Assert Assert.Collection(builder.GetFrames(), frame => AssertFrame.Element(frame, "parent", 6), frame => AssertFrame.Component(frame), frame => AssertFrame.Attribute(frame, "child1attribute1", "A"), frame => AssertFrame.Attribute(frame, "child1attribute2", "B"), frame => AssertFrame.Component(frame), frame => AssertFrame.Attribute(frame, "child2attribute", "C")); } [Fact] public void CanAddRegions() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); // Act builder.OpenElement(10, "parent"); // 0: builder.OpenRegion(11); // 1: [region builder.AddContent(3, "Hello"); // 2: Hello builder.OpenRegion(4); // 3: [region builder.OpenElement(3, "another"); // 4: builder.CloseElement(); // builder.CloseRegion(); // ] builder.AddContent(6, "Goodbye"); // 5: Goodbye builder.CloseRegion(); // ] builder.CloseElement(); // // Assert Assert.Collection(builder.GetFrames(), frame => AssertFrame.Element(frame, "parent", 6, 10), frame => AssertFrame.Region(frame, 5, 11), frame => AssertFrame.Text(frame, "Hello", 3), frame => AssertFrame.Region(frame, 2, 4), frame => AssertFrame.Element(frame, "another", 1, 3), frame => AssertFrame.Text(frame, "Goodbye", 6)); } [Fact] public void CanAddFragments() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); RenderFragment fragment = fragmentBuilder => { fragmentBuilder.AddContent(0, "Hello from the fragment"); fragmentBuilder.OpenElement(1, "Fragment element"); fragmentBuilder.AddContent(2, "Some text"); fragmentBuilder.CloseElement(); }; // Act builder.OpenElement(10, "parent"); builder.AddContent(11, fragment); builder.CloseElement(); // Assert Assert.Collection(builder.GetFrames(), frame => AssertFrame.Element(frame, "parent", 5, 10), frame => AssertFrame.Region(frame, 4, 11), frame => AssertFrame.Text(frame, "Hello from the fragment", 0), frame => AssertFrame.Element(frame, "Fragment element", 2, 1), frame => AssertFrame.Text(frame, "Some text", 2)); } [Fact] public void CanClear() { // Arrange var builder = new RenderTreeBuilder(new TestRenderer()); // Act builder.AddContent(0, "some text"); builder.OpenElement(1, "elem"); builder.AddContent(2, "more text"); builder.CloseElement(); builder.Clear(); // Assert Assert.Empty(builder.GetFrames()); } private class TestComponent : IComponent { public void Init(RenderHandle renderHandle) { } public void SetParameters(ParameterCollection parameters) => throw new NotImplementedException(); } private class TestRenderer : Renderer { public TestRenderer() : base(new TestServiceProvider()) { } protected override void UpdateDisplay(RenderBatch renderBatch) => throw new NotImplementedException(); } } }