Avalonia/tests/Avalonia.Base.UnitTests/Layout/LayoutableTests.cs

using System;
using System.Collections.Generic;
using Avalonia.Controls;
using Avalonia.Layout;
using Avalonia.UnitTests;
using Moq;
using Xunit;

namespace Avalonia.Base.UnitTests.Layout
{
    public class LayoutableTests
    {
        [Theory]
        [InlineData(0, 0, 0, 0, 100, 100)]
        [InlineData(10, 0, 0, 0, 90, 100)]
        [InlineData(10, 0, 5, 0, 85, 100)]
        [InlineData(0, 10, 0, 0, 100, 90)]
        [InlineData(0, 10, 0, 5, 100, 85)]
        [InlineData(4, 4, 6, 7, 90, 89)]
        public void Margin_Is_Applied_To_MeasureOverride_Size(
            double l,
            double t,
            double r,
            double b,
            double expectedWidth,
            double expectedHeight)
        {
            var target = new TestLayoutable
            {
                Margin = new Thickness(l, t, r, b),
            };

            target.Measure(new Size(100, 100));

            Assert.Equal(new Size(expectedWidth, expectedHeight), target.MeasureSize);
        }

        [Theory]
        [InlineData(HorizontalAlignment.Stretch, 100)]
        [InlineData(HorizontalAlignment.Left, 10)]
        [InlineData(HorizontalAlignment.Center, 10)]
        [InlineData(HorizontalAlignment.Right, 10)]
        public void HorizontalAlignment_Is_Applied_To_ArrangeOverride_Size(
            HorizontalAlignment h,
            double expectedWidth)
        {
            var target = new TestLayoutable
            {
                HorizontalAlignment = h,
            };

            target.Measure(Size.Infinity);
            target.Arrange(new Rect(0, 0, 100, 100));

            Assert.Equal(new Size(expectedWidth, 100), target.ArrangeSize);
        }

        [Theory]
        [InlineData(VerticalAlignment.Stretch, 100)]
        [InlineData(VerticalAlignment.Top, 10)]
        [InlineData(VerticalAlignment.Center, 10)]
        [InlineData(VerticalAlignment.Bottom, 10)]
        public void VerticalAlignment_Is_Applied_To_ArrangeOverride_Size(
            VerticalAlignment v,
            double expectedHeight)
        {
            var target = new TestLayoutable
            {
                VerticalAlignment = v,
            };

            target.Measure(Size.Infinity);
            target.Arrange(new Rect(0, 0, 100, 100));

            Assert.Equal(new Size(100, expectedHeight), target.ArrangeSize);
        }

        [Theory]
        [InlineData(0, 0, 0, 0, 100, 100)]
        [InlineData(10, 0, 0, 0, 90, 100)]
        [InlineData(10, 0, 5, 0, 85, 100)]
        [InlineData(0, 10, 0, 0, 100, 90)]
        [InlineData(0, 10, 0, 5, 100, 85)]
        [InlineData(4, 4, 6, 7, 90, 89)]
        public void Margin_Is_Applied_To_ArrangeOverride_Size(
            double l,
            double t,
            double r,
            double b,
            double expectedWidth,
            double expectedHeight)
        {
            var target = new TestLayoutable
            {
                Margin = new Thickness(l, t, r, b),
            };

            target.Measure(Size.Infinity);
            target.Arrange(new Rect(0, 0, 100, 100));

            Assert.Equal(new Size(expectedWidth, expectedHeight), target.ArrangeSize);
        }

        [Fact]
        public void Only_Calls_LayoutManager_InvalidateMeasure_Once()
        {
            var target = new Mock<ILayoutManager>();
            var control = new Decorator();
            var root = new LayoutTestRoot
            {
                Child = control,
                LayoutManager = target.Object,
            };

            root.Measure(Size.Infinity);
            root.Arrange(new Rect(root.DesiredSize));
            target.Invocations.Clear();

            control.InvalidateMeasure();
            control.InvalidateMeasure();

            target.Verify(x => x.InvalidateMeasure(control), Times.Once());
        }

        [Fact]
        public void Only_Calls_LayoutManager_InvalidateArrange_Once()
        {
            var target = new Mock<ILayoutManager>();
            var control = new Decorator();
            var root = new LayoutTestRoot
            {
                Child = control,
                LayoutManager = target.Object,
            };

            root.Measure(Size.Infinity);
            root.Arrange(new Rect(root.DesiredSize));
            target.Invocations.Clear();

            control.InvalidateArrange();
            control.InvalidateArrange();

            target.Verify(x => x.InvalidateArrange(control), Times.Once());
        }

