Sort versions in internal-versions.txt file

Author: lbussell

eng/update-dependencies/FromStagingPipelineCommand.cs

@@ -3,6 +3,7 @@
 
 using Dotnet.Docker.Git;
 using Dotnet.Docker.Sync;
+using Microsoft.DotNet.Docker.Shared;
 using Microsoft.Extensions.Logging;
 
 namespace Dotnet.Docker;
@@ -66,12 +67,13 @@ public override async Task<int> ExecuteAsync(FromStagingPipelineOptions options)
             options.StagingPipelineRunId);
 
         string dotnetProductVersion = VersionHelper.ResolveProductVersion(releaseConfig.RuntimeBuild);
-        string dockerfileVersion = VersionHelper.ResolveMajorMinorVersion(releaseConfig.RuntimeBuild).ToString();
+        DotNetVersion dotNetVersion = DotNetVersion.Parse(releaseConfig.RuntimeBuild);
+        string majorMinorVersionString = dotNetVersion.ToString(2);
 
-        // Record pipeline run ID for this dockerfileVersion, for later use by sync-internal-release command
+        // Record pipeline run ID for this internal version, for later use by sync-internal-release command
         _internalVersionsService.RecordInternalStagingBuild(
             repoRoot: gitRepoContext.LocalRepoPath,
-            dockerfileVersion: dockerfileVersion,
+            dotNetVersion: dotNetVersion,
             stagingPipelineRunId: options.StagingPipelineRunId);
 
         var productVersions = (options.Internal, releaseConfig.SdkOnly) switch
@@ -130,7 +132,7 @@ public override async Task<int> ExecuteAsync(FromStagingPipelineOptions options)
         var updateDependenciesOptions = new SpecificCommandOptions()
         {
             RepoRoot = gitRepoContext.LocalRepoPath,
-            DockerfileVersion = dockerfileVersion.ToString(),
+            DockerfileVersion = majorMinorVersionString,
             ProductVersions = productVersions,
             InternalBaseUrl = internalBaseUrl,
         };
@@ -144,10 +146,10 @@ public override async Task<int> ExecuteAsync(FromStagingPipelineOptions options)
             return exitCode;
         }
 
