├── .github └── workflows │ ├── Build.yaml │ └── Release.yaml ├── .gitignore ├── CODE_OF_CONDUCT.md ├── Directory.Build.props ├── FluentValidation.AutoValidation.Endpoints ├── FluentValidation.AutoValidation.Endpoints.csproj └── src │ ├── Configuration │ └── AutoValidationEndpointsConfiguration.cs │ ├── Extensions │ ├── EndpointRouteExtensions.cs │ └── ServiceCollectionExtensions.cs │ ├── Filters │ └── FluentValidationAutoValidationEndpointFilter.cs │ ├── Interceptors │ ├── IGlobalValidationInterceptor.cs │ └── IValidatorInterceptor.cs │ └── Results │ ├── FluentValidationAutoValidationDefaultResultFactory.cs │ └── IFluentValidationAutoValidationResultFactory.cs ├── FluentValidation.AutoValidation.Mvc ├── FluentValidation.AutoValidation.Mvc.csproj └── src │ ├── Attributes │ ├── AutoValidateAlwaysAttribute.cs │ ├── AutoValidateNeverAttribute.cs │ ├── AutoValidationAttribute.cs │ └── FluentValidationAutoValidationAttribute.cs │ ├── Configuration │ └── AutoValidationMvcConfiguration.cs │ ├── Enums │ └── ValidationStrategy.cs │ ├── Extensions │ └── ServiceCollectionExtensions.cs │ ├── Filters │ └── FluentValidationAutoValidationActionFilter.cs │ ├── Interceptors │ ├── IGlobalValidationInterceptor.cs │ └── IValidatorInterceptor.cs │ ├── Results │ ├── FluentValidationAutoValidationDefaultResultFactory.cs │ └── IFluentValidationAutoValidationResultFactory.cs │ └── Validation │ ├── FluentValidationAutoValidationObjectModelValidator.cs │ └── FluentValidationAutoValidationValidationVisitor.cs ├── FluentValidation.AutoValidation.Shared ├── FluentValidation.AutoValidation.Shared.csproj └── src │ └── Extensions │ ├── ParameterInfoExtensions.cs │ ├── ServiceProviderExtensions.cs │ ├── TypeExtensions.cs │ └── ValidationResultExtensions.cs ├── FluentValidation.AutoValidation.sln ├── LICENSE ├── README.md └── Tests ├── FluentValidation.AutoValidation.Tests.csproj └── src ├── FluentValidation.AutoValidation.Endpoints ├── Configuration │ └── AutoValidationEndpointsConfigurationTest.cs ├── Extensions │ └── ServiceCollectionExtensionsTest.cs ├── Filters │ └── FluentValidationAutoValidationEndpointFilterTest.cs └── Results │ └── FluentValidationAutoValidationDefaultResultFactoryTest.cs ├── FluentValidation.AutoValidation.Mvc ├── Configuration │ └── AutoValidationMvcConfigurationTest.cs ├── Extensions │ └── ServiceCollectionExtensionsTest.cs ├── Filters │ └── FluentValidationAutoValidationActionFilterTest.cs ├── Results │ └── FluentValidationAutoValidationDefaultResultFactoryTest.cs └── Validation │ ├── FluentValidationAutoValidationObjectModelValidatorTest.cs │ └── FluentValidationAutoValidationValidationVisitorTest.cs └── FluentValidation.AutoValidation.Shared └── Extensions ├── ServiceProviderExtensionsTest.cs ├── TypeExtensionsTest.cs └── ValidationResultExtensionsTest.cs /.github/workflows/Build.yaml: -------------------------------------------------------------------------------- 1 | name: FluentValidation.AutoValidation [Build] 2 | 3 | env: 4 | JAVA_VERSION: 17 5 | JAVA_DISTRIBUTION: microsoft 6 | DOTNET_VERSION: | 7 | 3.1.x 8 | 6.0.x 9 | 7.0.x 10 | 8.0.x 11 | 9.0.x 12 | DOTNET_BUILD_CONFIGURATION: Release 13 | SONAR_PATH: .\.sonar\scanner 14 | SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} 15 | SONAR_HOST: https://sonarcloud.io 16 | SONAR_ORGANIZATION: sharpgrip 17 | SONAR_PROJECT: SharpGrip_FluentValidation.AutoValidation 18 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 19 | 20 | on: 21 | workflow_dispatch: 22 | push: 23 | branches: 24 | - "**" 25 | 26 | jobs: 27 | build: 28 | runs-on: windows-latest 29 | 30 | steps: 31 | - name: Checkout 32 | uses: actions/checkout@v3 33 | with: 34 | fetch-depth: 0 35 | 36 | - name: Set up Java 37 | uses: actions/setup-java@v3 38 | with: 39 | java-version: ${{ env.JAVA_VERSION }} 40 | distribution: ${{ env.JAVA_DISTRIBUTION }} 41 | 42 | - name: Set up .NET 43 | uses: actions/setup-dotnet@v3 44 | with: 45 | dotnet-version: ${{ env.DOTNET_VERSION }} 46 | 47 | - name: Install dotnet-coverage 48 | shell: powershell 49 | run: dotnet tool install --global dotnet-coverage 50 | 51 | - name: Install SonarCloud scanner 52 | shell: powershell 53 | run: | 54 | New-Item -Path ${{ env.SONAR_PATH }} -ItemType Directory -Force 55 | dotnet tool update dotnet-sonarscanner --tool-path ${{ env.SONAR_PATH }} 56 | 57 | - name: Build solution 58 | run: dotnet build -c ${{ env.DOTNET_BUILD_CONFIGURATION }} /warnaserror /nowarn:CS0612,CS0618 59 | 60 | - name: Test solution 61 | run: dotnet test --no-build -c ${{ env.DOTNET_BUILD_CONFIGURATION }} --verbosity normal 62 | 63 | - name: Cleanup solution 64 | run: dotnet clean 65 | 66 | - name: Analyze solution 67 | shell: powershell 68 | run: | 69 | .\.sonar\scanner\dotnet-sonarscanner begin /k:"${{ env.SONAR_PROJECT }}" /o:"${{ env.SONAR_ORGANIZATION }}" /d:sonar.token="${{ env.SONAR_TOKEN }}" /d:sonar.host.url="${{ env.SONAR_HOST }}" /d:sonar.cs.vscoveragexml.reportsPaths=coverage.xml 70 | dotnet build -c ${{ env.DOTNET_BUILD_CONFIGURATION }} 71 | dotnet-coverage collect "dotnet test -c ${{ env.DOTNET_BUILD_CONFIGURATION }}" -f xml -o "coverage.xml" 72 | .\.sonar\scanner\dotnet-sonarscanner end /d:sonar.token="${{ env.SONAR_TOKEN }}" -------------------------------------------------------------------------------- /.github/workflows/Release.yaml: -------------------------------------------------------------------------------- 1 | name: FluentValidation.AutoValidation [Release] 2 | 3 | env: 4 | DOTNET_VERSION: 9.0.x 5 | DOTNET_BUILD_CONFIGURATION: Release 6 | DOTNET_PACKAGES_OUTPUT_DIRECTORY: .nuget 7 | NUGET_SOURCE: https://api.nuget.org/v3/index.json 8 | NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }} 9 | 10 | on: 11 | push: 12 | tags: 13 | - "*" 14 | 15 | jobs: 16 | build: 17 | runs-on: ubuntu-latest 18 | 19 | steps: 20 | - name: Checkout 21 | uses: actions/checkout@v3 22 | with: 23 | fetch-depth: 0 24 | 25 | - name: Set up .NET 26 | uses: actions/setup-dotnet@v3 27 | with: 28 | dotnet-version: ${{ env.DOTNET_VERSION }} 29 | 30 | - name: Pack packages 31 | run: dotnet pack --configuration ${{ env.DOTNET_BUILD_CONFIGURATION }} --output "${{ env.DOTNET_PACKAGES_OUTPUT_DIRECTORY }}" 32 | 33 | - name: Push packages 34 | run: dotnet nuget push "${{ env.DOTNET_PACKAGES_OUTPUT_DIRECTORY }}/*.nupkg" --source ${{ env.NUGET_SOURCE }} --api-key ${{ env.NUGET_API_KEY }} -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | .nuget/ 3 | NuGet/ 4 | [Oo]bj/ 5 | [Bb]in/ 6 | .DS_Store 7 | *.DotSettings.user 8 | .vs/ -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, sex characteristics, gender identity and expression, 9 | level of experience, education, socio-economic status, nationality, personal 10 | appearance, race, religion, or sexual identity and orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at info@sharpgrip.net. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 72 | 73 | [homepage]: https://www.contributor-covenant.org 74 | 75 | For answers to common questions about this code of conduct, see 76 | https://www.contributor-covenant.org/faq -------------------------------------------------------------------------------- /Directory.Build.props: -------------------------------------------------------------------------------- 1 | 2 | 3 | enable 4 | 8.0 5 | NU1701 6 | true 7 | true 8 | snupkg 9 | 10 | 11 | 12 | 1.5.0 13 | SharpGrip 14 | SharpGrip 15 | SharpGrip 16 | MIT 17 | README.md 18 | https://sharpgrip.net 19 | https://github.com/SharpGrip/FluentValidation.AutoValidation 20 | git 21 | 22 | 23 | 24 | true 25 | 26 | -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Endpoints/FluentValidation.AutoValidation.Endpoints.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | SharpGrip.FluentValidation.AutoValidation.Endpoints 5 | 6 | 7 | 8 | net7.0;net8.0;net9.0 9 | SharpGrip.FluentValidation.AutoValidation.Endpoints 10 | SharpGrip.FluentValidation.AutoValidation.Endpoints 11 | SharpGrip FluentValidation AutoValidation Endpoints 12 | SharpGrip FluentValidation AutoValidation Endpoints is an extension of the FluentValidation library enabling automatic asynchronous validation in minimal APIs (endpoints). 13 | sharpgrip;validation;fluent-validation;endpoints;minimal-api 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | all 23 | runtime; build; native; contentfiles; analyzers; buildtransitive 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Endpoints/src/Configuration/AutoValidationEndpointsConfiguration.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using Microsoft.AspNetCore.Http.HttpResults; 3 | using SharpGrip.FluentValidation.AutoValidation.Endpoints.Results; 4 | 5 | namespace SharpGrip.FluentValidation.AutoValidation.Endpoints.Configuration 6 | { 7 | public class AutoValidationEndpointsConfiguration 8 | { 9 | /// 10 | /// Holds the overridden result factory. This property is meant for infrastructure and should not be used by application code. 11 | /// 12 | public Type? OverriddenResultFactory { get; private set; } 13 | 14 | /// 15 | /// Overrides the default result factory with a custom result factory. Custom result factories are required to implement . 16 | /// The default result factory returns the validation errors wrapped in a object. 17 | /// 18 | /// 19 | /// The custom result factory implementing . 20 | public void OverrideDefaultResultFactoryWith() where TResultFactory : IFluentValidationAutoValidationResultFactory 21 | { 22 | OverriddenResultFactory = typeof(TResultFactory); 23 | } 24 | } 25 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Endpoints/src/Extensions/EndpointRouteExtensions.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.AspNetCore.Builder; 2 | using Microsoft.AspNetCore.Http; 3 | using Microsoft.AspNetCore.Routing; 4 | using SharpGrip.FluentValidation.AutoValidation.Endpoints.Filters; 5 | 6 | namespace SharpGrip.FluentValidation.AutoValidation.Endpoints.Extensions 7 | { 8 | public static class EndpointRouteExtensions 9 | { 10 | /// 11 | /// Adds asynchronous minimal API automatic validation to the specified . 12 | /// 13 | /// The route handler builder. 14 | /// The route handler builder. 15 | public static RouteHandlerBuilder AddFluentValidationAutoValidation(this RouteHandlerBuilder routeHandlerBuilder) 16 | { 17 | routeHandlerBuilder.AddEndpointFilter(); 18 | 19 | return routeHandlerBuilder; 20 | } 21 | 22 | /// 23 | /// Adds asynchronous minimal API Fluent Validation automatic validation to the specified . 24 | /// 25 | /// The route group builder. 26 | /// The route group builder. 27 | public static RouteGroupBuilder AddFluentValidationAutoValidation(this RouteGroupBuilder routeGroupBuilder) 28 | { 29 | routeGroupBuilder.AddEndpointFilter(); 30 | 31 | return routeGroupBuilder; 32 | } 33 | } 34 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Endpoints/src/Extensions/ServiceCollectionExtensions.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using Microsoft.Extensions.DependencyInjection; 3 | using Microsoft.Extensions.DependencyInjection.Extensions; 4 | using SharpGrip.FluentValidation.AutoValidation.Endpoints.Configuration; 5 | using SharpGrip.FluentValidation.AutoValidation.Endpoints.Results; 6 | 7 | namespace SharpGrip.FluentValidation.AutoValidation.Endpoints.Extensions 8 | { 9 | public static class ServiceCollectionExtensions 10 | { 11 | /// 12 | /// Adds asynchronous Endpoints Fluent Validation automatic validation to the specified . 13 | /// 14 | /// The service collection. 15 | /// The configuration delegate used to configure the FluentValidation AutoValidation Endpoints validation. 16 | /// The service collection. 17 | public static IServiceCollection AddFluentValidationAutoValidation(this IServiceCollection serviceCollection, 18 | Action? autoValidationEndpointsConfiguration = null) 19 | { 20 | var configuration = new AutoValidationEndpointsConfiguration(); 21 | 22 | if (autoValidationEndpointsConfiguration != null) 23 | { 24 | autoValidationEndpointsConfiguration.Invoke(configuration); 25 | serviceCollection.Configure(autoValidationEndpointsConfiguration); 26 | } 27 | 28 | // Add the default result factory. 29 | serviceCollection.AddScoped(); 30 | 31 | // If the custom result factory is not null, replace the default result factory with the overridden result factory. 32 | if (configuration.OverriddenResultFactory != null) 33 | { 34 | serviceCollection.Replace(new ServiceDescriptor(typeof(IFluentValidationAutoValidationResultFactory), configuration.OverriddenResultFactory, ServiceLifetime.Scoped)); 35 | } 36 | 37 | return serviceCollection; 38 | } 39 | } 40 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Endpoints/src/Filters/FluentValidationAutoValidationEndpointFilter.cs: -------------------------------------------------------------------------------- 1 | using System.Threading.Tasks; 2 | using FluentValidation; 3 | using Microsoft.AspNetCore.Http; 4 | using Microsoft.Extensions.DependencyInjection; 5 | using SharpGrip.FluentValidation.AutoValidation.Endpoints.Interceptors; 6 | using SharpGrip.FluentValidation.AutoValidation.Endpoints.Results; 7 | using SharpGrip.FluentValidation.AutoValidation.Shared.Extensions; 8 | 9 | namespace SharpGrip.FluentValidation.AutoValidation.Endpoints.Filters 10 | { 11 | public class FluentValidationAutoValidationEndpointFilter : IEndpointFilter 12 | { 13 | public async ValueTask InvokeAsync(EndpointFilterInvocationContext endpointFilterInvocationContext, EndpointFilterDelegate next) 14 | { 15 | var serviceProvider = endpointFilterInvocationContext.HttpContext.RequestServices; 16 | 17 | foreach (var argument in endpointFilterInvocationContext.Arguments) 18 | { 19 | if (argument != null && argument.GetType().IsCustomType() && serviceProvider.GetValidator(argument.GetType()) is IValidator validator) 20 | { 21 | // ReSharper disable once SuspiciousTypeConversion.Global 22 | var validatorInterceptor = validator as IValidatorInterceptor; 23 | var globalValidationInterceptor = serviceProvider.GetService(); 24 | 25 | IValidationContext validationContext = new ValidationContext(argument); 26 | 27 | if (validatorInterceptor != null) 28 | { 29 | validationContext = validatorInterceptor.BeforeValidation(endpointFilterInvocationContext, validationContext) ?? validationContext; 30 | } 31 | 32 | if (globalValidationInterceptor != null) 33 | { 34 | validationContext = globalValidationInterceptor.BeforeValidation(endpointFilterInvocationContext, validationContext) ?? validationContext; 35 | } 36 | 37 | var validationResult = await validator.ValidateAsync(validationContext, endpointFilterInvocationContext.HttpContext.RequestAborted); 38 | 39 | if (validatorInterceptor != null) 40 | { 41 | validationResult = validatorInterceptor.AfterValidation(endpointFilterInvocationContext, validationContext) ?? validationResult; 42 | } 43 | 44 | if (globalValidationInterceptor != null) 45 | { 46 | validationResult = globalValidationInterceptor.AfterValidation(endpointFilterInvocationContext, validationContext) ?? validationResult; 47 | } 48 | 49 | if (!validationResult.IsValid) 50 | { 51 | var fluentValidationAutoValidationResultFactory = serviceProvider.GetService(); 52 | 53 | if (fluentValidationAutoValidationResultFactory != null) 54 | { 55 | return fluentValidationAutoValidationResultFactory.CreateResult(endpointFilterInvocationContext, validationResult); 56 | } 57 | 58 | return new FluentValidationAutoValidationDefaultResultFactory().CreateResult(endpointFilterInvocationContext, validationResult); 59 | } 60 | } 61 | } 62 | 63 | return await next(endpointFilterInvocationContext); 64 | } 65 | } 66 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Endpoints/src/Interceptors/IGlobalValidationInterceptor.cs: -------------------------------------------------------------------------------- 1 | using FluentValidation; 2 | using FluentValidation.Results; 3 | using Microsoft.AspNetCore.Http; 4 | 5 | namespace SharpGrip.FluentValidation.AutoValidation.Endpoints.Interceptors 6 | { 7 | /// 8 | /// Allows global intercepting and altering of the validation process by implementing this interface on a custom class and registering it with the service collection. 9 | /// 10 | /// The interceptor methods of instances of this interface will get called on each validation attempt. 11 | /// 12 | public interface IGlobalValidationInterceptor 13 | { 14 | public IValidationContext? BeforeValidation(EndpointFilterInvocationContext endpointFilterInvocationContext, IValidationContext validationContext); 15 | public ValidationResult? AfterValidation(EndpointFilterInvocationContext endpointFilterInvocationContext, IValidationContext validationContext); 16 | } 17 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Endpoints/src/Interceptors/IValidatorInterceptor.cs: -------------------------------------------------------------------------------- 1 | namespace SharpGrip.FluentValidation.AutoValidation.Endpoints.Interceptors 2 | { 3 | /// 4 | /// Allows intercepting and altering of the validation process by implementing this interface on a validator. 5 | /// 6 | /// The interceptor methods of instances of this interface will only get called when the implementing validator gets validated. 7 | /// 8 | public interface IValidatorInterceptor : IGlobalValidationInterceptor 9 | { 10 | } 11 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Endpoints/src/Results/FluentValidationAutoValidationDefaultResultFactory.cs: -------------------------------------------------------------------------------- 1 | using FluentValidation.Results; 2 | using Microsoft.AspNetCore.Http; 3 | using SharpGrip.FluentValidation.AutoValidation.Shared.Extensions; 4 | 5 | namespace SharpGrip.FluentValidation.AutoValidation.Endpoints.Results 6 | { 7 | public class FluentValidationAutoValidationDefaultResultFactory : IFluentValidationAutoValidationResultFactory 8 | { 9 | public IResult CreateResult(EndpointFilterInvocationContext context, ValidationResult validationResult) 10 | { 11 | return TypedResults.ValidationProblem(validationResult.ToValidationProblemErrors()); 12 | } 13 | } 14 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Endpoints/src/Results/IFluentValidationAutoValidationResultFactory.cs: -------------------------------------------------------------------------------- 1 | using FluentValidation.Results; 2 | using Microsoft.AspNetCore.Http; 3 | 4 | namespace SharpGrip.FluentValidation.AutoValidation.Endpoints.Results 5 | { 6 | public interface IFluentValidationAutoValidationResultFactory 7 | { 8 | /// 9 | /// Creates an object to be executed by the endpoint. 10 | /// 11 | /// The associated with the current request/response. 12 | /// The object containing the validation failures. 13 | /// The object to be executed by the endpoint. 14 | public IResult CreateResult(EndpointFilterInvocationContext context, ValidationResult validationResult); 15 | } 16 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Mvc/FluentValidation.AutoValidation.Mvc.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | SharpGrip.FluentValidation.AutoValidation.Mvc 5 | 6 | 7 | 8 | netcoreapp3.1;net6.0;net7.0;net8.0;net9.0 9 | SharpGrip.FluentValidation.AutoValidation.Mvc 10 | SharpGrip.FluentValidation.AutoValidation.Mvc 11 | SharpGrip FluentValidation AutoValidation MVC 12 | SharpGrip FluentValidation AutoValidation MVC is an extension of the FluentValidation library enabling automatic asynchronous validation in MVC controllers. 13 | sharpgrip;validation;fluent-validation;mvc 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | all 23 | runtime; build; native; contentfiles; analyzers; buildtransitive 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Mvc/src/Attributes/AutoValidateAlwaysAttribute.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace SharpGrip.FluentValidation.AutoValidation.Mvc.Attributes 4 | { 5 | [AttributeUsage(AttributeTargets.Parameter)] 6 | public class AutoValidateAlwaysAttribute : Attribute 7 | { 8 | } 9 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Mvc/src/Attributes/AutoValidateNeverAttribute.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace SharpGrip.FluentValidation.AutoValidation.Mvc.Attributes 4 | { 5 | [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method | AttributeTargets.Parameter)] 6 | public class AutoValidateNeverAttribute : Attribute 7 | { 8 | } 9 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Mvc/src/Attributes/AutoValidationAttribute.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace SharpGrip.FluentValidation.AutoValidation.Mvc.Attributes 4 | { 5 | [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)] 6 | public class AutoValidationAttribute : Attribute 7 | { 8 | } 9 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Mvc/src/Attributes/FluentValidationAutoValidationAttribute.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace SharpGrip.FluentValidation.AutoValidation.Mvc.Attributes 4 | { 5 | [Obsolete("Attribute is obsolete and will be removed in v2. Use the [AutoValidation] attribute instead.")] 6 | [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)] 7 | public class FluentValidationAutoValidationAttribute : Attribute 8 | { 9 | } 10 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Mvc/src/Configuration/AutoValidationMvcConfiguration.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using Microsoft.AspNetCore.Mvc; 3 | using Microsoft.AspNetCore.Mvc.ModelBinding; 4 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Attributes; 5 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Enums; 6 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Results; 7 | 8 | namespace SharpGrip.FluentValidation.AutoValidation.Mvc.Configuration 9 | { 10 | public class AutoValidationMvcConfiguration 11 | { 12 | /// 13 | /// Disables the built-in .NET model (data annotations) validation. 14 | /// 15 | public bool DisableBuiltInModelValidation { get; set; } 16 | 17 | /// 18 | /// Configures the validation strategy. Validation strategy enables asynchronous automatic validation on all controllers inheriting from . 19 | /// Validation strategy enables asynchronous automatic validation on controllers inheriting from decorated (class or method) with a attribute. 20 | /// 21 | public ValidationStrategy ValidationStrategy { get; set; } = ValidationStrategy.All; 22 | 23 | /// 24 | /// Enables asynchronous automatic validation for parameters bound from binding sources (typically parameters decorated with the [FromBody] attribute). 25 | /// 26 | /// 27 | public bool EnableBodyBindingSourceAutomaticValidation { get; set; } = true; 28 | 29 | /// 30 | /// Enables asynchronous automatic validation for parameters bound from binding sources (typically parameters decorated with the [FromForm] attribute). 31 | /// 32 | /// 33 | public bool EnableFormBindingSourceAutomaticValidation { get; set; } = false; 34 | 35 | /// 36 | /// Enables asynchronous automatic validation for parameters bound from binding sources (typically parameters decorated with the [FromQuery] attribute). 37 | /// 38 | /// 39 | public bool EnableQueryBindingSourceAutomaticValidation { get; set; } = true; 40 | 41 | /// 42 | /// Enables asynchronous automatic validation for parameters bound from binding sources (typically parameters decorated with the [FromRoute] attribute). 43 | /// 44 | /// 45 | public bool EnablePathBindingSourceAutomaticValidation { get; set; } = false; 46 | 47 | /// 48 | /// Enables asynchronous automatic validation for parameters bound from binding sources. 49 | /// 50 | public bool EnableCustomBindingSourceAutomaticValidation { get; set; } = false; 51 | 52 | /// 53 | /// Enables asynchronous automatic validation for parameters not bound from any binding source (typically parameters without a declared or inferred binding source). 54 | /// 55 | public bool EnableNullBindingSourceAutomaticValidation { get; set; } = false; 56 | 57 | /// 58 | /// Holds the overridden result factory. This property is meant for infrastructure and should not be used by application code. 59 | /// 60 | public Type? OverriddenResultFactory { get; private set; } 61 | 62 | /// 63 | /// Overrides the default result factory with a custom result factory. Custom result factories are required to implement . 64 | /// The default result factory returns the default object wrapped in a >. 65 | /// 66 | /// 67 | /// The custom result factory implement . 68 | public void OverrideDefaultResultFactoryWith() where TResultFactory : IFluentValidationAutoValidationResultFactory 69 | { 70 | OverriddenResultFactory = typeof(TResultFactory); 71 | } 72 | } 73 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Mvc/src/Enums/ValidationStrategy.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.AspNetCore.Mvc; 2 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Attributes; 3 | 4 | namespace SharpGrip.FluentValidation.AutoValidation.Mvc.Enums 5 | { 6 | public enum ValidationStrategy 7 | { 8 | /// 9 | /// Enables asynchronous automatic validation on all controllers inheriting from . 10 | /// 11 | All = 1, 12 | 13 | /// 14 | /// Enables asynchronous automatic validation on controllers inheriting from decorated with a attribute. 15 | /// 16 | Annotations = 2 17 | } 18 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Mvc/src/Extensions/ServiceCollectionExtensions.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using Microsoft.AspNetCore.Mvc; 3 | using Microsoft.AspNetCore.Mvc.Infrastructure; 4 | using Microsoft.AspNetCore.Mvc.ModelBinding; 5 | using Microsoft.AspNetCore.Mvc.ModelBinding.Validation; 6 | using Microsoft.Extensions.DependencyInjection; 7 | using Microsoft.Extensions.DependencyInjection.Extensions; 8 | using Microsoft.Extensions.Logging.Abstractions; 9 | using Microsoft.Extensions.Options; 10 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Configuration; 11 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Filters; 12 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Results; 13 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Validation; 14 | 15 | namespace SharpGrip.FluentValidation.AutoValidation.Mvc.Extensions 16 | { 17 | public static class ServiceCollectionExtensions 18 | { 19 | /// 20 | /// Adds asynchronous MVC Fluent Validation automatic validation to the specified . 21 | /// 22 | /// The service collection. 23 | /// The configuration delegate used to configure the FluentValidation AutoValidation MVC validation. 24 | /// The service collection. 25 | public static IServiceCollection AddFluentValidationAutoValidation(this IServiceCollection serviceCollection, Action? autoValidationMvcConfiguration = null) 26 | { 27 | var configuration = new AutoValidationMvcConfiguration(); 28 | 29 | if (autoValidationMvcConfiguration != null) 30 | { 31 | autoValidationMvcConfiguration.Invoke(configuration); 32 | serviceCollection.Configure(autoValidationMvcConfiguration); 33 | } 34 | 35 | if (configuration.DisableBuiltInModelValidation) 36 | { 37 | serviceCollection.AddSingleton(serviceProvider => 38 | new FluentValidationAutoValidationObjectModelValidator( 39 | serviceProvider.GetRequiredService(), 40 | serviceProvider.GetRequiredService>().Value.ModelValidatorProviders, 41 | configuration.DisableBuiltInModelValidation)); 42 | } 43 | 44 | // Add the default result factory. 45 | serviceCollection.AddScoped(); 46 | 47 | // If the custom result factory is not null, replace the default result factory with the overridden result factory. 48 | if (configuration.OverriddenResultFactory != null) 49 | { 50 | serviceCollection.Replace(new ServiceDescriptor(typeof(IFluentValidationAutoValidationResultFactory), configuration.OverriddenResultFactory, ServiceLifetime.Scoped)); 51 | } 52 | 53 | // Create a default instance of the `ModelStateInvalidFilter` to access the non static property `Order` in a static context. 54 | var modelStateInvalidFilter = new ModelStateInvalidFilter(new ApiBehaviorOptions {InvalidModelStateResponseFactory = context => new OkResult()}, NullLogger.Instance); 55 | 56 | // Make sure we insert the `FluentValidationAutoValidationActionFilter` before the built-in `ModelStateInvalidFilter` to prevent it short-circuiting the request. 57 | serviceCollection.Configure(options => options.Filters.Add(modelStateInvalidFilter.Order - 1)); 58 | 59 | return serviceCollection; 60 | } 61 | } 62 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Mvc/src/Filters/FluentValidationAutoValidationActionFilter.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Linq; 3 | using System.Threading.Tasks; 4 | using FluentValidation; 5 | using Microsoft.AspNetCore.Http; 6 | using Microsoft.AspNetCore.Mvc; 7 | using Microsoft.AspNetCore.Mvc.Controllers; 8 | using Microsoft.AspNetCore.Mvc.Filters; 9 | using Microsoft.AspNetCore.Mvc.Infrastructure; 10 | using Microsoft.AspNetCore.Mvc.ModelBinding; 11 | using Microsoft.Extensions.DependencyInjection; 12 | using Microsoft.Extensions.Options; 13 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Attributes; 14 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Configuration; 15 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Enums; 16 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Interceptors; 17 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Results; 18 | using SharpGrip.FluentValidation.AutoValidation.Shared.Extensions; 19 | 20 | namespace SharpGrip.FluentValidation.AutoValidation.Mvc.Filters 21 | { 22 | public class FluentValidationAutoValidationActionFilter : IAsyncActionFilter 23 | { 24 | private readonly IFluentValidationAutoValidationResultFactory fluentValidationAutoValidationResultFactory; 25 | private readonly AutoValidationMvcConfiguration autoValidationMvcConfiguration; 26 | 27 | public FluentValidationAutoValidationActionFilter(IFluentValidationAutoValidationResultFactory fluentValidationAutoValidationResultFactory, IOptions autoValidationMvcConfiguration) 28 | { 29 | this.fluentValidationAutoValidationResultFactory = fluentValidationAutoValidationResultFactory; 30 | this.autoValidationMvcConfiguration = autoValidationMvcConfiguration.Value; 31 | } 32 | 33 | public async Task OnActionExecutionAsync(ActionExecutingContext actionExecutingContext, ActionExecutionDelegate next) 34 | { 35 | if (IsValidController(actionExecutingContext.Controller)) 36 | { 37 | var endpoint = actionExecutingContext.HttpContext.GetEndpoint(); 38 | var controllerActionDescriptor = (ControllerActionDescriptor) actionExecutingContext.ActionDescriptor; 39 | var serviceProvider = actionExecutingContext.HttpContext.RequestServices; 40 | 41 | if (endpoint != null && 42 | ((autoValidationMvcConfiguration.ValidationStrategy == ValidationStrategy.Annotations && 43 | !endpoint.Metadata.OfType().Any() && !endpoint.Metadata.OfType().Any()) || 44 | endpoint.Metadata.OfType().Any())) 45 | { 46 | HandleUnvalidatedEntries(actionExecutingContext); 47 | 48 | await next(); 49 | 50 | return; 51 | } 52 | 53 | foreach (var parameter in controllerActionDescriptor.Parameters) 54 | { 55 | if (actionExecutingContext.ActionArguments.TryGetValue(parameter.Name, out var subject)) 56 | { 57 | var parameterInfo = (parameter as ControllerParameterDescriptor)?.ParameterInfo; 58 | var parameterType = subject?.GetType(); 59 | var bindingSource = parameter.BindingInfo?.BindingSource; 60 | 61 | var hasAutoValidateAlwaysAttribute = parameterInfo?.HasCustomAttribute() ?? false; 62 | var hasAutoValidateNeverAttribute = parameterInfo?.HasCustomAttribute() ?? false; 63 | 64 | if (subject != null && parameterType != null && parameterType.IsCustomType() && 65 | !hasAutoValidateNeverAttribute && (hasAutoValidateAlwaysAttribute || HasValidBindingSource(bindingSource)) && 66 | serviceProvider.GetValidator(parameterType) is IValidator validator) 67 | { 68 | // ReSharper disable once SuspiciousTypeConversion.Global 69 | var validatorInterceptor = validator as IValidatorInterceptor; 70 | var globalValidationInterceptor = serviceProvider.GetService(); 71 | 72 | IValidationContext validationContext = new ValidationContext(subject); 73 | 74 | if (validatorInterceptor != null) 75 | { 76 | validationContext = validatorInterceptor.BeforeValidation(actionExecutingContext, validationContext) ?? validationContext; 77 | } 78 | 79 | if (globalValidationInterceptor != null) 80 | { 81 | validationContext = globalValidationInterceptor.BeforeValidation(actionExecutingContext, validationContext) ?? validationContext; 82 | } 83 | 84 | var validationResult = await validator.ValidateAsync(validationContext, actionExecutingContext.HttpContext.RequestAborted); 85 | 86 | if (validatorInterceptor != null) 87 | { 88 | validationResult = validatorInterceptor.AfterValidation(actionExecutingContext, validationContext) ?? validationResult; 89 | } 90 | 91 | if (globalValidationInterceptor != null) 92 | { 93 | validationResult = globalValidationInterceptor.AfterValidation(actionExecutingContext, validationContext) ?? validationResult; 94 | } 95 | 96 | if (!validationResult.IsValid) 97 | { 98 | foreach (var error in validationResult.Errors) 99 | { 100 | actionExecutingContext.ModelState.AddModelError(error.PropertyName, error.ErrorMessage); 101 | } 102 | } 103 | } 104 | } 105 | } 106 | 107 | HandleUnvalidatedEntries(actionExecutingContext); 108 | 109 | if (!actionExecutingContext.ModelState.IsValid) 110 | { 111 | var problemDetailsFactory = serviceProvider.GetRequiredService(); 112 | var validationProblemDetails = problemDetailsFactory.CreateValidationProblemDetails(actionExecutingContext.HttpContext, actionExecutingContext.ModelState); 113 | 114 | actionExecutingContext.Result = fluentValidationAutoValidationResultFactory.CreateActionResult(actionExecutingContext, validationProblemDetails); 115 | 116 | return; 117 | } 118 | } 119 | 120 | await next(); 121 | } 122 | 123 | private bool IsValidController(object controller) 124 | { 125 | var controllerType = controller.GetType(); 126 | 127 | if (controllerType.HasCustomAttribute()) 128 | { 129 | return false; 130 | } 131 | 132 | return controller is ControllerBase || 133 | controllerType.HasCustomAttribute() || 134 | controllerType.Name.EndsWith("Controller", StringComparison.OrdinalIgnoreCase) || 135 | controllerType.InheritsFromTypeWithNameEndingIn("Controller"); 136 | } 137 | 138 | private bool HasValidBindingSource(BindingSource? bindingSource) 139 | { 140 | return (autoValidationMvcConfiguration.EnableBodyBindingSourceAutomaticValidation && bindingSource == BindingSource.Body) || 141 | (autoValidationMvcConfiguration.EnableFormBindingSourceAutomaticValidation && bindingSource == BindingSource.Form) || 142 | (autoValidationMvcConfiguration.EnableQueryBindingSourceAutomaticValidation && bindingSource == BindingSource.Query) || 143 | (autoValidationMvcConfiguration.EnablePathBindingSourceAutomaticValidation && bindingSource == BindingSource.Path) || 144 | (autoValidationMvcConfiguration.EnableCustomBindingSourceAutomaticValidation && bindingSource == BindingSource.Custom) || 145 | (autoValidationMvcConfiguration.EnableNullBindingSourceAutomaticValidation && bindingSource == null); 146 | } 147 | 148 | private void HandleUnvalidatedEntries(ActionExecutingContext context) 149 | { 150 | if (autoValidationMvcConfiguration.DisableBuiltInModelValidation) 151 | { 152 | foreach (var modelStateEntry in context.ModelState.Values.Where(modelStateEntry => modelStateEntry.ValidationState == ModelValidationState.Unvalidated)) 153 | { 154 | modelStateEntry.ValidationState = ModelValidationState.Skipped; 155 | } 156 | } 157 | } 158 | } 159 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Mvc/src/Interceptors/IGlobalValidationInterceptor.cs: -------------------------------------------------------------------------------- 1 | using FluentValidation; 2 | using FluentValidation.Results; 3 | using Microsoft.AspNetCore.Mvc.Filters; 4 | 5 | namespace SharpGrip.FluentValidation.AutoValidation.Mvc.Interceptors 6 | { 7 | /// 8 | /// Allows global intercepting and altering of the validation process by implementing this interface on a custom class and registering it with the service collection. 9 | /// 10 | /// The interceptor methods of instances of this interface will get called on each validation attempt. 11 | /// 12 | public interface IGlobalValidationInterceptor 13 | { 14 | public IValidationContext? BeforeValidation(ActionExecutingContext actionExecutingContext, IValidationContext validationContext); 15 | public ValidationResult? AfterValidation(ActionExecutingContext actionExecutingContext, IValidationContext validationContext); 16 | } 17 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Mvc/src/Interceptors/IValidatorInterceptor.cs: -------------------------------------------------------------------------------- 1 | namespace SharpGrip.FluentValidation.AutoValidation.Mvc.Interceptors 2 | { 3 | /// 4 | /// Allows intercepting and altering of the validation process by implementing this interface on a validator. 5 | /// 6 | /// The interceptor methods of instances of this interface will only get called when the implementing validator gets validated. 7 | /// 8 | public interface IValidatorInterceptor : IGlobalValidationInterceptor 9 | { 10 | } 11 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Mvc/src/Results/FluentValidationAutoValidationDefaultResultFactory.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.AspNetCore.Mvc; 2 | using Microsoft.AspNetCore.Mvc.Filters; 3 | 4 | namespace SharpGrip.FluentValidation.AutoValidation.Mvc.Results 5 | { 6 | public class FluentValidationAutoValidationDefaultResultFactory : IFluentValidationAutoValidationResultFactory 7 | { 8 | public IActionResult CreateActionResult(ActionExecutingContext context, ValidationProblemDetails? validationProblemDetails) 9 | { 10 | return new BadRequestObjectResult(validationProblemDetails); 11 | } 12 | } 13 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Mvc/src/Results/IFluentValidationAutoValidationResultFactory.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.AspNetCore.Mvc; 2 | using Microsoft.AspNetCore.Mvc.Filters; 3 | 4 | namespace SharpGrip.FluentValidation.AutoValidation.Mvc.Results 5 | { 6 | public interface IFluentValidationAutoValidationResultFactory 7 | { 8 | /// 9 | /// Creates a to be executed by the controller action. 10 | /// 11 | /// The associated with the current request/response. 12 | /// The instance object containing the validation failures. 13 | /// The object to be executed by the controller action. 14 | public IActionResult CreateActionResult(ActionExecutingContext context, ValidationProblemDetails? validationProblemDetails); 15 | } 16 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Mvc/src/Validation/FluentValidationAutoValidationObjectModelValidator.cs: -------------------------------------------------------------------------------- 1 | using System.Collections.Generic; 2 | using Microsoft.AspNetCore.Mvc; 3 | using Microsoft.AspNetCore.Mvc.ModelBinding; 4 | using Microsoft.AspNetCore.Mvc.ModelBinding.Validation; 5 | 6 | namespace SharpGrip.FluentValidation.AutoValidation.Mvc.Validation 7 | { 8 | public class FluentValidationAutoValidationObjectModelValidator : ObjectModelValidator 9 | { 10 | private readonly bool disableBuiltInModelValidation; 11 | 12 | public FluentValidationAutoValidationObjectModelValidator(IModelMetadataProvider modelMetadataProvider, IList validatorProviders, bool disableBuiltInModelValidation) 13 | : base(modelMetadataProvider, validatorProviders) 14 | { 15 | this.disableBuiltInModelValidation = disableBuiltInModelValidation; 16 | } 17 | 18 | public override ValidationVisitor GetValidationVisitor(ActionContext actionContext, 19 | IModelValidatorProvider validatorProvider, 20 | ValidatorCache validatorCache, 21 | IModelMetadataProvider metadataProvider, 22 | ValidationStateDictionary? validationState) 23 | { 24 | return new FluentValidationAutoValidationValidationVisitor(actionContext, validatorProvider, validatorCache, metadataProvider, validationState, disableBuiltInModelValidation); 25 | } 26 | } 27 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Mvc/src/Validation/FluentValidationAutoValidationValidationVisitor.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.AspNetCore.Mvc; 2 | using Microsoft.AspNetCore.Mvc.ModelBinding; 3 | using Microsoft.AspNetCore.Mvc.ModelBinding.Validation; 4 | 5 | namespace SharpGrip.FluentValidation.AutoValidation.Mvc.Validation 6 | { 7 | public class FluentValidationAutoValidationValidationVisitor : ValidationVisitor 8 | { 9 | private readonly bool disableBuiltInModelValidation; 10 | 11 | public FluentValidationAutoValidationValidationVisitor(ActionContext actionContext, 12 | IModelValidatorProvider validatorProvider, 13 | ValidatorCache validatorCache, 14 | IModelMetadataProvider metadataProvider, 15 | ValidationStateDictionary? validationState, 16 | bool disableBuiltInModelValidation) 17 | : base(actionContext, validatorProvider, validatorCache, metadataProvider, validationState) 18 | { 19 | this.disableBuiltInModelValidation = disableBuiltInModelValidation; 20 | } 21 | 22 | public override bool Validate(ModelMetadata? metadata, string? key, object? model, bool alwaysValidateAtTopLevel) 23 | { 24 | // If built in model validation is disabled return true for later validation in the action filter. 25 | return disableBuiltInModelValidation || base.Validate(metadata, key, model, alwaysValidateAtTopLevel); 26 | } 27 | 28 | #if !NETCOREAPP3_1 29 | public override bool Validate(ModelMetadata? metadata, string? key, object? model, bool alwaysValidateAtTopLevel, object? container) 30 | { 31 | // If built in model validation is disabled return true for later validation in the action filter. 32 | return disableBuiltInModelValidation || base.Validate(metadata, key, model, alwaysValidateAtTopLevel, container); 33 | } 34 | #endif 35 | } 36 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Shared/FluentValidation.AutoValidation.Shared.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | SharpGrip.FluentValidation.AutoValidation.Shared 5 | 6 | 7 | 8 | netstandard2.0;netstandard2.1;netcoreapp3.1;net6.0;net7.0;net8.0;net9.0 9 | SharpGrip.FluentValidation.AutoValidation.Shared 10 | SharpGrip.FluentValidation.AutoValidation.Shared 11 | SharpGrip FluentValidation AutoValidation Shared 12 | SharpGrip FluentValidation AutoValidation is an extension of the FluentValidation library enabling automatic asynchronous validation in MVC controllers and minimal APIs (endpoints). 13 | sharpgrip;validation;fluent-validation;mvc;endpoints;minimal-api 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | all 24 | runtime; build; native; contentfiles; analyzers; buildtransitive 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Shared/src/Extensions/ParameterInfoExtensions.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Linq; 3 | using System.Reflection; 4 | 5 | namespace SharpGrip.FluentValidation.AutoValidation.Shared.Extensions 6 | { 7 | public static class ParameterInfoExtensions 8 | { 9 | public static bool HasCustomAttribute(this ParameterInfo parameterInfo) where TAttribute : Attribute 10 | { 11 | return parameterInfo.CustomAttributes.Any(attribute => attribute.AttributeType == typeof(TAttribute)); 12 | } 13 | } 14 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Shared/src/Extensions/ServiceProviderExtensions.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using FluentValidation; 3 | 4 | namespace SharpGrip.FluentValidation.AutoValidation.Shared.Extensions 5 | { 6 | public static class ServiceProviderExtensions 7 | { 8 | public static object? GetValidator(this IServiceProvider serviceProvider, Type type) 9 | { 10 | return serviceProvider.GetService(typeof(IValidator<>).MakeGenericType(type)); 11 | } 12 | } 13 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Shared/src/Extensions/TypeExtensions.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Linq; 3 | 4 | namespace SharpGrip.FluentValidation.AutoValidation.Shared.Extensions 5 | { 6 | public static class TypeExtensions 7 | { 8 | public static bool IsCustomType(this Type? type) 9 | { 10 | var builtInTypes = new[] 11 | { 12 | typeof(string), 13 | typeof(decimal), 14 | typeof(DateTime), 15 | typeof(DateTimeOffset), 16 | typeof(TimeSpan), 17 | typeof(Guid), 18 | typeof(Enum) 19 | }; 20 | 21 | return type != null && type.IsClass && !type.IsEnum && !type.IsValueType && !type.IsPrimitive && !builtInTypes.Contains(type); 22 | } 23 | 24 | public static bool HasCustomAttribute(this Type type) where TAttribute : Attribute 25 | { 26 | return type.CustomAttributes.Any(attribute => attribute.AttributeType == typeof(TAttribute)); 27 | } 28 | 29 | public static bool InheritsFromTypeWithNameEndingIn(this Type type, string name) 30 | { 31 | while (type.BaseType != null) 32 | { 33 | type = type.BaseType; 34 | 35 | if (type.Name.EndsWith(name, StringComparison.OrdinalIgnoreCase)) 36 | { 37 | return true; 38 | } 39 | } 40 | 41 | return false; 42 | } 43 | } 44 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.Shared/src/Extensions/ValidationResultExtensions.cs: -------------------------------------------------------------------------------- 1 | using System.Collections.Generic; 2 | using System.Linq; 3 | using FluentValidation.Results; 4 | 5 | namespace SharpGrip.FluentValidation.AutoValidation.Shared.Extensions 6 | { 7 | public static class ValidationResultExtensions 8 | { 9 | public static IDictionary ToValidationProblemErrors(this ValidationResult validationResult) 10 | { 11 | return validationResult.Errors.GroupBy(validationFailure => validationFailure.PropertyName) 12 | .ToDictionary(validationFailureGrouping => validationFailureGrouping.Key, 13 | validationFailureGrouping => validationFailureGrouping.Select(validationFailure => validationFailure.ErrorMessage).ToArray()); 14 | } 15 | } 16 | } -------------------------------------------------------------------------------- /FluentValidation.AutoValidation.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FluentValidation.AutoValidation.Endpoints", "FluentValidation.AutoValidation.Endpoints\FluentValidation.AutoValidation.Endpoints.csproj", "{8743E1EF-94ED-4B9C-B117-3D6B533334D0}" 4 | EndProject 5 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FluentValidation.AutoValidation.Mvc", "FluentValidation.AutoValidation.Mvc\FluentValidation.AutoValidation.Mvc.csproj", "{84A6D838-49F2-4245-BAA4-E4B7B69D3D0D}" 6 | EndProject 7 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FluentValidation.AutoValidation.Shared", "FluentValidation.AutoValidation.Shared\FluentValidation.AutoValidation.Shared.csproj", "{EFB3047F-34BD-4A84-86B9-52F96E2D240D}" 8 | EndProject 9 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FluentValidation.AutoValidation.Tests", "Tests\FluentValidation.AutoValidation.Tests.csproj", "{8E3ACDDB-5344-4B1A-830C-119B1306596C}" 10 | EndProject 11 | Global 12 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 13 | Debug|Any CPU = Debug|Any CPU 14 | Release|Any CPU = Release|Any CPU 15 | EndGlobalSection 16 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 17 | {8743E1EF-94ED-4B9C-B117-3D6B533334D0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 18 | {8743E1EF-94ED-4B9C-B117-3D6B533334D0}.Debug|Any CPU.Build.0 = Debug|Any CPU 19 | {8743E1EF-94ED-4B9C-B117-3D6B533334D0}.Release|Any CPU.ActiveCfg = Release|Any CPU 20 | {8743E1EF-94ED-4B9C-B117-3D6B533334D0}.Release|Any CPU.Build.0 = Release|Any CPU 21 | {84A6D838-49F2-4245-BAA4-E4B7B69D3D0D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 22 | {84A6D838-49F2-4245-BAA4-E4B7B69D3D0D}.Debug|Any CPU.Build.0 = Debug|Any CPU 23 | {84A6D838-49F2-4245-BAA4-E4B7B69D3D0D}.Release|Any CPU.ActiveCfg = Release|Any CPU 24 | {84A6D838-49F2-4245-BAA4-E4B7B69D3D0D}.Release|Any CPU.Build.0 = Release|Any CPU 25 | {EFB3047F-34BD-4A84-86B9-52F96E2D240D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 26 | {EFB3047F-34BD-4A84-86B9-52F96E2D240D}.Debug|Any CPU.Build.0 = Debug|Any CPU 27 | {EFB3047F-34BD-4A84-86B9-52F96E2D240D}.Release|Any CPU.ActiveCfg = Release|Any CPU 28 | {EFB3047F-34BD-4A84-86B9-52F96E2D240D}.Release|Any CPU.Build.0 = Release|Any CPU 29 | {8E3ACDDB-5344-4B1A-830C-119B1306596C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 30 | {8E3ACDDB-5344-4B1A-830C-119B1306596C}.Debug|Any CPU.Build.0 = Debug|Any CPU 31 | {8E3ACDDB-5344-4B1A-830C-119B1306596C}.Release|Any CPU.ActiveCfg = Release|Any CPU 32 | {8E3ACDDB-5344-4B1A-830C-119B1306596C}.Release|Any CPU.Build.0 = Release|Any CPU 33 | EndGlobalSection 34 | EndGlobal 35 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 SharpGrip 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # SharpGrip FluentValidation AutoValidation 2 | 3 | ## Builds 4 | 5 | [![FluentValidation.AutoValidation [Build]](https://github.com/SharpGrip/FluentValidation.AutoValidation/actions/workflows/Build.yaml/badge.svg)](https://github.com/SharpGrip/FluentValidation.AutoValidation/actions/workflows/Build.yaml) 6 | 7 | [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=SharpGrip_FluentValidation.AutoValidation&metric=alert_status)](https://sonarcloud.io/summary/overall?id=SharpGrip_FluentValidation.AutoValidation) \ 8 | [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=SharpGrip_FluentValidation.AutoValidation&metric=sqale_rating)](https://sonarcloud.io/summary/overall?id=SharpGrip_FluentValidation.AutoValidation) \ 9 | [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=SharpGrip_FluentValidation.AutoValidation&metric=reliability_rating)](https://sonarcloud.io/summary/overall?id=SharpGrip_FluentValidation.AutoValidation) \ 10 | [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=SharpGrip_FluentValidation.AutoValidation&metric=security_rating)](https://sonarcloud.io/summary/overall?id=SharpGrip_FluentValidation.AutoValidation) \ 11 | [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=SharpGrip_FluentValidation.AutoValidation&metric=coverage)](https://sonarcloud.io/summary/overall?id=SharpGrip_FluentValidation.AutoValidation) 12 | 13 | ## Introduction 14 | 15 | SharpGrip FluentValidation AutoValidation is an extension of the [FluentValidation](https://github.com/FluentValidation/FluentValidation) (v10+) library enabling automatic asynchronous validation in MVC controllers and minimal APIs (endpoints). 16 | The library [FluentValidation.AspNetCore](https://github.com/FluentValidation/FluentValidation.AspNetCore) is no longer being maintained and is unsupported. As a result, support for automatic validation provided by this library is no longer available. 17 | This library re-introduces this functionality for MVC controllers and introduces automatic validation for minimal APIs (endpoints). It enables developers to easily implement automatic validation in their projects. 18 | 19 | ## Installation 20 | 21 | ### Validator registration 22 | 23 | To enable this library to automatically resolve and invoke validators for your models, you must register your validators with the Dependency Injection (DI) service container. 24 | 25 | #### Manual registration 26 | 27 | Manually register your validator with the service container: 28 | 29 | ```cs 30 | services.AddScoped, UserValidator>(); 31 | ``` 32 | 33 | #### Automatic registration 34 | 35 | Automatically register all validators from the assembly containing your UserValidator: 36 | 37 | ```cs 38 | services.AddValidatorsFromAssemblyContaining(); 39 | ``` 40 | 41 | For more instructions on setting that up please see https://docs.fluentvalidation.net/en/latest/di.html. 42 | 43 | ### MVC controllers [![NuGet](https://img.shields.io/nuget/v/SharpGrip.FluentValidation.AutoValidation.Mvc)](https://www.nuget.org/packages/SharpGrip.FluentValidation.AutoValidation.Mvc) 44 | 45 | For MVC controllers reference NuGet package `SharpGrip.FluentValidation.AutoValidation.Mvc` (https://www.nuget.org/packages/SharpGrip.FluentValidation.AutoValidation.Mvc). 46 | 47 | ```cs 48 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Extensions; 49 | 50 | builder.Services.AddFluentValidationAutoValidation(); 51 | ``` 52 | 53 | ### Minimal APIs (endpoints) [![NuGet](https://img.shields.io/nuget/v/SharpGrip.FluentValidation.AutoValidation.Endpoints)](https://www.nuget.org/packages/SharpGrip.FluentValidation.AutoValidation.Endpoints) 54 | 55 | For minimal APIs (endpoints) reference NuGet package `SharpGrip.FluentValidation.AutoValidation.Endpoints` (https://www.nuget.org/packages/SharpGrip.FluentValidation.AutoValidation.Endpoints). 56 | 57 | Enabling minimal API (endpoint) automatic validation can be done on both route groups and routes. 58 | 59 | ```cs 60 | using SharpGrip.FluentValidation.AutoValidation.Endpoints.Extensions; 61 | 62 | builder.Services.AddFluentValidationAutoValidation(); 63 | 64 | var app = builder.Build(); 65 | var endpointGroup = app.MapGroup("/some-group").AddFluentValidationAutoValidation(); 66 | endpointGroup.MapPost("/", (SomeModel someModel) => $"Hello {someModel.Name}"); 67 | 68 | app.MapPost("/", (SomeOtherModel someOtherModel) => $"Hello again {someOtherModel.Name}").AddFluentValidationAutoValidation(); 69 | ``` 70 | 71 | ## Configuration 72 | 73 | ### MVC controllers 74 | 75 | | Property | Default value | Description | 76 | |----------------------------------------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 77 | | DisableBuiltInModelValidation | `false` | Disables the built-in .NET model (data annotations) validation. | 78 | | ValidationStrategy | `ValidationStrategy.All` | Configures the validation strategy. Validation strategy `ValidationStrategy.All` enables asynchronous automatic validation on all controllers inheriting from `ControllerBase`. Validation strategy `ValidationStrategy.Annotations` enables asynchronous automatic validation on controllers inheriting from `ControllerBase` decorated (class or method) with a `[AutoValidationAttribute]` attribute. | 79 | | EnableBodyBindingSourceAutomaticValidation | `true` | Enables asynchronous automatic validation for parameters bound from `BindingSource.Body` binding sources (typically parameters decorated with the `[FromBody]` attribute). | 80 | | EnableFormBindingSourceAutomaticValidation | `false` | Enables asynchronous automatic validation for parameters bound from `BindingSource.Form` binding sources (typically parameters decorated with the `[FromForm]` attribute). | 81 | | EnableQueryBindingSourceAutomaticValidation | `true` | Enables asynchronous automatic validation for parameters bound from `BindingSource.Query` binding sources (typically parameters decorated with the `[FromQuery]` attribute). | 82 | | EnablePathBindingSourceAutomaticValidation | `false` | Enables asynchronous automatic validation for parameters bound from `BindingSource.Path` binding sources (typically parameters decorated with the `[FromRoute]` attribute). | 83 | | EnableCustomBindingSourceAutomaticValidation | `false` | Enables asynchronous automatic validation for parameters bound from `BindingSource.Custom` binding sources. | 84 | | EnableNullBindingSourceAutomaticValidation | `false` | Enables asynchronous automatic validation for parameters not bound from any binding source (typically parameters without a declared or inferred binding source). | 85 | 86 | ```cs 87 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Extensions; 88 | 89 | builder.Services.AddFluentValidationAutoValidation(configuration => 90 | { 91 | // Disable the built-in .NET model (data annotations) validation. 92 | configuration.DisableBuiltInModelValidation = true; 93 | 94 | // Only validate controllers decorated with the `AutoValidation` attribute. 95 | configuration.ValidationStrategy = ValidationStrategy.Annotations; 96 | 97 | // Enable validation for parameters bound from `BindingSource.Body` binding sources. 98 | configuration.EnableBodyBindingSourceAutomaticValidation = true; 99 | 100 | // Enable validation for parameters bound from `BindingSource.Form` binding sources. 101 | configuration.EnableFormBindingSourceAutomaticValidation = true; 102 | 103 | // Enable validation for parameters bound from `BindingSource.Query` binding sources. 104 | configuration.EnableQueryBindingSourceAutomaticValidation = true; 105 | 106 | // Enable validation for parameters bound from `BindingSource.Path` binding sources. 107 | configuration.EnablePathBindingSourceAutomaticValidation = true; 108 | 109 | // Enable validation for parameters bound from 'BindingSource.Custom' binding sources. 110 | configuration.EnableCustomBindingSourceAutomaticValidation = true; 111 | 112 | // Replace the default result factory with a custom implementation. 113 | configuration.OverrideDefaultResultFactoryWith(); 114 | }); 115 | 116 | public class CustomResultFactory : IFluentValidationAutoValidationResultFactory 117 | { 118 | public IActionResult CreateActionResult(ActionExecutingContext context, ValidationProblemDetails? validationProblemDetails) 119 | { 120 | return new BadRequestObjectResult(new {Title = "Validation errors", ValidationErrors = validationProblemDetails?.Errors}); 121 | } 122 | } 123 | ``` 124 | 125 | ### Minimal APIs (endpoints) 126 | 127 | ```cs 128 | using SharpGrip.FluentValidation.AutoValidation.Endpoints.Extensions; 129 | 130 | builder.Services.AddFluentValidationAutoValidation(configuration => 131 | { 132 | // Replace the default result factory with a custom implementation. 133 | configuration.OverrideDefaultResultFactoryWith(); 134 | }); 135 | 136 | public class CustomResultFactory : IFluentValidationAutoValidationResultFactory 137 | { 138 | public IResult CreateResult(EndpointFilterInvocationContext context, ValidationResult validationResult) 139 | { 140 | var validationProblemErrors = validationResult.ToValidationProblemErrors(); 141 | 142 | return Results.ValidationProblem(validationProblemErrors, "Some details text.", "Some instance text.", (int) HttpStatusCode.BadRequest, "Some title."); 143 | } 144 | } 145 | ``` 146 | 147 | ## Validation attributes 148 | 149 | ### MVC controllers 150 | 151 | Customizing automatic validation behavior is achievable through the use of attributes. 152 | 153 | The `[AutoValidateAlways]` attribute can be applied to a controller parameter, compelling automatic validation to disregard the validation check for a valid binding source. 154 | This proves useful when the `ApiBehaviorOptions.SuppressInferBindingSourcesForParameters` option is enabled, and a custom model is used, with parameters bound from multiple binding sources. 155 | 156 | The `[AutoValidateNever]` attribute can be placed on a controller class, controller method, or controller parameter, instructing automatic validation to be skipped. 157 | 158 | ## Validation interceptors 159 | 160 | **Note:** Using validation interceptors is considered to be an advanced feature and is not needed for most use cases. 161 | 162 | Validation interceptors provide a mechanism for intercepting and modifying the validation process. This can be achieved through two distinct approaches: 163 | 164 | Global validation interceptor: 165 | Create a custom class that implements the `IGlobalValidationInterceptor` interface and register it with the service provider. 166 | 167 | Per validator interceptor: 168 | Implement the `IValidatorInterceptor` interface directly on a specific validator. 169 | 170 | In the validation process, both the global and the validator interceptors are resolved and invoked (if they exist), thereby establishing a miniature pipeline of validation interceptors: 171 | 172 | ``` 173 | ==> IValidatorInterceptor.BeforeValidation() 174 | ==> IGlobalValidationInterceptor.BeforeValidation() 175 | 176 | Validation 177 | 178 | ==> IValidatorInterceptor.AfterValidation() 179 | ==> IGlobalValidationInterceptor.AfterValidation() 180 | ``` 181 | 182 | Both interfaces define a `BeforeValidation` and a `AfterValidation` method. 183 | 184 | The `BeforeValidation` method gets called before validation and allows you to return a custom `IValidationContext` which gets passed to the validator. 185 | In case you return `null` the default `IValidationContext` will be passed to the validator. 186 | 187 | The `AfterValidation` method gets called after validation and allows you to return a custom `IValidationResult` which gets passed to the `IFluentValidationAutoValidationResultFactory`. 188 | In case you return `null` the default `IValidationResult` will be passed to the `IFluentValidationAutoValidationResultFactory`. 189 | 190 | ### MVC controllers 191 | 192 | ```cs 193 | // Example of a global validation interceptor. 194 | builder.Services.AddTransient(); 195 | 196 | public class CustomGlobalValidationInterceptor : IGlobalValidationInterceptor 197 | { 198 | public IValidationContext? BeforeValidation(ActionExecutingContext actionExecutingContext, IValidationContext validationContext) 199 | { 200 | // Return a custom `IValidationContext` or null. 201 | return null; 202 | } 203 | 204 | public ValidationResult? AfterValidation(ActionExecutingContext actionExecutingContext, IValidationContext validationContext) 205 | { 206 | // Return a custom `ValidationResult` or null. 207 | return null; 208 | } 209 | } 210 | 211 | // Example of a single validator interceptor. 212 | private class TestValidator : AbstractValidator, IValidatorInterceptor 213 | { 214 | public TestValidator() 215 | { 216 | RuleFor(x => x.Parameter1).Empty(); 217 | RuleFor(x => x.Parameter2).Empty(); 218 | RuleFor(x => x.Parameter3).Empty(); 219 | } 220 | 221 | public IValidationContext? BeforeValidation(ActionExecutingContext actionExecutingContext, IValidationContext validationContext) 222 | { 223 | // Return a custom `IValidationContext` or null. 224 | return null; 225 | } 226 | 227 | public ValidationResult? AfterValidation(ActionExecutingContext actionExecutingContext, IValidationContext validationContext) 228 | { 229 | // Return a custom `ValidationResult` or null. 230 | return null; 231 | } 232 | } 233 | ``` 234 | 235 | ### Minimal APIs (endpoints) 236 | 237 | ```cs 238 | // Example of a global validation interceptor. 239 | builder.Services.AddTransient(); 240 | 241 | public class CustomGlobalValidationInterceptor : IGlobalValidationInterceptor 242 | { 243 | public IValidationContext? BeforeValidation(EndpointFilterInvocationContext endpointFilterInvocationContext, IValidationContext validationContext) 244 | { 245 | // Return a custom `IValidationContext` or null. 246 | return null; 247 | } 248 | 249 | public ValidationResult? AfterValidation(EndpointFilterInvocationContext endpointFilterInvocationContext, IValidationContext validationContext) 250 | { 251 | // Return a custom `ValidationResult` or null. 252 | return null; 253 | } 254 | } 255 | 256 | // Example of a single validator interceptor. 257 | private class TestValidator : AbstractValidator, IValidatorInterceptor 258 | { 259 | public TestValidator() 260 | { 261 | RuleFor(x => x.Parameter1).Empty(); 262 | RuleFor(x => x.Parameter2).Empty(); 263 | RuleFor(x => x.Parameter3).Empty(); 264 | } 265 | 266 | public IValidationContext? BeforeValidation(EndpointFilterInvocationContext endpointFilterInvocationContext, IValidationContext validationContext) 267 | { 268 | // Return a custom `IValidationContext` or null. 269 | return null; 270 | } 271 | 272 | public ValidationResult? AfterValidation(EndpointFilterInvocationContext endpointFilterInvocationContext, IValidationContext validationContext) 273 | { 274 | // Return a custom `ValidationResult` or null. 275 | return null; 276 | } 277 | } 278 | ``` 279 | -------------------------------------------------------------------------------- /Tests/FluentValidation.AutoValidation.Tests.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net7.0;net8.0;net9.0 5 | latest 6 | false 7 | SharpGrip.FluentValidation.AutoValidation.Tests 8 | 9 | 10 | 11 | 12 | 13 | 14 | all 15 | runtime; build; native; contentfiles; analyzers; buildtransitive 16 | 17 | 18 | 19 | all 20 | runtime; build; native; contentfiles; analyzers; buildtransitive 21 | 22 | 23 | all 24 | runtime; build; native; contentfiles; analyzers; buildtransitive 25 | 26 | 27 | all 28 | runtime; build; native; contentfiles; analyzers; buildtransitive 29 | 30 | 31 | all 32 | runtime; build; native; contentfiles; analyzers; buildtransitive 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | -------------------------------------------------------------------------------- /Tests/src/FluentValidation.AutoValidation.Endpoints/Configuration/AutoValidationEndpointsConfigurationTest.cs: -------------------------------------------------------------------------------- 1 | using FluentValidation.Results; 2 | using Microsoft.AspNetCore.Http; 3 | using SharpGrip.FluentValidation.AutoValidation.Endpoints.Configuration; 4 | using SharpGrip.FluentValidation.AutoValidation.Endpoints.Results; 5 | using Xunit; 6 | 7 | namespace SharpGrip.FluentValidation.AutoValidation.Tests.FluentValidation.AutoValidation.Endpoints.Configuration; 8 | 9 | public class AutoValidationEndpointsConfigurationTest 10 | { 11 | [Fact] 12 | public void TestOverrideDefaultResultFactoryWith() 13 | { 14 | var autoValidationEndpointsConfiguration = new AutoValidationEndpointsConfiguration(); 15 | 16 | autoValidationEndpointsConfiguration.OverrideDefaultResultFactoryWith(); 17 | 18 | Assert.Equal(typeof(TestResultFactory), autoValidationEndpointsConfiguration.OverriddenResultFactory); 19 | } 20 | 21 | private class TestResultFactory : IFluentValidationAutoValidationResultFactory 22 | { 23 | public IResult CreateResult(EndpointFilterInvocationContext context, ValidationResult validationResult) 24 | { 25 | return TypedResults.Empty; 26 | } 27 | } 28 | } -------------------------------------------------------------------------------- /Tests/src/FluentValidation.AutoValidation.Endpoints/Extensions/ServiceCollectionExtensionsTest.cs: -------------------------------------------------------------------------------- 1 | using FluentValidation.Results; 2 | using Microsoft.AspNetCore.Http; 3 | using Microsoft.Extensions.DependencyInjection; 4 | using SharpGrip.FluentValidation.AutoValidation.Endpoints.Extensions; 5 | using SharpGrip.FluentValidation.AutoValidation.Endpoints.Results; 6 | using Xunit; 7 | 8 | namespace SharpGrip.FluentValidation.AutoValidation.Tests.FluentValidation.AutoValidation.Endpoints.Extensions; 9 | 10 | public class ServiceCollectionExtensionsTest 11 | { 12 | [Fact] 13 | public void TestAddFluentValidationAutoValidation() 14 | { 15 | var serviceCollection = new ServiceCollection(); 16 | 17 | serviceCollection.AddFluentValidationAutoValidation(); 18 | 19 | AssertNotContainsServiceDescriptor(serviceCollection, ServiceLifetime.Scoped); 20 | AssertContainsServiceDescriptor(serviceCollection, ServiceLifetime.Scoped); 21 | } 22 | 23 | [Fact] 24 | public void TestAddFluentValidationAutoValidation_WithConfiguration_OverriddenResultFactory() 25 | { 26 | var serviceCollection = new ServiceCollection(); 27 | 28 | serviceCollection.AddFluentValidationAutoValidation(options => options.OverrideDefaultResultFactoryWith()); 29 | 30 | AssertContainsServiceDescriptor(serviceCollection, ServiceLifetime.Scoped); 31 | AssertNotContainsServiceDescriptor(serviceCollection, ServiceLifetime.Scoped); 32 | } 33 | 34 | // ReSharper disable ParameterOnlyUsedForPreconditionCheck.Local 35 | private static void AssertContainsServiceDescriptor(ServiceCollection serviceCollection, ServiceLifetime serviceLifetime) 36 | { 37 | Assert.Contains(serviceCollection, serviceDescriptor => serviceDescriptor.ServiceType == typeof(TService) && 38 | (serviceDescriptor.ImplementationType == typeof(TImplementation) || 39 | serviceDescriptor.ImplementationFactory?.Method.ReturnType == typeof(TImplementation) || 40 | serviceDescriptor.ImplementationInstance?.GetType() == typeof(TImplementation)) && 41 | serviceDescriptor.Lifetime == serviceLifetime); 42 | } 43 | // ReSharper restore ParameterOnlyUsedForPreconditionCheck.Local 44 | 45 | // ReSharper disable ParameterOnlyUsedForPreconditionCheck.Local 46 | private static void AssertNotContainsServiceDescriptor(ServiceCollection serviceCollection, ServiceLifetime serviceLifetime) 47 | { 48 | Assert.DoesNotContain(serviceCollection, serviceDescriptor => serviceDescriptor.ServiceType == typeof(TService) && 49 | (serviceDescriptor.ImplementationType == typeof(TImplementation) || 50 | serviceDescriptor.ImplementationFactory?.Method.ReturnType == typeof(TImplementation) || 51 | serviceDescriptor.ImplementationInstance?.GetType() == typeof(TImplementation)) && 52 | serviceDescriptor.Lifetime == serviceLifetime); 53 | } 54 | // ReSharper restore ParameterOnlyUsedForPreconditionCheck.Local 55 | 56 | private class TestResultFactory : IFluentValidationAutoValidationResultFactory 57 | { 58 | public IResult CreateResult(EndpointFilterInvocationContext context, ValidationResult validationResult) 59 | { 60 | return TypedResults.Ok(); 61 | } 62 | } 63 | } -------------------------------------------------------------------------------- /Tests/src/FluentValidation.AutoValidation.Endpoints/Filters/FluentValidationAutoValidationEndpointFilterTest.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Linq; 4 | using System.Threading.Tasks; 5 | using FluentValidation; 6 | using FluentValidation.Results; 7 | using Microsoft.AspNetCore.Http; 8 | using Microsoft.AspNetCore.Http.HttpResults; 9 | using NSubstitute; 10 | using SharpGrip.FluentValidation.AutoValidation.Endpoints.Filters; 11 | using SharpGrip.FluentValidation.AutoValidation.Endpoints.Interceptors; 12 | using Xunit; 13 | 14 | namespace SharpGrip.FluentValidation.AutoValidation.Tests.FluentValidation.AutoValidation.Endpoints.Filters; 15 | 16 | public class FluentValidationAutoValidationEndpointFilterTest 17 | { 18 | private static readonly Dictionary ValidationFailures = new() 19 | { 20 | {nameof(TestModel.Parameter1), [$"'{nameof(TestModel.Parameter1)}' must be empty."]}, 21 | {nameof(TestModel.Parameter2), [$"'{nameof(TestModel.Parameter2)}' must be empty."]}, 22 | {nameof(TestModel.Parameter3), [$"'{nameof(TestModel.Parameter3)}' must be empty."]} 23 | }; 24 | 25 | [Fact] 26 | public async Task TestInvokeAsync_ValidatorFound() 27 | { 28 | var serviceProvider = Substitute.For(); 29 | var endpointFilterInvocationContext = Substitute.For(); 30 | 31 | endpointFilterInvocationContext.HttpContext.Returns(new DefaultHttpContext {RequestServices = serviceProvider}); 32 | endpointFilterInvocationContext.Arguments.Returns(new List {new TestModel {Parameter1 = "Value 1", Parameter2 = "Value 2", Parameter3 = "Value 3"}}); 33 | serviceProvider.GetService(typeof(IValidator<>).MakeGenericType(typeof(TestModel))).Returns(new TestValidator()); 34 | serviceProvider.GetService(typeof(IGlobalValidationInterceptor)).Returns(new GlobalValidationInterceptor()); 35 | 36 | var validationFailuresValues = ValidationFailures.Values.ToList(); 37 | 38 | var endpointFilter = new FluentValidationAutoValidationEndpointFilter(); 39 | 40 | var result = (ValidationProblem) (await endpointFilter.InvokeAsync(endpointFilterInvocationContext, _ => ValueTask.FromResult(new object())!))!; 41 | var problemDetailsErrorValues = result.ProblemDetails.Errors.ToList(); 42 | 43 | Assert.Contains(validationFailuresValues[0].First(), problemDetailsErrorValues[0].Value); 44 | Assert.Contains(validationFailuresValues[1].First(), problemDetailsErrorValues[1].Value); 45 | Assert.Contains(validationFailuresValues[2].First(), problemDetailsErrorValues[2].Value); 46 | } 47 | 48 | [Fact] 49 | public async Task TestInvokeAsync_ValidatorNotFound() 50 | { 51 | var serviceProvider = Substitute.For(); 52 | var endpointFilterInvocationContext = Substitute.For(); 53 | 54 | endpointFilterInvocationContext.HttpContext.Returns(new DefaultHttpContext {RequestServices = serviceProvider}); 55 | endpointFilterInvocationContext.Arguments.Returns(new List {new TestModel {Parameter1 = "Value 1", Parameter2 = "Value 2", Parameter3 = "Value 3"}}); 56 | serviceProvider.GetService(typeof(IValidator<>).MakeGenericType(typeof(TestModel))).Returns(null); 57 | serviceProvider.GetService(typeof(IGlobalValidationInterceptor)).Returns(null); 58 | 59 | var endpointFilter = new FluentValidationAutoValidationEndpointFilter(); 60 | 61 | var result = await endpointFilter.InvokeAsync(endpointFilterInvocationContext, _ => ValueTask.FromResult(new object())!); 62 | 63 | Assert.IsType(result); 64 | } 65 | 66 | private class TestModel 67 | { 68 | public string? Parameter1 { get; set; } 69 | public string? Parameter2 { get; set; } 70 | public string? Parameter3 { get; set; } 71 | } 72 | 73 | private class TestValidator : AbstractValidator, IValidatorInterceptor 74 | { 75 | public TestValidator() 76 | { 77 | RuleFor(x => x.Parameter1).Empty(); 78 | RuleFor(x => x.Parameter2).Empty(); 79 | RuleFor(x => x.Parameter3).Empty(); 80 | } 81 | 82 | public IValidationContext? BeforeValidation(EndpointFilterInvocationContext endpointFilterInvocationContext, IValidationContext validationContext) 83 | { 84 | return null; 85 | } 86 | 87 | public ValidationResult? AfterValidation(EndpointFilterInvocationContext endpointFilterInvocationContext, IValidationContext validationContext) 88 | { 89 | return null; 90 | } 91 | } 92 | 93 | private class GlobalValidationInterceptor : IGlobalValidationInterceptor 94 | { 95 | public IValidationContext? BeforeValidation(EndpointFilterInvocationContext endpointFilterInvocationContext, IValidationContext validationContext) 96 | { 97 | return null; 98 | } 99 | 100 | public ValidationResult? AfterValidation(EndpointFilterInvocationContext endpointFilterInvocationContext, IValidationContext validationContext) 101 | { 102 | return null; 103 | } 104 | } 105 | } -------------------------------------------------------------------------------- /Tests/src/FluentValidation.AutoValidation.Endpoints/Results/FluentValidationAutoValidationDefaultResultFactoryTest.cs: -------------------------------------------------------------------------------- 1 | using System.Collections.Generic; 2 | using FluentValidation.Results; 3 | using Microsoft.AspNetCore.Http; 4 | using Microsoft.AspNetCore.Http.HttpResults; 5 | using NSubstitute; 6 | using SharpGrip.FluentValidation.AutoValidation.Endpoints.Results; 7 | using SharpGrip.FluentValidation.AutoValidation.Shared.Extensions; 8 | using Xunit; 9 | 10 | namespace SharpGrip.FluentValidation.AutoValidation.Tests.FluentValidation.AutoValidation.Endpoints.Results; 11 | 12 | public class FluentValidationAutoValidationDefaultResultFactoryTest 13 | { 14 | [Fact] 15 | public void TestAddFluentValidationAutoValidation_WithConfiguration_DisableBuiltInModelValidation_False() 16 | { 17 | var fluentValidationAutoValidationDefaultResultFactory = new FluentValidationAutoValidationDefaultResultFactory(); 18 | var endpointFilterInvocationContext = Substitute.For(); 19 | 20 | var validationFailures = new List 21 | { 22 | new(nameof(TestModel.Parameter1), $"'{nameof(TestModel.Parameter1)}' must be empty."), 23 | new(nameof(TestModel.Parameter2), $"'{nameof(TestModel.Parameter2)}' must be empty."), 24 | new(nameof(TestModel.Parameter3), $"'{nameof(TestModel.Parameter3)}' must be empty.") 25 | }; 26 | 27 | var validationResult = new ValidationResult(validationFailures); 28 | 29 | var resultFactoryResult = (ValidationProblem) fluentValidationAutoValidationDefaultResultFactory.CreateResult(endpointFilterInvocationContext, validationResult); 30 | 31 | Assert.Equal(resultFactoryResult.ProblemDetails.Errors, validationResult.ToValidationProblemErrors()); 32 | } 33 | 34 | private class TestModel 35 | { 36 | public string? Parameter1 { get; set; } 37 | public string? Parameter2 { get; set; } 38 | public string? Parameter3 { get; set; } 39 | } 40 | } -------------------------------------------------------------------------------- /Tests/src/FluentValidation.AutoValidation.Mvc/Configuration/AutoValidationMvcConfigurationTest.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.AspNetCore.Mvc; 2 | using Microsoft.AspNetCore.Mvc.Filters; 3 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Configuration; 4 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Results; 5 | using Xunit; 6 | 7 | namespace SharpGrip.FluentValidation.AutoValidation.Tests.FluentValidation.AutoValidation.Mvc.Configuration; 8 | 9 | public class AutoValidationMvcConfigurationTest 10 | { 11 | [Fact] 12 | public void TestOverrideDefaultResultFactoryWith() 13 | { 14 | var autoValidationMvcConfiguration = new AutoValidationMvcConfiguration 15 | { 16 | DisableBuiltInModelValidation = true 17 | }; 18 | 19 | autoValidationMvcConfiguration.OverrideDefaultResultFactoryWith(); 20 | 21 | Assert.True(autoValidationMvcConfiguration.DisableBuiltInModelValidation); 22 | Assert.Equal(typeof(TestResultFactory), autoValidationMvcConfiguration.OverriddenResultFactory); 23 | } 24 | 25 | private class TestResultFactory : IFluentValidationAutoValidationResultFactory 26 | { 27 | public IActionResult CreateActionResult(ActionExecutingContext context, ValidationProblemDetails? validationProblemDetails) 28 | { 29 | return new OkResult(); 30 | } 31 | } 32 | } -------------------------------------------------------------------------------- /Tests/src/FluentValidation.AutoValidation.Mvc/Extensions/ServiceCollectionExtensionsTest.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.AspNetCore.Mvc; 2 | using Microsoft.AspNetCore.Mvc.Filters; 3 | using Microsoft.AspNetCore.Mvc.ModelBinding.Validation; 4 | using Microsoft.Extensions.DependencyInjection; 5 | using Microsoft.Extensions.Options; 6 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Extensions; 7 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Results; 8 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Validation; 9 | using Xunit; 10 | 11 | namespace SharpGrip.FluentValidation.AutoValidation.Tests.FluentValidation.AutoValidation.Mvc.Extensions; 12 | 13 | public class ServiceCollectionExtensionsTest 14 | { 15 | [Fact] 16 | public void TestAddFluentValidationAutoValidation() 17 | { 18 | var serviceCollection = new ServiceCollection(); 19 | 20 | serviceCollection.AddFluentValidationAutoValidation(); 21 | 22 | AssertNotContainsServiceDescriptor(serviceCollection, ServiceLifetime.Scoped); 23 | AssertContainsServiceDescriptor(serviceCollection, ServiceLifetime.Scoped); 24 | AssertNotContainsServiceDescriptor(serviceCollection, ServiceLifetime.Singleton); 25 | AssertContainsServiceDescriptor, ConfigureNamedOptions>(serviceCollection, ServiceLifetime.Singleton); 26 | } 27 | 28 | [Fact] 29 | public void TestAddFluentValidationAutoValidation_WithConfiguration_OverriddenResultFactory() 30 | { 31 | var serviceCollection = new ServiceCollection(); 32 | 33 | serviceCollection.AddFluentValidationAutoValidation(options => options.OverrideDefaultResultFactoryWith()); 34 | 35 | AssertContainsServiceDescriptor(serviceCollection, ServiceLifetime.Scoped); 36 | AssertNotContainsServiceDescriptor(serviceCollection, ServiceLifetime.Scoped); 37 | AssertNotContainsServiceDescriptor(serviceCollection, ServiceLifetime.Singleton); 38 | AssertContainsServiceDescriptor, ConfigureNamedOptions>(serviceCollection, ServiceLifetime.Singleton); 39 | } 40 | 41 | [Fact] 42 | public void TestAddFluentValidationAutoValidation_WithConfiguration_DisableBuiltInModelValidation_False() 43 | { 44 | var serviceCollection = new ServiceCollection(); 45 | 46 | serviceCollection.AddFluentValidationAutoValidation(options => { options.DisableBuiltInModelValidation = false; }); 47 | 48 | AssertNotContainsServiceDescriptor(serviceCollection, ServiceLifetime.Scoped); 49 | AssertContainsServiceDescriptor(serviceCollection, ServiceLifetime.Scoped); 50 | AssertNotContainsServiceDescriptor(serviceCollection, ServiceLifetime.Singleton); 51 | AssertContainsServiceDescriptor, ConfigureNamedOptions>(serviceCollection, ServiceLifetime.Singleton); 52 | } 53 | 54 | [Fact] 55 | public void TestAddFluentValidationAutoValidation_WithConfiguration_DisableBuiltInModelValidation_True() 56 | { 57 | var serviceCollection = new ServiceCollection(); 58 | 59 | serviceCollection.AddFluentValidationAutoValidation(options => { options.DisableBuiltInModelValidation = true; }); 60 | 61 | AssertNotContainsServiceDescriptor(serviceCollection, ServiceLifetime.Scoped); 62 | AssertContainsServiceDescriptor(serviceCollection, ServiceLifetime.Scoped); 63 | AssertContainsServiceDescriptor(serviceCollection, ServiceLifetime.Singleton); 64 | AssertContainsServiceDescriptor, ConfigureNamedOptions>(serviceCollection, ServiceLifetime.Singleton); 65 | } 66 | 67 | // ReSharper disable ParameterOnlyUsedForPreconditionCheck.Local 68 | private static void AssertContainsServiceDescriptor(ServiceCollection serviceCollection, ServiceLifetime serviceLifetime) 69 | { 70 | Assert.Contains(serviceCollection, serviceDescriptor => serviceDescriptor.ServiceType == typeof(TService) && 71 | (serviceDescriptor.ImplementationType == typeof(TImplementation) || 72 | serviceDescriptor.ImplementationFactory?.Method.ReturnType == typeof(TImplementation) || 73 | serviceDescriptor.ImplementationInstance?.GetType() == typeof(TImplementation)) && 74 | serviceDescriptor.Lifetime == serviceLifetime); 75 | } 76 | 77 | // ReSharper disable ParameterOnlyUsedForPreconditionCheck.Local 78 | private static void AssertNotContainsServiceDescriptor(ServiceCollection serviceCollection, ServiceLifetime serviceLifetime) 79 | { 80 | Assert.DoesNotContain(serviceCollection, serviceDescriptor => serviceDescriptor.ServiceType == typeof(TService) && 81 | (serviceDescriptor.ImplementationType == typeof(TImplementation) || 82 | serviceDescriptor.ImplementationFactory?.Method.ReturnType == typeof(TImplementation) || 83 | serviceDescriptor.ImplementationInstance?.GetType() == typeof(TImplementation)) && 84 | serviceDescriptor.Lifetime == serviceLifetime); 85 | } 86 | 87 | private class TestResultFactory : IFluentValidationAutoValidationResultFactory 88 | { 89 | public IActionResult CreateActionResult(ActionExecutingContext context, ValidationProblemDetails? validationProblemDetails) 90 | { 91 | return new OkResult(); 92 | } 93 | } 94 | } -------------------------------------------------------------------------------- /Tests/src/FluentValidation.AutoValidation.Mvc/Filters/FluentValidationAutoValidationActionFilterTest.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Linq; 4 | using System.Threading.Tasks; 5 | using FluentValidation; 6 | using FluentValidation.Results; 7 | using Microsoft.AspNetCore.Http; 8 | using Microsoft.AspNetCore.Mvc; 9 | using Microsoft.AspNetCore.Mvc.Abstractions; 10 | using Microsoft.AspNetCore.Mvc.Controllers; 11 | using Microsoft.AspNetCore.Mvc.Filters; 12 | using Microsoft.AspNetCore.Mvc.Infrastructure; 13 | using Microsoft.AspNetCore.Mvc.ModelBinding; 14 | using Microsoft.AspNetCore.Routing; 15 | using Microsoft.Extensions.Options; 16 | using NSubstitute; 17 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Configuration; 18 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Filters; 19 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Interceptors; 20 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Results; 21 | using Xunit; 22 | using IValidatorInterceptor = SharpGrip.FluentValidation.AutoValidation.Mvc.Interceptors.IValidatorInterceptor; 23 | 24 | namespace SharpGrip.FluentValidation.AutoValidation.Tests.FluentValidation.AutoValidation.Mvc.Filters; 25 | 26 | public class FluentValidationAutoValidationActionFilterTest 27 | { 28 | [Fact] 29 | public async Task TestOnActionExecutionAsync() 30 | { 31 | var actionArguments = new Dictionary 32 | { 33 | { 34 | nameof(TestModel), new TestModel 35 | { 36 | Parameter1 = "Value 1", 37 | Parameter2 = "Value 2", 38 | Parameter3 = "Value 3" 39 | } 40 | }, 41 | }; 42 | var controllerActionDescriptor = new ControllerActionDescriptor 43 | { 44 | Parameters = new List 45 | { 46 | new() 47 | { 48 | Name = nameof(TestModel), 49 | ParameterType = typeof(TestModel), 50 | BindingInfo = new BindingInfo {BindingSource = BindingSource.Body} 51 | } 52 | } 53 | }; 54 | var validationFailures = new Dictionary 55 | { 56 | {nameof(TestModel.Parameter1), [$"'{nameof(TestModel.Parameter1)}' must be empty."]}, 57 | {nameof(TestModel.Parameter2), [$"'{nameof(TestModel.Parameter2)}' must be empty."]}, 58 | {nameof(TestModel.Parameter3), [$"'{nameof(TestModel.Parameter3)}' must be empty."]} 59 | }; 60 | 61 | var validationProblemDetails = new ValidationProblemDetails(validationFailures); 62 | var modelStateDictionary = new ModelStateDictionary(); 63 | 64 | var serviceProvider = Substitute.For(); 65 | var problemDetailsFactory = Substitute.For(); 66 | var fluentValidationAutoValidationResultFactory = Substitute.For(); 67 | var autoValidationMvcConfiguration = Substitute.For>(); 68 | var httpContext = Substitute.For(); 69 | var controller = Substitute.For(); 70 | var actionContext = Substitute.For(httpContext, Substitute.For(), controllerActionDescriptor, modelStateDictionary); 71 | var actionExecutingContext = Substitute.For(actionContext, new List(), actionArguments, new object()); 72 | var actionExecutedContext = Substitute.For(actionContext, new List(), new object()); 73 | 74 | serviceProvider.GetService(typeof(IValidator<>).MakeGenericType(typeof(TestModel))).Returns(new TestValidator()); 75 | serviceProvider.GetService(typeof(IGlobalValidationInterceptor)).Returns(new GlobalValidationInterceptor()); 76 | serviceProvider.GetService(typeof(ProblemDetailsFactory)).Returns(problemDetailsFactory); 77 | 78 | problemDetailsFactory.CreateValidationProblemDetails(httpContext, modelStateDictionary).Returns(validationProblemDetails); 79 | fluentValidationAutoValidationResultFactory.CreateActionResult(actionExecutingContext, validationProblemDetails).Returns(new BadRequestObjectResult(validationProblemDetails)); 80 | httpContext.RequestServices.Returns(serviceProvider); 81 | actionExecutingContext.Controller.Returns(controller); 82 | actionExecutingContext.ActionDescriptor = controllerActionDescriptor; 83 | actionExecutingContext.ActionArguments.Returns(actionArguments); 84 | autoValidationMvcConfiguration.Value.Returns(new AutoValidationMvcConfiguration()); 85 | 86 | var actionFilter = new FluentValidationAutoValidationActionFilter(fluentValidationAutoValidationResultFactory, autoValidationMvcConfiguration); 87 | 88 | await actionFilter.OnActionExecutionAsync(actionExecutingContext, () => Task.FromResult(actionExecutedContext)); 89 | 90 | var modelStateDictionaryValues = modelStateDictionary.Values.ToList(); 91 | var validationFailuresValues = validationFailures.Values.ToList(); 92 | var badRequestObjectResult = (BadRequestObjectResult) actionExecutingContext.Result!; 93 | var badRequestObjectResultValidationProblemDetails = (ValidationProblemDetails) badRequestObjectResult.Value!; 94 | 95 | Assert.Contains(validationFailuresValues[0].First(), modelStateDictionaryValues[0].Errors.Select(error => error.ErrorMessage)); 96 | Assert.Contains(validationFailuresValues[1].First(), modelStateDictionaryValues[1].Errors.Select(error => error.ErrorMessage)); 97 | Assert.Contains(validationFailuresValues[2].First(), modelStateDictionaryValues[2].Errors.Select(error => error.ErrorMessage)); 98 | 99 | Assert.Contains(validationFailuresValues[0].First(), badRequestObjectResultValidationProblemDetails.Errors[nameof(TestModel.Parameter1)][0]); 100 | Assert.Contains(validationFailuresValues[1].First(), badRequestObjectResultValidationProblemDetails.Errors[nameof(TestModel.Parameter2)][0]); 101 | Assert.Contains(validationFailuresValues[2].First(), badRequestObjectResultValidationProblemDetails.Errors[nameof(TestModel.Parameter3)][0]); 102 | } 103 | 104 | [Fact] 105 | public async Task OnActionExecutionAsync_WithInstanceTypeDifferentThanParameterType_UsesInstanceTypeValidator() 106 | { 107 | // Arrange 108 | var httpContext = Substitute.For(); 109 | var modelStateDictionary = new ModelStateDictionary(); 110 | 111 | var validationFailures = new Dictionary 112 | { 113 | {nameof(CreatePersonRequest.Name), [$"'{nameof(CreatePersonRequest.Name)}' must be equal to 'John Doe'."]} 114 | }; 115 | var validationProblemDetails = new ValidationProblemDetails(validationFailures); 116 | 117 | var problemDetailsFactory = Substitute.For(); 118 | problemDetailsFactory.CreateValidationProblemDetails(httpContext, modelStateDictionary).Returns(validationProblemDetails); 119 | 120 | var serviceProvider = Substitute.For(); 121 | serviceProvider.GetService(typeof(IValidator<>).MakeGenericType(typeof(CreateAnimalRequest))).Returns(new CreateAnimalRequestValidator()); 122 | serviceProvider.GetService(typeof(IValidator<>).MakeGenericType(typeof(CreatePersonRequest))).Returns(new CreatePersonRequestValidator()); 123 | serviceProvider.GetService(typeof(ProblemDetailsFactory)).Returns(problemDetailsFactory); 124 | 125 | httpContext.RequestServices.Returns(serviceProvider); 126 | 127 | var controller = Substitute.For(); 128 | var controllerActionDescriptor = new ControllerActionDescriptor 129 | { 130 | Parameters = 131 | [ 132 | new() 133 | { 134 | Name = "request", 135 | ParameterType = typeof(CreateAnimalRequest), 136 | BindingInfo = new BindingInfo {BindingSource = BindingSource.Body} 137 | } 138 | ] 139 | }; 140 | var actionContext = Substitute.For(httpContext, Substitute.For(), controllerActionDescriptor, modelStateDictionary); 141 | 142 | var actionArguments = new Dictionary 143 | { 144 | { 145 | "request", new CreatePersonRequest 146 | { 147 | Name = "Jane Doe" 148 | } 149 | }, 150 | }; 151 | var actionExecutingContext = Substitute.For(actionContext, new List(), actionArguments, new object()); 152 | actionExecutingContext.Controller.Returns(controller); 153 | actionExecutingContext.ActionDescriptor = controllerActionDescriptor; 154 | actionExecutingContext.ActionArguments.Returns(actionArguments); 155 | 156 | var actionExecutedContext = Substitute.For(actionContext, new List(), new object()); 157 | 158 | var fluentValidationAutoValidationResultFactory = Substitute.For(); 159 | fluentValidationAutoValidationResultFactory.CreateActionResult(actionExecutingContext, validationProblemDetails).Returns(new BadRequestObjectResult(validationProblemDetails)); 160 | 161 | var autoValidationMvcConfiguration = Substitute.For>(); 162 | autoValidationMvcConfiguration.Value.Returns(new AutoValidationMvcConfiguration()); 163 | 164 | var actionFilter = new FluentValidationAutoValidationActionFilter(fluentValidationAutoValidationResultFactory, autoValidationMvcConfiguration); 165 | 166 | // Act 167 | await actionFilter.OnActionExecutionAsync(actionExecutingContext, () => Task.FromResult(actionExecutedContext)); 168 | 169 | // Assert 170 | var modelStateDictionaryValues = modelStateDictionary.Values.ToList(); 171 | var validationFailuresValues = validationFailures.Values.ToList(); 172 | var badRequestObjectResult = (BadRequestObjectResult)actionExecutingContext.Result!; 173 | var badRequestObjectResultValidationProblemDetails = (ValidationProblemDetails)badRequestObjectResult.Value!; 174 | 175 | Assert.Contains(validationFailuresValues[0].First(), modelStateDictionaryValues[0].Errors.Select(error => error.ErrorMessage)); 176 | Assert.Contains(validationFailuresValues[0].First(), badRequestObjectResultValidationProblemDetails.Errors[nameof(CreatePersonRequest.Name)][0]); 177 | } 178 | 179 | public class AnimalsController : ControllerBase 180 | { 181 | } 182 | 183 | public class CreateAnimalRequest 184 | { 185 | } 186 | 187 | public class CreatePersonRequest : CreateAnimalRequest 188 | { 189 | public required string Name { get; set; } 190 | } 191 | 192 | public class CreateAnimalRequestValidator : AbstractValidator 193 | { 194 | public CreateAnimalRequestValidator() 195 | { 196 | } 197 | } 198 | 199 | public class CreatePersonRequestValidator : AbstractValidator 200 | { 201 | public CreatePersonRequestValidator() 202 | { 203 | this.Include(new CreateAnimalRequestValidator()); 204 | 205 | this.RuleFor(x => x.Name).Equal("John Doe"); 206 | } 207 | } 208 | 209 | public class TestController : ControllerBase 210 | { 211 | } 212 | 213 | private class TestModel 214 | { 215 | public string? Parameter1 { get; set; } 216 | public string? Parameter2 { get; set; } 217 | public string? Parameter3 { get; set; } 218 | } 219 | 220 | private class TestValidator : AbstractValidator, IValidatorInterceptor 221 | { 222 | public TestValidator() 223 | { 224 | RuleFor(x => x.Parameter1).Empty(); 225 | RuleFor(x => x.Parameter2).Empty(); 226 | RuleFor(x => x.Parameter3).Empty(); 227 | } 228 | 229 | public IValidationContext? BeforeValidation(ActionExecutingContext actionExecutingContext, IValidationContext validationContext) 230 | { 231 | return null; 232 | } 233 | 234 | public ValidationResult? AfterValidation(ActionExecutingContext actionExecutingContext, IValidationContext validationContext) 235 | { 236 | return null; 237 | } 238 | } 239 | 240 | private class GlobalValidationInterceptor : IGlobalValidationInterceptor 241 | { 242 | public IValidationContext? BeforeValidation(ActionExecutingContext actionExecutingContext, IValidationContext validationContext) 243 | { 244 | return null; 245 | } 246 | 247 | public ValidationResult? AfterValidation(ActionExecutingContext actionExecutingContext, IValidationContext validationContext) 248 | { 249 | return null; 250 | } 251 | } 252 | } -------------------------------------------------------------------------------- /Tests/src/FluentValidation.AutoValidation.Mvc/Results/FluentValidationAutoValidationDefaultResultFactoryTest.cs: -------------------------------------------------------------------------------- 1 | using System.Collections.Generic; 2 | using Microsoft.AspNetCore.Http; 3 | using Microsoft.AspNetCore.Mvc; 4 | using Microsoft.AspNetCore.Mvc.Abstractions; 5 | using Microsoft.AspNetCore.Mvc.Filters; 6 | using Microsoft.AspNetCore.Routing; 7 | using NSubstitute; 8 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Results; 9 | using Xunit; 10 | 11 | namespace SharpGrip.FluentValidation.AutoValidation.Tests.FluentValidation.AutoValidation.Mvc.Results; 12 | 13 | public class FluentValidationAutoValidationDefaultResultFactoryTest 14 | { 15 | private static readonly Dictionary ValidationFailures = new() 16 | { 17 | {"Property 1", new[] {"Error message 1"}}, 18 | {"Property 2", new[] {"Error message 2"}}, 19 | {"Property 3", new[] {"Error message 3"}}, 20 | }; 21 | 22 | [Fact] 23 | public void TestAddFluentValidationAutoValidation_WithConfiguration_DisableBuiltInModelValidation_False() 24 | { 25 | var fluentValidationAutoValidationDefaultResultFactory = new FluentValidationAutoValidationDefaultResultFactory(); 26 | 27 | var actionContext = Substitute.For(Substitute.For(), Substitute.For(), Substitute.For()); 28 | var actionExecutingContext = Substitute.For(actionContext, new List(), new Dictionary(), new object()); 29 | 30 | var validationProblemDetails = new ValidationProblemDetails(ValidationFailures); 31 | var badRequestObjectResult = new BadRequestObjectResult(validationProblemDetails); 32 | 33 | var resultFactoryResult = (BadRequestObjectResult) fluentValidationAutoValidationDefaultResultFactory.CreateActionResult(actionExecutingContext, validationProblemDetails); 34 | 35 | Assert.Equal(badRequestObjectResult.Value, resultFactoryResult.Value); 36 | } 37 | } -------------------------------------------------------------------------------- /Tests/src/FluentValidation.AutoValidation.Mvc/Validation/FluentValidationAutoValidationObjectModelValidatorTest.cs: -------------------------------------------------------------------------------- 1 | using System.Collections.Generic; 2 | using Microsoft.AspNetCore.Mvc; 3 | using Microsoft.AspNetCore.Mvc.ModelBinding; 4 | using Microsoft.AspNetCore.Mvc.ModelBinding.Validation; 5 | using NSubstitute; 6 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Validation; 7 | using Xunit; 8 | 9 | namespace SharpGrip.FluentValidation.AutoValidation.Tests.FluentValidation.AutoValidation.Mvc.Validation; 10 | 11 | public class FluentValidationAutoValidationObjectModelValidatorTest 12 | { 13 | [Fact] 14 | public void TestGetValidationVisitor() 15 | { 16 | var modelMetadataProvider = Substitute.For(); 17 | var modelMetadataProviders = Substitute.For>(); 18 | var actionContext = Substitute.For(); 19 | var modelValidatorProvider = Substitute.For(); 20 | var validatorCache = Substitute.For(); 21 | 22 | var fluentValidationAutoValidationObjectModelValidator = new FluentValidationAutoValidationObjectModelValidator(modelMetadataProvider, modelMetadataProviders, true); 23 | 24 | Assert.IsType( 25 | fluentValidationAutoValidationObjectModelValidator.GetValidationVisitor(actionContext, modelValidatorProvider, validatorCache, modelMetadataProvider, null)); 26 | } 27 | } -------------------------------------------------------------------------------- /Tests/src/FluentValidation.AutoValidation.Mvc/Validation/FluentValidationAutoValidationValidationVisitorTest.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.AspNetCore.Mvc; 2 | using Microsoft.AspNetCore.Mvc.ModelBinding; 3 | using Microsoft.AspNetCore.Mvc.ModelBinding.Validation; 4 | using NSubstitute; 5 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Validation; 6 | using Xunit; 7 | 8 | namespace SharpGrip.FluentValidation.AutoValidation.Tests.FluentValidation.AutoValidation.Mvc.Validation; 9 | 10 | public class FluentValidationAutoValidationValidationVisitorTest 11 | { 12 | [Fact] 13 | public void TestGetValidationVisitor() 14 | { 15 | var modelMetadataProvider = Substitute.For(); 16 | var actionContext = Substitute.For(); 17 | var modelValidatorProvider = Substitute.For(); 18 | var validatorCache = Substitute.For(); 19 | 20 | var fluentValidationAutoValidationObjectModelValidator = 21 | new FluentValidationAutoValidationValidationVisitor(actionContext, modelValidatorProvider, validatorCache, modelMetadataProvider, null, true); 22 | 23 | #if NETCOREAPP3_1 24 | Assert.True(fluentValidationAutoValidationObjectModelValidator.Validate(null, null, new TestModel(), true)); 25 | #else 26 | Assert.True(fluentValidationAutoValidationObjectModelValidator.Validate(null, null, new TestModel(), true, null)); 27 | #endif 28 | } 29 | 30 | private class TestModel 31 | { 32 | } 33 | } -------------------------------------------------------------------------------- /Tests/src/FluentValidation.AutoValidation.Shared/Extensions/ServiceProviderExtensionsTest.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using FluentValidation; 3 | using NSubstitute; 4 | using SharpGrip.FluentValidation.AutoValidation.Shared.Extensions; 5 | using Xunit; 6 | 7 | namespace SharpGrip.FluentValidation.AutoValidation.Tests.FluentValidation.AutoValidation.Shared.Extensions; 8 | 9 | public class ServiceProviderExtensionsTest 10 | { 11 | [Fact] 12 | public void Test_GetValidator() 13 | { 14 | var serviceProvider = Substitute.For(); 15 | 16 | var testModel = new TestModel(); 17 | var testModelValidator = new TestModelValidator(); 18 | 19 | serviceProvider.GetService(typeof(IValidator<>).MakeGenericType(testModel.GetType())).Returns(testModelValidator); 20 | 21 | var validator = serviceProvider.GetValidator(testModel.GetType()); 22 | 23 | Assert.Equal(testModelValidator, validator); 24 | } 25 | 26 | private class TestModel; 27 | 28 | private class TestModelValidator; 29 | } -------------------------------------------------------------------------------- /Tests/src/FluentValidation.AutoValidation.Shared/Extensions/TypeExtensionsTest.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using Microsoft.AspNetCore.Mvc; 3 | using SharpGrip.FluentValidation.AutoValidation.Mvc.Attributes; 4 | using SharpGrip.FluentValidation.AutoValidation.Shared.Extensions; 5 | using Xunit; 6 | 7 | namespace SharpGrip.FluentValidation.AutoValidation.Tests.FluentValidation.AutoValidation.Shared.Extensions; 8 | 9 | public class TypeExtensionsTest 10 | { 11 | [Fact] 12 | public void Test_IsCustomType() 13 | { 14 | Assert.True(typeof(TestModelClass).IsCustomType()); 15 | Assert.True(typeof(TestModelRecord).IsCustomType()); 16 | Assert.False(typeof(TestModelEnum).IsCustomType()); 17 | Assert.False(typeof(Enum).IsCustomType()); 18 | Assert.False(typeof(string).IsCustomType()); 19 | Assert.False(typeof(char).IsCustomType()); 20 | Assert.False(typeof(short).IsCustomType()); 21 | Assert.False(typeof(ushort).IsCustomType()); 22 | Assert.False(typeof(int).IsCustomType()); 23 | Assert.False(typeof(uint).IsCustomType()); 24 | Assert.False(typeof(nint).IsCustomType()); 25 | Assert.False(typeof(nuint).IsCustomType()); 26 | Assert.False(typeof(long).IsCustomType()); 27 | Assert.False(typeof(ulong).IsCustomType()); 28 | Assert.False(typeof(double).IsCustomType()); 29 | Assert.False(typeof(float).IsCustomType()); 30 | Assert.False(typeof(decimal).IsCustomType()); 31 | Assert.False(typeof(byte).IsCustomType()); 32 | Assert.False(typeof(sbyte).IsCustomType()); 33 | Assert.False(typeof(DateTime).IsCustomType()); 34 | Assert.False(typeof(DateTimeOffset).IsCustomType()); 35 | Assert.False(typeof(TimeSpan).IsCustomType()); 36 | Assert.False(typeof(Guid).IsCustomType()); 37 | Assert.False(typeof(DateOnly).IsCustomType()); 38 | Assert.False(typeof(TimeOnly).IsCustomType()); 39 | } 40 | 41 | [Fact] 42 | public void Test_HasCustomAttribute() 43 | { 44 | Assert.True(typeof(TestModelClass).HasCustomAttribute()); 45 | Assert.False(typeof(TestModelClass).HasCustomAttribute()); 46 | Assert.True(typeof(TestModelRecord).HasCustomAttribute()); 47 | Assert.False(typeof(TestModelRecord).HasCustomAttribute()); 48 | } 49 | 50 | [Fact] 51 | public void Test_InheritsFromTypeWithNameEndingIn() 52 | { 53 | Assert.True(typeof(TestInherits1).InheritsFromTypeWithNameEndingIn("Controller")); 54 | Assert.True(typeof(TestInherits1).InheritsFromTypeWithNameEndingIn("controller")); 55 | Assert.True(typeof(TestInherits2).InheritsFromTypeWithNameEndingIn("Controller")); 56 | Assert.True(typeof(TestInherits2).InheritsFromTypeWithNameEndingIn("controller")); 57 | Assert.False(typeof(TestInherits3).InheritsFromTypeWithNameEndingIn("Controller")); 58 | Assert.False(typeof(TestInherits3).InheritsFromTypeWithNameEndingIn("controller")); 59 | Assert.False(typeof(TestInherits4).InheritsFromTypeWithNameEndingIn("Controller")); 60 | Assert.False(typeof(TestInherits4).InheritsFromTypeWithNameEndingIn("controller")); 61 | Assert.False(typeof(TestInherits5).InheritsFromTypeWithNameEndingIn("Controller")); 62 | Assert.False(typeof(TestInherits5).InheritsFromTypeWithNameEndingIn("controller")); 63 | } 64 | 65 | [AutoValidation] 66 | private class TestModelClass; 67 | 68 | [AutoValidateNever] 69 | private record TestModelRecord; 70 | 71 | private enum TestModelEnum; 72 | 73 | private class TestInherits1 : Controller; 74 | 75 | private class TestInherits2 : CustomControllerBase; 76 | 77 | private class TestInherits3 : ControllerBase; 78 | 79 | private class TestInherits4 : ActionContext; 80 | 81 | private class TestInherits5 : object; 82 | 83 | private class CustomControllerBase : Controller; 84 | } -------------------------------------------------------------------------------- /Tests/src/FluentValidation.AutoValidation.Shared/Extensions/ValidationResultExtensionsTest.cs: -------------------------------------------------------------------------------- 1 | using System.Collections.Generic; 2 | using System.Linq; 3 | using FluentValidation.Results; 4 | using SharpGrip.FluentValidation.AutoValidation.Shared.Extensions; 5 | using Xunit; 6 | 7 | namespace SharpGrip.FluentValidation.AutoValidation.Tests.FluentValidation.AutoValidation.Shared.Extensions; 8 | 9 | public class ValidationResultExtensionsTest 10 | { 11 | [Fact] 12 | public void Test_GetValidator() 13 | { 14 | var validationFailures = new List 15 | { 16 | new("Property 1", "Error message 1"), 17 | new("Property 2", "Error message 2"), 18 | new("Property 3", "Error message 3"), 19 | }; 20 | 21 | var validationResult = new ValidationResult(validationFailures); 22 | 23 | var validationProblemErrors = validationResult.ToValidationProblemErrors(); 24 | 25 | Assert.Equal(validationProblemErrors, ToValidationProblemErrors(validationResult)); 26 | } 27 | 28 | private static Dictionary ToValidationProblemErrors(ValidationResult validationResult) 29 | { 30 | return validationResult.Errors.GroupBy(validationFailure => validationFailure.PropertyName) 31 | .ToDictionary(validationFailureGrouping => validationFailureGrouping.Key, 32 | validationFailureGrouping => validationFailureGrouping.Select(validationFailure => validationFailure.ErrorMessage).ToArray()); 33 | } 34 | } --------------------------------------------------------------------------------