        [Fact]
        public void Attaching_Control_To_Tree_Invalidates_Parent_Measure()
        {
            var target = new Mock<ILayoutManager>();
            var control = new Decorator();
            var root = new LayoutTestRoot
            {
                Child = control,
                LayoutManager = target.Object,
            };

            root.Measure(Size.Infinity);
            root.Arrange(new Rect(root.DesiredSize));
            Assert.True(control.IsMeasureValid);

            root.Child = null;
            root.Measure(Size.Infinity);
            root.Arrange(new Rect(root.DesiredSize));

            Assert.False(control.IsMeasureValid);
            Assert.True(root.IsMeasureValid);

            target.Invocations.Clear();

            root.Child = control;

            Assert.False(root.IsMeasureValid);
            Assert.False(control.IsMeasureValid);
            target.Verify(x => x.InvalidateMeasure(root), Times.Once());
        }

        [Fact]
        public void LayoutUpdated_Is_Called_At_End_Of_Layout_Pass()
        {
            Border border1;
            Border border2;
            var root = new TestRoot
            {
                Child = border1 = new Border
                {
                    Child = border2 = new Border(),
                },
            };
            var raised = 0;

            void ValidateBounds(object? sender, EventArgs e)
            {
                Assert.Equal(new Rect(0, 0, 100, 100), border1.Bounds);
                Assert.Equal(new Rect(0, 0, 100, 100), border2.Bounds);
                ++raised;
            }

            root.LayoutUpdated += ValidateBounds;
            border1.LayoutUpdated += ValidateBounds;
            border2.LayoutUpdated += ValidateBounds;

            root.Measure(new Size(100, 100));
            root.Arrange(new Rect(0, 0, 100, 100));
            
            root.LayoutManager.ExecuteLayoutPass();

            Assert.Equal(3, raised);
            Assert.Equal(new Rect(0, 0, 100, 100), border1.Bounds);
            Assert.Equal(new Rect(0, 0, 100, 100), border2.Bounds);
        }

        [Fact]
        public void LayoutUpdated_Subscribes_To_LayoutManager()
        {
            Border target;
            var layoutManager = new Mock<ILayoutManager>();
            layoutManager.SetupAdd(m => m.LayoutUpdated += (sender, args) => { });

            var root = new TestRoot
            {
                Child = new Border
                {
                    Child = target = new Border(),
                },
                LayoutManager = layoutManager.Object,
            };

            void Handler(object? sender, EventArgs e) {}

            layoutManager.Invocations.Clear();
            target.LayoutUpdated += Handler;

            layoutManager.VerifyAdd(
                x => x.LayoutUpdated += It.IsAny<EventHandler>(),
                Times.Once);

            layoutManager.Invocations.Clear();
            target.LayoutUpdated -= Handler;

            layoutManager.VerifyRemove(
                x => x.LayoutUpdated -= It.IsAny<EventHandler>(),
                Times.Once);
        }

        [Fact]
        public void LayoutManager_LayoutUpdated_Is_Subscribed_When_Attached_To_Tree()
        {
            Border border1;
            var layoutManager = new Mock<ILayoutManager>();
            layoutManager.SetupAdd(m => m.LayoutUpdated += (sender, args) => { });

            var root = new TestRoot
            {
                Child = border1 = new Border(),
                LayoutManager = layoutManager.Object,
            };

            var border2 = new Border();
            border2.LayoutUpdated += (s, e) => { };

            layoutManager.Invocations.Clear();
            border1.Child = border2;

            layoutManager.VerifyAdd(
                x => x.LayoutUpdated += It.IsAny<EventHandler>(),
                Times.Once);
        }

        [Fact]
        public void LayoutManager_LayoutUpdated_Is_Unsubscribed_When_Detached_From_Tree()
        {
            Border border1;
            var layoutManager = new Mock<ILayoutManager>();
            layoutManager.SetupAdd(m => m.LayoutUpdated += (sender, args) => { });

            var root = new TestRoot
            {
                Child = border1 = new Border(),
                LayoutManager = layoutManager.Object,
            };

            var border2 = new Border();
            border2.LayoutUpdated += (s, e) => { };
            border1.Child = border2;

            layoutManager.Invocations.Clear();
            border1.Child = null;

            layoutManager.VerifyRemove(
                x => x.LayoutUpdated -= It.IsAny<EventHandler>(),
                Times.Once);
        }

        [Fact]
        public void LayoutManager_LayoutUpdated_Should_Not_Be_Subscribed_Twice_In_AttachedToVisualTree()
        {
            Border border1;
            var layoutManager = new Mock<ILayoutManager>();
            layoutManager.SetupAdd(m => m.LayoutUpdated += (_, _) => { });

            _ = new TestRoot
            {
                Child = border1 = new Border(),
                LayoutManager = layoutManager.Object,
            };

            var border2 = new Border();
            border2.AttachedToVisualTree += (_, _) => border2.LayoutUpdated += (_, _) => { };

            layoutManager.Invocations.Clear();
            border1.Child = border2;

            layoutManager.VerifyAdd(
                x => x.LayoutUpdated += It.IsAny<EventHandler>(),
                Times.Once);
        }

