Fixed FileExtensionsAttributeAdapter to trim(whitespaces, dot character) and lowercase the extensions

This commit is contained in:
Kiran Challa 2017-09-20 16:26:30 -07:00
parent 324db455d9
commit a96fb68690
2 changed files with 89 additions and 31 deletions

View File

@ -3,6 +3,7 @@
using System; using System;
using System.ComponentModel.DataAnnotations; using System.ComponentModel.DataAnnotations;
using System.Linq;
using Microsoft.AspNetCore.Mvc.ModelBinding.Validation; using Microsoft.AspNetCore.Mvc.ModelBinding.Validation;
using Microsoft.Extensions.Localization; using Microsoft.Extensions.Localization;
@ -10,9 +11,20 @@ namespace Microsoft.AspNetCore.Mvc.DataAnnotations.Internal
{ {
public class FileExtensionsAttributeAdapter : AttributeAdapterBase<FileExtensionsAttribute> public class FileExtensionsAttributeAdapter : AttributeAdapterBase<FileExtensionsAttribute>
{ {
private readonly string _extensions;
private readonly string _formattedExtensions;
public FileExtensionsAttributeAdapter(FileExtensionsAttribute attribute, IStringLocalizer stringLocalizer) public FileExtensionsAttributeAdapter(FileExtensionsAttribute attribute, IStringLocalizer stringLocalizer)
: base(attribute, stringLocalizer) : base(attribute, stringLocalizer)
{ {
// Build the extension list based on how the JQuery Validation's 'extension' method expects it
// https://jqueryvalidation.org/extension-method/
// These lines follow the same approach as the FileExtensionsAttribute.
var normalizedExtensions = Attribute.Extensions.Replace(" ", string.Empty).Replace(".", string.Empty).ToLowerInvariant();
var parsedExtensions = normalizedExtensions.Split(',').Select(e => "." + e);
_formattedExtensions = string.Join(", ", parsedExtensions);
_extensions = string.Join(",", parsedExtensions);
} }
/// <inheritdoc /> /// <inheritdoc />
@ -25,7 +37,7 @@ namespace Microsoft.AspNetCore.Mvc.DataAnnotations.Internal
MergeAttribute(context.Attributes, "data-val", "true"); MergeAttribute(context.Attributes, "data-val", "true");
MergeAttribute(context.Attributes, "data-val-fileextensions", GetErrorMessage(context)); MergeAttribute(context.Attributes, "data-val-fileextensions", GetErrorMessage(context));
MergeAttribute(context.Attributes, "data-val-fileextensions-extensions", Attribute.Extensions.ToLowerInvariant()); MergeAttribute(context.Attributes, "data-val-fileextensions-extensions", _extensions);
} }
/// <inheritdoc /> /// <inheritdoc />
@ -39,7 +51,7 @@ namespace Microsoft.AspNetCore.Mvc.DataAnnotations.Internal
return GetErrorMessage( return GetErrorMessage(
validationContext.ModelMetadata, validationContext.ModelMetadata,
validationContext.ModelMetadata.GetDisplayName(), validationContext.ModelMetadata.GetDisplayName(),
Attribute.Extensions); _formattedExtensions);
} }
} }
} }

View File

