src/Features/JsonPatch.SystemTextJson/test/Internal/PocoAdapterTest.cs - main - githubmirror/aspnetcore

src/Features/JsonPatch.SystemTextJson/test/Internal/PocoAdapterTest.cs
268 строк8 KB
Artak
Added System.Text.Json serialization-based JsonPatch implementation (#61313)
22 апр 2025, 01:53
22 апр 2025, 01:53b9e9970
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Text.Json;
using System.Text.Json.Serialization.Metadata;
using Xunit;

namespace Microsoft.AspNetCore.JsonPatch.SystemTextJson.Internal;

public class PocoAdapterTest
{
    [Fact]
    public void TryAdd_ReplacesExistingProperty()
    {
        // Arrange
        var adapter = new PocoAdapter();
        var serializerOptions = JsonSerializerOptions.Default;
        var model = new Customer
        {
            Name = "Joana"
        };

        // Act
        var addStatus = adapter.TryAdd(model, "Name", serializerOptions, "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 serializerOptions = JsonSerializerOptions.Default;
        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", serializerOptions, "Smith", out var errorMessage);

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

    [Fact]
    public void TryGet_ExistingProperty()
    {
        // Arrange
        var adapter = new PocoAdapter();
        var serializerOptions = JsonSerializerOptions.Default;
        var model = new Customer
        {
            Name = "Joana"
        };

        // Act
        var getStatus = adapter.TryGet(model, "Name", serializerOptions, 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 serializerOptions = JsonSerializerOptions.Default;
        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", serializerOptions, 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 serializerOptions = JsonSerializerOptions.Default;
        var model = new Customer
        {
            Name = "Joana"
        };

        // Act
        var removeStatus = adapter.TryRemove(model, "Name", serializerOptions, 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 serializerOptions = JsonSerializerOptions.Default;
        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", serializerOptions, out var errorMessage);

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

    [Fact]
    public void TryReplace_OverwritesExistingValue()
    {
        // Arrange
        var adapter = new PocoAdapter();
        var serializerOptions = JsonSerializerOptions.Default;
        var model = new Customer
        {
            Name = "Joana"
        };

        // Act
        var replaceStatus = adapter.TryReplace(model, "Name", serializerOptions, "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 serializerOptions = JsonSerializerOptions.Default;
        var model = new Customer
        {
            Age = 25
        };

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

        // Act
        var replaceStatus = adapter.TryReplace(model, "Age", serializerOptions, "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 serializerOptions = JsonSerializerOptions.Default;
        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", serializerOptions, "Smith", out var errorMessage);

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

    [Fact]
    public void TryReplace_UsesCustomConverter()
    {
        // Arrange
        var adapter = new PocoAdapter();
        var contractResolver = new RectangleContractResolver();
        var serializerOptions = new JsonSerializerOptions();
        serializerOptions.Converters.Add(new RectangleJsonConverter());
        serializerOptions.TypeInfoResolver = new DefaultJsonTypeInfoResolver();

        var model = new Square()
        {
            Rectangle = new Rectangle()
            {
                RectangleProperty = "Square"
            }
        };

        // Act
        var replaceStatus = adapter.TryReplace(model, "Rectangle", serializerOptions, "Oval", out var errorMessage);

        // Assert
        Assert.True(replaceStatus);
        Assert.Equal("Oval", model.Rectangle.RectangleProperty);
        Assert.Null(errorMessage);
    }

    [Fact]
    public void TryTest_DoesNotThrowException_IfTestSuccessful()
    {
        var adapter = new PocoAdapter();
        var serializerOptions = JsonSerializerOptions.Default;
        var model = new Customer
        {
            Name = "Joana"
        };

        // Act
        var testStatus = adapter.TryTest(model, "Name", serializerOptions, "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 serializerOptions = JsonSerializerOptions.Default;
        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", serializerOptions, "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; }
    }
}