        [Fact]
        public void Making_Control_Invisible_Should_Invalidate_Parent_Measure()
        {
            Border child;
            var target = new StackPanel
            {
                Children =
                {
                    (child = new Border
                    {
                        Width = 100,
                    }),
                }
            };

            target.Measure(new Size(double.PositiveInfinity, double.PositiveInfinity));
            target.Arrange(new Rect(target.DesiredSize));

            Assert.True(target.IsMeasureValid);
            Assert.True(target.IsArrangeValid);
            Assert.True(child.IsMeasureValid);
            Assert.True(child.IsArrangeValid);

            child.IsVisible = false;

            Assert.False(target.IsMeasureValid);
            Assert.False(target.IsArrangeValid);
            Assert.True(child.IsMeasureValid);
            Assert.True(child.IsArrangeValid);
        }

        [Fact]
        public void Making_Control_Visible_Should_Invalidate_Own_And_Parent_Measure()
        {
            Border child;
            var target = new StackPanel
            {
                Children =
                {
                    (child = new Border
                    {
                        Width = 100,
                        IsVisible = false,
                    }),
                }
            };

            target.Measure(new Size(double.PositiveInfinity, double.PositiveInfinity));
            target.Arrange(new Rect(target.DesiredSize));

            Assert.True(target.IsMeasureValid);
            Assert.True(target.IsArrangeValid);
            Assert.True(child.IsMeasureValid);
            Assert.False(child.IsArrangeValid);

            child.IsVisible = true;

            Assert.False(target.IsMeasureValid);
            Assert.False(target.IsArrangeValid);
            Assert.False(child.IsMeasureValid);
            Assert.False(child.IsArrangeValid);
        }

        [Fact]
        public void Measuring_Invisible_Control_Should_Not_Invalidate_Parent_Measure()
        {
            Border child;
            var target = new StackPanel
            {
                Children =
                {
                    (child = new Border
                    {
                        Width = 100,
                    }),
                }
            };

            target.Measure(new Size(double.PositiveInfinity, double.PositiveInfinity));
            target.Arrange(new Rect(target.DesiredSize));

            Assert.True(target.IsMeasureValid);
            Assert.True(target.IsArrangeValid);
            Assert.Equal(new Size(100, 0), child.DesiredSize);

            child.IsVisible = false;
            Assert.Equal(default, child.DesiredSize);

            target.Measure(new Size(double.PositiveInfinity, double.PositiveInfinity));
            target.Arrange(new Rect(target.DesiredSize));
            child.Measure(new Size(double.PositiveInfinity, double.PositiveInfinity));

            Assert.True(target.IsMeasureValid);
            Assert.True(target.IsArrangeValid);
            Assert.Equal(default, child.DesiredSize);
        }

        [Fact]
        public void Size_Properties_Reject_Invalid_Values()
        {
            var target = new Layoutable();

            Assert.Multiple(() =>
            {
                SetShouldThrow([Layoutable.WidthProperty, Layoutable.HeightProperty], double.PositiveInfinity);
                SetShouldThrow([Layoutable.WidthProperty, Layoutable.HeightProperty], -10);

                SetShouldThrow([Layoutable.MinWidthProperty, Layoutable.MinHeightProperty], double.PositiveInfinity);
                SetShouldThrow([Layoutable.MinWidthProperty, Layoutable.MinHeightProperty], -10);

                SetShouldThrow([Layoutable.MaxWidthProperty, Layoutable.MaxHeightProperty], -10);

                void SetShouldThrow(IEnumerable<StyledProperty<double>> properies, double value)
                {
                    foreach (var prop in properies)
                        Assert.Throws<ArgumentException>(() => target.SetValue(prop, value));
                }
            });
        }

        [Fact]
        public void Constraint_And_Negative_Margin()
        {
            using var app = UnitTestApplication.Start(TestServices.MockPlatformRenderInterface);

            var textBlock = new TextBlock
            {
                Margin = new Thickness(-10),
                Text = "Lorem ipsum dolor sit amet",
            };

            var border = new Border
            {
                MaxWidth = 100,
                Child = textBlock,
            };

            border.Measure(new Size(double.PositiveInfinity, double.PositiveInfinity));
            border.Arrange(new Rect(default, border.DesiredSize));

            Assert.Multiple(() =>
            {
                Assert.Equal(new Size(100, 0), border.DesiredSize);
                Assert.Equal(new Rect(0, 0, 100, 0), border.Bounds);
                Assert.Equal(new Size(100, 0), textBlock.DesiredSize);
                Assert.Equal(new Rect(-10, -10, 120, 20), textBlock.Bounds);
            });
        }

        private class TestLayoutable : Layoutable
        {
            public Size ArrangeSize { get; private set; }
            public Size MeasureResult { get; set; } = new Size(10, 10);
            public Size MeasureSize { get; private set; }

            protected override Size MeasureOverride(Size availableSize)
            {
                MeasureSize = availableSize;
                return MeasureResult;
            }

            protected override Size ArrangeOverride(Size finalSize)
            {
                ArrangeSize = finalSize;
                return base.ArrangeOverride(finalSize);
            }
        }
    }
}