Add Package Channel Service API for Aspire CLI (#10801)

* Initial plan

* Implement PackageChannelService API and models

Co-authored-by: mitchdenny <[email protected]>

* WIP

* Tests working again.

* Add test coverage for NuGetConfigLocator.

* WIP

* Fix tests.

* NuGet config generation.

* Fix.

* Fix source mapping bug.

* WIP.

* Add GH CLI to devcontainer to support PR testing.

* WIP

* WIP

* WIP ... prompting working.

* Vibe coded nuget drop

* PR feedback.

* WIP on fixing tests.

* Tests passing (some redundant tests removed).

* Update src/Aspire.Cli/Templating/DotNetTemplateFactory.cs

Co-authored-by: Copilot <[email protected]>

* Confirmation to strings.

* Nuget file created confirmation message.

* Find config file even with spelling variants.

* Relocate nuget.config.

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: mitchdenny <[email protected]>
Co-authored-by: Mitch Denny <[email protected]>
Co-authored-by: Copilot <[email protected]>

Author: 3 people

.devcontainer/devcontainer.json

@@ -8,6 +8,7 @@
 		"ghcr.io/devcontainers/features/azure-cli:1": {},
 		"ghcr.io/azure/azure-dev/azd:0": {},
 		"ghcr.io/devcontainers/features/docker-in-docker": {},
+		"ghcr.io/devcontainers/features/github-cli:1": {},
 		"ghcr.io/devcontainers/features/dotnet": {
 			"additionalVersions": [
 				"8.0.403",

src/Aspire.Cli/CliExecutionContext.cs

@@ -0,0 +1,10 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Aspire.Cli;
+
+internal sealed class CliExecutionContext(DirectoryInfo workingDirectory, DirectoryInfo hivesDirectory)
+{
+    public DirectoryInfo WorkingDirectory { get; } = workingDirectory;
+    public DirectoryInfo HivesDirectory { get; } = hivesDirectory;
+}

src/Aspire.Cli/Commands/AddCommand.cs

@@ -94,7 +94,7 @@ protected override async Task<int> ExecuteAsync(ParseResult parseResult, Cancell
                 () => _nuGetPackageCache.GetIntegrationPackagesAsync(
                     workingDirectory: effectiveAppHostProjectFile.Directory!,
                     prerelease: true,
-                    source: source,
+                    nugetConfigFile: null,
                     cancellationToken: cancellationToken)
                 );
 

src/Aspire.Cli/Commands/NewCommand.cs

@@ -8,11 +8,11 @@
 using Aspire.Cli.DotNet;
 using Aspire.Cli.Interaction;
 using Aspire.Cli.NuGet;
+using Aspire.Cli.Packaging;
 using Aspire.Cli.Resources;
 using Aspire.Cli.Telemetry;
 using Aspire.Cli.Templating;
 using Aspire.Cli.Utils;
-using Semver;
 using Spectre.Console;
 using NuGetPackage = Aspire.Shared.NuGetPackageCli;
 
@@ -127,66 +127,103 @@ protected override async Task<int> ExecuteAsync(ParseResult parseResult, Cancell
 
 internal interface INewCommandPrompter
 {
-    Task<NuGetPackage> PromptForTemplatesVersionAsync(IEnumerable<NuGetPackage> candidatePackages, CancellationToken cancellationToken);
+    Task<(NuGetPackage Package, PackageChannel Channel)> PromptForTemplatesVersionAsync(IEnumerable<(NuGetPackage Package, PackageChannel Channel)> candidatePackages, CancellationToken cancellationToken);
     Task<ITemplate> PromptForTemplateAsync(ITemplate[] validTemplates, CancellationToken cancellationToken);
     Task<string> PromptForProjectNameAsync(string defaultName, CancellationToken cancellationToken);
     Task<string> PromptForOutputPath(string v, CancellationToken cancellationToken);
 }
 
 internal class NewCommandPrompter(IInteractionService interactionService) : INewCommandPrompter
 {
-    public virtual async Task<NuGetPackage> PromptForTemplatesVersionAsync(IEnumerable<NuGetPackage> candidatePackages, CancellationToken cancellationToken)
+    public virtual async Task<(NuGetPackage Package, PackageChannel Channel)> PromptForTemplatesVersionAsync(IEnumerable<(NuGetPackage Package, PackageChannel Channel)> candidatePackages, CancellationToken cancellationToken)
     {
-        var packagesGroupedByReleaseStatus = candidatePackages.GroupBy(p => SemVersion.Parse(p.Version).IsPrerelease ? "Prerelease" : "Released");
-        var releasedGroup = packagesGroupedByReleaseStatus.FirstOrDefault(g => g.Key == "Released");
-        var prereleaseGroup = packagesGroupedByReleaseStatus.FirstOrDefault(g => g.Key == "Prerelease");
+        // Create a hierarchical selection experience:
+        // - Top-level: all packages from the implicit channel (if any)
+        // - Then: one entry per remaining channel that opens a sub-menu with that channel's packages
 
-        var selections = new List<(string SelectionText, Func<Task<NuGetPackage>> PackageSelector)>();
+        // Local helpers
+        static string FormatPackageLabel((NuGetPackage Package, PackageChannel Channel) item)
+        {
+            // Keep it concise: "Id Version"
+            var pkg = item.Package;
+            var source = pkg.Source is not null && pkg.Source.Length > 0 ? pkg.Source : item.Channel.Name;
+            return $"{pkg.Version} ({source})";
+        }
 
-        foreach (var releasedPackage in releasedGroup ?? Enumerable.Empty<NuGetPackage>())
+        async Task<(NuGetPackage Package, PackageChannel Channel)> PromptForChannelPackagesAsync(
+            PackageChannel channel,
+            IEnumerable<(NuGetPackage Package, PackageChannel Channel)> items,
+            CancellationToken ct)
         {
-            selections.Add(($"{releasedPackage.Version} ({releasedPackage.Source})", () => Task.FromResult(releasedPackage!)));
+            // Show a sub-menu for this channel's packages
+            var packageChoices = items
+                .Select(i => (
+                    Label: FormatPackageLabel(i),
+                    Result: i
+                ))
+                .ToArray();
+
+            var selection = await interactionService.PromptForSelectionAsync(
+                NewCommandStrings.SelectATemplateVersion,
+                packageChoices,
+                c => c.Label,
+                ct);
+
+            return selection.Result;
         }
 
-        if (releasedGroup is not null && prereleaseGroup is not null)
+        // Group incoming items by channel instance
+        var byChannel = candidatePackages
+            .GroupBy(cp => cp.Channel)
+            .ToArray();
+
+        var implicitGroup = byChannel.FirstOrDefault(g => g.Key.Type is Packaging.PackageChannelType.Implicit);
+        var explicitGroups = byChannel
+            .Where(g => g.Key.Type is Packaging.PackageChannelType.Explicit)
+            .ToArray();
+
+        // Build the root menu as tuples of (label, action)
+        var rootChoices = new List<(string Label, Func<CancellationToken, Task<(NuGetPackage, PackageChannel)>> Action)>();
+
+        if (implicitGroup is not null)
         {
-            // If we have prerelease packages (and there are released packages) we
-            // want to show a sub-menu option which we will use to prompt the user.
-            // To make this work the first prompt returns a function which is invoke
-            // which will either return the package or trigger another prompt for
-            // sub-packages. This is the sub-prompt logic.
-            selections.Add((NewCommandStrings.UsePrereleaseTemplates, async () =>
+            // Add each implicit package directly to the root
+            foreach (var item in implicitGroup)
             {
-                return await interactionService.PromptForSelectionAsync(
-                     NewCommandStrings.SelectATemplateVersion,
-                     prereleaseGroup,
-                     (p) => $"{p.Version} ({p.Source})",
-                     cancellationToken
-                     );
+                var captured = item; // avoid modified-closure issues
+                rootChoices.Add((
+                    Label: FormatPackageLabel((captured.Package, captured.Channel)),
+                    Action: ct => Task.FromResult((captured.Package, captured.Channel))
+                ));
             }
+        }
+
+        // Add a submenu entry for each explicit channel
+        foreach (var channelGroup in explicitGroups)
+        {
+            var channel = channelGroup.Key;
+            var items = channelGroup.ToArray();
+
+            rootChoices.Add((
+                Label: channel.Name,
+                Action: ct => PromptForChannelPackagesAsync(channel, items, ct)
             ));
         }
-        else if (prereleaseGroup is not null)
+
+        // If for some reason we have no choices, fall back to the first candidate
+        if (rootChoices.Count == 0)
         {
-            // Fallback behavior if we happen to have NuGet feeds configured such
-            // that we only have access to prerelease template packages - in this
-            // case we just want to display them rather than having a special
-            // expander menu.
-            foreach (var prereleasePackage in prereleaseGroup)
-            {
-                selections.Add(($"{prereleasePackage.Version} ({prereleasePackage.Source})", () => Task.FromResult(prereleasePackage)));
-            }
+            return candidatePackages.First();
         }
 
-        var selection = await interactionService.PromptForSelectionAsync(
-                    NewCommandStrings.SelectATemplateVersion,
-                    selections,
-                    s => s.SelectionText,
-                    cancellationToken
-                    );
+        // Prompt user for the top-level selection
+        var topSelection = await interactionService.PromptForSelectionAsync(
+            NewCommandStrings.SelectATemplateVersion,
+            rootChoices,
+            c => c.Label,
+            cancellationToken);
 
-        var package = await selection.PackageSelector();
-        return package;
+        return await topSelection.Action(cancellationToken);
     }
 
     public virtual async Task<string> PromptForOutputPath(string path, CancellationToken cancellationToken)

src/Aspire.Cli/Configuration/ConfigurationService.cs

@@ -8,7 +8,7 @@
 
 namespace Aspire.Cli.Configuration;
 
-internal sealed class ConfigurationService(IConfiguration configuration, DirectoryInfo currentDirectory, FileInfo globalSettingsFile) : IConfigurationService
+internal sealed class ConfigurationService(IConfiguration configuration, CliExecutionContext executionContext, FileInfo globalSettingsFile) : IConfigurationService
 {
     public async Task SetConfigurationAsync(string key, string value, bool isGlobal = false, CancellationToken cancellationToken = default)
     {
@@ -93,7 +93,7 @@ private string GetSettingsFilePath(bool isGlobal)
 
     private string FindNearestSettingsFile()
     {
-        var searchDirectory = currentDirectory;
+        var searchDirectory = executionContext.WorkingDirectory;
 
         // Walk up the directory tree to find existing settings file
         while (searchDirectory is not null)
@@ -109,7 +109,7 @@ private string FindNearestSettingsFile()
         }
 
         // If no existing settings file found, create one in current directory
-        return ConfigurationHelper.BuildPathToSettingsJsonFile(currentDirectory.FullName);
+        return ConfigurationHelper.BuildPathToSettingsJsonFile(executionContext.WorkingDirectory.FullName);
     }
 
     public async Task<Dictionary<string, string>> GetAllConfigurationAsync(CancellationToken cancellationToken = default)

src/Aspire.Cli/DotNet/DotNetCliRunner.cs

@@ -29,11 +29,11 @@ internal interface IDotNetCliRunner
     Task<int> RunAsync(FileInfo projectFile, bool watch, bool noBuild, string[] args, IDictionary<string, string>? env, TaskCompletionSource<IAppHostBackchannel>? backchannelCompletionSource, DotNetCliRunnerInvocationOptions options, CancellationToken cancellationToken);
     Task<int> CheckHttpCertificateAsync(DotNetCliRunnerInvocationOptions options, CancellationToken cancellationToken);
     Task<int> TrustHttpCertificateAsync(DotNetCliRunnerInvocationOptions options, CancellationToken cancellationToken);
-    Task<(int ExitCode, string? TemplateVersion)> InstallTemplateAsync(string packageName, string version, string? nugetSource, bool force, DotNetCliRunnerInvocationOptions options, CancellationToken cancellationToken);
+    Task<(int ExitCode, string? TemplateVersion)> InstallTemplateAsync(string packageName, string version, FileInfo? nugetConfigFile, string? nugetSource, bool force, DotNetCliRunnerInvocationOptions options, CancellationToken cancellationToken);
     Task<int> NewProjectAsync(string templateName, string name, string outputPath, string[] extraArgs, DotNetCliRunnerInvocationOptions options, CancellationToken cancellationToken);
     Task<int> BuildAsync(FileInfo projectFilePath, DotNetCliRunnerInvocationOptions options, CancellationToken cancellationToken);
     Task<int> AddPackageAsync(FileInfo projectFilePath, string packageName, string packageVersion, string? nugetSource, DotNetCliRunnerInvocationOptions options, CancellationToken cancellationToken);
-    Task<(int ExitCode, NuGetPackage[]? Packages)> SearchPackagesAsync(DirectoryInfo workingDirectory, string query, bool prerelease, int take, int skip, string? nugetSource, DotNetCliRunnerInvocationOptions options, CancellationToken cancellationToken);
+    Task<(int ExitCode, NuGetPackage[]? Packages)> SearchPackagesAsync(DirectoryInfo workingDirectory, string query, bool prerelease, int take, int skip, FileInfo? nugetConfigFile, DotNetCliRunnerInvocationOptions options, CancellationToken cancellationToken);
 }
 
 internal sealed class DotNetCliRunnerInvocationOptions
@@ -45,7 +45,7 @@ internal sealed class DotNetCliRunnerInvocationOptions
     public bool StartDebugSession { get; set; }
 }
 
-internal class DotNetCliRunner(ILogger<DotNetCliRunner> logger, IServiceProvider serviceProvider, AspireCliTelemetry telemetry, IConfiguration configuration, IFeatures features, IInteractionService interactionService) : IDotNetCliRunner
+internal class DotNetCliRunner(ILogger<DotNetCliRunner> logger, IServiceProvider serviceProvider, AspireCliTelemetry telemetry, IConfiguration configuration, IFeatures features, IInteractionService interactionService, CliExecutionContext executionContext) : IDotNetCliRunner
 {
 
     internal Func<int> GetCurrentProcessId { get; set; } = () => Environment.ProcessId;
@@ -267,11 +267,12 @@ public async Task<int> TrustHttpCertificateAsync(DotNetCliRunnerInvocationOption
             cancellationToken: cancellationToken);
     }
 
-    public async Task<(int ExitCode, string? TemplateVersion)> InstallTemplateAsync(string packageName, string version, string? nugetSource, bool force, DotNetCliRunnerInvocationOptions options, CancellationToken cancellationToken)
+    public async Task<(int ExitCode, string? TemplateVersion)> InstallTemplateAsync(string packageName, string version, FileInfo? nugetConfigFile, string? nugetSource, bool force, DotNetCliRunnerInvocationOptions options, CancellationToken cancellationToken)
     {
         using var activity = telemetry.ActivitySource.StartActivity(nameof(InstallTemplateAsync), ActivityKind.Client);
 
-        List<string> cliArgs = ["new", "install", $"{packageName}::{version}"];
+        // NOTE: The change to @ over :: for template version separator (now enforced in .NET 10.0 SDK).
+        List<string> cliArgs = ["new", "install", $"{packageName}@{version}"];
 
         if (force)
         {
@@ -298,6 +299,14 @@ public async Task<int> TrustHttpCertificateAsync(DotNetCliRunnerInvocationOption
             existingStandardErrorCallback?.Invoke(line);
         };
 
+        // The dotnet new install command does not support the --configfile option so if we
+        // are installing packages based on a channel config we'll be passing in a nuget config
+        // file which is dynamically generated in a temporary folder. We'll use that temporary
+        // folder as the working directory for the command. If we are using an implicit channel
+        // then we just use the current execution context for the CLI and inherit whatever
+        // NuGet.configs that may or may not be laying around.
+        var workingDirectory = nugetConfigFile?.Directory ?? executionContext.WorkingDirectory;
+
         var exitCode = await ExecuteAsync(
             args: [.. cliArgs],
             env: new Dictionary<string, string>
@@ -307,7 +316,7 @@ public async Task<int> TrustHttpCertificateAsync(DotNetCliRunnerInvocationOption
                 [KnownConfigNames.DotnetCliUiLanguage] = "en-US"
             },
             projectFile: null,
-            workingDirectory: new DirectoryInfo(Environment.CurrentDirectory),
+            workingDirectory: workingDirectory,
             backchannelCompletionSource: null,
             options: options,
             cancellationToken: cancellationToken);
@@ -705,7 +714,7 @@ public async Task<int> AddPackageAsync(FileInfo projectFilePath, string packageN
         return result;
     }
 
-    public async Task<(int ExitCode, NuGetPackage[]? Packages)> SearchPackagesAsync(DirectoryInfo workingDirectory, string query, bool prerelease, int take, int skip, string? nugetSource, DotNetCliRunnerInvocationOptions options, CancellationToken cancellationToken)
+    public async Task<(int ExitCode, NuGetPackage[]? Packages)> SearchPackagesAsync(DirectoryInfo workingDirectory, string query, bool prerelease, int take, int skip, FileInfo? nugetConfigFile, DotNetCliRunnerInvocationOptions options, CancellationToken cancellationToken)
     {
         using var activity = telemetry.ActivitySource.StartActivity();
         List<string> cliArgs = [
@@ -720,10 +729,10 @@ public async Task<int> AddPackageAsync(FileInfo projectFilePath, string packageN
             "json"
         ];
 
-        if (nugetSource is not null)
+        if (nugetConfigFile is not null)
         {
-            cliArgs.Add("--source");
-            cliArgs.Add(nugetSource);
+            cliArgs.Add("--configfile");
+            cliArgs.Add(nugetConfigFile.FullName);
         }
 
         if (prerelease)