Skip to content

Respect JsonSerializerOptions in validation errors #62341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 79 additions & 6 deletions src/Validation/src/ValidatablePropertyInfo.cs
Original file line number Diff line number Diff line change
@@ -3,6 +3,9 @@

using System.ComponentModel.DataAnnotations;
using System.Diagnostics.CodeAnalysis;
using System.Reflection;
using System.Text.Json;
using System.Text.Json.Serialization;

namespace Microsoft.Extensions.Validation;

@@ -13,12 +16,13 @@ namespace Microsoft.Extensions.Validation;
public abstract class ValidatablePropertyInfo : IValidatableInfo
{
private RequiredAttribute? _requiredAttribute;
private readonly bool _hasDisplayAttribute;

/// <summary>
/// Creates a new instance of <see cref="ValidatablePropertyInfo"/>.
/// </summary>
protected ValidatablePropertyInfo(
[param: DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicProperties)]
[param: DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicConstructors)]
Type declaringType,
Type propertyType,
string name,
@@ -28,12 +32,18 @@ protected ValidatablePropertyInfo(
PropertyType = propertyType;
Name = name;
DisplayName = displayName;

// Cache the HasDisplayAttribute result to avoid repeated reflection calls
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Comment about why we don't use the name from the attribute

And maybe we should set DisplayName to the attributes value if the provided value happens to be null? (I know the API definition says non-null but...)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And maybe we should set DisplayName to the attributes value if the provided value happens to be null? (I know the API definition says non-null but...)

What would this help with?

// We only check for the existence of the DisplayAttribute here and not the
// Name value itself since we rely on the source generator populating it
var property = DeclaringType.GetProperty(Name);
Copy link
Preview

Copilot AI Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider specifying explicit BindingFlags (e.g. BindingFlags.Public | BindingFlags.Instance) with GetProperty to ensure the lookup behavior is unambiguous.

Suggested change
var property = DeclaringType.GetProperty(Name);
var property = DeclaringType.GetProperty(Name, BindingFlags.Public | BindingFlags.Instance);

Copilot uses AI. Check for mistakes.

_hasDisplayAttribute = property is not null && HasDisplayAttribute(property);
}

/// <summary>
/// Gets the member type.
/// </summary>
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicProperties)]
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicConstructors)]
internal Type DeclaringType { get; }

/// <summary>
@@ -65,18 +75,24 @@ public virtual async Task ValidateAsync(object? value, ValidateContext context,
var validationAttributes = GetValidationAttributes();

// Calculate and save the current path
var namingPolicy = context.SerializerOptions?.PropertyNamingPolicy;
var memberName = GetJsonPropertyName(Name, property, namingPolicy);
var originalPrefix = context.CurrentValidationPath;
if (string.IsNullOrEmpty(originalPrefix))
{
context.CurrentValidationPath = Name;
context.CurrentValidationPath = memberName;
}
else
{
context.CurrentValidationPath = $"{originalPrefix}.{Name}";
context.CurrentValidationPath = $"{originalPrefix}.{memberName}";
}

context.ValidationContext.DisplayName = DisplayName;
context.ValidationContext.MemberName = Name;
// Format the display name and member name according to JsonPropertyName attribute first, then naming policy
// If the property has a [Display] attribute (either on property or record parameter), use DisplayName directly without formatting
context.ValidationContext.DisplayName = _hasDisplayAttribute
? DisplayName
: GetJsonPropertyName(DisplayName, property, namingPolicy);
context.ValidationContext.MemberName = memberName;

// Check required attribute first
if (_requiredAttribute is not null || validationAttributes.TryGetRequiredAttribute(out _requiredAttribute))
@@ -172,4 +188,61 @@ void ValidateValue(object? val, string name, string errorPrefix, ValidationAttri
}
}
}

/// <summary>
/// Gets the effective member name for JSON serialization, considering <see cref="JsonPropertyNameAttribute"/> and naming policy.
/// </summary>
/// <param name="targetValue">The target value to get the name for.</param>
/// <param name="property">The property info to get the name for.</param>
/// <param name="namingPolicy">The JSON naming policy to apply if no <see cref="JsonPropertyNameAttribute"/> is present.</param>
/// <returns>The effective property name for JSON serialization.</returns>
private static string GetJsonPropertyName(string targetValue, PropertyInfo property, JsonNamingPolicy? namingPolicy)
{
var jsonPropertyName = property.GetCustomAttribute<JsonPropertyNameAttribute>()?.Name;

if (jsonPropertyName is not null)
{
return jsonPropertyName;
}

if (namingPolicy is not null)
{
return namingPolicy.ConvertName(targetValue);
}

return targetValue;
}

