Merge pull request #115 from TraGicCode/chore/add-fluent-validation-for-config-file

Add fluentvalidation to be able to handle issues in busly config file

Author: TraGicCode

src/BuslyCLI.Console/BuslyCLI.Console.csproj

@@ -25,6 +25,8 @@
   </ItemGroup> 
 
   <ItemGroup>
+    <PackageReference Include="FluentValidation" Version="12.1.1" />
+    <PackageReference Include="FluentValidation.DependencyInjectionExtensions" Version="12.1.1" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="10.0.0" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="10.0.0" />
     <PackageReference Include="NServiceBus" Version="9.2.7" />

src/BuslyCLI.Console/Commands/Command/SendCommand.cs

@@ -11,7 +11,7 @@ public class SendCommand(IRawEndpointFactory rawEndpointFactory, INServiceBusCon
 {
     public override async Task<int> ExecuteAsync(CommandContext context, SendCommandSettings settings, CancellationToken cancellationToken)
     {
-        var config = await nServiceBusConfiguration.GetConfigurationAsync(settings.Config.Path);
+        var config = await nServiceBusConfiguration.GetValidatedConfigurationAsync(settings.Config.Path);
         var rawEndpoint = await rawEndpointFactory.CreateRawSendOnlyEndpoint(Constants.DefaultOriginatingEndpoint, config.CurrentTransportConfig);
         // TODO: Validate body is valid json/xml
         var headers = new Dictionary<string, string>

src/BuslyCLI.Console/Commands/Demo/StartCommand.cs

@@ -13,7 +13,7 @@ public class StartDemoCommand(IAnsiConsole console, IRawEndpointFactory rawEndpo
     public override async Task<int> ExecuteAsync(CommandContext context, CurrentTransportSettings settings, CancellationToken cancellationToken)
     {
         console.WriteLine("Starting demo endpoint for quick start guide...");
-        var config = await nServiceBusConfiguration.GetConfigurationAsync(settings.Config.Path);
+        var config = await nServiceBusConfiguration.GetValidatedConfigurationAsync(settings.Config.Path);
         var rawEndpoint = await rawEndpointFactory.CreateRawEndpoint(Constants.DemoDefaultOriginatingEndpoint, config.CurrentTransportConfig);
 
         await rawEndpoint.StartEndpoint();

src/BuslyCLI.Console/Commands/Event/PublishCommand.cs

@@ -13,7 +13,7 @@ public class PublishCommand(IRawEndpointFactory rawEndpointFactory, INServiceBus
 {
     public override async Task<int> ExecuteAsync(CommandContext context, PublishCommandSettings settings, CancellationToken cancellationToken)
     {
-        var config = await nServiceBusConfiguration.GetConfigurationAsync(settings.Config.Path);
+        var config = await nServiceBusConfiguration.GetValidatedConfigurationAsync(settings.Config.Path);
         var rawEndpoint = await rawEndpointFactory.CreateRawSendOnlyEndpoint(Constants.DefaultOriginatingEndpoint, config.CurrentTransportConfig);
         // TODO: Validate body is valid json/xml
         var headers = new Dictionary<string, string>

src/BuslyCLI.Console/Commands/Transport/CurrentTransportCommand.cs

@@ -9,7 +9,7 @@ public class CurrentTransportCommand(IAnsiConsole console, INServiceBusConfigura
 {
     public override async Task<int> ExecuteAsync(CommandContext context, CurrentTransportSettings settings, CancellationToken cancellationToken)
     {
-        var nsbConfiguration = await nservicebusConfiguration.GetConfigurationAsync(settings.Config.Path);
+        var nsbConfiguration = await nservicebusConfiguration.GetUnValidatedConfigurationAsync(settings.Config.Path);
 
         console.WriteLine(nsbConfiguration != null && nsbConfiguration.CurrentTransport is not null ? nsbConfiguration.CurrentTransport : "Current transport is not set.");
         return 0;

src/BuslyCLI.Console/Commands/Transport/DeleteTransportCommand.cs

@@ -9,7 +9,7 @@ public class DeleteTransportCommand(IAnsiConsole console, INServiceBusConfigurat
 {
     public override async Task<int> ExecuteAsync(CommandContext context, DeleteTransportSettings settings, CancellationToken cancellationToken)
     {
-        var nsbConfiguration = await nservicebusConfiguration.GetConfigurationAsync(settings.Config.Path);
+        var nsbConfiguration = await nservicebusConfiguration.GetValidatedConfigurationAsync(settings.Config.Path);
         var targetTransport = settings.TransportName.ToLower();
         if (nsbConfiguration.Transports.Select(x => x.Name.ToLower()).Contains(targetTransport))
         {

src/BuslyCLI.Console/Commands/Transport/ListTransportsCommand.cs

@@ -32,9 +32,9 @@ public override async Task<int> ExecuteAsync(CommandContext context, ListTranspo
         // Add header row
         grid.AddRow("CURRENT", "NAME", "TRANSPORT-TYPE");
 
-        var nsbConfiguration = await nservicebusConfiguration.GetConfigurationAsync(settings.Config.Path);
+        var nsbConfiguration = await nservicebusConfiguration.GetUnValidatedConfigurationAsync(settings.Config.Path);
 
-        if (nsbConfiguration != null)
+        if (nsbConfiguration is { Transports: not null })
         {
             foreach (var transport in nsbConfiguration.Transports)
             {

src/BuslyCLI.Console/Commands/Transport/SetTransportCommand.cs

@@ -9,7 +9,7 @@ public class SetTransportCommand(IAnsiConsole console, INServiceBusConfiguration
 {
     public override async Task<int> ExecuteAsync(CommandContext context, SetTransportSettings settings, CancellationToken cancellationToken)
     {
-        var nsbConfiguration = await nservicebusConfiguration.GetConfigurationAsync(settings.Config.Path);
+        var nsbConfiguration = await nservicebusConfiguration.GetValidatedConfigurationAsync(settings.Config.Path);
         var targetTransport = settings.TransportName.ToLower();
         if (nsbConfiguration.Transports.Select(x => x.Name.ToLower()).Contains(targetTransport))
         {

src/BuslyCLI.Console/Config/INServiceBusConfiguration.cs

@@ -1,28 +1,45 @@
-using YamlDotNet.Serialization;
+using FluentValidation;
+using YamlDotNet.Serialization;
 
 namespace BuslyCLI.Config;
 
 public interface INServiceBusConfiguration
 {
-    Task<NServiceBusConfig> GetConfigurationAsync(string path);
+    Task<NServiceBusConfig> GetValidatedConfigurationAsync(string path);
+
+    Task<NServiceBusConfig> GetUnValidatedConfigurationAsync(string path);
 
     Task PersistConfiguration(string path, NServiceBusConfig config);
 }
 
-public class NServiceBusConfiguration(IDeserializer yamlDeserializer, ISerializer yamlSerializer) : INServiceBusConfiguration
+public class NServiceBusConfiguration(IDeserializer yamlDeserializer, ISerializer yamlSerializer, IValidator<NServiceBusConfig> validator) : INServiceBusConfiguration
 {
 
-    public async Task<NServiceBusConfig> GetConfigurationAsync(string path)
+
+    private async Task<NServiceBusConfig> LoadConfigurationAsync(
+        string path,
+        bool validate)
     {
-        if (File.Exists(path))
-        {
-            var yaml = await File.ReadAllTextAsync(path);
-            return yamlDeserializer.Deserialize<NServiceBusConfig>(yaml);
-        }
+        if (!File.Exists(path)) return null;
+
+        var yaml = await File.ReadAllTextAsync(path);
+        var config = yamlDeserializer.Deserialize<NServiceBusConfig>(yaml);
+
+        // config is null if yaml file is empty
+        if (config is null) return null;
 
-        return null;
+        if (validate)
+            await validator.ValidateAsync(config, opts => opts.ThrowOnFailures());
+
+        return config;
     }
 
+    public async Task<NServiceBusConfig> GetValidatedConfigurationAsync(string path)
+        => await LoadConfigurationAsync(path, validate: true);
+
+    public async Task<NServiceBusConfig> GetUnValidatedConfigurationAsync(string path)
+        => await LoadConfigurationAsync(path, validate: false);
+
     public async Task PersistConfiguration(string path, NServiceBusConfig config)
     {
         var yaml = yamlSerializer.Serialize(config);

src/BuslyCLI.Console/Config/Validators/LearningTransportConfigValidator.cs

@@ -0,0 +1,12 @@
+using FluentValidation;
+
+namespace BuslyCLI.Config.Validators;
+
+public class LearningTransportConfigValidator : AbstractValidator<LearningTransportConfig>
+{
+    public LearningTransportConfigValidator()
+    {
+        RuleFor(x => x.StorageDirectory)
+            .NotEmpty();
+    }
+}