Enable workload search for users to find latest set versions (#42652)

Progress on #42367

This adds three new parameters to the dotnet workload list command: version, --take, and --format. If version is specified, it will print the most recent `--take` workload sets (within the feature band; default (or if you specify a value < 1) is 5) and output them in --format (which can be json or csv; default (unspecified or other) is to put each version on its own line).

```terminal
> dotnet workload search version
9.0.105
9.0.104
9.0.103
9.0.102
9.0.101
```

```terminal
> dotnet workload search version --format json --take 2
[{ "workloadVersion": "9.0.105"},{ "workloadVersion": "9.0.104" }]
```

### Converting the json output to lines/other formats

#### sh (with jq)
```bash
> dotnet workload search version --format json --take 2 | jq 'map(.workloadVersion) | .[]'
9.0.105
9.0.104
```

#### Powershell core
```powershell
> dotnet workload search version --format json --take 2 | ConvertFrom-Json | ForEach-Object { Write-Host $_.workloadVersion }
9.0.105
9.0.104
```

Author: Forgind

src/Cli/dotnet/NugetPackageDownloader/INuGetPackageDownloader.cs

@@ -29,6 +29,11 @@ Task<NuGetVersion> GetLatestPackageVersion(PackageId packageId,
              PackageSourceLocation packageSourceLocation = null,
              bool includePreview = false);
 
+        Task<IEnumerable<NuGetVersion>> GetLatestPackageVersions(PackageId packageId,
+             int numberOfResults,
+             PackageSourceLocation packageSourceLocation = null,
+             bool includePreview = false);
+
         Task<NuGetVersion> GetBestPackageVersionAsync(PackageId packageId,
             VersionRange versionRange,
              PackageSourceLocation packageSourceLocation = null);

src/Cli/dotnet/NugetPackageDownloader/NuGetPackageDownloader.cs

@@ -227,6 +227,12 @@ public async Task<IEnumerable<string>> ExtractPackageAsync(string packagePath, D
             return allFilesInPackage;
         }
 
+        public async Task<IEnumerable<IPackageSearchMetadata>> GetLatestVersionsOfPackage(string packageId, bool includePreview, int numberOfResults)
+        {
+            IEnumerable<PackageSource> packageSources = LoadNuGetSources(new PackageId(packageId), null, null);
+            return (await GetLatestVersionsInternalAsync(packageId, packageSources, includePreview, CancellationToken.None, numberOfResults)).Select(result => result.Item2);
+        }
+
         private async Task<(PackageSource, NuGetVersion)> GetPackageSourceAndVersion(PackageId packageId,
              NuGetVersion packageVersion = null,
              PackageSourceLocation packageSourceLocation = null,
@@ -489,8 +495,13 @@ private static string GenerateVersionRangeErrorDescription(string packageIdentif
         string packageIdentifier, IEnumerable<PackageSource> packageSources, bool includePreview,
         CancellationToken cancellationToken)
         {
-            ArgumentNullException.ThrowIfNull(packageSources);
+            return (await GetLatestVersionsInternalAsync(packageIdentifier, packageSources, includePreview, cancellationToken, 1)).First();
+        }
 
+        private async Task<IEnumerable<(PackageSource, IPackageSearchMetadata)>> GetLatestVersionsInternalAsync(
+            string packageIdentifier, IEnumerable<PackageSource> packageSources, bool includePreview, CancellationToken cancellationToken, int numberOfResults)
+        {
+            ArgumentNullException.ThrowIfNull(packageSources);
             if (string.IsNullOrWhiteSpace(packageIdentifier))
             {
                 throw new ArgumentException($"{nameof(packageIdentifier)} cannot be null or empty",
@@ -540,13 +551,13 @@ await Task.WhenAll(
 
                 if (stableVersions.Any())
                 {
-                    return stableVersions.MaxBy(r => r.package.Identity.Version);
+                    return stableVersions.OrderByDescending(r => r.package.Identity.Version).Take(numberOfResults);
                 }
             }
 
-            (PackageSource, IPackageSearchMetadata) latestVersion = accumulativeSearchResults
-                .MaxBy(r => r.package.Identity.Version);
-            return latestVersion;
+            IEnumerable<(PackageSource, IPackageSearchMetadata)> latestVersions = accumulativeSearchResults
+                .OrderByDescending(r => r.package.Identity.Version);
+            return latestVersions.Take(numberOfResults);
         }
 
         public async Task<NuGetVersion> GetBestPackageVersionAsync(PackageId packageId,
@@ -691,15 +702,18 @@ bool TryGetPackageMetadata(
         public async Task<NuGetVersion> GetLatestPackageVersion(PackageId packageId,
              PackageSourceLocation packageSourceLocation = null,
              bool includePreview = false)
+        {
+            return (await GetLatestPackageVersions(packageId, numberOfResults: 1, packageSourceLocation, includePreview)).First();
+        }
+
+        public async Task<IEnumerable<NuGetVersion>> GetLatestPackageVersions(PackageId packageId, int numberOfResults, PackageSourceLocation packageSourceLocation = null, bool includePreview = false)
         {
             CancellationToken cancellationToken = CancellationToken.None;
-            IPackageSearchMetadata packageMetadata;
             IEnumerable<PackageSource> packagesSources = LoadNuGetSources(packageId, packageSourceLocation);
 
-            (_, packageMetadata) = await GetLatestVersionInternalAsync(packageId.ToString(), packagesSources,
-                includePreview, cancellationToken).ConfigureAwait(false);
-
-            return packageMetadata.Identity.Version;
+            return (await GetLatestVersionsInternalAsync(packageId.ToString(), packagesSources,
+                includePreview, cancellationToken, numberOfResults).ConfigureAwait(false)).Select(result =>
+                result.Item2.Identity.Version);
         }
 
         public async Task<IEnumerable<string>> GetPackageIdsAsync(string idStem, bool allowPrerelease, PackageSourceLocation packageSourceLocation = null, CancellationToken cancellationToken = default)

src/Cli/dotnet/commands/dotnet-workload/search/LocalizableStrings.resx

@@ -135,4 +135,14 @@
   <data name="PlatformColumnName" xml:space="preserve">
     <value>Platforms</value>
   </data>
+  <data name="PrintSetVersionsDescription" xml:space="preserve">
+    <value>Output a list of the latest released workload versions. Takes the --take option to specify how many to provide and --format to alter the format.</value>
+    <comment>Do not localize --take or --format</comment>
+  </data>
+  <data name="FormatOptionDescription" xml:space="preserve">
+    <value>Changes the format of outputted workload versions. Can take 'json' or 'list'</value>
+  </data>
+  <data name="TakeOptionMustBePositive" xml:space="preserve">
+    <value>The --take option must be positive.</value>
+  </data>
 </root>

src/Cli/dotnet/commands/dotnet-workload/search/SearchWorkloadSetsParser.cs

@@ -0,0 +1,48 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.CommandLine;
+using Microsoft.DotNet.Workloads.Workload.Search;
+using LocalizableStrings = Microsoft.DotNet.Workloads.Workload.Search.LocalizableStrings;
+
+namespace Microsoft.DotNet.Cli
+{
+    internal static class SearchWorkloadSetsParser
+    {
+        public static readonly CliOption<int> TakeOption = new("--take") { DefaultValueFactory = (_) => 5 };
+
+        public static readonly CliOption<string> FormatOption = new("--format")
+        {
+            Description = LocalizableStrings.FormatOptionDescription
+        };
+
+        private static readonly CliCommand Command = ConstructCommand();
+
+        public static CliCommand GetCommand()
+        {
+            return Command;
+        }
+
+        private static CliCommand ConstructCommand()
+        {
+            var command = new CliCommand("version", LocalizableStrings.PrintSetVersionsDescription);
+            command.Options.Add(FormatOption);
+            command.Options.Add(TakeOption);
+
+            TakeOption.Validators.Add(optionResult =>
+            {
+                if (optionResult.GetValueOrDefault<int>() <= 0)
+                {
+                    throw new ArgumentException(LocalizableStrings.TakeOptionMustBePositive);
+                }
+            });
+
+            command.SetAction(parseResult => new WorkloadSearchCommand(parseResult)
+            {
+                ListWorkloadSetVersions = true
+            }.Execute());
+
+            return command;
+        }
+    }
+}

src/Cli/dotnet/commands/dotnet-workload/search/WorkloadSearchCommand.cs

@@ -2,11 +2,14 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.CommandLine;
+using System.Text.Json;
 using Microsoft.Deployment.DotNet.Releases;
 using Microsoft.DotNet.Cli;
+using Microsoft.DotNet.Cli.NuGetPackageDownloader;
 using Microsoft.DotNet.Cli.Utils;
 using Microsoft.DotNet.Workloads.Workload.Install;
 using Microsoft.NET.Sdk.WorkloadManifestReader;
+using Microsoft.TemplateEngine.Cli.Commands;
 
 namespace Microsoft.DotNet.Workloads.Workload.Search
 {
@@ -15,6 +18,10 @@ internal class WorkloadSearchCommand : WorkloadCommandBase
         private readonly IWorkloadResolver _workloadResolver;
         private readonly ReleaseVersion _sdkVersion;
         private readonly string _workloadIdStub;
+        private readonly int _numberOfWorkloadSetsToTake;
+        private readonly string _workloadSetOutputFormat;
+        private readonly IWorkloadManifestInstaller _installer;
+        internal bool ListWorkloadSetVersions { get; set; } = false;
 
         public WorkloadSearchCommand(
             ParseResult result,
@@ -34,10 +41,43 @@ public WorkloadSearchCommand(
 
             _sdkVersion = creationResult.SdkVersion;
             _workloadResolver = creationResult.WorkloadResolver;
+
+            _numberOfWorkloadSetsToTake = result.GetValue(SearchWorkloadSetsParser.TakeOption);
+            _workloadSetOutputFormat = result.GetValue(SearchWorkloadSetsParser.FormatOption);
+
+            _installer = WorkloadInstallerFactory.GetWorkloadInstaller(
+                reporter,
+                new SdkFeatureBand(_sdkVersion),
+                _workloadResolver,
+                Verbosity,
+                creationResult.UserProfileDir,
+                !SignCheck.IsDotNetSigned(),
+                restoreActionConfig: new RestoreActionConfig(result.HasOption(SharedOptions.InteractiveOption)),
+                elevationRequired: false,
+                shouldLog: false);
         }
 
         public override int Execute()
         {
+            if (ListWorkloadSetVersions)
+            {
+                var featureBand = new SdkFeatureBand(_sdkVersion);
+                var packageId = _installer.GetManifestPackageId(new ManifestId("Microsoft.NET.Workloads"), featureBand);
+                var versions = PackageDownloader.GetLatestPackageVersions(packageId, _numberOfWorkloadSetsToTake, packageSourceLocation: null, includePreview: !string.IsNullOrWhiteSpace(_sdkVersion.Prerelease))
+                    .GetAwaiter().GetResult()
+                    .Select(version => WorkloadManifestUpdater.WorkloadSetPackageVersionToWorkloadSetVersion(featureBand, version.Version.ToString()));
+                if (_workloadSetOutputFormat?.Equals("json", StringComparison.OrdinalIgnoreCase) == true)
+                {
+                    Reporter.WriteLine(JsonSerializer.Serialize(versions.Select(version => version.ToDictionary(_ => "workloadVersion", v => v))));
+                }
+                else
+                {
+                    Reporter.WriteLine(string.Join('\n', versions));
+                }
+
+                return 0;
+            }
+
             IEnumerable<WorkloadResolver.WorkloadInfo> availableWorkloads = _workloadResolver.GetAvailableWorkloads()
                 .OrderBy(workload => workload.Id);
 

src/Cli/dotnet/commands/dotnet-workload/search/WorkloadSearchCommandParser.cs

@@ -29,6 +29,7 @@ public static CliCommand GetCommand()
         private static CliCommand ConstructCommand()
         {
             var command = new CliCommand("search", LocalizableStrings.CommandDescription);
+            command.Subcommands.Add(SearchWorkloadSetsParser.GetCommand());
             command.Arguments.Add(WorkloadIdStubArgument);
             command.Options.Add(CommonOptions.HiddenVerbosityOption);
             command.Options.Add(VersionOption);