/// <summary>
/// Determines whether the property has a <see cref="DisplayAttribute"/>, either directly on the property
/// or on the corresponding constructor parameter if the declaring type is a record.
/// </summary>
/// <param name="property">The property to check.</param>
/// <returns>True if the property has a <see cref="DisplayAttribute"/> , false otherwise.</returns>
private bool HasDisplayAttribute(PropertyInfo property)
{
// Check if the property itself has the DisplayAttribute with a valid Name
if (property.GetCustomAttribute<DisplayAttribute>() is { Name: not null })
{
return true;
}

// Look for a constructor parameter matching the property name (case-insensitive)
// to account for the record scenario
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and primary ctors?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite since there isn't the same case-based 1:1 mapping between property names and parameter names when using primary constructors. It's a variation of #61526.

foreach (var constructor in DeclaringType.GetConstructors())
{
foreach (var parameter in constructor.GetParameters())
{
if (string.Equals(parameter.Name, property.Name, StringComparison.OrdinalIgnoreCase))
{
if (parameter.GetCustomAttribute<DisplayAttribute>() is { Name: not null })
{
return true;
}
}
}
}

return false;
}
}
8 changes: 6 additions & 2 deletions src/Validation/src/ValidatableTypeInfo.cs
Original file line number Diff line number Diff line change
@@ -106,9 +106,13 @@ public virtual async Task ValidateAsync(object? value, ValidateContext context,
// Create a validation error for each member name that is provided
foreach (var memberName in validationResult.MemberNames)
{
// Format the member name using JsonSerializerOptions naming policy if available
// Note: we don't respect [JsonPropertyName] here because we have no context of the property being validated.
var formattedMemberName = context.SerializerOptions?.PropertyNamingPolicy?.ConvertName(memberName) ?? memberName;

var key = string.IsNullOrEmpty(originalPrefix) ?
memberName :
$"{originalPrefix}.{memberName}";
formattedMemberName :
$"{originalPrefix}.{formattedMemberName}";
context.AddOrExtendValidationError(memberName, key, validationResult.ErrorMessage, value);
}

51 changes: 49 additions & 2 deletions src/Validation/src/ValidateContext.cs
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

using System.ComponentModel.DataAnnotations;
using System.Diagnostics.CodeAnalysis;
using System.Text.Json;
using Microsoft.Extensions.Options;

namespace Microsoft.Extensions.Validation;

@@ -60,6 +62,52 @@ public sealed class ValidateContext
/// </summary>
public int CurrentDepth { get; set; }

private JsonSerializerOptions? _cachedSerializerOptions;
private bool _serializerOptionsResolved;

internal JsonSerializerOptions? SerializerOptions
{
get
{
if (_serializerOptionsResolved)
{
return _cachedSerializerOptions;
}

_cachedSerializerOptions = ResolveSerializerOptions();
_serializerOptionsResolved = true;
return _cachedSerializerOptions;
}
}

/// <summary>
/// Attempts to resolve the <see cref="JsonSerializerOptions"/> used for serialization
/// using reflection to access JsonOptions from the ASP.NET Core shared framework.
/// </summary>
private JsonSerializerOptions? ResolveSerializerOptions()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How AOT friendly is this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's generally safe. The main issue would be the resolution of the IOptions<JsonOptions> type but since that's always configured in the DI container for ASP.NET Core apps, I don't expect it to be trimmed away. The other issue would beJsonOptions.SerializerOptions but I don't think that's likely to be trimmed away given how it's referenced in the framework.

I am long overdue for adding a native AoT test project to this package... :/

{
var targetType = "Microsoft.AspNetCore.Http.Json.JsonOptions, Microsoft.AspNetCore.Http.Extensions";
var jsonOptionsType = Type.GetType(targetType, throwOnError: false);
if (jsonOptionsType is null)
{
return null;
}

var iOptionsType = typeof(IOptions<>).MakeGenericType(jsonOptionsType);

var optionsObj = ValidationContext.GetService(iOptionsType);
if (optionsObj is null)
{
return null;
}

var valueProp = iOptionsType.GetProperty("Value")!;
var jsonOptions = valueProp.GetValue(optionsObj);
var serializerProp = jsonOptionsType.GetProperty("SerializerOptions")!;

return serializerProp.GetValue(jsonOptions) as JsonSerializerOptions;
}

/// <summary>
/// Optional event raised when a validation error is reported.
/// </summary>
@@ -68,7 +116,6 @@ public sealed class ValidateContext
internal void AddValidationError(string propertyName, string key, string[] error, object? container)
{
ValidationErrors ??= [];

ValidationErrors[key] = error;
OnValidationError?.Invoke(new ValidationErrorContext
{
@@ -110,7 +157,7 @@ internal void AddOrExtendValidationError(string name, string key, string error,

if (ValidationErrors.TryGetValue(key, out var existingErrors) && !existingErrors.Contains(error))
{
ValidationErrors[key] = [.. existingErrors, error];
ValidationErrors[key] = [..existingErrors, error];
}
else
{
Original file line number Diff line number Diff line change
@@ -126,8 +126,8 @@ async Task InvalidIntegerWithRangeProducesError(Endpoint endpoint)
var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors, kvp =>
{
Assert.Equal("IntegerWithRange", kvp.Key);
Assert.Equal("The field IntegerWithRange must be between 10 and 100.", kvp.Value.Single());
Assert.Equal("integerWithRange", kvp.Key);
Assert.Equal("The field integerWithRange must be between 10 and 100.", kvp.Value.Single());
});
}

@@ -145,7 +145,7 @@ async Task InvalidIntegerWithRangeAndDisplayNameProducesError(Endpoint endpoint)
var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors, kvp =>
{
Assert.Equal("IntegerWithRangeAndDisplayName", kvp.Key);
Assert.Equal("integerWithRangeAndDisplayName", kvp.Key);
Assert.Equal("The field Valid identifier must be between 10 and 100.", kvp.Value.Single());
});
}
@@ -164,8 +164,8 @@ async Task MissingRequiredSubtypePropertyProducesError(Endpoint endpoint)
var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors, kvp =>
{
Assert.Equal("PropertyWithMemberAttributes", kvp.Key);
Assert.Equal("The PropertyWithMemberAttributes field is required.", kvp.Value.Single());
Assert.Equal("propertyWithMemberAttributes", kvp.Key);
Assert.Equal("The propertyWithMemberAttributes field is required.", kvp.Value.Single());
});
}

