File: ModelBinding\Binders\KeyValuePairModelBinderTest.cs
Web Access
Project: src\src\Mvc\Mvc.Core\test\Microsoft.AspNetCore.Mvc.Core.Test.csproj (Microsoft.AspNetCore.Mvc.Core.Test)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging.Abstractions;
 
namespace Microsoft.AspNetCore.Mvc.ModelBinding.Binders;
 
public class KeyValuePairModelBinderTest
{
    [Fact]
    public async Task BindModel_MissingKey_ReturnsResult_AndAddsModelValidationError()
    {
        // Arrange
        var valueProvider = new SimpleValueProvider();
 
        // Create string binder to create the value but not the key.
        var bindingContext = GetBindingContext(valueProvider, typeof(KeyValuePair<int, string>));
        var binder = new KeyValuePairModelBinder<int, string>(
            CreateIntBinder(false),
            CreateStringBinder(),
            NullLoggerFactory.Instance);
 
        // Act
        await binder.BindModelAsync(bindingContext);
 
        // Assert
        Assert.False(bindingContext.Result.IsModelSet);
        Assert.Null(bindingContext.Result.Model);
        Assert.False(bindingContext.ModelState.IsValid);
        Assert.Equal("someName", bindingContext.ModelName);
        var error = Assert.Single(bindingContext.ModelState["someName.Key"].Errors);
        Assert.Equal("A value is required.", error.ErrorMessage);
    }
 
    [Fact]
    public async Task BindModel_MissingValue_ReturnsResult_AndAddsModelValidationError()
    {
        // Arrange
        var valueProvider = new SimpleValueProvider();
 
        // Create int binder to create the value but not the key.
        var bindingContext = GetBindingContext(valueProvider, typeof(KeyValuePair<int, string>));
        var binder = new KeyValuePairModelBinder<int, string>(
            CreateIntBinder(),
            CreateStringBinder(false),
            NullLoggerFactory.Instance);
 
        // Act
        await binder.BindModelAsync(bindingContext);
 
        // Assert
        Assert.Null(bindingContext.Result.Model);
        Assert.False(bindingContext.ModelState.IsValid);
        Assert.Equal("someName", bindingContext.ModelName);
        var state = bindingContext.ModelState["someName.Value"];
        Assert.NotNull(state);
        var error = Assert.Single(state.Errors);
        Assert.Equal("A value is required.", error.ErrorMessage);
    }
 
    [Fact]
    public async Task BindModel_MissingKeyAndMissingValue_DoNotAddModelStateError()
    {
        // Arrange
        var valueProvider = new SimpleValueProvider();
 
        // Create int binder to create the value but not the key.
        var bindingContext = GetBindingContext(valueProvider, typeof(KeyValuePair<int, string>));
        var binder = new KeyValuePairModelBinder<int, string>(
            CreateIntBinder(false),
            CreateStringBinder(false),
            NullLoggerFactory.Instance);
 
        // Act
        await binder.BindModelAsync(bindingContext);
 
        // Assert
        Assert.False(bindingContext.Result.IsModelSet);
        Assert.True(bindingContext.ModelState.IsValid);
        Assert.Equal(0, bindingContext.ModelState.ErrorCount);
    }
 
    [Fact]
    public async Task BindModel_SubBindingSucceeds()
    {
        // Arrange
        var valueProvider = new SimpleValueProvider();
 
        var bindingContext = GetBindingContext(valueProvider, typeof(KeyValuePair<int, string>));
        var binder = new KeyValuePairModelBinder<int, string>(
            CreateIntBinder(),
            CreateStringBinder(),
            NullLoggerFactory.Instance);
 
        // Act
        await binder.BindModelAsync(bindingContext);
 
        // Assert
        Assert.True(bindingContext.Result.IsModelSet);
        Assert.Equal(new KeyValuePair<int, string>(42, "some-value"), bindingContext.Result.Model);
    }
 
    [Theory]
    [InlineData(null, false)]
    [InlineData(null, true)]
    [InlineData(42, true)]
    public async Task TryBindStrongModel_InnerBinderReturnsAResult_ReturnsInnerBinderResult(
        object model,
        bool isSuccess)
    {
        // Arrange
        ModelBindingResult innerResult;
        if (isSuccess)
        {
            innerResult = ModelBindingResult.Success(model);
        }
        else
        {
            innerResult = ModelBindingResult.Failed();
        }
 
        var innerBinder = new StubModelBinder(context =>
        {
            Assert.Equal("someName.Key", context.ModelName);
            return innerResult;
        });
 
        var valueProvider = new SimpleValueProvider();
 
        var bindingContext = GetBindingContext(valueProvider, typeof(KeyValuePair<int, string>));
        var binder = new KeyValuePairModelBinder<int, string>(innerBinder, innerBinder, NullLoggerFactory.Instance);
 
        // Act
        var result = await KeyValuePairModelBinder<int, string>.TryBindStrongModel<int>(bindingContext, innerBinder, "Key", "someName.Key");
 
        // Assert
        Assert.Equal(innerResult, result);
        Assert.Empty(bindingContext.ModelState);
    }
 
