aspnetcore/test/Microsoft.AspNetCore.JsonPatch.Test/DynamicObjectAdapterTest.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.

using System.Collections.Generic;
using Newtonsoft.Json.Serialization;
using Xunit;

namespace Microsoft.AspNetCore.JsonPatch.Internal
{
    public class DynamicObjectAdapterTest
    {
        [Fact]
        public void TryAdd_AddsNewProperty()
        {
            // Arrange
            var adapter = new DynamicObjectAdapter();
            dynamic target = new DynamicTestObject();
            var segment = "NewProperty";
            var resolver = new DefaultContractResolver();

            // Act
            var status = adapter.TryAdd(target, segment, resolver, "new", out string errorMessage);

            // Assert
            Assert.True(status);
            Assert.Null(errorMessage);
            Assert.Equal("new", target.NewProperty);
        }

        [Fact]
        public void TryAdd_ReplacesExistingPropertyValue()
        {
            // Arrange
            var adapter = new DynamicObjectAdapter();
            dynamic target = new DynamicTestObject();
            target.List = new List<int>() { 1, 2, 3 };
            var value = new List<string>() { "stringValue1", "stringValue2" };
            var segment = "List";
            var resolver = new DefaultContractResolver();

            // Act
            var status = adapter.TryAdd(target, segment, resolver, value, out string errorMessage);

            // Assert
            Assert.True(status);
            Assert.Null(errorMessage);
            Assert.Equal(value, target.List);
        }

        [Fact]
        public void TryGet_GetsPropertyValue_ForExistingProperty()
        {
            // Arrange
            var adapter = new DynamicObjectAdapter();
            dynamic target = new DynamicTestObject();
            var segment = "NewProperty";
            var resolver = new DefaultContractResolver();

            // Act 1
            var addStatus = adapter.TryAdd(target, segment, resolver, "new", out string errorMessage);

            // Assert 1
            Assert.True(addStatus);
            Assert.Null(errorMessage);
            Assert.Equal("new", target.NewProperty);

            // Act 2
            var getStatus = adapter.TryGet(target, segment, resolver, out object getValue, out string getErrorMessage);

            // Assert 2
            Assert.True(getStatus);
            Assert.Null(getErrorMessage);
            Assert.Equal(getValue, target.NewProperty);
        }

        [Fact]
        public void TryGet_ThrowsPathNotFoundException_ForNonExistingProperty()
        {
            // Arrange
            var adapter = new DynamicObjectAdapter();
            dynamic target = new DynamicTestObject();
            var segment = "NewProperty";
            var resolver = new DefaultContractResolver();

            // Act
            var getStatus = adapter.TryGet(target, segment, resolver, out object getValue, out string getErrorMessage);

            // Assert
            Assert.False(getStatus);
            Assert.Null(getValue);
            Assert.Equal($"The target location specified by path segment '{segment}' was not found.", getErrorMessage);
        }

        [Fact]
        public void TryTraverse_FindsNextTarget()
        {
            // Arrange
            var adapter = new DynamicObjectAdapter();
            dynamic target = new DynamicTestObject();
            target.NestedObject = new DynamicTestObject();
            target.NestedObject.NewProperty = "A";
            var segment = "NestedObject";
            var resolver = new DefaultContractResolver();

            // Act
            var status = adapter.TryTraverse(target, segment, resolver, out object nextTarget, out string errorMessage);

            // Assert
            Assert.True(status);
            Assert.Null(errorMessage);
            Assert.Equal(target.NestedObject, nextTarget);
        }

        [Fact]
        public void TryTraverse_ThrowsPathNotFoundException_ForNonExistingProperty()
        {
            // Arrange
            var adapter = new DynamicObjectAdapter();
            dynamic target = new DynamicTestObject();
            target.NestedObject = new DynamicTestObject();
            var segment = "NewProperty";
            var resolver = new DefaultContractResolver();

            // Act
            var status = adapter.TryTraverse(target.NestedObject, segment, resolver, out object nextTarget, out string errorMessage);

            // Assert
            Assert.False(status);
            Assert.Equal($"The target location specified by path segment '{segment}' was not found.", errorMessage);
        }

        [Fact]
        public void TryReplace_ReplacesPropertyValue()
        {
            // Arrange
            var adapter = new DynamicObjectAdapter();
            dynamic target = new DynamicTestObject();
            target.NewProperty = new object();
            var segment = "NewProperty";
            var resolver = new DefaultContractResolver();

            // Act
            var status = adapter.TryReplace(target, segment, resolver, "new", out string errorMessage);

            // Assert
            Assert.True(status);
            Assert.Null(errorMessage);
            Assert.Equal("new", target.NewProperty);
        }

        [Fact]
        public void TryReplace_ThrowsPathNotFoundException_ForNonExistingProperty()
        {
            // Arrange
            var adapter = new DynamicObjectAdapter();
            dynamic target = new DynamicTestObject();
            var segment = "NewProperty";
            var resolver = new DefaultContractResolver();

            // Act
            var status = adapter.TryReplace(target, segment, resolver, "test", out string errorMessage);

            // Assert
            Assert.False(status);
            Assert.Equal($"The target location specified by path segment '{segment}' was not found.", errorMessage);
        }

        [Fact]
        public void TryReplace_ThrowsPropertyInvalidException_IfNewValueIsNotTheSameTypeAsInitialValue()
        {
            // Arrange
            var adapter = new DynamicObjectAdapter();
            dynamic target = new DynamicTestObject();
            target.NewProperty = 1;
            var segment = "NewProperty";
            var resolver = new DefaultContractResolver();

            // Act
            var status = adapter.TryReplace(target, segment, resolver, "test", out string errorMessage);

            // Assert
            Assert.False(status);
            Assert.Equal($"The value 'test' is invalid for target location.", errorMessage);
        }

        [Theory]
        [InlineData(1, 0)]
        [InlineData("new", null)]
        public void TryRemove_SetsPropertyToDefaultOrNull(object value, object expectedValue)
        {
            // Arrange
            var adapter = new DynamicObjectAdapter();
            dynamic target = new DynamicTestObject();
            var segment = "NewProperty";
            var resolver = new DefaultContractResolver();

            // Act 1
            var addStatus = adapter.TryAdd(target, segment, resolver, value, out string errorMessage);

            // Assert 1
            Assert.True(addStatus);
            Assert.Null(errorMessage);
            Assert.Equal(value, target.NewProperty);

            // Act 2
            var removeStatus = adapter.TryRemove(target, segment, resolver, out string removeErrorMessage);

            // Assert 2
            Assert.True(removeStatus);
            Assert.Null(removeErrorMessage);
            Assert.Equal(expectedValue, target.NewProperty);
        }

        [Fact]
        public void TryRemove_ThrowsPathNotFoundException_ForNonExistingProperty()
        {
            // Arrange
            var adapter = new DynamicObjectAdapter();
            dynamic target = new DynamicTestObject();
            var segment = "NewProperty";
            var resolver = new DefaultContractResolver();

            // Act
            var removeStatus = adapter.TryRemove(target, segment, resolver, out string removeErrorMessage);

            // Assert
            Assert.False(removeStatus);
            Assert.Equal($"The target location specified by path segment '{segment}' was not found.", removeErrorMessage);
        }
    }
}