@@ -187,13 +187,13 @@ async Task InvalidRequiredSubtypePropertyProducesError(Endpoint endpoint)
Assert.Collection(problemDetails.Errors,
kvp =>
{
Assert.Equal("PropertyWithMemberAttributes.RequiredProperty", kvp.Key);
Assert.Equal("The RequiredProperty field is required.", kvp.Value.Single());
Assert.Equal("propertyWithMemberAttributes.requiredProperty", kvp.Key);
Assert.Equal("The requiredProperty field is required.", kvp.Value.Single());
},
kvp =>
{
Assert.Equal("PropertyWithMemberAttributes.StringWithLength", kvp.Key);
Assert.Equal("The field StringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
Assert.Equal("propertyWithMemberAttributes.stringWithLength", kvp.Key);
Assert.Equal("The field stringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
});
}

@@ -216,18 +216,18 @@ async Task InvalidSubTypeWithInheritancePropertyProducesError(Endpoint endpoint)
Assert.Collection(problemDetails.Errors,
kvp =>
{
Assert.Equal("PropertyWithInheritance.EmailString", kvp.Key);
Assert.Equal("The EmailString field is not a valid e-mail address.", kvp.Value.Single());
Assert.Equal("propertyWithInheritance.emailString", kvp.Key);
Assert.Equal("The emailString field is not a valid e-mail address.", kvp.Value.Single());
},
kvp =>
{
Assert.Equal("PropertyWithInheritance.RequiredProperty", kvp.Key);
Assert.Equal("The RequiredProperty field is required.", kvp.Value.Single());
Assert.Equal("propertyWithInheritance.requiredProperty", kvp.Key);
Assert.Equal("The requiredProperty field is required.", kvp.Value.Single());
},
kvp =>
{
Assert.Equal("PropertyWithInheritance.StringWithLength", kvp.Key);
Assert.Equal("The field StringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
Assert.Equal("propertyWithInheritance.stringWithLength", kvp.Key);
Assert.Equal("The field stringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
});
}

@@ -259,18 +259,18 @@ async Task InvalidListOfSubTypesProducesError(Endpoint endpoint)
Assert.Collection(problemDetails.Errors,
kvp =>
{
Assert.Equal("ListOfSubTypes[0].RequiredProperty", kvp.Key);
Assert.Equal("The RequiredProperty field is required.", kvp.Value.Single());
Assert.Equal("listOfSubTypes[0].requiredProperty", kvp.Key);
Assert.Equal("The requiredProperty field is required.", kvp.Value.Single());
},
kvp =>
{
Assert.Equal("ListOfSubTypes[0].StringWithLength", kvp.Key);
Assert.Equal("The field StringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
Assert.Equal("listOfSubTypes[0].stringWithLength", kvp.Key);
Assert.Equal("The field stringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
},
kvp =>
{
Assert.Equal("ListOfSubTypes[1].StringWithLength", kvp.Key);
Assert.Equal("The field StringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
Assert.Equal("listOfSubTypes[1].stringWithLength", kvp.Key);
Assert.Equal("The field stringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
});
}

@@ -288,7 +288,7 @@ async Task InvalidPropertyWithDerivedValidationAttributeProducesError(Endpoint e
var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors, kvp =>
{
Assert.Equal("IntegerWithDerivedValidationAttribute", kvp.Key);
Assert.Equal("integerWithDerivedValidationAttribute", kvp.Key);
Assert.Equal("Value must be an even number", kvp.Value.Single());
});
}
@@ -297,7 +297,7 @@ async Task InvalidPropertyWithMultipleAttributesProducesError(Endpoint endpoint)
{
var payload = """
{
"PropertyWithMultipleAttributes": 5
"propertyWithMultipleAttributes": 5
}
""";
var context = CreateHttpContextWithPayload(payload, serviceProvider);
@@ -307,15 +307,15 @@ async Task InvalidPropertyWithMultipleAttributesProducesError(Endpoint endpoint)
var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors, kvp =>
{
Assert.Equal("PropertyWithMultipleAttributes", kvp.Key);
Assert.Equal("propertyWithMultipleAttributes", kvp.Key);
Assert.Collection(kvp.Value,
error =>
{
Assert.Equal("The field PropertyWithMultipleAttributes is invalid.", error);
Assert.Equal("The field propertyWithMultipleAttributes is invalid.", error);
},
error =>
{
Assert.Equal("The field PropertyWithMultipleAttributes must be between 10 and 100.", error);
Assert.Equal("The field propertyWithMultipleAttributes must be between 10 and 100.", error);
});
});
}
@@ -335,7 +335,7 @@ async Task InvalidPropertyWithCustomValidationProducesError(Endpoint endpoint)
var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors, kvp =>
{
Assert.Equal("IntegerWithCustomValidation", kvp.Key);
Assert.Equal("integerWithCustomValidation", kvp.Key);
var error = Assert.Single(kvp.Value);
Assert.Equal("Can't use the same number value in two properties on the same class.", error);
});
Original file line number Diff line number Diff line change
@@ -128,23 +128,23 @@ async Task ValidateMethodCalledIfPropertyValidationsFail()
Assert.Collection(problemDetails.Errors,
error =>
{
Assert.Equal("Value2", error.Key);
Assert.Equal("value2", error.Key);
Assert.Collection(error.Value,
msg => Assert.Equal("The Value2 field is required.", msg));
msg => Assert.Equal("The value2 field is required.", msg));
},
error =>
{
Assert.Equal("SubType.RequiredProperty", error.Key);
Assert.Equal("The RequiredProperty field is required.", error.Value.Single());
Assert.Equal("subType.requiredProperty", error.Key);
Assert.Equal("The requiredProperty field is required.", error.Value.Single());
},
error =>
{
Assert.Equal("SubType.Value3", error.Key);
Assert.Equal("subType.value3", error.Key);
Assert.Equal("The field ValidatableSubType must be 'some-value'.", error.Value.Single());
},
error =>
{
Assert.Equal("Value1", error.Key);
Assert.Equal("value1", error.Key);
Assert.Equal("The field Value1 must be between 10 and 100.", error.Value.Single());
});
}
@@ -169,12 +169,12 @@ async Task ValidateForSubtypeInvokedFirst()
Assert.Collection(problemDetails.Errors,
error =>
{
Assert.Equal("SubType.Value3", error.Key);
Assert.Equal("subType.value3", error.Key);
Assert.Equal("The field ValidatableSubType must be 'some-value'.", error.Value.Single());
},
error =>
{
Assert.Equal("Value1", error.Key);
Assert.Equal("value1", error.Key);
Assert.Equal("The field Value1 must be between 10 and 100.", error.Value.Single());
});
}
@@ -199,7 +199,7 @@ async Task ValidateForTopLevelInvoked()
Assert.Collection(problemDetails.Errors,
error =>
{
Assert.Equal("Value1", error.Key);
Assert.Equal("value1", error.Key);
Assert.Equal("The field Value1 must be between 10 and 100.", error.Value.Single());
});
}
Original file line number Diff line number Diff line change
@@ -69,8 +69,8 @@ async Task InvalidStringWithLengthProducesError(Endpoint endpoint)
var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors, kvp =>
{
Assert.Equal("StringWithLength", kvp.Key);
Assert.Equal("The field StringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
Assert.Equal("stringWithLength", kvp.Key);
Assert.Equal("The field stringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
});
}

