-
Notifications
You must be signed in to change notification settings - Fork 13
FluentValidation support
Adam Bajguz edited this page Feb 23, 2021
·
1 revision
See TypinExamples.Validation example for working project.
To validate command with FluentValidation you have to:
- Install
FluentValidation
andFluentValidation.DependencyInjectionExtensions
in your project. - Create a middleware:
namespace TypinExamples.Validation.Middleware
{
using System;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using FluentValidation;
using FluentValidation.Results;
using Microsoft.Extensions.Logging;
using Typin;
using Typin.Console;
using Typin.Schemas;
public sealed class FluentValidationMiddleware : IMiddleware
{
private readonly IServiceProvider _serviceProvider;
private readonly ILogger _logger;
public FluentValidationMiddleware(IServiceProvider serviceProvider, ILogger<FluentValidationMiddleware> logger)
{
_serviceProvider = serviceProvider;
_logger = logger;
}
public async Task HandleAsync(ICliContext context, CommandPipelineHandlerDelegate next, CancellationToken cancellationToken)
{
try
{
await ValidateCurrentCommand(context, cancellationToken);
await next();
}
catch (ValidationException ex)
{
_logger.LogError(ex, "Validation of command {CommandType} failed.", context.CommandSchema.Type.FullName);
PrintValidationResults(context, ex);
}
}
private async Task ValidateCurrentCommand(ICliContext context, CancellationToken cancellationToken)
{
Type validatorType = typeof(IValidator<>).MakeGenericType(context.CommandSchema.Type);
if (_serviceProvider.GetService(validatorType) is IValidator validator)
{
IValidationContext validationContext = new ValidationContext<ICommand>(context.Command);
ValidationResult validationResult = await validator.ValidateAsync(validationContext, cancellationToken);
if (!validationResult.IsValid)
{
throw new ValidationException(validationResult.Errors);
}
}
else
{
_logger.LogDebug("No validator for {Type}.", validatorType);
}
}
private static void PrintValidationResults(ICliContext context, ValidationException ex)
{
context.Console.Error.WithForegroundColor(ConsoleColor.Red, (error) => error.WriteLine("Validation failed:"));
foreach (IGrouping<string, ValidationFailure> group in ex.Errors.GroupBy(x => x.PropertyName))
{
ArgumentSchema property = context.CommandSchema.GetArguments().Where(x => x.Property?.Name == group.Key).First();
string name = group.Key;
if (property is CommandOptionSchema option)
{
name = "--" + option.Name;
}
else if (property is CommandParameterSchema parameter)
{
name = $"Parameter {parameter.Order}";
}
context.Console.Error.Write(" ");
context.Console.Error.WithForegroundColor(ConsoleColor.Cyan, (error) => error.Write(name));
context.Console.Error.Write(" ");
context.Console.Error.WithForegroundColor(ConsoleColor.Green, (error) => error.Write($"[{group.First().AttemptedValue}]"));
context.Console.Error.WriteLine(" ");
foreach (var validationError in group)
{
context.Console.Error.Write(" -- ");
context.Console.Error.WithForegroundColor(ConsoleColor.White, (error) => error.WriteLine(validationError.ErrorMessage));
}
context.Console.Error.WriteLine();
}
}
}
}
3. Configure app:
```c#
namespace TypinExamples.Validation
{
using FluentValidation;
using Microsoft.Extensions.DependencyInjection;
using Typin;
using Typin.Directives;
using TypinExamples.Infrastructure.TypinWeb.Commands;
using TypinExamples.Validation.Middleware;
public class Startup : ICliStartup
{
public void Configure(CliApplicationBuilder app)
{
ValidatorOptions.Global.LanguageManager.Enabled = false;
app.AddCommandsFromThisAssembly()
.UseMiddleware<FluentValidationMiddleware>();
}
public void ConfigureServices(IServiceCollection services)
{
services.AddValidatorsFromAssemblyContaining(typeof(Startup));
}
}
}
- Add validator for command, e.g.:
namespace TypinExamples.Validation.Commands
{
using FluentValidation;
public class EmailCommandValidator : AbstractValidator<EmailCommand>
{
public EmailCommandValidator()
{
RuleFor(x => x.Email).NotEmpty();
RuleFor(x => x.Email).EmailAddress();
RuleFor(x => x.Email).MinimumLength(3);
}
}
}
Getting started
Advanced features
- Reporting errors
- Exception handling
- Metadata and startup message
- Graceful cancellation
- Dependency injection
- Middleware pipeline
- Environment variables
Utilities
Tests
Misc