    [Fact]
    public async Task KeyValuePairModelBinder_CreatesEmptyCollection_IfIsTopLevelObject()
    {
        // Arrange
        var binder = new KeyValuePairModelBinder<string, string>(
            new SimpleTypeModelBinder(typeof(string), NullLoggerFactory.Instance),
            new SimpleTypeModelBinder(typeof(string), NullLoggerFactory.Instance),
            NullLoggerFactory.Instance);
 
        var bindingContext = CreateContext();
        bindingContext.IsTopLevelObject = true;
 
        // Lack of prefix and non-empty model name both ignored.
        bindingContext.ModelName = "modelName";
 
        var metadataProvider = new TestModelMetadataProvider();
        bindingContext.ModelMetadata = metadataProvider.GetMetadataForType(typeof(KeyValuePair<string, string>));
 
        bindingContext.ValueProvider = new TestValueProvider(new Dictionary<string, object>());
 
        // Act
        await binder.BindModelAsync(bindingContext);
 
        // Assert
        var model = Assert.IsType<KeyValuePair<string, string>>(bindingContext.Result.Model);
        Assert.Equal(default(KeyValuePair<string, string>), model);
        Assert.True(bindingContext.Result.IsModelSet);
    }
 
    [Theory]
    [InlineData("")]
    [InlineData("param")]
    public async Task KeyValuePairModelBinder_DoesNotCreateCollection_IfNotIsTopLevelObject(string prefix)
    {
        // Arrange
        var binder = new KeyValuePairModelBinder<string, string>(
            new SimpleTypeModelBinder(typeof(string), NullLoggerFactory.Instance),
            new SimpleTypeModelBinder(typeof(string), NullLoggerFactory.Instance),
            NullLoggerFactory.Instance);
 
        var bindingContext = CreateContext();
        bindingContext.ModelName = ModelNames.CreatePropertyModelName(prefix, "KeyValuePairProperty");
 
        var metadataProvider = new TestModelMetadataProvider();
        bindingContext.ModelMetadata = metadataProvider.GetMetadataForProperty(
            typeof(ModelWithKeyValuePairProperty),
            nameof(ModelWithKeyValuePairProperty.KeyValuePairProperty));
 
        bindingContext.ValueProvider = new TestValueProvider(new Dictionary<string, object>());
 
        // Act
        await binder.BindModelAsync(bindingContext);
 
        // Assert
        Assert.False(bindingContext.Result.IsModelSet);
    }
 
    private static DefaultModelBindingContext CreateContext()
    {
        var modelBindingContext = new DefaultModelBindingContext()
        {
            ActionContext = new ActionContext()
            {
                HttpContext = new DefaultHttpContext(),
            },
            ModelState = new ModelStateDictionary(),
        };
 
        return modelBindingContext;
    }
 
    private static DefaultModelBindingContext GetBindingContext(
        IValueProvider valueProvider,
        Type keyValuePairType)
    {
        var metadataProvider = new TestModelMetadataProvider();
        var bindingContext = new DefaultModelBindingContext
        {
            ModelMetadata = metadataProvider.GetMetadataForType(keyValuePairType),
            ModelName = "someName",
            ModelState = new ModelStateDictionary(),
            ValueProvider = valueProvider,
        };
        return bindingContext;
    }
 
    private static IModelBinder CreateIntBinder(bool success = true)
    {
        var mockIntBinder = new StubModelBinder(mbc =>
        {
            if (mbc.ModelType == typeof(int) && success)
            {
                var model = 42;
                return ModelBindingResult.Success(model);
            }
            return ModelBindingResult.Failed();
        });
        return mockIntBinder;
    }
 
    private static IModelBinder CreateStringBinder(bool success = true)
    {
        return new StubModelBinder(mbc =>
        {
            if (mbc.ModelType == typeof(string) && success)
            {
                var model = "some-value";
                return ModelBindingResult.Success(model);
            }
            return ModelBindingResult.Failed();
        });
    }
 
    private class ModelWithKeyValuePairProperty
    {
        public KeyValuePair<string, string> KeyValuePairProperty { get; set; }
    }
}