@@ -106,8 +106,8 @@ async Task InvalidStringWithLengthProducesError(Endpoint endpoint)
var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors, kvp =>
{
Assert.Equal("StringWithLength", kvp.Key);
Assert.Equal("The field StringWithLength must be a string with a maximum length of 20.", kvp.Value.Single());
Assert.Equal("stringWithLength", kvp.Key);
Assert.Equal("The field stringWithLength must be a string with a maximum length of 20.", kvp.Value.Single());
});
}

Original file line number Diff line number Diff line change
@@ -173,8 +173,8 @@ await VerifyEndpoint(compilation, "/complex-type", async (endpoint, serviceProvi
var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors, kvp =>
{
Assert.Equal("IntegerWithRange", kvp.Key);
Assert.Equal("The field IntegerWithRange must be between 10 and 100.", kvp.Value.Single());
Assert.Equal("integerWithRange", kvp.Key);
Assert.Equal("The field integerWithRange must be between 10 and 100.", kvp.Value.Single());
});
});
}
Original file line number Diff line number Diff line change
@@ -88,32 +88,32 @@ await VerifyEndpoint(compilation, "/complex-type-with-parsable-properties", asyn
Assert.Collection(problemDetails.Errors.OrderBy(kvp => kvp.Key),
error =>
{
Assert.Equal("DateOnlyWithRange", error.Key);
Assert.Equal("dateOnlyWithRange", error.Key);
Assert.Contains("Date must be between 2023-01-01 and 2025-12-31", error.Value);
},
error =>
{
Assert.Equal("DecimalWithRange", error.Key);
Assert.Equal("decimalWithRange", error.Key);
Assert.Contains("Amount must be between 0.1 and 100.5", error.Value);
},
error =>
{
Assert.Equal("TimeOnlyWithRequiredValue", error.Key);
Assert.Contains("The TimeOnlyWithRequiredValue field is required.", error.Value);
Assert.Equal("timeOnlyWithRequiredValue", error.Key);
Assert.Contains("The timeOnlyWithRequiredValue field is required.", error.Value);
},
error =>
{
Assert.Equal("TimeSpanWithHourRange", error.Key);
Assert.Equal("timeSpanWithHourRange", error.Key);
Assert.Contains("Hours must be between 0 and 12", error.Value);
},
error =>
{
Assert.Equal("Url", error.Key);
Assert.Equal("url", error.Key);
Assert.Contains("The field Url must be a valid URL.", error.Value);
},
error =>
{
Assert.Equal("VersionWithRegex", error.Key);
Assert.Equal("versionWithRegex", error.Key);
Assert.Contains("Must be a valid version number (e.g. 1.0.0)", error.Value);
}
);
Original file line number Diff line number Diff line change
@@ -96,18 +96,18 @@ await VerifyEndpoint(compilation, "/basic-polymorphism", async (endpoint, servic
Assert.Collection(problemDetails.Errors,
error =>
{
Assert.Equal("Value3", error.Key);
Assert.Equal("The Value3 field is not a valid Base64 encoding.", error.Value.Single());
Assert.Equal("value3", error.Key);
Assert.Equal("The value3 field is not a valid Base64 encoding.", error.Value.Single());
},
error =>
{
Assert.Equal("Value1", error.Key);
Assert.Equal("value1", error.Key);
Assert.Equal("The field Value 1 must be between 10 and 100.", error.Value.Single());
},
error =>
{
Assert.Equal("Value2", error.Key);
Assert.Equal("The Value2 field is not a valid e-mail address.", error.Value.Single());
Assert.Equal("value2", error.Key);
Assert.Equal("The value2 field is not a valid e-mail address.", error.Value.Single());
});
});

@@ -127,12 +127,12 @@ await VerifyEndpoint(compilation, "/validatable-polymorphism", async (endpoint,
Assert.Collection(problemDetails.Errors,
error =>
{
Assert.Equal("Value3", error.Key);
Assert.Equal("The Value3 field is not a valid e-mail address.", error.Value.Single());
Assert.Equal("value3", error.Key);
Assert.Equal("The value3 field is not a valid e-mail address.", error.Value.Single());
},
error =>
{
Assert.Equal("Value1", error.Key);
Assert.Equal("value1", error.Key);
Assert.Equal("The field Value 1 must be between 10 and 100.", error.Value.Single());
});

@@ -150,7 +150,7 @@ await VerifyEndpoint(compilation, "/validatable-polymorphism", async (endpoint,
Assert.Collection(problemDetails1.Errors,
error =>
{
Assert.Equal("Value1", error.Key);
Assert.Equal("value1", error.Key);
Assert.Equal("The field Value 1 must be between 10 and 100.", error.Value.Single());
});
});
@@ -179,22 +179,22 @@ await VerifyEndpoint(compilation, "/polymorphism-container", async (endpoint, se
Assert.Collection(problemDetails.Errors,
error =>
{
Assert.Equal("BaseType.Value3", error.Key);
Assert.Equal("The Value3 field is not a valid Base64 encoding.", error.Value.Single());
Assert.Equal("baseType.value3", error.Key);
Assert.Equal("The value3 field is not a valid Base64 encoding.", error.Value.Single());
},
error =>
{
Assert.Equal("BaseType.Value1", error.Key);
Assert.Equal("baseType.value1", error.Key);
Assert.Equal("The field Value 1 must be between 10 and 100.", error.Value.Single());
},
error =>
{
Assert.Equal("BaseType.Value2", error.Key);
Assert.Equal("The Value2 field is not a valid e-mail address.", error.Value.Single());
Assert.Equal("baseType.value2", error.Key);
Assert.Equal("The value2 field is not a valid e-mail address.", error.Value.Single());
},
error =>
{
Assert.Equal("BaseValidatableType.Value1", error.Key);
Assert.Equal("baseValidatableType.value1", error.Key);
Assert.Equal("The field Value 1 must be between 10 and 100.", error.Value.Single());
});
});
Original file line number Diff line number Diff line change
@@ -113,8 +113,8 @@ async Task InvalidIntegerWithRangeProducesError(Endpoint endpoint)
var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors, kvp =>
{
Assert.Equal("IntegerWithRange", kvp.Key);
Assert.Equal("The field IntegerWithRange must be between 10 and 100.", kvp.Value.Single());
Assert.Equal("integerWithRange", kvp.Key);
Assert.Equal("The field integerWithRange must be between 10 and 100.", kvp.Value.Single());
});
}

@@ -132,7 +132,7 @@ async Task InvalidIntegerWithRangeAndDisplayNameProducesError(Endpoint endpoint)
var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors, kvp =>
{
Assert.Equal("IntegerWithRangeAndDisplayName", kvp.Key);
Assert.Equal("integerWithRangeAndDisplayName", kvp.Key);
Assert.Equal("The field Valid identifier must be between 10 and 100.", kvp.Value.Single());
});
}
@@ -151,18 +151,17 @@ async Task InvalidRequiredSubtypePropertyProducesError(Endpoint endpoint)

