// 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; using System.Collections.Generic; using System.Globalization; using System.Linq; using System.Threading.Tasks; using Microsoft.AspNetCore.Http.Internal; using Microsoft.AspNetCore.Mvc.Internal; using Microsoft.AspNetCore.Mvc.ModelBinding.Test; using Microsoft.AspNetCore.Mvc.ModelBinding.Validation; using Xunit; namespace Microsoft.AspNetCore.Mvc.ModelBinding { public class CollectionModelBinderTest { [Fact] public async Task BindComplexCollectionFromIndexes_FiniteIndexes() { // Arrange var valueProvider = new SimpleValueProvider { { "someName[foo]", "42" }, { "someName[baz]", "200" } }; var bindingContext = GetModelBindingContext(valueProvider); var binder = new CollectionModelBinder(); // Act var collectionResult = await binder.BindComplexCollectionFromIndexes( bindingContext, new[] { "foo", "bar", "baz" }); // Assert Assert.Equal(new[] { 42, 0, 200 }, collectionResult.Model.ToArray()); // This requires a non-default IValidationStrategy var strategy = Assert.IsType(collectionResult.ValidationStrategy); Assert.Equal(new[] { "foo", "bar", "baz" }, strategy.ElementKeys); } [Fact] public async Task BindComplexCollectionFromIndexes_InfiniteIndexes() { // Arrange var valueProvider = new SimpleValueProvider { { "someName[0]", "42" }, { "someName[1]", "100" }, { "someName[3]", "400" } }; var bindingContext = GetModelBindingContext(valueProvider); var binder = new CollectionModelBinder(); // Act var boundCollection = await binder.BindComplexCollectionFromIndexes(bindingContext, indexNames: null); // Assert Assert.Equal(new[] { 42, 100 }, boundCollection.Model.ToArray()); // This uses the default IValidationStrategy Assert.DoesNotContain(boundCollection, bindingContext.ValidationState.Keys); } [Theory] [InlineData(false)] [InlineData(true)] public async Task BindModel_ComplexCollection_Succeeds(bool isReadOnly) { // Arrange var valueProvider = new SimpleValueProvider { { "someName.index", new[] { "foo", "bar", "baz" } }, { "someName[foo]", "42" }, { "someName[bar]", "100" }, { "someName[baz]", "200" } }; var bindingContext = GetModelBindingContext(valueProvider, isReadOnly); var modelState = bindingContext.ModelState; var binder = new CollectionModelBinder(); // Act var result = await binder.BindModelResultAsync(bindingContext); // Assert Assert.NotEqual(default(ModelBindingResult), result); Assert.True(result.IsModelSet); var list = Assert.IsAssignableFrom>(result.Model); Assert.Equal(new[] { 42, 100, 200 }, list.ToArray()); Assert.True(modelState.IsValid); } [Theory] [InlineData(false)] [InlineData(true)] public async Task BindModel_ComplexCollection_BindingContextModelNonNull_Succeeds(bool isReadOnly) { // Arrange var valueProvider = new SimpleValueProvider { { "someName.index", new[] { "foo", "bar", "baz" } }, { "someName[foo]", "42" }, { "someName[bar]", "100" }, { "someName[baz]", "200" } }; var bindingContext = GetModelBindingContext(valueProvider, isReadOnly); var modelState = bindingContext.ModelState; var list = new List(); bindingContext.Model = list; var binder = new CollectionModelBinder(); // Act var result = await binder.BindModelResultAsync(bindingContext); // Assert Assert.NotEqual(default(ModelBindingResult), result); Assert.True(result.IsModelSet); Assert.Same(list, result.Model); Assert.Equal(new[] { 42, 100, 200 }, list.ToArray()); Assert.True(modelState.IsValid); } [Theory] [InlineData(false)] [InlineData(true)] public async Task BindModel_SimpleCollection_Succeeds(bool isReadOnly) { // Arrange var valueProvider = new SimpleValueProvider { { "someName", new[] { "42", "100", "200" } } }; var bindingContext = GetModelBindingContext(valueProvider, isReadOnly); var modelState = bindingContext.ModelState; var binder = new CollectionModelBinder(); // Act var result = await binder.BindModelResultAsync(bindingContext); // Assert Assert.NotEqual(default(ModelBindingResult), result); Assert.True(result.IsModelSet); var list = Assert.IsAssignableFrom>(result.Model); Assert.Equal(new[] { 42, 100, 200 }, list.ToArray()); } [Theory] [InlineData(false)] [InlineData(true)] public async Task BindModel_SimpleCollection_BindingContextModelNonNull_Succeeds(bool isReadOnly) { // Arrange var valueProvider = new SimpleValueProvider { { "someName", new[] { "42", "100", "200" } } }; var bindingContext = GetModelBindingContext(valueProvider, isReadOnly); var modelState = bindingContext.ModelState; var list = new List(); bindingContext.Model = list; var binder = new CollectionModelBinder(); // Act var result = await binder.BindModelResultAsync(bindingContext); // Assert Assert.NotEqual(default(ModelBindingResult), result); Assert.True(result.IsModelSet); Assert.Same(list, result.Model); Assert.Equal(new[] { 42, 100, 200 }, list.ToArray()); } [Fact] public async Task BindModelAsync_SimpleCollectionWithNullValue_Succeeds() { // Arrange var binder = new CollectionModelBinder(); var valueProvider = new SimpleValueProvider { { "someName", null }, }; var bindingContext = GetModelBindingContext(valueProvider, isReadOnly: false); var modelState = bindingContext.ModelState; // Act var result = await binder.BindModelResultAsync(bindingContext); // Assert Assert.NotEqual(default(ModelBindingResult), result); Assert.True(result.IsModelSet); Assert.NotNull(result.Model); var model = Assert.IsType>(result.Model); Assert.Empty(model); } [Fact] public async Task BindSimpleCollection_RawValueIsEmptyCollection_ReturnsEmptyList() { // Arrange var binder = new CollectionModelBinder(); var context = GetModelBindingContext(new SimpleValueProvider()); // Act var boundCollection = await binder.BindSimpleCollection(context, new ValueProviderResult(new string[0])); // Assert Assert.NotNull(boundCollection.Model); Assert.Empty(boundCollection.Model); } [Fact] public async Task CollectionModelBinder_CreatesEmptyCollection_IfIsTopLevelObject() { // Arrange var binder = new CollectionModelBinder(); 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(List)); context.ValueProvider = new TestValueProvider(new Dictionary()); // Act var result = await binder.BindModelResultAsync(context); // Assert Assert.NotEqual(default(ModelBindingResult), result); Assert.Empty(Assert.IsType>(result.Model)); Assert.Equal("modelName", result.Key); Assert.True(result.IsModelSet); } // Setup like CollectionModelBinder_CreatesEmptyCollection_IfIsTopLevelObject except // Model already has a value. [Fact] public async Task CollectionModelBinder_DoesNotCreateEmptyCollection_IfModelNonNull() { // Arrange var binder = new CollectionModelBinder(); var context = CreateContext(); context.IsTopLevelObject = true; var list = new List(); context.Model = list; // Lack of prefix and non-empty model name both ignored. context.ModelName = "modelName"; var metadataProvider = context.OperationBindingContext.MetadataProvider; context.ModelMetadata = metadataProvider.GetMetadataForType(typeof(List)); context.ValueProvider = new TestValueProvider(new Dictionary()); // Act var result = await binder.BindModelResultAsync(context); // Assert Assert.NotEqual(default(ModelBindingResult), result); Assert.Same(list, result.Model); Assert.Empty(list); Assert.Equal("modelName", result.Key); Assert.True(result.IsModelSet); } [Theory] [InlineData("")] [InlineData("param")] public async Task CollectionModelBinder_DoesNotCreateCollection_IfNotIsTopLevelObject(string prefix) { // Arrange var binder = new CollectionModelBinder(); var context = CreateContext(); context.ModelName = ModelNames.CreatePropertyModelName(prefix, "ListProperty"); var metadataProvider = context.OperationBindingContext.MetadataProvider; context.ModelMetadata = metadataProvider.GetMetadataForProperty( typeof(ModelWithListProperty), nameof(ModelWithListProperty.ListProperty)); context.ValueProvider = new TestValueProvider(new Dictionary()); // Act var result = await binder.BindModelResultAsync(context); // Assert Assert.Equal(default(ModelBindingResult), result); } // Model type -> can create instance. public static TheoryData CanCreateInstanceData { get { return new TheoryData { { typeof(IEnumerable), true }, { typeof(ICollection), true }, { typeof(IList), true }, { typeof(List), true }, { typeof(LinkedList), true }, { typeof(ISet), false }, }; } } [Theory] [MemberData(nameof(CanCreateInstanceData))] public void CanCreateInstance_ReturnsExpectedValue(Type modelType, bool expectedResult) { // Arrange var binder = new CollectionModelBinder(); // Act var result = binder.CanCreateInstance(modelType); // Assert Assert.Equal(expectedResult, result); } [Fact] public async Task BindSimpleCollection_SubBindingSucceeds() { // Arrange var culture = new CultureInfo("fr-FR"); var bindingContext = GetModelBindingContext(new SimpleValueProvider()); bindingContext.OperationBindingContext.ModelBinder = new StubModelBinder(mbc => { Assert.Equal("someName", mbc.ModelName); mbc.Result = ModelBindingResult.Success(mbc.ModelName, 42); }); var modelBinder = new CollectionModelBinder(); // Act var boundCollection = await modelBinder.BindSimpleCollection( bindingContext, new ValueProviderResult(new string[] { "0" })); // Assert Assert.Equal(new[] { 42 }, boundCollection.Model.ToArray()); } private static DefaultModelBindingContext GetModelBindingContext( IValueProvider valueProvider, bool isReadOnly = false) { var metadataProvider = new TestModelMetadataProvider(); metadataProvider .ForProperty(nameof(ModelWithIListProperty.ListProperty)) .BindingDetails(bd => bd.IsReadOnly = isReadOnly); var metadata = metadataProvider.GetMetadataForProperty( typeof(ModelWithIListProperty), nameof(ModelWithIListProperty.ListProperty)); var bindingContext = new DefaultModelBindingContext { ModelMetadata = metadata, ModelName = "someName", ModelState = new ModelStateDictionary(), ValueProvider = valueProvider, OperationBindingContext = new OperationBindingContext { ModelBinder = CreateIntBinder(), MetadataProvider = metadataProvider }, ValidationState = new ValidationStateDictionary(), FieldName = "testfieldname", }; return bindingContext; } private static IModelBinder CreateIntBinder() { return new StubModelBinder(mbc => { var value = mbc.ValueProvider.GetValue(mbc.ModelName); if (value == ValueProviderResult.None) { return null; } var model = value.ConvertTo(mbc.ModelType); if (model == null) { return ModelBindingResult.Failed(mbc.ModelName); } else { return ModelBindingResult.Success(mbc.ModelName, model); } }); } private static DefaultModelBindingContext CreateContext() { var modelBindingContext = new DefaultModelBindingContext() { OperationBindingContext = new OperationBindingContext() { ActionContext = new ActionContext() { HttpContext = new DefaultHttpContext(), }, MetadataProvider = new TestModelMetadataProvider(), } }; return modelBindingContext; } private class ModelWithListProperty { public List ListProperty { get; set; } } private class ModelWithIListProperty { public IList ListProperty { get; set; } } private class ModelWithSimpleProperties { public int Id { get; set; } public string Name { get; set; } } } }