dohertj2/jdescopingtool
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(configmanager): add runtime config validation using Infrastructure validators

Browse Source 
Enable ConfigManager to validate runtime configuration (SecureStore secrets,
connection strings, LDAP) using the same validators as the Host application.
Adds AddInfrastructureValidators() extension for shared validator registration.
This commit is contained in:
Joseph Doherty
2026-01-21 18:31:42 -05:00
parent e5fe2f06e9
commit 6642c83cdb
11 changed files with 792 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
NEW/src/Utils/JdeScoping.ConfigManager/App.axaml.cs
+3
View File
@@ -71,6 +71,9 @@ public partial class App : Avalonia.Application
services.AddSingleton<StoreUseCases>();
services.AddSingleton<SecretUseCases>();
// Runtime Validation Services
services.AddSingleton<IRuntimeConfigValidationService, RuntimeConfigValidationService>();
// ViewModels
services.AddTransient<MainWindowViewModel>();
}
NEW/src/Utils/JdeScoping.ConfigManager/JdeScoping.ConfigManager.csproj
+6 -3
View File
@@ -18,9 +18,11 @@
<PackageReference Include="Avalonia.Diagnostics" Version="11.2.*" Condition="'$(Configuration)' == 'Debug'" />
<PackageReference Include="DiffPlex" Version="1.7.*" />
<PackageReference Include="MessageBox.Avalonia" Version="3.1.*" />
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.*" />
<PackageReference Include="Microsoft.Extensions.Logging" Version="9.0.*" />
<PackageReference Include="Microsoft.Extensions.Logging.Console" Version="9.0.*" />
<PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="10.0.*" />
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="10.0.*" />
<PackageReference Include="Microsoft.Extensions.Logging" Version="10.0.*" />
<PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="10.0.*" />
<PackageReference Include="Microsoft.Extensions.Logging.Console" Version="10.0.*" />
<PackageReference Include="Serilog.Extensions.Logging" Version="8.0.*" />
<PackageReference Include="SecureStore" Version="1.2.0" />
<PackageReference Include="Serilog.Sinks.File" Version="6.0.*" />
@@ -28,5 +30,6 @@
<ItemGroup>
<ProjectReference Include="..\..\JdeScoping.Core\JdeScoping.Core.csproj" />
<ProjectReference Include="..\..\JdeScoping.Infrastructure\JdeScoping.Infrastructure.csproj" />
</ItemGroup>
</Project>
NEW/src/Utils/JdeScoping.ConfigManager/Services/IRuntimeConfigValidationService.cs
+40
View File
@@ -0,0 +1,40 @@
namespace JdeScoping.ConfigManager.Services;
/// <summary>
/// Result of runtime configuration validation.
/// </summary>
public class RuntimeValidationResult
{
/// <summary>
/// Gets or sets the name of the validator that produced this result.
/// </summary>
public string ValidatorName { get; init; } = "";
/// <summary>
/// Gets whether validation passed (no errors).
/// </summary>
public bool IsValid => Errors.Count == 0;
/// <summary>
/// Gets the list of validation errors.
/// </summary>
public List<string> Errors { get; } = [];
/// <summary>
/// Gets the list of validation warnings.
/// </summary>
public List<string> Warnings { get; } = [];
}
/// <summary>
/// Service for validating runtime configuration using Infrastructure validators.
/// </summary>
public interface IRuntimeConfigValidationService
{
/// <summary>
/// Validates the configuration in the specified folder using Infrastructure validators.
/// </summary>
/// <param name="configFolderPath">Path to the configuration folder.</param>
/// <returns>List of validation results from each validator.</returns>
List<RuntimeValidationResult> ValidateRuntimeConfig(string configFolderPath);
}
NEW/src/Utils/JdeScoping.ConfigManager/Services/RuntimeConfigValidationService.cs
+114
View File
@@ -0,0 +1,114 @@
using JdeScoping.ConfigManager.Services.SecureStore;
using JdeScoping.Core.Interfaces;
using JdeScoping.Core.Validation;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Abstractions;
namespace JdeScoping.ConfigManager.Services;
/// <summary>
/// Service that validates configuration using Infrastructure validators.
/// Uses DI-based automatic validator discovery (same pattern as Host).
/// </summary>
public class RuntimeConfigValidationService : IRuntimeConfigValidationService
{
private readonly ISecureStoreManager _secureStoreManager;
private readonly ILogger<RuntimeConfigValidationService> _logger;
/// <summary>
/// Creates a new instance of the runtime config validation service.
/// </summary>
/// <param name="secureStoreManager">The SecureStore manager for accessing secrets.</param>
/// <param name="logger">Optional logger for diagnostics.</param>
public RuntimeConfigValidationService(
ISecureStoreManager secureStoreManager,
ILogger<RuntimeConfigValidationService>? logger = null)
{
_secureStoreManager = secureStoreManager;
_logger = logger ?? NullLogger<RuntimeConfigValidationService>.Instance;
}
/// <inheritdoc />
public List<RuntimeValidationResult> ValidateRuntimeConfig(string configFolderPath)
{
var results = new List<RuntimeValidationResult>();
// Build IConfiguration from appsettings.json
var appSettingsPath = Path.Combine(configFolderPath, "appsettings.json");
if (!File.Exists(appSettingsPath))
{
var configResult = new RuntimeValidationResult { ValidatorName = "Configuration" };
configResult.Errors.Add($"appsettings.json not found at: {appSettingsPath}");
results.Add(configResult);
return results;
}
var configuration = new ConfigurationBuilder()
.SetBasePath(configFolderPath)
.AddJsonFile("appsettings.json", optional: false)
.Build();
// Check if SecureStore is open
if (!_secureStoreManager.IsStoreOpen)
{
var storeWarning = new RuntimeValidationResult { ValidatorName = "SecureStore" };
storeWarning.Warnings.Add("No SecureStore is currently open. SecureStore-dependent validations will be skipped.");
results.Add(storeWarning);
}
// Build a scoped service provider for validators (automatic discovery)
using var validatorServices = BuildValidatorServiceProvider(configuration);
// Discover validators automatically via DI
var validators = validatorServices
.GetServices<IConfigurationValidator>()
.OrderBy(v => v.Order)
.ToList();
_logger.LogDebug("Discovered {Count} configuration validators", validators.Count);
foreach (var validator in validators)
{
try
{
_logger.LogDebug("Running validator: {Name} (Order={Order})", validator.Name, validator.Order);
var validationResult = validator.Validate();
var runtimeResult = new RuntimeValidationResult { ValidatorName = validationResult.ValidatorName };
runtimeResult.Errors.AddRange(validationResult.Errors);
runtimeResult.Warnings.AddRange(validationResult.Warnings);
results.Add(runtimeResult);
}
catch (Exception ex)
{
_logger.LogError(ex, "Validator {Name} threw exception", validator.Name);
var errorResult = new RuntimeValidationResult { ValidatorName = validator.Name };
errorResult.Errors.Add($"Validator threw exception: {ex.Message}");
results.Add(errorResult);
}
}
return results;
}
/// <summary>
/// Builds a scoped service provider with validators and their dependencies.
/// New validators added via AddInfrastructureValidators() are automatically discovered.
/// </summary>
private ServiceProvider BuildValidatorServiceProvider(IConfiguration configuration)
{
var services = new ServiceCollection();
// Register core services that validators depend on
services.AddSingleton(configuration);
services.AddSingleton<ISecureStoreService>(new SecureStoreServiceAdapter(_secureStoreManager));
services.AddLogging();
// Register validators using the same extension method as Host
// This ensures new validators are automatically discovered
services.AddInfrastructureValidators(configuration);
return services.BuildServiceProvider();
}
}
NEW/src/Utils/JdeScoping.ConfigManager/Services/SecureStoreServiceAdapter.cs
+67
View File
@@ -0,0 +1,67 @@
using JdeScoping.ConfigManager.Services.SecureStore;
using JdeScoping.Core.Interfaces;
namespace JdeScoping.ConfigManager.Services;
/// <summary>
/// Adapts ISecureStoreManager to ISecureStoreService for use by Infrastructure validators.
/// </summary>
public class SecureStoreServiceAdapter : ISecureStoreService
{
private readonly ISecureStoreManager _manager;
/// <summary>
/// Creates a new adapter wrapping the specified manager.
/// </summary>
/// <param name="manager">The SecureStore manager to adapt.</param>
public SecureStoreServiceAdapter(ISecureStoreManager manager)
{
_manager = manager ?? throw new ArgumentNullException(nameof(manager));
}
/// <inheritdoc />
public string? Get(string key)
{
if (!_manager.IsStoreOpen) return null;
try { return _manager.GetSecret(key); }
catch { return null; }
}
/// <inheritdoc />
public string GetRequired(string key)
{
if (!_manager.IsStoreOpen)
throw new InvalidOperationException("No SecureStore is currently open");
return _manager.GetSecret(key);
}
/// <inheritdoc />
public void Set(string key, string value) => _manager.SetSecret(key, value);
/// <inheritdoc />
public bool Contains(string key)
{
if (!_manager.IsStoreOpen) return false;
return _manager.GetKeys().Contains(key);
}
/// <inheritdoc />
public bool Remove(string key)
{
if (!_manager.IsStoreOpen) return false;
try { _manager.RemoveSecret(key); return true; }
catch { return false; }
}
/// <inheritdoc />
public void Save() => _manager.Save();
/// <inheritdoc />
public IEnumerable<string> Keys => _manager.IsStoreOpen ? _manager.GetKeys() : [];
/// <inheritdoc />
public void Dispose()
{
// Manager lifecycle handled elsewhere - we don't own it
}
}
NEW/src/Utils/JdeScoping.ConfigManager/ViewModels/MainWindowViewModel.cs
+40
View File
@@ -24,6 +24,7 @@ public class MainWindowViewModel : ViewModelBase
private readonly IDialogService? _dialogService;
private readonly ISecureStoreManager _secureStoreManager;
private readonly IClipboardService _clipboardService;
private readonly IRuntimeConfigValidationService _runtimeValidationService;
private readonly ILogger<MainWindowViewModel>? _logger;
private string _configFolderPath = "No folder selected";
@@ -193,6 +194,11 @@ public class MainWindowViewModel : ViewModelBase
/// </summary>
public ICommand DeletePipelineCommand { get; }
/// <summary>
/// Gets the command for validating runtime configuration using Infrastructure validators.
/// </summary>
public ICommand ValidateRuntimeConfigCommand { get; }
/// <summary>
/// Initializes a new instance of the <see cref="MainWindowViewModel"/> class.
/// </summary>
@@ -204,6 +210,7 @@ public class MainWindowViewModel : ViewModelBase
/// <param name="dialogService">Service for showing platform dialogs.</param>
/// <param name="secureStoreManager">Service for managing encrypted secret stores.</param>
/// <param name="clipboardService">Service for clipboard operations.</param>
/// <param name="runtimeValidationService">Service for runtime configuration validation.</param>
/// <param name="logger">Optional logger for recording view model activities.</param>
public MainWindowViewModel(
IFileSystem fileSystem,
@@ -214,6 +221,7 @@ public class MainWindowViewModel : ViewModelBase
IDialogService? dialogService,
ISecureStoreManager secureStoreManager,
IClipboardService clipboardService,
IRuntimeConfigValidationService runtimeValidationService,
ILogger<MainWindowViewModel>? logger)
{
_fileSystem = fileSystem;
@@ -224,6 +232,7 @@ public class MainWindowViewModel : ViewModelBase
_dialogService = dialogService;
_secureStoreManager = secureStoreManager;
_clipboardService = clipboardService;
_runtimeValidationService = runtimeValidationService;
_logger = logger;
OpenFolderCommand = new AsyncRelayCommand(OpenFolderAsync);
@@ -249,6 +258,11 @@ public class MainWindowViewModel : ViewModelBase
AddPipelineCommand = new AsyncRelayCommand(AddPipelineAsync, CanAddPipeline);
DeletePipelineCommand = new AsyncRelayCommand(DeletePipelineAsync, CanDeletePipeline);
// Validation commands
ValidateRuntimeConfigCommand = new AsyncRelayCommand(
ValidateRuntimeConfigAsync,
() => ConfigFolderPath != "No folder selected");
_ = InitializeAsync();
}
@@ -264,6 +278,7 @@ public class MainWindowViewModel : ViewModelBase
null,
new SecureStoreManager(),
new NullClipboardService(),
new RuntimeConfigValidationService(new SecureStoreManager()),
null)
{
}
@@ -746,6 +761,31 @@ public class MainWindowViewModel : ViewModelBase
}
}
/// <summary>
/// Validates runtime configuration using Infrastructure validators (SecureStore, Connection Strings, LDAP).
/// </summary>
private async Task ValidateRuntimeConfigAsync()
{
if (_dialogService == null || ConfigFolderPath == "No folder selected")
return;
var results = _runtimeValidationService.ValidateRuntimeConfig(ConfigFolderPath);
// Convert to ValidationResult for dialog
var appSettingsResult = new ValidationResult();
var pipelinesResult = new ValidationResult(); // Will remain empty for runtime validation
foreach (var result in results)
{
foreach (var error in result.Errors)
appSettingsResult.AddError($"[{result.ValidatorName}] {error}");
foreach (var warning in result.Warnings)
appSettingsResult.AddWarning($"[{result.ValidatorName}] {warning}");
}
await _dialogService.ShowValidationResultsAsync(appSettingsResult, pipelinesResult);
}
/// <summary>
/// Tests database connections defined in the configuration.
/// </summary>
NEW/src/Utils/JdeScoping.ConfigManager/Views/MainWindow.axaml
+3
View File
@@ -93,6 +93,7 @@
<MenuItem Header="_Tools">
<MenuItem Header="_Validate All" Command="{Binding ValidateCommand}" InputGesture="F5"/>
<MenuItem Header="_Test Connection" Command="{Binding TestConnectionCommand}" InputGesture="F6"/>
<MenuItem Header="Validate _Runtime Config" Command="{Binding ValidateRuntimeConfigCommand}" InputGesture="F7"/>
<Separator/>
<MenuItem Header="View _Backups..."/>
</MenuItem>
@@ -154,6 +155,8 @@
<Border Width="1" Height="20" Background="#2D3540" Margin="4,0"/>
<Button Content="Test" Command="{Binding TestConnectionCommand}" Classes="toolbar"/>
<Button Content="Validate" Command="{Binding ValidateCommand}" Classes="toolbar"/>
<Button Content="Validate Runtime" Command="{Binding ValidateRuntimeConfigCommand}"
ToolTip.Tip="Validate SecureStore, Connection Strings, LDAP" Classes="toolbar"/>
<Border Width="1" Height="20" Background="#2D3540" Margin="4,0"/>
<Button Content="+ Pipeline" Command="{Binding AddPipelineCommand}" ToolTip.Tip="Add Pipeline" Classes="toolbar"/>
<Border Width="1" Height="20" Background="#2D3540" Margin="4,0"/>