await endpoint.RequestDelegate(context);

var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors,
kvp =>
{
Assert.Equal("PropertyWithMemberAttributes.RequiredProperty", kvp.Key);
Assert.Equal("The RequiredProperty field is required.", kvp.Value.Single());
},
kvp =>
{
Assert.Equal("PropertyWithMemberAttributes.StringWithLength", kvp.Key);
Assert.Equal("The field StringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
});
var problemDetails = await AssertBadRequest(context); Assert.Collection(problemDetails.Errors,
kvp =>
{
Assert.Equal("propertyWithMemberAttributes.requiredProperty", kvp.Key);
Assert.Equal("The requiredProperty field is required.", kvp.Value.Single());
},
kvp =>
{
Assert.Equal("propertyWithMemberAttributes.stringWithLength", kvp.Key);
Assert.Equal("The field stringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
});
}

async Task InvalidSubTypeWithInheritancePropertyProducesError(Endpoint endpoint)
@@ -180,23 +179,22 @@ async Task InvalidSubTypeWithInheritancePropertyProducesError(Endpoint endpoint)

await endpoint.RequestDelegate(context);

var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors,
kvp =>
{
Assert.Equal("PropertyWithInheritance.EmailString", kvp.Key);
Assert.Equal("The EmailString field is not a valid e-mail address.", kvp.Value.Single());
},
kvp =>
{
Assert.Equal("PropertyWithInheritance.RequiredProperty", kvp.Key);
Assert.Equal("The RequiredProperty field is required.", kvp.Value.Single());
},
kvp =>
{
Assert.Equal("PropertyWithInheritance.StringWithLength", kvp.Key);
Assert.Equal("The field StringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
});
var problemDetails = await AssertBadRequest(context); Assert.Collection(problemDetails.Errors,
kvp =>
{
Assert.Equal("propertyWithInheritance.emailString", kvp.Key);
Assert.Equal("The emailString field is not a valid e-mail address.", kvp.Value.Single());
},
kvp =>
{
Assert.Equal("propertyWithInheritance.requiredProperty", kvp.Key);
Assert.Equal("The requiredProperty field is required.", kvp.Value.Single());
},
kvp =>
{
Assert.Equal("propertyWithInheritance.stringWithLength", kvp.Key);
Assert.Equal("The field stringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
});
}

