From 8ac3c6b9afed1d303f71fb0c8fc51150803c64ef Mon Sep 17 00:00:00 2001 From: Patrick Hallisey Date: Tue, 16 Apr 2024 11:10:07 -0700 Subject: [PATCH] Improve status and list commands (#8102) --- .../Commands/ListCommand.cs | 19 ++- .../Commands/StatusCommand.cs | 110 ++++++++---------- .../SimplerConsoleFormatter.cs | 4 +- .../RotationException.cs | 2 +- .../TaskExtensions.cs | 51 ++++++++ 5 files changed, 117 insertions(+), 69 deletions(-) create mode 100644 tools/secret-management/Azure.Sdk.Tools.SecretRotation.Core/TaskExtensions.cs diff --git a/tools/secret-management/Azure.Sdk.Tools.SecretManagement.Cli/Commands/ListCommand.cs b/tools/secret-management/Azure.Sdk.Tools.SecretManagement.Cli/Commands/ListCommand.cs index 6d6a5c3b72d..11bd7f67261 100644 --- a/tools/secret-management/Azure.Sdk.Tools.SecretManagement.Cli/Commands/ListCommand.cs +++ b/tools/secret-management/Azure.Sdk.Tools.SecretManagement.Cli/Commands/ListCommand.cs @@ -1,7 +1,6 @@ using System.CommandLine.Invocation; -using System.Text.Json; +using System.Text; using Azure.Sdk.Tools.SecretRotation.Configuration; -using Azure.Sdk.Tools.SecretRotation.Core; namespace Azure.Sdk.Tools.SecretManagement.Cli.Commands; @@ -16,7 +15,21 @@ protected override Task HandleCommandAsync(ILogger logger, RotationConfiguration { foreach (PlanConfiguration plan in rotationConfiguration.PlanConfigurations) { - Console.WriteLine($"name: {plan.Name} - tags: {string.Join(", ", plan.Tags)}"); + logger.LogInformation(plan.Name); + + if (logger.IsEnabled(LogLevel.Debug)) + { + var builder = new StringBuilder(); + + builder.AppendLine($" Tags: {string.Join(", ", plan.Tags)}"); + builder.AppendLine($" Rotation Period: {plan.RotationPeriod}"); + builder.AppendLine($" Rotation Threshold: {plan.RotationThreshold}"); + builder.AppendLine($" Warning Threshold: {plan.WarningThreshold}"); + builder.AppendLine($" Revoke After Period: {plan.RevokeAfterPeriod}"); + builder.AppendLine($" Store Types: {string.Join(", ", plan.StoreConfigurations.Select(s => s.Type).Distinct() )}"); + + logger.LogDebug(builder.ToString()); + } } return Task.CompletedTask; diff --git a/tools/secret-management/Azure.Sdk.Tools.SecretManagement.Cli/Commands/StatusCommand.cs b/tools/secret-management/Azure.Sdk.Tools.SecretManagement.Cli/Commands/StatusCommand.cs index bafb33044b5..38e27fec7a6 100644 --- a/tools/secret-management/Azure.Sdk.Tools.SecretManagement.Cli/Commands/StatusCommand.cs +++ b/tools/secret-management/Azure.Sdk.Tools.SecretManagement.Cli/Commands/StatusCommand.cs @@ -1,8 +1,5 @@ using System.CommandLine.Invocation; -using System.Reflection; using System.Text; -using System.Text.Json; -using System.Text.Json.Serialization; using Azure.Sdk.Tools.SecretRotation.Configuration; using Azure.Sdk.Tools.SecretRotation.Core; @@ -18,68 +15,73 @@ protected override async Task HandleCommandAsync(ILogger logger, RotationConfigu InvocationContext invocationContext) { var timeProvider = new TimeProvider(); - IEnumerable plans = rotationConfiguration.GetAllRotationPlans(logger, timeProvider); + RotationPlan[] plans = rotationConfiguration.GetAllRotationPlans(logger, timeProvider).ToArray(); - List<(RotationPlan Plan, RotationPlanStatus Status)> statuses = new(); + logger.LogInformation($"Getting status for {plans.Length} plans"); - foreach (RotationPlan plan in plans) - { - logger.LogInformation($"Getting status for plan '{plan.Name}'"); - RotationPlanStatus status = await plan.GetStatusAsync(); - - if (logger.IsEnabled(LogLevel.Debug)) - { - var builder = new StringBuilder(); - - builder.AppendLine($" Plan:"); - builder.AppendLine($" RotationPeriod: {plan.RotationPeriod}"); - builder.AppendLine($" RotationThreshold: {plan.RotationThreshold}"); - builder.AppendLine($" RevokeAfterPeriod: {plan.RevokeAfterPeriod}"); - - builder.AppendLine($" Status:"); - builder.AppendLine($" ExpirationDate: {status.ExpirationDate}"); - builder.AppendLine($" State: {status.State}"); - builder.AppendLine($" RequiresRevocation: {status.RequiresRevocation}"); - builder.AppendLine($" Exception: {status.Exception?.Message}"); - - logger.LogDebug(builder.ToString()); - } + (RotationPlan Plan, RotationPlanStatus Status)[] statuses = await plans + .Select(async plan => { + logger.LogDebug($"Getting status for plan '{plan.Name}'."); + return (plan, await plan.GetStatusAsync()); + }) + .LimitConcurrencyAsync(10); - statuses.Add((plan, status)); - } - var plansBuyState = statuses.GroupBy(x => x.Status.State) .ToDictionary(x => x.Key, x => x.ToArray()); - var statusBuilder = new StringBuilder(); - void AppendStatusSection(RotationState state, string header) + void LogStatusSection(RotationState state, string header) { - if (!plansBuyState.TryGetValue(RotationState.Expired, out var matchingPlans)) + if (!plansBuyState.TryGetValue(state, out var matchingPlans)) { return; } - statusBuilder.AppendLine(); - statusBuilder.AppendLine(header); + logger.LogInformation($"\n{header}"); + foreach ((RotationPlan plan, RotationPlanStatus status) in matchingPlans) { - foreach (string line in GetPlanStatusLine(plan, status).Split("\n")) + var builder = new StringBuilder(); + var debugBuilder = new StringBuilder(); + + builder.Append($" {plan.Name} - "); + DateTimeOffset? expirationDate = status.ExpirationDate; + if (expirationDate.HasValue) + { + builder.AppendLine($"{expirationDate} ({FormatTimeSpan(expirationDate.Value.Subtract(DateTimeOffset.UtcNow))})"); + } + else { - statusBuilder.Append(" "); - statusBuilder.AppendLine(line); + builder.AppendLine("no expiration date"); } + + debugBuilder.AppendLine($" Plan:"); + debugBuilder.AppendLine($" Rotation Period: {plan.RotationPeriod}"); + debugBuilder.AppendLine($" Rotation Threshold: {plan.RotationThreshold}"); + debugBuilder.AppendLine($" Warning Threshold: {plan.WarningThreshold}"); + debugBuilder.AppendLine($" Revoke After Period: {plan.RevokeAfterPeriod}"); + debugBuilder.AppendLine($" Status:"); + debugBuilder.AppendLine($" Expiration Date: {status.ExpirationDate}"); + debugBuilder.AppendLine($" State: {status.State}"); + debugBuilder.AppendLine($" Requires Revocation: {status.RequiresRevocation}"); + + if (status.Exception != null) + { + builder.AppendLine($" Exception:"); + builder.AppendLine($" {status.Exception.Message}"); + } + + logger.LogInformation(builder.ToString()); + logger.LogDebug(debugBuilder.ToString()); } } - AppendStatusSection(RotationState.Expired, "Expired:"); - AppendStatusSection(RotationState.Warning, "Expiring:"); - AppendStatusSection(RotationState.Rotate, "Should Rotate:"); - AppendStatusSection(RotationState.UpToDate, "Up-to-date:"); - AppendStatusSection(RotationState.Error, "Error reading plan status:"); - - logger.LogInformation(statusBuilder.ToString()); + LogStatusSection(RotationState.Expired, "Expired:"); + LogStatusSection(RotationState.Warning, "Expiring:"); + LogStatusSection(RotationState.Rotate, "Should Rotate:"); + LogStatusSection(RotationState.UpToDate, "Up-to-date:"); + LogStatusSection(RotationState.Error, "Error reading plan status:"); if (statuses.Any(x => x.Status.State is RotationState.Expired or RotationState.Warning)) { @@ -87,24 +89,6 @@ void AppendStatusSection(RotationState state, string header) } } - private static string GetPlanStatusLine(RotationPlan plan, RotationPlanStatus status) - { - if (status.Exception != null) - { - return $"{plan.Name}:\n {status.Exception.Message}"; - } - - DateTimeOffset? expirationDate = status.ExpirationDate; - - DateTimeOffset now = DateTimeOffset.UtcNow; - - string expiration = expirationDate.HasValue - ? $"{FormatTimeSpan(expirationDate.Value.Subtract(now))}" - : "No expiration date"; - - return $"{plan.Name} - {expiration} / ({FormatTimeSpan(plan.RotationPeriod)} @ {FormatTimeSpan(plan.RotationThreshold)})"; - } - private static string FormatTimeSpan(TimeSpan timeSpan) { if (timeSpan == TimeSpan.Zero) diff --git a/tools/secret-management/Azure.Sdk.Tools.SecretManagement.Cli/SimplerConsoleFormatter.cs b/tools/secret-management/Azure.Sdk.Tools.SecretManagement.Cli/SimplerConsoleFormatter.cs index e495c510bca..194d0bba9e5 100644 --- a/tools/secret-management/Azure.Sdk.Tools.SecretManagement.Cli/SimplerConsoleFormatter.cs +++ b/tools/secret-management/Azure.Sdk.Tools.SecretManagement.Cli/SimplerConsoleFormatter.cs @@ -1,4 +1,4 @@ -using Microsoft.Extensions.Logging.Abstractions; +using Microsoft.Extensions.Logging.Abstractions; using Microsoft.Extensions.Logging.Console; using Microsoft.Extensions.Options; @@ -83,7 +83,7 @@ private DateTimeOffset GetCurrentDateTime() return logLevel switch { LogLevel.Trace => "trce: ", - LogLevel.Debug => "dbug: ", + LogLevel.Debug => null, LogLevel.Information => null, LogLevel.Warning => "warn: ", LogLevel.Error => "fail: ", diff --git a/tools/secret-management/Azure.Sdk.Tools.SecretRotation.Core/RotationException.cs b/tools/secret-management/Azure.Sdk.Tools.SecretRotation.Core/RotationException.cs index 001ae8cffed..eb60e747bef 100644 --- a/tools/secret-management/Azure.Sdk.Tools.SecretRotation.Core/RotationException.cs +++ b/tools/secret-management/Azure.Sdk.Tools.SecretRotation.Core/RotationException.cs @@ -1,4 +1,4 @@ -namespace Azure.Sdk.Tools.SecretRotation.Core; +namespace Azure.Sdk.Tools.SecretRotation.Core; public class RotationException : Exception { diff --git a/tools/secret-management/Azure.Sdk.Tools.SecretRotation.Core/TaskExtensions.cs b/tools/secret-management/Azure.Sdk.Tools.SecretRotation.Core/TaskExtensions.cs new file mode 100644 index 00000000000..b3793a7fec8 --- /dev/null +++ b/tools/secret-management/Azure.Sdk.Tools.SecretRotation.Core/TaskExtensions.cs @@ -0,0 +1,51 @@ +namespace Azure.Sdk.Tools.SecretRotation.Core; + +public static class TaskExtensions +{ + public static async Task LimitConcurrencyAsync(this IEnumerable> tasks, int concurrencyLimit = 1, CancellationToken cancellationToken = default) + { + if (concurrencyLimit == int.MaxValue) + { + return await Task.WhenAll(tasks); + } + + var results = new List(); + + if (concurrencyLimit == 1) + { + foreach (var task in tasks) + { + results.Add(await task); + } + + return results.ToArray(); + } + + var pending = new List>(); + + foreach (var task in tasks) + { + pending.Add(task); + + if (cancellationToken.IsCancellationRequested) + { + break; + } + + if (pending.Count < concurrencyLimit) continue; + + var completed = await Task.WhenAny(pending); + pending.Remove(completed); + results.Add(await completed); + } + + results.AddRange(await Task.WhenAll(pending)); + + return results.ToArray(); + } + + public static Task LimitConcurrencyAsync(this IEnumerable source, Func> taskFactory, int concurrencyLimit = 1, CancellationToken cancellationToken = default) + { + return LimitConcurrencyAsync(source.Select(taskFactory), concurrencyLimit, cancellationToken); + } +}