aspnetcore/test/Microsoft.AspNetCore.JsonPatch.Test/Adapters/PocoAdapterTest.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 Newtonsoft.Json.Serialization;
using Xunit;

namespace Microsoft.AspNetCore.JsonPatch.Internal
{
    public class PocoAdapterTest
    {
        [Fact]
        public void TryAdd_ReplacesExistingProperty()
        {
            // Arrange
            var adapter = new PocoAdapter();
            var contractResolver = new DefaultContractResolver();
            var model = new Customer
            {
                Name = "Joana"
            };

            // Act
            var addStatus = adapter.TryAdd(model, "Name", contractResolver, "John", out var errorMessage);

            // Assert
            Assert.Equal("John", model.Name);
            Assert.True(addStatus);
            Assert.True(string.IsNullOrEmpty(errorMessage), "Expected no error message");
        }

        [Fact]
        public void TryAdd_ThrowsJsonPatchException_IfPropertyDoesNotExist()
        {
            // Arrange
            var adapter = new PocoAdapter();
            var contractResolver = new DefaultContractResolver();
            var model = new Customer
            {
                Name = "Joana"
            };
            var expectedErrorMessage = "The target location specified by path segment 'LastName' was not found.";

            // Act
            var addStatus = adapter.TryAdd(model, "LastName", contractResolver, "Smith", out var errorMessage);

            // Assert
            Assert.False(addStatus);
            Assert.Equal(expectedErrorMessage, errorMessage);
        }

        [Fact]
        public void TryGet_ExistingProperty()
        {
            // Arrange
            var adapter = new PocoAdapter();
            var contractResolver = new DefaultContractResolver();
            var model = new Customer
            {
                Name = "Joana"
            };

            // Act
            var getStatus = adapter.TryGet(model, "Name", contractResolver, out var value, out var errorMessage);

            // Assert
            Assert.Equal("Joana", value);
            Assert.True(getStatus);
            Assert.True(string.IsNullOrEmpty(errorMessage), "Expected no error message");
        }

        [Fact]
        public void TryGet_ThrowsJsonPatchException_IfPropertyDoesNotExist()
        {
            // Arrange
            var adapter = new PocoAdapter();
            var contractResolver = new DefaultContractResolver();
            var model = new Customer
            {
                Name = "Joana"
            };
            var expectedErrorMessage = "The target location specified by path segment 'LastName' was not found.";

            // Act
            var getStatus = adapter.TryGet(model, "LastName", contractResolver, out var value, out var errorMessage);

            // Assert
            Assert.Null(value);
            Assert.False(getStatus);
            Assert.Equal(expectedErrorMessage, errorMessage);
        }

        [Fact]
        public void TryRemove_SetsPropertyToNull()
        {
            // Arrange
            var adapter = new PocoAdapter();
            var contractResolver = new DefaultContractResolver();
            var model = new Customer
            {
                Name = "Joana"
            };

            // Act
            var removeStatus = adapter.TryRemove(model, "Name", contractResolver, out var errorMessage);

            // Assert
            Assert.Null(model.Name);
            Assert.True(removeStatus);
            Assert.True(string.IsNullOrEmpty(errorMessage), "Expected no error message");
        }

        [Fact]
        public void TryRemove_ThrowsJsonPatchException_IfPropertyDoesNotExist()
        {
            // Arrange
            var adapter = new PocoAdapter();
            var contractResolver = new DefaultContractResolver();
            var model = new Customer
            {
                Name = "Joana"
            };
            var expectedErrorMessage = "The target location specified by path segment 'LastName' was not found.";

            // Act
            var removeStatus = adapter.TryRemove(model, "LastName", contractResolver, out var errorMessage);

            // Assert
            Assert.False(removeStatus);
            Assert.Equal(expectedErrorMessage, errorMessage);
        }

        [Fact]
        public void TryReplace_OverwritesExistingValue()
        {
            // Arrange
            var adapter = new PocoAdapter();
            var contractResolver = new DefaultContractResolver();
            var model = new Customer
            {
                Name = "Joana"
            };

            // Act
            var replaceStatus = adapter.TryReplace(model, "Name", contractResolver, "John", out var errorMessage);

            // Assert
            Assert.Equal("John", model.Name);
            Assert.True(replaceStatus);
            Assert.True(string.IsNullOrEmpty(errorMessage), "Expected no error message");
        }

        [Fact]
        public void TryReplace_ThrowsJsonPatchException_IfNewValueIsInvalidType()
        {
            // Arrange
            var adapter = new PocoAdapter();
            var contractResolver = new DefaultContractResolver();
            var model = new Customer
            {
                Age = 25
            };

            var expectedErrorMessage = "The value 'TwentySix' is invalid for target location.";

            // Act
            var replaceStatus = adapter.TryReplace(model, "Age", contractResolver, "TwentySix", out var errorMessage);

            // Assert
            Assert.Equal(25, model.Age);
            Assert.False(replaceStatus);
            Assert.Equal(expectedErrorMessage, errorMessage);
        }

        [Fact]
        public void TryReplace_ThrowsJsonPatchException_IfPropertyDoesNotExist()
        {
            // Arrange
            var adapter = new PocoAdapter();
            var contractResolver = new DefaultContractResolver();
            var model = new Customer
            {
                Name = "Joana"
            };
            var expectedErrorMessage = "The target location specified by path segment 'LastName' was not found.";

            // Act
            var replaceStatus = adapter.TryReplace(model, "LastName", contractResolver, "Smith", out var errorMessage);

            // Assert
            Assert.Equal("Joana", model.Name);
            Assert.False(replaceStatus);
            Assert.Equal(expectedErrorMessage, errorMessage);
        }

        [Fact]
        public void TryTest_DoesNotThrowException_IfTestSuccessful()
        {
            var adapter = new PocoAdapter();
            var contractResolver = new DefaultContractResolver();
            var model = new Customer
            {
                Name = "Joana"
            };

            // Act
            var testStatus = adapter.TryTest(model, "Name", contractResolver, "Joana", out var errorMessage);

            // Assert
            Assert.Equal("Joana", model.Name);
            Assert.True(testStatus);
            Assert.True(string.IsNullOrEmpty(errorMessage), "Expected no error message");
        }

        [Fact]
        public void TryTest_ThrowsJsonPatchException_IfTestFails()
        {
            // Arrange            
            var adapter = new PocoAdapter();
            var contractResolver = new DefaultContractResolver();
            var model = new Customer
            {
                Name = "Joana"
            };
            var expectedErrorMessage = "The current value 'Joana' at path 'Name' is not equal to the test value 'John'.";

            // Act
            var testStatus = adapter.TryTest(model, "Name", contractResolver, "John", out var errorMessage);

            // Assert
            Assert.False(testStatus);
            Assert.Equal(expectedErrorMessage, errorMessage);
        }

        private class Customer
        {
            public string Name { get; set; }

            public int Age { get; set; }
        }
    }
}