@ -1,7 +1,6 @@
// Copyright (c) .NET Foundation. All rights reserved. // 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. // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System.Linq;
using System.ComponentModel.DataAnnotations; using System.ComponentModel.DataAnnotations;
using Microsoft.AspNetCore.Mvc.DataAnnotations.Internal; using Microsoft.AspNetCore.Mvc.DataAnnotations.Internal;
using Microsoft.AspNetCore.Mvc.ViewFeatures; using Microsoft.AspNetCore.Mvc.ViewFeatures;
@ -15,26 +14,24 @@ namespace Microsoft.AspNetCore.Mvc.ModelBinding.Validation
public class FileExtensionsAttributeAdapterTest public class FileExtensionsAttributeAdapterTest
{ {
[Theory] [Theory]
[InlineData("jpg,png")] [InlineData("", ".png,.jpg,.jpeg,.gif")]
[InlineData("jpg, png")] [InlineData(null, ".png,.jpg,.jpeg,.gif")]
[InlineData("JPEG, Png")]
[ReplaceCulture] [ReplaceCulture]
public void AddValidation_WithoutLocalization(string extensions) public void AddValidation_WithoutLocalizationAndDefaultFileExtensions(string extensions, string expectedExtensions)
{ {
// Arrange // Arrange
var provider = TestModelMetadataProvider.CreateDefaultProvider(); var provider = TestModelMetadataProvider.CreateDefaultProvider();
var metadata = provider.GetMetadataForProperty(typeof(Profile), "PhotoFileName"); var metadata = provider.GetMetadataForProperty(typeof(Profile), nameof(Profile.PhotoFileName));
var attribute = new FileExtensionsAttribute() { Extensions = extensions }; var attribute = new FileExtensionsAttribute() { Extensions = extensions };
attribute.ErrorMessage = "{0} expects only the following extensions: {1}"; attribute.ErrorMessage = "{0} expects only the following extensions: {1}";
var expectedExtensions = string.Join(", ", extensions.Split(',').Select(s => $".{s.Trim().ToLowerInvariant()}")); // FileExtensionsAttribute formats the extension list for the error message
var expectedMessage = $"PhotoFileName expects only the following extensions: {expectedExtensions}"; var formattedExtensions = string.Join(", ", expectedExtensions.Split(','));
var expectedErrorMessage = string.Format(attribute.ErrorMessage, nameof(Profile.PhotoFileName), formattedExtensions);
var adapter = new FileExtensionsAttributeAdapter(attribute, stringLocalizer: null); var adapter = new FileExtensionsAttributeAdapter(attribute, stringLocalizer: null);
var context = new ClientModelValidationContext(new ActionContext(), metadata, provider, new AttributeDictionary());
var actionContext = new ActionContext();
var context = new ClientModelValidationContext(actionContext, metadata, provider, new AttributeDictionary());
// Act // Act
adapter.AddValidation(context); adapter.AddValidation(context);
@ -43,33 +40,84 @@ namespace Microsoft.AspNetCore.Mvc.ModelBinding.Validation
Assert.Collection( Assert.Collection(
context.Attributes, context.Attributes,
kvp => { Assert.Equal("data-val", kvp.Key); Assert.Equal("true", kvp.Value); }, kvp => { Assert.Equal("data-val", kvp.Key); Assert.Equal("true", kvp.Value); },
kvp => { Assert.Equal("data-val-fileextensions", kvp.Key); Assert.Equal(expectedMessage, kvp.Value); }, kvp => { Assert.Equal("data-val-fileextensions", kvp.Key); Assert.Equal(expectedErrorMessage, kvp.Value); },
kvp => { Assert.Equal("data-val-fileextensions-extensions", kvp.Key); Assert.Equal(extensions.ToLowerInvariant(), kvp.Value); }); kvp => { Assert.Equal("data-val-fileextensions-extensions", kvp.Key); Assert.Equal(expectedExtensions, kvp.Value); });
} }
[Fact] public static TheoryData<string, string> ExtensionsData
{
get
{
return new TheoryData<string, string>()
{
{ "jpg", ".jpg" },
{ " j p g ", ".jpg" },
{ ".jpg", ".jpg" },
{ ".x", ".x" },
{ "jpg,png", ".jpg,.png" },
{ "jpg, png", ".jpg,.png" },
{ "JPG, Png", ".jpg,.png" },
{ ".jpg,.png", ".jpg,.png" },
{ "..jpg,..png", ".jpg,.png" },
{ ".TXT, .png", ".txt,.png" },
{ ".pdf , .docx", ".pdf,.docx" },
};
}
}
[Theory]
[MemberData(nameof(ExtensionsData))]
[ReplaceCulture] [ReplaceCulture]
public void AddValidation_WithLocalization() public void AddValidation_WithoutLocalizationAndCustomFileExtensions(string extensions, string expectedExtensions)
{ {
// Arrange // Arrange
var provider = TestModelMetadataProvider.CreateDefaultProvider(); var provider = TestModelMetadataProvider.CreateDefaultProvider();
var metadata = provider.GetMetadataForProperty(typeof(Profile), "PhotoFileName"); var metadata = provider.GetMetadataForProperty(typeof(Profile), nameof(Profile.PhotoFileName));
var attribute = new FileExtensionsAttribute() { Extensions = "jpg" }; var attribute = new FileExtensionsAttribute() { Extensions = extensions };
attribute.ErrorMessage = "{0} expects only the following extensions: {1}"; attribute.ErrorMessage = "{0} expects only the following extensions: {1}";
var expectedProperties = new object[] { "PhotoFileName", "jpg" }; // FileExtensionsAttribute formats the extension list for the error message
var expectedMessage = "PhotoFileName expects only the following extensions: jpg"; var formattedExtensions = string.Join(", ", expectedExtensions.Split(','));
var expectedErrorMessage = string.Format(attribute.ErrorMessage, nameof(Profile.PhotoFileName), formattedExtensions);
var adapter = new FileExtensionsAttributeAdapter(attribute, stringLocalizer: null);
var context = new ClientModelValidationContext(new ActionContext(), metadata, provider, new AttributeDictionary());
// Act
adapter.AddValidation(context);
// Assert
Assert.Collection(
context.Attributes,
kvp => { Assert.Equal("data-val", kvp.Key); Assert.Equal("true", kvp.Value); },
kvp => { Assert.Equal("data-val-fileextensions", kvp.Key); Assert.Equal(expectedErrorMessage, kvp.Value); },
kvp => { Assert.Equal("data-val-fileextensions-extensions", kvp.Key); Assert.Equal(expectedExtensions, kvp.Value); });
}
[Theory]
[MemberData(nameof(ExtensionsData))]
[ReplaceCulture]
public void AddValidation_WithLocalization(string extensions, string expectedExtensions)
{
// Arrange
var provider = TestModelMetadataProvider.CreateDefaultProvider();
var metadata = provider.GetMetadataForProperty(typeof(Profile), nameof(Profile.PhotoFileName));
var attribute = new FileExtensionsAttribute() { Extensions = extensions };
attribute.ErrorMessage = "{0} expects only the following extensions: {1}";
var formattedExtensions = string.Join(", ", expectedExtensions.Split(','));
var expectedProperties = new object[] { "PhotoFileName", formattedExtensions };
var expectedErrorMessage = $"{nameof(Profile.PhotoFileName)} expects only the following extensions: {formattedExtensions}";
var stringLocalizer = new Mock<IStringLocalizer>(); var stringLocalizer = new Mock<IStringLocalizer>();
stringLocalizer stringLocalizer
.Setup(s => s[attribute.ErrorMessage, expectedProperties]) .Setup(s => s[attribute.ErrorMessage, expectedProperties])
.Returns(new LocalizedString(attribute.ErrorMessage, expectedMessage)); .Returns(new LocalizedString(attribute.ErrorMessage, expectedErrorMessage));
var adapter = new FileExtensionsAttributeAdapter(attribute, stringLocalizer: stringLocalizer.Object); var adapter = new FileExtensionsAttributeAdapter(attribute, stringLocalizer: stringLocalizer.Object);
var context = new ClientModelValidationContext(new ActionContext(), metadata, provider, new AttributeDictionary());
var actionContext = new ActionContext();
var context = new ClientModelValidationContext(actionContext, metadata, provider, new AttributeDictionary());
// Act // Act
adapter.AddValidation(context); adapter.AddValidation(context);
@ -78,8 +126,8 @@ namespace Microsoft.AspNetCore.Mvc.ModelBinding.Validation
Assert.Collection( Assert.Collection(
context.Attributes, context.Attributes,
kvp => { Assert.Equal("data-val", kvp.Key); Assert.Equal("true", kvp.Value); }, kvp => { Assert.Equal("data-val", kvp.Key); Assert.Equal("true", kvp.Value); },
kvp => { Assert.Equal("data-val-fileextensions", kvp.Key); Assert.Equal(expectedMessage, kvp.Value); }, kvp => { Assert.Equal("data-val-fileextensions", kvp.Key); Assert.Equal(expectedErrorMessage, kvp.Value); },
kvp => { Assert.Equal("data-val-fileextensions-extensions", kvp.Key); Assert.Equal("jpg", kvp.Value); }); kvp => { Assert.Equal("data-val-fileextensions-extensions", kvp.Key); Assert.Equal(expectedExtensions, kvp.Value); });
} }
[Fact] [Fact]
@ -92,11 +140,9 @@ namespace Microsoft.AspNetCore.Mvc.ModelBinding.Validation
var attribute = new FileExtensionsAttribute() { Extensions = "jpg" }; var attribute = new FileExtensionsAttribute() { Extensions = "jpg" };
attribute.ErrorMessage = "{0} expects only the following extensions: {1}"; attribute.ErrorMessage = "{0} expects only the following extensions: {1}";
var adapter = new FileExtensionsAttributeAdapter(attribute, stringLocalizer: null);
var actionContext = new ActionContext(); var adapter = new FileExtensionsAttributeAdapter(attribute, stringLocalizer: null);
var context = new ClientModelValidationContext(actionContext, metadata, provider, new AttributeDictionary()); var context = new ClientModelValidationContext(new ActionContext(), metadata, provider, new AttributeDictionary());
context.Attributes.Add("data-val", "original"); context.Attributes.Add("data-val", "original");
context.Attributes.Add("data-val-fileextensions", "original"); context.Attributes.Add("data-val-fileextensions", "original");