-        var commitMessage = $"Update .NET {dockerfileVersion} to {productVersions["sdk"]} SDK / {productVersions["runtime"]} Runtime";
+        var commitMessage = $"Update .NET {majorMinorVersionString} to {productVersions["sdk"]} SDK / {productVersions["runtime"]} Runtime";
         var prTitle = $"[{options.TargetBranch}] {commitMessage}";
         var prBody = $"""
-            This pull request updates .NET {dockerfileVersion} to the following versions:
+            This pull request updates .NET {majorMinorVersionString} to the following versions:
 
             - SDK: {productVersions["sdk"]}
             - Runtime: {productVersions["runtime"]}

eng/update-dependencies/Sync/DotNetVersionExtensions.cs

@@ -0,0 +1,20 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using Microsoft.DotNet.Docker.Shared;
+using NuGet.Versioning;
+
+namespace Dotnet.Docker.Sync;
+
+/// <summary>
+/// <see cref="DotNetVersion"/> Extensions that are only used for release branch synchronization.
+/// </summary>
+internal static class DotNetVersionExtensions
+{
+    /// <summary>
+    /// Converts a <see cref="DotNetVersion"/> to a new <see cref="DotNetVersion"/>
+    /// with only the major and minor version parts.
+    /// </summary>
+    public static DotNetVersion ToMajorMinorVersion(this DotNetVersion version) =>
+        new DotNetVersion(new SemanticVersion(version.Major, version.Minor, 0));
+}

eng/update-dependencies/Sync/IInternalVersionsService.cs

@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using Microsoft.DotNet.Docker.Shared;
+
 namespace Dotnet.Docker.Sync;
 
 /// <summary>
@@ -18,13 +20,13 @@ internal interface IInternalVersionsService
     /// Records a staging pipeline run ID in the repo.
     /// </summary>
     /// <remarks>
-    /// This will only store one staging pipeline run ID per dockerfileVersion.
+    /// This will only store one staging pipeline run ID per <paramref name="dotNetVersion"/>.
     /// If a version already exists for the same dockerfileVersion, it will be
     /// overwritten.
     /// </remarks>
-    /// <param name="dockerfileVersion">major-minor version</param>
+    /// <param name="dotNetVersion">.NET build or product version</param>
     /// <param name="stagingPipelineRunId">the build ID of the staging pipeline run</param>
-    void RecordInternalStagingBuild(string repoRoot, string dockerfileVersion, int stagingPipelineRunId);
+    void RecordInternalStagingBuild(string repoRoot, DotNetVersion dotNetVersion, int stagingPipelineRunId);
 
     /// <summary>
     /// Gets any previously recorded internal staging builds in the repo.

eng/update-dependencies/Sync/InternalStagingBuilds.cs

@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Collections.Immutable;
+using Microsoft.DotNet.Docker.Shared;
 
 namespace Dotnet.Docker.Sync;
 
@@ -12,7 +13,7 @@ namespace Dotnet.Docker.Sync;
 /// <param name="Versions">
 /// Mapping of Major.Minor .NET version to staging pipeline run ID.
 /// </param>
-internal sealed record InternalStagingBuilds(ImmutableDictionary<string, int> Versions)
+internal sealed record InternalStagingBuilds(ImmutableDictionary<DotNetVersion, int> Versions)
 {
     /// <summary>
     /// Parses <see cref=" InternalStagingBuilds"/> from lines of text.
@@ -25,7 +26,11 @@ public static InternalStagingBuilds Parse(IEnumerable<string> lines)
         var versions = lines
             .Select(line => line.Split('=', 2))
             .Where(parts => parts.Length == 2)
-            .ToImmutableDictionary(parts => parts[0], parts => int.Parse(parts[1]));
+            .ToImmutableDictionary(
+                // Reduce the version to major.minor only.
+                // If we don't, we could end up with multiple entries for the same version.
+                parts => DotNetVersion.Parse(parts[0]).ToMajorMinorVersion(),
+                parts => int.Parse(parts[1]));
 
         return new InternalStagingBuilds(versions);
     }
@@ -34,9 +39,14 @@ public static InternalStagingBuilds Parse(IEnumerable<string> lines)
     /// Returns a new <see cref="InternalStagingBuilds"/> with the specified
     /// version added.
     /// </summary>
-    public InternalStagingBuilds Add(string dockerfileVersion, int stagingPipelineRunId) =>
-        this with { Versions = Versions.SetItem(dockerfileVersion, stagingPipelineRunId) };
+    public InternalStagingBuilds Add(DotNetVersion dotNetVersion, int stagingPipelineRunId) =>
+        this with { Versions = Versions.SetItem(dotNetVersion, stagingPipelineRunId) };
 
+    // Internal versions file should have one line per dockerfileVersion, and
+    // each line should be formatted as: <dockerfileVersion>=<stagingPipelineRunId>
     public override string ToString() =>
-        string.Join(Environment.NewLine, Versions.Select(kv => $"{kv.Key}={kv.Value}"));
+        string.Join(Environment.NewLine,
+            Versions
+                .OrderBy(kv => kv.Key)
+                .Select(kv => $"{kv.Key.ToString(2)}={kv.Value}"));
 }

eng/update-dependencies/Sync/InternalVersionsService.cs

@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Collections.Immutable;
+using Microsoft.DotNet.Docker.Shared;
 
 namespace Dotnet.Docker.Sync;
 
@@ -21,12 +22,12 @@ public InternalStagingBuilds GetInternalStagingBuilds(string repoRoot)
         }
         catch (FileNotFoundException)
         {
-            return new InternalStagingBuilds(ImmutableDictionary<string, int>.Empty);
+            return new InternalStagingBuilds(ImmutableDictionary<DotNetVersion, int>.Empty);
         }
     }
 
     /// <inheritdoc/>
-    public void RecordInternalStagingBuild(string repoRoot, string dockerfileVersion, int stagingPipelineRunId)
+    public void RecordInternalStagingBuild(string repoRoot, DotNetVersion dotNetVersion, int stagingPipelineRunId)
     {
         // Internal versions file should have one line per dockerfileVersion
         // Each line should be formatted as: <dockerfileVersion>=<stagingPipelineRunId>
@@ -38,10 +39,7 @@ public void RecordInternalStagingBuild(string repoRoot, string dockerfileVersion
         // 2) lots of regex JSON manipulation which is error-prone and harder to maintain
         //
         // So for now, the separate file and format is a compromise.
-
-        // Internal versions file should have one line per dockerfileVersion
-        // Each line should be formatted as: <dockerfileVersion>=<stagingPipelineRunId>
-        var builds = GetInternalStagingBuilds(repoRoot).Add(dockerfileVersion, stagingPipelineRunId);
+        var builds = GetInternalStagingBuilds(repoRoot).Add(dotNetVersion, stagingPipelineRunId);
         var internalVersionFile = Path.Combine(repoRoot, InternalVersionsFileName);
         File.WriteAllText(internalVersionFile, builds.ToString());
     }

tests/UpdateDependencies.Tests/SyncInternalReleaseTests.cs

@@ -6,6 +6,7 @@
 using Dotnet.Docker.Git;
 using Dotnet.Docker.Sync;
 using Microsoft.DotNet.DarcLib;
+using Microsoft.DotNet.Docker.Shared;
 using Microsoft.Extensions.Logging;
 
 namespace UpdateDependencies.Tests;
@@ -224,7 +225,11 @@ public async Task Sync()
                 : throw new Exception($"PR {PullRequestUrl} was not created first"));
 
         // For this scenario, two internal versions have been checked in to this repo.
-        var internalVersions = new Dictionary<string, int> { { "8.0", 8000000 }, { "10.0", 1000000 } };
+        var internalVersions = new Dictionary<DotNetVersion, int>
+        {
+            { DotNetVersion.Parse("8.0"), 8000000 },
+            { DotNetVersion.Parse("10.0"), 1000000 }
+        };
         var internalVersionsService = CreateInternalVersionsService(LocalRepoPath, internalVersions);
 
         var fromStagingPipelineCommandMock = new Mock<ICommand<FromStagingPipelineOptions>>();
@@ -239,7 +244,7 @@ public async Task Sync()
         exitCode.ShouldBe(0);
 
         // Verify that we re-applied all internal versions by calling the downstream command.
-        foreach ((string dotnetVersion, int buildId) in internalVersions)
+        foreach ((_, int buildId) in internalVersions)
         {
             fromStagingPipelineCommandMock.Verify(command =>
                 command.ExecuteAsync(It.Is<FromStagingPipelineOptions>(o =>
@@ -299,7 +304,7 @@ private SyncInternalReleaseCommand CreateCommand(
     /// Helper method to create a mock version of <see cref="IInternalVersionsService"/>
     /// </summary>
     private static IInternalVersionsService CreateInternalVersionsService(
-        string repoPath, Dictionary<string, int> versions)
+        string repoPath, Dictionary<DotNetVersion, int> versions)
     {
         var internalStagingBuilds = new InternalStagingBuilds(versions.ToImmutableDictionary());