// 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. #if DNX451 using System; using System.Collections.Generic; using System.Globalization; using System.Linq; using System.Threading.Tasks; using Microsoft.AspNet.Http.Internal; using Moq; using Xunit; namespace Microsoft.AspNet.Mvc.ModelBinding.Test { public class DictionaryModelBinderTest { [Theory] [InlineData(false)] [InlineData(true)] public async Task BindModel_Succeeds(bool isReadOnly) { // Arrange var bindingContext = GetModelBindingContext(isReadOnly); var modelState = bindingContext.ModelState; var binder = new DictionaryModelBinder(); // Act var result = await binder.BindModelAsync(bindingContext); // Assert Assert.NotNull(result); Assert.True(result.IsModelSet); var dictionary = Assert.IsAssignableFrom>(result.Model); Assert.True(modelState.IsValid); Assert.NotNull(dictionary); Assert.Equal(2, dictionary.Count); Assert.Equal("forty-two", dictionary[42]); Assert.Equal("eighty-four", dictionary[84]); } [Theory] [InlineData(false)] [InlineData(true)] public async Task BindModel_BindingContextModelNonNull_Succeeds(bool isReadOnly) { // Arrange var bindingContext = GetModelBindingContext(isReadOnly); var modelState = bindingContext.ModelState; var dictionary = new Dictionary(); bindingContext.Model = dictionary; var binder = new DictionaryModelBinder(); // Act var result = await binder.BindModelAsync(bindingContext); // Assert Assert.NotNull(result); Assert.True(result.IsModelSet); Assert.Same(dictionary, result.Model); Assert.True(modelState.IsValid); Assert.NotNull(dictionary); Assert.Equal(2, dictionary.Count); Assert.Equal("forty-two", dictionary[42]); Assert.Equal("eighty-four", dictionary[84]); } // modelName, keyFormat, dictionary public static TheoryData> StringToStringData { get { var dictionaryWithOne = new Dictionary(StringComparer.Ordinal) { { "one", "one" }, }; var dictionaryWithThree = new Dictionary(StringComparer.Ordinal) { { "one", "one" }, { "two", "two" }, { "three", "three" }, }; return new TheoryData> { { string.Empty, "[{0}]", dictionaryWithOne }, { string.Empty, "[{0}]", dictionaryWithThree }, { "prefix", "prefix[{0}]", dictionaryWithOne }, { "prefix", "prefix[{0}]", dictionaryWithThree }, { "prefix.property", "prefix.property[{0}]", dictionaryWithOne }, { "prefix.property", "prefix.property[{0}]", dictionaryWithThree }, }; } } [Theory] [MemberData(nameof(StringToStringData))] public async Task BindModel_FallsBackToBindingValues( string modelName, string keyFormat, IDictionary dictionary) { // Arrange var binder = new DictionaryModelBinder(); var context = CreateContext(); context.ModelName = modelName; context.OperationBindingContext.ModelBinder = CreateCompositeBinder(); context.OperationBindingContext.ValueProvider = CreateEnumerableValueProvider(keyFormat, dictionary); context.ValueProvider = context.OperationBindingContext.ValueProvider; var metadataProvider = context.OperationBindingContext.MetadataProvider; context.ModelMetadata = metadataProvider.GetMetadataForProperty( typeof(ModelWithDictionaryProperty), nameof(ModelWithDictionaryProperty.DictionaryProperty)); // Act var result = await binder.BindModelAsync(context); // Assert Assert.NotNull(result); Assert.False(result.IsFatalError); Assert.True(result.IsModelSet); Assert.Equal(modelName, result.Key); Assert.NotNull(result.ValidationNode); var resultDictionary = Assert.IsAssignableFrom>(result.Model); Assert.Equal(dictionary, resultDictionary); } // Similar to one BindModel_FallsBackToBindingValues case but without an IEnumerableValueProvider. [Fact] public async Task BindModel_DoesNotFallBack_WithoutEnumerableValueProvider() { // Arrange var dictionary = new Dictionary(StringComparer.Ordinal) { { "one", "one" }, { "two", "two" }, { "three", "three" }, }; var binder = new DictionaryModelBinder(); var context = CreateContext(); context.ModelName = "prefix"; context.OperationBindingContext.ModelBinder = CreateCompositeBinder(); context.OperationBindingContext.ValueProvider = CreateTestValueProvider("prefix[{0}]", dictionary); context.ValueProvider = context.OperationBindingContext.ValueProvider; var metadataProvider = context.OperationBindingContext.MetadataProvider; context.ModelMetadata = metadataProvider.GetMetadataForProperty( typeof(ModelWithDictionaryProperty), nameof(ModelWithDictionaryProperty.DictionaryProperty)); // Act var result = await binder.BindModelAsync(context); // Assert Assert.NotNull(result); Assert.False(result.IsFatalError); Assert.True(result.IsModelSet); Assert.Equal("prefix", result.Key); Assert.NotNull(result.ValidationNode); var resultDictionary = Assert.IsAssignableFrom>(result.Model); Assert.Empty(resultDictionary); } public static TheoryData> LongToIntData { get { var dictionaryWithOne = new Dictionary { { 0L, 0 }, }; var dictionaryWithThree = new Dictionary { { -1L, -1 }, { long.MaxValue, int.MaxValue }, { long.MinValue, int.MinValue }, }; return new TheoryData> { dictionaryWithOne, dictionaryWithThree }; } } [Theory] [MemberData(nameof(LongToIntData))] public async Task BindModel_FallsBackToBindingValues_WithValueTypes(IDictionary dictionary) { // Arrange var stringDictionary = dictionary.ToDictionary(kvp => kvp.Key.ToString(), kvp => kvp.Value.ToString()); var binder = new DictionaryModelBinder(); var context = CreateContext(); context.ModelName = "prefix"; context.OperationBindingContext.ModelBinder = CreateCompositeBinder(); context.OperationBindingContext.ValueProvider = CreateEnumerableValueProvider("prefix[{0}]", stringDictionary); context.ValueProvider = context.OperationBindingContext.ValueProvider; var metadataProvider = context.OperationBindingContext.MetadataProvider; context.ModelMetadata = metadataProvider.GetMetadataForProperty( typeof(ModelWithDictionaryProperty), nameof(ModelWithDictionaryProperty.DictionaryProperty)); // Act var result = await binder.BindModelAsync(context); // Assert Assert.NotNull(result); Assert.False(result.IsFatalError); Assert.True(result.IsModelSet); Assert.Equal("prefix", result.Key); Assert.NotNull(result.ValidationNode); var resultDictionary = Assert.IsAssignableFrom>(result.Model); Assert.Equal(dictionary, resultDictionary); } [Fact] public async Task BindModel_FallsBackToBindingValues_WithComplexValues() { // Arrange var dictionary = new Dictionary { { 23, new ModelWithProperties { Id = 43, Name = "Wilma" } }, { 27, new ModelWithProperties { Id = 98, Name = "Fred" } }, }; var stringDictionary = new Dictionary { { "prefix[23].Id", "43" }, { "prefix[23].Name", "Wilma" }, { "prefix[27].Id", "98" }, { "prefix[27].Name", "Fred" }, }; var binder = new DictionaryModelBinder(); var context = CreateContext(); context.ModelName = "prefix"; context.OperationBindingContext.ModelBinder = CreateCompositeBinder(); context.OperationBindingContext.ValueProvider = CreateEnumerableValueProvider("{0}", stringDictionary); context.ValueProvider = context.OperationBindingContext.ValueProvider; var metadataProvider = context.OperationBindingContext.MetadataProvider; context.ModelMetadata = metadataProvider.GetMetadataForProperty( typeof(ModelWithDictionaryProperty), nameof(ModelWithDictionaryProperty.DictionaryProperty)); // Act var result = await binder.BindModelAsync(context); // Assert Assert.NotNull(result); Assert.False(result.IsFatalError); Assert.True(result.IsModelSet); Assert.Equal("prefix", result.Key); Assert.NotNull(result.ValidationNode); var resultDictionary = Assert.IsAssignableFrom>(result.Model); Assert.Equal(dictionary, resultDictionary); } [Fact] public async Task DictionaryModelBinder_DoesNotCreateCollection_IfIsTopLevelObjectAndIsFirstChanceBinding() { // Arrange var binder = new DictionaryModelBinder(); var context = CreateContext(); context.IsTopLevelObject = true; context.IsFirstChanceBinding = true; // Explicit prefix and empty model name both ignored. context.BinderModelName = "prefix"; context.ModelName = string.Empty; var metadataProvider = context.OperationBindingContext.MetadataProvider; context.ModelMetadata = metadataProvider.GetMetadataForType(typeof(Dictionary)); context.ValueProvider = new TestValueProvider(new Dictionary()); // Act var result = await binder.BindModelAsync(context); // Assert Assert.Null(result); } [Fact] public async Task DictionaryModelBinder_CreatesEmptyCollection_IfIsTopLevelObjectAndNotIsFirstChanceBinding() { // Arrange var binder = new DictionaryModelBinder(); var context = CreateContext(); context.IsTopLevelObject = true; // Lack of prefix and non-empty model name both ignored. context.ModelName = "modelName"; var metadataProvider = context.OperationBindingContext.MetadataProvider; context.ModelMetadata = metadataProvider.GetMetadataForType(typeof(Dictionary)); context.ValueProvider = new TestValueProvider(new Dictionary()); // Act var result = await binder.BindModelAsync(context); // Assert Assert.NotNull(result); Assert.Empty(Assert.IsType>(result.Model)); Assert.Equal("modelName", result.Key); Assert.True(result.IsModelSet); Assert.Same(result.ValidationNode.Model, result.Model); Assert.Same(result.ValidationNode.Key, result.Key); Assert.Same(result.ValidationNode.ModelMetadata, context.ModelMetadata); } [Theory] [InlineData("")] [InlineData("param")] public async Task DictionaryModelBinder_DoesNotCreateCollection_IfNotIsTopLevelObject(string prefix) { // Arrange var binder = new DictionaryModelBinder(); var context = CreateContext(); context.ModelName = ModelNames.CreatePropertyModelName(prefix, "ListProperty"); var metadataProvider = context.OperationBindingContext.MetadataProvider; context.ModelMetadata = metadataProvider.GetMetadataForProperty( typeof(ModelWithDictionaryProperty), nameof(ModelWithDictionaryProperty.DictionaryProperty)); context.ValueProvider = new TestValueProvider(new Dictionary()); // Act var result = await binder.BindModelAsync(context); // Assert Assert.Null(result); } private static ModelBindingContext CreateContext() { var modelBindingContext = new ModelBindingContext() { OperationBindingContext = new OperationBindingContext() { HttpContext = new DefaultHttpContext(), MetadataProvider = new TestModelMetadataProvider(), } }; return modelBindingContext; } private static IModelBinder CreateCompositeBinder() { var binders = new IModelBinder[] { new TypeConverterModelBinder(), new TypeMatchModelBinder(), new MutableObjectModelBinder(), new ComplexModelDtoModelBinder(), }; return new CompositeModelBinder(binders); } private static IValueProvider CreateEnumerableValueProvider( string keyFormat, IDictionary dictionary) { // Convert to an IDictionary then wrap it up. var backingStore = dictionary.ToDictionary( kvp => string.Format(keyFormat, kvp.Key), kvp => new[] { kvp.Value }); var stringCollection = new ReadableStringCollection(backingStore); return new ReadableStringCollectionValueProvider( BindingSource.Form, stringCollection, CultureInfo.InvariantCulture); } // Like CreateEnumerableValueProvider except returned instance does not implement IEnumerableValueProvider. private static IValueProvider CreateTestValueProvider(string keyFormat, IDictionary dictionary) { // Convert to an IDictionary then wrap it up. var backingStore = dictionary.ToDictionary( kvp => string.Format(keyFormat, kvp.Key), kvp => (object)kvp.Value); return new TestValueProvider(BindingSource.Form, backingStore); } private static ModelBindingContext GetModelBindingContext(bool isReadOnly) { var metadataProvider = new TestModelMetadataProvider(); metadataProvider.ForType>().BindingDetails(bd => bd.IsReadOnly = isReadOnly); var valueProvider = new SimpleHttpValueProvider { { "someName[0]", new KeyValuePair(42, "forty-two") }, { "someName[1]", new KeyValuePair(84, "eighty-four") }, }; var bindingContext = new ModelBindingContext { ModelMetadata = metadataProvider.GetMetadataForType(typeof(IDictionary)), ModelName = "someName", ValueProvider = valueProvider, OperationBindingContext = new OperationBindingContext { ModelBinder = CreateKvpBinder(), MetadataProvider = metadataProvider } }; return bindingContext; } private static IModelBinder CreateKvpBinder() { Mock mockKvpBinder = new Mock(); mockKvpBinder .Setup(o => o.BindModelAsync(It.IsAny())) .Returns(async (ModelBindingContext mbc) => { var value = await mbc.ValueProvider.GetValueAsync(mbc.ModelName); if (value != null) { var model = value.ConvertTo(mbc.ModelType); return new ModelBindingResult(model, key: null, isModelSet: true); } return null; }); return mockKvpBinder.Object; } private class ModelWithDictionaryProperty { public Dictionary DictionaryProperty { get; set; } } private class ModelWithProperties { public int Id { get; set; } public string Name { get; set; } public override bool Equals(object obj) { var other = obj as ModelWithProperties; return other != null && Id == other.Id && string.Equals(Name, other.Name, StringComparison.Ordinal); } public override int GetHashCode() { int nameCode = Name == null ? 0 : Name.GetHashCode(); return nameCode ^ Id.GetHashCode(); } public override string ToString() { return $"{{{ Id }, '{ Name }'}}"; } } } } #endif