async Task InvalidListOfSubTypesProducesError(Endpoint endpoint)
@@ -223,23 +221,22 @@ async Task InvalidListOfSubTypesProducesError(Endpoint endpoint)

await endpoint.RequestDelegate(context);

var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors,
kvp =>
{
Assert.Equal("ListOfSubTypes[0].RequiredProperty", kvp.Key);
Assert.Equal("The RequiredProperty field is required.", kvp.Value.Single());
},
kvp =>
{
Assert.Equal("ListOfSubTypes[0].StringWithLength", kvp.Key);
Assert.Equal("The field StringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
},
kvp =>
{
Assert.Equal("ListOfSubTypes[1].StringWithLength", kvp.Key);
Assert.Equal("The field StringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
});
var problemDetails = await AssertBadRequest(context); Assert.Collection(problemDetails.Errors,
kvp =>
{
Assert.Equal("listOfSubTypes[0].requiredProperty", kvp.Key);
Assert.Equal("The requiredProperty field is required.", kvp.Value.Single());
},
kvp =>
{
Assert.Equal("listOfSubTypes[0].stringWithLength", kvp.Key);
Assert.Equal("The field stringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
},
kvp =>
{
Assert.Equal("listOfSubTypes[1].stringWithLength", kvp.Key);
Assert.Equal("The field stringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
});
}

async Task InvalidPropertyWithDerivedValidationAttributeProducesError(Endpoint endpoint)
@@ -256,7 +253,7 @@ async Task InvalidPropertyWithDerivedValidationAttributeProducesError(Endpoint e
var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors, kvp =>
{
Assert.Equal("IntegerWithDerivedValidationAttribute", kvp.Key);
Assert.Equal("integerWithDerivedValidationAttribute", kvp.Key);
Assert.Equal("Value must be an even number", kvp.Value.Single());
});
}
@@ -275,15 +272,15 @@ async Task InvalidPropertyWithMultipleAttributesProducesError(Endpoint endpoint)
var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors, kvp =>
{
Assert.Equal("PropertyWithMultipleAttributes", kvp.Key);
Assert.Equal("propertyWithMultipleAttributes", kvp.Key);
Assert.Collection(kvp.Value,
error =>
{
Assert.Equal("The field PropertyWithMultipleAttributes is invalid.", error);
Assert.Equal("The field propertyWithMultipleAttributes is invalid.", error);
},
error =>
{
Assert.Equal("The field PropertyWithMultipleAttributes must be between 10 and 100.", error);
Assert.Equal("The field propertyWithMultipleAttributes must be between 10 and 100.", error);
});
});
}
@@ -303,7 +300,7 @@ async Task InvalidPropertyWithCustomValidationProducesError(Endpoint endpoint)
var problemDetails = await AssertBadRequest(context);
Assert.Collection(problemDetails.Errors, kvp =>
{
Assert.Equal("IntegerWithCustomValidation", kvp.Key);
Assert.Equal("integerWithCustomValidation", kvp.Key);
var error = Assert.Single(kvp.Value);
Assert.Equal("Can't use the same number value in two properties on the same class.", error);
});
@@ -327,13 +324,13 @@ async Task InvalidPropertyOfSubtypeWithoutConstructorProducesError(Endpoint endp
Assert.Collection(problemDetails.Errors,
kvp =>
{
Assert.Equal("PropertyOfSubtypeWithoutConstructor.RequiredProperty", kvp.Key);
Assert.Equal("The RequiredProperty field is required.", kvp.Value.Single());
Assert.Equal("propertyOfSubtypeWithoutConstructor.requiredProperty", kvp.Key);
Assert.Equal("The requiredProperty field is required.", kvp.Value.Single());
},
kvp =>
{
Assert.Equal("PropertyOfSubtypeWithoutConstructor.StringWithLength", kvp.Key);
Assert.Equal("The field StringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
Assert.Equal("propertyOfSubtypeWithoutConstructor.stringWithLength", kvp.Key);
Assert.Equal("The field stringWithLength must be a string with a maximum length of 10.", kvp.Value.Single());
});
}

Original file line number Diff line number Diff line change
@@ -116,43 +116,43 @@ async Task ValidatesTypeWithLimitedNesting(Endpoint endpoint)
Assert.Collection(problemDetails.Errors,
error =>
{
Assert.Equal("Value", error.Key);
Assert.Equal("The field Value must be between 10 and 100.", error.Value.Single());
Assert.Equal("value", error.Key);
Assert.Equal("The field value must be between 10 and 100.", error.Value.Single());
},
error =>
{
Assert.Equal("Next.Value", error.Key);
Assert.Equal("The field Value must be between 10 and 100.", error.Value.Single());
Assert.Equal("next.value", error.Key);
Assert.Equal("The field value must be between 10 and 100.", error.Value.Single());
},
error =>
{
Assert.Equal("Next.Next.Value", error.Key);
Assert.Equal("The field Value must be between 10 and 100.", error.Value.Single());
Assert.Equal("next.next.value", error.Key);
Assert.Equal("The field value must be between 10 and 100.", error.Value.Single());
},
error =>
{
Assert.Equal("Next.Next.Next.Value", error.Key);
Assert.Equal("The field Value must be between 10 and 100.", error.Value.Single());
Assert.Equal("next.next.next.value", error.Key);
Assert.Equal("The field value must be between 10 and 100.", error.Value.Single());
},
error =>
{
Assert.Equal("Next.Next.Next.Next.Value", error.Key);
Assert.Equal("The field Value must be between 10 and 100.", error.Value.Single());
Assert.Equal("next.next.next.next.value", error.Key);
Assert.Equal("The field value must be between 10 and 100.", error.Value.Single());
},
error =>
{
Assert.Equal("Next.Next.Next.Next.Next.Value", error.Key);
Assert.Equal("The field Value must be between 10 and 100.", error.Value.Single());
Assert.Equal("next.next.next.next.next.value", error.Key);
Assert.Equal("The field value must be between 10 and 100.", error.Value.Single());
},
error =>
{
Assert.Equal("Next.Next.Next.Next.Next.Next.Value", error.Key);
Assert.Equal("The field Value must be between 10 and 100.", error.Value.Single());
Assert.Equal("next.next.next.next.next.next.value", error.Key);
Assert.Equal("The field value must be between 10 and 100.", error.Value.Single());
},
error =>
{
Assert.Equal("Next.Next.Next.Next.Next.Next.Next.Value", error.Key);
Assert.Equal("The field Value must be between 10 and 100.", error.Value.Single());
Assert.Equal("next.next.next.next.next.next.next.value", error.Key);
Assert.Equal("The field value must be between 10 and 100.", error.Value.Single());
});
}
});
Original file line number Diff line number Diff line change
@@ -8,6 +8,8 @@
<ItemGroup>
<Reference Include="Microsoft.Extensions.Validation" />
<Reference Include="Microsoft.Extensions.DependencyInjection" />
<Reference Include="Microsoft.AspNetCore.Http.Extensions" />
<Reference Include="Microsoft.Extensions.Options" />
</ItemGroup>

</Project>

Large diffs are not rendered by default.