From 9361d8f80c5cbcab4cdf810c1220fc59b7b4e0c4 Mon Sep 17 00:00:00 2001 From: James Newton-King Date: Tue, 17 Nov 2026 08:44:51 +0800 Subject: [PATCH] Show restore diagnostics when aspire update fails Capture restore stdout and stderr in the CLI log and display them on failure while preserving rollback and exit codes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- src/Aspire.Cli/Projects/ProjectUpdater.cs | 20 +++--- src/Aspire.Cli/README.md | 3 + .../ProjectUpdaterNuGetConfigurationTests.cs | 65 +++++++++++++++++++ .../Projects/ProjectUpdaterTests.cs | 24 ++++--- tests/Aspire.Cli.Tests/Utils/CliTestHelper.cs | 2 +- 5 files changed, 95 insertions(+), 19 deletions(-) diff --git a/src/Aspire.Cli/Projects/ProjectUpdater.cs b/src/Aspire.Cli/Projects/ProjectUpdater.cs index d750209d288..2cee9aaca41 100644 --- a/src/Aspire.Cli/Projects/ProjectUpdater.cs +++ b/src/Aspire.Cli/Projects/ProjectUpdater.cs @@ -8,6 +8,7 @@ using System.Xml; using System.Xml.Linq; using Aspire.Cli.Configuration; +using Aspire.Cli.Diagnostics; using Aspire.Cli.DotNet; using Aspire.Cli.Interaction; using Aspire.Cli.NuGet; @@ -28,7 +29,7 @@ internal interface IProjectUpdater Task UpdateProjectAsync(UpdatePackagesContext context, CancellationToken cancellationToken = default); } -internal sealed partial class ProjectUpdater(ILogger logger, IDotNetCliRunner runner, IInteractionService interactionService, IMemoryCache cache, CliExecutionContext executionContext, FallbackProjectParser fallbackParser, BundleNuGetService nuGetService) : IProjectUpdater +internal sealed partial class ProjectUpdater(ILogger logger, IDotNetCliRunner runner, IInteractionService interactionService, IMemoryCache cache, CliExecutionContext executionContext, FallbackProjectParser fallbackParser, BundleNuGetService nuGetService, FileLoggerProvider fileLoggerProvider) : IProjectUpdater { public async Task UpdateProjectAsync(UpdatePackagesContext context, CancellationToken cancellationToken = default) { @@ -321,21 +322,24 @@ await interactionService.ShowStatusAsync( { // Validate the complete updated graph, not old versions against a new feed or a // half-updated graph. Native restore retains each referenced project's own settings. - await interactionService.ShowStatusAsync( + var restoreOutput = new OutputCollector(fileLoggerProvider, CliLogFormat.Categories.Package); + var restoreExitCode = await interactionService.ShowStatusAsync( UpdateCommandStrings.RestoringPackagesAfterUpdate, async () => { await transaction.VerifyAsync(cancellationToken); - var restoreExitCode = await runner.RestoreAsync(projectFile, new() + return await runner.RestoreAsync(projectFile, new() { + StandardOutputCallback = restoreOutput.AppendOutput, + StandardErrorCallback = restoreOutput.AppendError, NuGetRestoreTargetsFile = restorePreview?.TargetsFile ?? repairedRestorePreview?.TargetsFile }, cancellationToken); - if (restoreExitCode != 0) - { - throw new ProjectUpdaterException(string.Format(CultureInfo.InvariantCulture, UpdateCommandStrings.FailedToRestoreAfterUpdateFormat, projectFile.FullName)); - } - return 0; }); + if (restoreExitCode != 0) + { + interactionService.DisplayLines(restoreOutput.GetLines()); + throw new ProjectUpdaterException(string.Format(CultureInfo.InvariantCulture, UpdateCommandStrings.FailedToRestoreAfterUpdateFormat, projectFile.FullName)); + } } await transaction.VerifyAsync(cancellationToken); diff --git a/src/Aspire.Cli/README.md b/src/Aspire.Cli/README.md index 12fcde30f2a..119d2eac443 100644 --- a/src/Aspire.Cli/README.md +++ b/src/Aspire.Cli/README.md @@ -123,6 +123,9 @@ Automatic SDK rewrites are limited to unconditional declarations. Conditional SDK declarations that cannot be safely classified require an explicit version edit; source fallback does not guess whether their MSBuild conditions are active. +If the post-update package restore fails, `aspire update` displays the restore +diagnostics and includes the restore output in its CLI log. + ## Configured template sources Register named local directories or Git repositories in the diff --git a/tests/Aspire.Cli.Tests/Projects/ProjectUpdaterNuGetConfigurationTests.cs b/tests/Aspire.Cli.Tests/Projects/ProjectUpdaterNuGetConfigurationTests.cs index ed6a5fb699e..eada5cc79dc 100644 --- a/tests/Aspire.Cli.Tests/Projects/ProjectUpdaterNuGetConfigurationTests.cs +++ b/tests/Aspire.Cli.Tests/Projects/ProjectUpdaterNuGetConfigurationTests.cs @@ -6,6 +6,7 @@ using System.Text.Json.Nodes; using System.Xml; using Aspire.Cli.Configuration; +using Aspire.Cli.Diagnostics; using Aspire.Cli.DotNet; using Aspire.Cli.Interaction; using Aspire.Cli.NuGet; @@ -1489,6 +1490,70 @@ await Assert.ThrowsAsync(() => Assert.Equal(originalProps, await File.ReadAllBytesAsync(propsFile.FullName)); } + [Theory] + [InlineData("AppHost.csproj", false)] + [InlineData("apphost.cs", false)] + [InlineData("AppHost.csproj", true)] + [InlineData("apphost.cs", true)] + public async Task UpdateAsync_RestoreDiagnosticsAreLoggedAndOnlyDisplayedOnFailure(string fileName, bool restoreFails) + { + using var workspace = TemporaryWorkspace.CreateForCli(outputHelper); + var projectFile = await CreateAppHostAsync(workspace, fileName); + var originalProject = await File.ReadAllBytesAsync(projectFile.FullName); + const string restoreMessage = "Determining projects to restore..."; + const string restoreError = "error : Access to the path 'Aspire.Hosting.Tasks.dll' is denied."; + const string stderrMessage = "NuGet restore diagnostic on stderr."; + var runner = CreateRunner(projectFile, hasExplicitChannel: false); + runner.GetProjectItemsAndPropertiesAsyncCallback = (_, _, _, _, _) => CreatePackageEvaluation(); + runner.RestoreAsyncCallback = (_, options, _) => + { + options.StandardOutputCallback?.Invoke(restoreMessage); + options.StandardOutputCallback?.Invoke(restoreError); + options.StandardErrorCallback?.Invoke(stderrMessage); + return restoreFails ? 1 : 0; + }; + string logFilePath; + using (var provider = CreateServices(workspace, runner).BuildServiceProvider()) + { + logFilePath = provider.GetRequiredService().LogFilePath; + var context = await CreateContextAsync(provider, projectFile, "default", hasExplicitChannel: false); + var updater = provider.GetRequiredService(); + var interaction = Assert.IsType(provider.GetRequiredService()); + if (restoreFails) + { + var exception = await Assert.ThrowsAsync(() => + updater.UpdateProjectAsync(context, TestContext.Current.CancellationToken)); + + Assert.Equal(string.Format(CultureInfo.InvariantCulture, + UpdateCommandStrings.FailedToRestoreAfterUpdateFormat, projectFile.FullName), exception.Message); + Assert.Equal( + [(OutputLineStream.StdOut, restoreMessage), (OutputLineStream.StdOut, restoreError), (OutputLineStream.StdErr, stderrMessage)], + interaction.DisplayedLines); + Assert.Equal(originalProject, await File.ReadAllBytesAsync(projectFile.FullName)); + } + else + { + var result = await updater.UpdateProjectAsync(context, TestContext.Current.CancellationToken); + + Assert.True(result.UpdatedApplied); + Assert.Empty(interaction.DisplayedLines); + } + } + + var logEntries = (await File.ReadAllLinesAsync(logFilePath)).Select(line => + { + Assert.True(CliLogFormat.TryParseFileLogLine(line, out var entry)); + return entry; + }); + Assert.Equal( + [ + new CliLogFormat.FileLogEntry(CliLogFormat.FileLevelTokens.Information, CliLogFormat.Categories.Package, restoreMessage), + new CliLogFormat.FileLogEntry(CliLogFormat.FileLevelTokens.Information, CliLogFormat.Categories.Package, restoreError), + new CliLogFormat.FileLogEntry(CliLogFormat.FileLevelTokens.Error, CliLogFormat.Categories.Package, stderrMessage) + ], + logEntries); + } + private static async Task WriteCurrentPolicyAsync(TemporaryWorkspace workspace, string source, bool configureCache) { var configFile = new FileInfo(Path.Combine(workspace.Path, "NuGet.Config")); diff --git a/tests/Aspire.Cli.Tests/Projects/ProjectUpdaterTests.cs b/tests/Aspire.Cli.Tests/Projects/ProjectUpdaterTests.cs index 1e0cbba0214..7948887bfcd 100644 --- a/tests/Aspire.Cli.Tests/Projects/ProjectUpdaterTests.cs +++ b/tests/Aspire.Cli.Tests/Projects/ProjectUpdaterTests.cs @@ -4,6 +4,7 @@ using System.Text.Json; using System.Text.Json.Nodes; using Aspire.Cli.Configuration; +using Aspire.Cli.Diagnostics; using Aspire.Cli.DotNet; using Aspire.Cli.Interaction; using Aspire.Cli.Packaging; @@ -127,7 +128,8 @@ public async Task UpdateImportedSdkUsesDeclarationInsteadOfImplicitPackage(strin provider.GetRequiredService(), CreateExecutionContext(workspace.WorkspaceRoot), provider.GetRequiredService(), - provider.GetRequiredService()); + provider.GetRequiredService(), + provider.GetRequiredService()); var channel = (await provider.GetRequiredService().GetChannelsAsync().DefaultTimeout()) .Single(c => c.Name == "daily"); @@ -289,7 +291,8 @@ await File.WriteAllTextAsync(cpmFile, provider.GetRequiredService(), CreateExecutionContext(workspace.WorkspaceRoot), provider.GetRequiredService(), - provider.GetRequiredService()); + provider.GetRequiredService(), + provider.GetRequiredService()); var channel = (await provider.GetRequiredService().GetChannelsAsync().DefaultTimeout()) .Single(c => c.Name == "daily"); @@ -377,7 +380,8 @@ public async Task UpdateConditionalSdkRequiresExplicitEditWithoutChangingSource( provider.GetRequiredService(), CreateExecutionContext(workspace.WorkspaceRoot), provider.GetRequiredService(), - provider.GetRequiredService()); + provider.GetRequiredService(), + provider.GetRequiredService()); var channel = (await provider.GetRequiredService().GetChannelsAsync().DefaultTimeout()) .Single(c => c.Name == "daily"); @@ -2761,7 +2765,7 @@ await File.WriteAllTextAsync( var channels = await packagingService.GetChannelsAsync().DefaultTimeout(); var selectedChannel = channels.Single(c => c.Name == "default"); - var projectUpdater = new ProjectUpdater(logger, runner, interactionService, cache, executionContext, fallbackParser, provider.GetRequiredService()); + var projectUpdater = new ProjectUpdater(logger, runner, interactionService, cache, executionContext, fallbackParser, provider.GetRequiredService(), provider.GetRequiredService()); var updateResult = await projectUpdater.UpdateProjectAsync(CreateUpdateContext(appHostProjectFile, selectedChannel)).DefaultTimeout(); // Should not throw ProjectUpdaterException; should produce update steps including AppHost SDK @@ -2863,7 +2867,7 @@ await File.WriteAllTextAsync( var channels = await packagingService.GetChannelsAsync().DefaultTimeout(); var selectedChannel = channels.Single(c => c.Name == "default"); - var projectUpdater = new ProjectUpdater(logger, runner, interactionService, cache, executionContext, fallbackParser, provider.GetRequiredService()); + var projectUpdater = new ProjectUpdater(logger, runner, interactionService, cache, executionContext, fallbackParser, provider.GetRequiredService(), provider.GetRequiredService()); var updateResult = await projectUpdater.UpdateProjectAsync(CreateUpdateContext(appHostProjectFile, selectedChannel)).DefaultTimeout(); // Should discover package reference (version may be absent) and not crash @@ -2942,7 +2946,7 @@ await File.WriteAllTextAsync( var channels = await packagingService.GetChannelsAsync().DefaultTimeout(); var selectedChannel = channels.Single(c => c.Name == "default"); - var projectUpdater = new ProjectUpdater(logger, runner, interactionService, cache, executionContext, fallbackParser, provider.GetRequiredService()); + var projectUpdater = new ProjectUpdater(logger, runner, interactionService, cache, executionContext, fallbackParser, provider.GetRequiredService(), provider.GetRequiredService()); // Should throw ProjectUpdaterException due to invalid XML await Assert.ThrowsAsync(() => @@ -3025,7 +3029,7 @@ await File.WriteAllTextAsync( var channels = await packagingService.GetChannelsAsync().DefaultTimeout(); var selectedChannel = channels.Single(c => c.Name == "default"); - var projectUpdater = new ProjectUpdater(logger, runner, interactionService, cache, executionContext, fallbackParser, provider.GetRequiredService()); + var projectUpdater = new ProjectUpdater(logger, runner, interactionService, cache, executionContext, fallbackParser, provider.GetRequiredService(), provider.GetRequiredService()); var updateResult = await projectUpdater.UpdateProjectAsync(CreateUpdateContext(appHostProjectFile, selectedChannel)).DefaultTimeout(); // Normal path unaffected - no updates needed since version is already current @@ -3104,7 +3108,7 @@ await File.WriteAllTextAsync( var channels = await packagingService.GetChannelsAsync().DefaultTimeout(); var selectedChannel = channels.Single(c => c.Name == "default"); - var projectUpdater = new ProjectUpdater(logger, runner, interactionService, cache, executionContext, fallbackParser, provider.GetRequiredService()); + var projectUpdater = new ProjectUpdater(logger, runner, interactionService, cache, executionContext, fallbackParser, provider.GetRequiredService(), provider.GetRequiredService()); var updateResult = await projectUpdater.UpdateProjectAsync(CreateUpdateContext(appHostFile, selectedChannel)).DefaultTimeout(); Assert.True(updateResult.UpdatedApplied); @@ -3367,7 +3371,7 @@ await File.WriteAllTextAsync( var channels = await packagingService.GetChannelsAsync().DefaultTimeout(); var selectedChannel = channels.Single(c => c.Name == "default"); - var projectUpdater = new ProjectUpdater(logger, runner, interactionService, cache, executionContext, fallbackParser, provider.GetRequiredService()); + var projectUpdater = new ProjectUpdater(logger, runner, interactionService, cache, executionContext, fallbackParser, provider.GetRequiredService(), provider.GetRequiredService()); var updateResult = await projectUpdater.UpdateProjectAsync(CreateUpdateContext(appHostFile, selectedChannel)).DefaultTimeout(); Assert.True(updateResult.UpdatedApplied); @@ -3455,7 +3459,7 @@ await File.WriteAllTextAsync( var channels = await packagingService.GetChannelsAsync().DefaultTimeout(); var selectedChannel = channels.Single(c => c.Name == "default"); - var projectUpdater = new ProjectUpdater(logger, runner, interactionService, cache, executionContext, fallbackParser, provider.GetRequiredService()); + var projectUpdater = new ProjectUpdater(logger, runner, interactionService, cache, executionContext, fallbackParser, provider.GetRequiredService(), provider.GetRequiredService()); // This should not throw and should handle the * version gracefully var updateResult = await projectUpdater.UpdateProjectAsync(CreateUpdateContext(appHostProjectFile, selectedChannel)).DefaultTimeout(); diff --git a/tests/Aspire.Cli.Tests/Utils/CliTestHelper.cs b/tests/Aspire.Cli.Tests/Utils/CliTestHelper.cs index 1b1cd73d274..02c15fa3204 100644 --- a/tests/Aspire.Cli.Tests/Utils/CliTestHelper.cs +++ b/tests/Aspire.Cli.Tests/Utils/CliTestHelper.cs @@ -536,7 +536,7 @@ public ISolutionLocator CreateDefaultSolutionLocatorFactory(IServiceProvider ser var cache = serviceProvider.GetRequiredService(); var executionContext = serviceProvider.GetRequiredService(); var fallbackParser = serviceProvider.GetRequiredService(); - return new ProjectUpdater(logger, runner, interactionService, cache, executionContext, fallbackParser, serviceProvider.GetRequiredService()); + return new ProjectUpdater(logger, runner, interactionService, cache, executionContext, fallbackParser, serviceProvider.GetRequiredService(), serviceProvider.GetRequiredService()); }; public Func CliHostEnvironmentFactory { get; set; } = (IServiceProvider serviceProvider) =>