dependabot-nuget 0.315.0 → 0.316.0

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Run/UpdateHandlers/UpdateHandlerSelectionTests.cs

@@ -0,0 +1,183 @@
+using NuGetUpdater.Core.Run.ApiModel;
+using NuGetUpdater.Core.Run.UpdateHandlers;
+using NuGetUpdater.Core.Run;
+using Xunit;
+
+namespace NuGetUpdater.Core.Test.Run.UpdateHandlers;
+
+public class UpdateHandlerSelectionTests : UpdateHandlersTestsBase
+{
+    [Theory]
+    [MemberData(nameof(GetUpdateHandlerFromJobTestData))]
+    public void GetUpdateHandlerFromJob(Job job, IUpdateHandler expectedUpdateHandler)
+    {
+        var actualUpdateHandler = RunWorker.GetUpdateHandler(job);
+        Assert.Equal(expectedUpdateHandler.GetType(), actualUpdateHandler.GetType());
+    }
+
+    public static IEnumerable<object[]> GetUpdateHandlerFromJobTestData()
+    {
+        // to ensure we're not depending on any default values, _ALWAYS_ set the following properties explicitly:
+        //   Source
+        //   Dependencies
+        //   DependencyGroups
+        //   DependencyGroupToRefresh
+        //   SecurityUpdatesOnly
+        //   UpdatingAPullRequest
+
+        //
+        // group_update_all_versions
+        //
+        yield return
+        [
+            new Job()
+            {
+                Source = CreateJobSource("/"),
+                Dependencies = [],
+                DependencyGroups = [],
+                DependencyGroupToRefresh = null,
+                SecurityUpdatesOnly = false,
+                UpdatingAPullRequest = false,
+            },
+            GroupUpdateAllVersionsHandler.Instance,
+        ];
+
+        yield return
+        [
+            new Job()
+            {
+                Source = CreateJobSource("/"),
+                Dependencies = ["Dependency.A", "Dependency.B"],
+                DependencyGroups = [],
+                DependencyGroupToRefresh = null,
+                SecurityUpdatesOnly = true,
+                UpdatingAPullRequest = false,
+            },
+            GroupUpdateAllVersionsHandler.Instance,
+        ];
+
+        yield return
+        [
+            new Job()
+            {
+                Source = CreateJobSource("/"),
+                Dependencies = [],
+                DependencyGroups = [new() { Name = "some-group", AppliesTo = "security-updates" }],
+                DependencyGroupToRefresh = null,
+                SecurityUpdatesOnly = true,
+                UpdatingAPullRequest = false,
+            },
+            GroupUpdateAllVersionsHandler.Instance,
+        ];
+
+        //
+        // update_version_group_pr
+        //
+        yield return
+        [
+            new Job()
+            {
+                Source = CreateJobSource("/dir1", "/dir2"),
+                Dependencies = ["Some.Dependency"],
+                DependencyGroups = [new() { Name = "some-group", AppliesTo = "security-updates" }], // this
+                DependencyGroupToRefresh = "some-group",
+                SecurityUpdatesOnly = false,
+                UpdatingAPullRequest = true,
+            },
+            RefreshGroupUpdatePullRequestHandler.Instance,
+        ];
+
+        yield return
+        [
+            new Job()
+            {
+                Source = CreateJobSource("/src"),
+                Dependencies = ["Dependency.A", "Dependency.B"],
+                DependencyGroups = [new() { Name = "some-group", AppliesTo = "security-updates" }], // this
+                DependencyGroupToRefresh = "some-group",
+                SecurityUpdatesOnly = true,
+                UpdatingAPullRequest = true,
+            },
+            RefreshGroupUpdatePullRequestHandler.Instance,
+        ];
+
+        yield return
+        [
+            new Job()
+            {
+                Source = CreateJobSource("/src"),
+                Dependencies = ["Some.Dependency"],
+                DependencyGroups = [new() { Name = "some-group", AppliesTo = "security-updates" }],
+                DependencyGroupToRefresh = "some-group",
+                SecurityUpdatesOnly = true,
+                UpdatingAPullRequest = true,
+            },
+            RefreshGroupUpdatePullRequestHandler.Instance,
+        ];
+
+        yield return
+        [
+            new Job()
+            {
+                Source = CreateJobSource("/src"),
+                Dependencies = ["Some.Dependency"],
+                DependencyGroups = [new() { Name = "some-group", AppliesTo = "security-updates" }],
+                DependencyGroupToRefresh = "some-group",
+                SecurityUpdatesOnly = true,
+                UpdatingAPullRequest = true,
+            },
+            RefreshGroupUpdatePullRequestHandler.Instance,
+        ];
+
+        //
+        // create_security_pr
+        //
+        yield return
+        [
+            new Job()
+            {
+                Source = CreateJobSource("/src"),
+                Dependencies = ["Some.Dependency"],
+                DependencyGroups = [],
+                DependencyGroupToRefresh = null,
+                SecurityUpdatesOnly = true,
+                UpdatingAPullRequest = false,
+            },
+            CreateSecurityUpdatePullRequestHandler.Instance,
+        ];
+
+        //
+        // update_security_pr
+        //
+        yield return
+        [
+            new Job()
+            {
+                Source = CreateJobSource("/src"),
+                Dependencies = ["Some.Dependency"],
+                DependencyGroups = [],
+                DependencyGroupToRefresh = null,
+                SecurityUpdatesOnly = true,
+                UpdatingAPullRequest = true,
+            },
+            RefreshSecurityUpdatePullRequestHandler.Instance,
+        ];
+
+        //
+        // update_version_pr
+        //
+        yield return
+        [
+            new Job()
+            {
+                Source = CreateJobSource("/src"),
+                Dependencies = ["Some.Dependency"], // must not be empty
+                DependencyGroups = [],
+                DependencyGroupToRefresh = null,
+                SecurityUpdatesOnly = false, // must be false
+                UpdatingAPullRequest = true, // must be true
+            },
+            RefreshVersionUpdatePullRequestHandler.Instance,
+        ];
+    }
+}

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Run/UpdateHandlers/UpdateHandlersTestsBase.cs

@@ -0,0 +1,43 @@
+using NuGetUpdater.Core.Run.ApiModel;
+using NuGetUpdater.Core.Run.UpdateHandlers;
+using NuGetUpdater.Core.Run;
+using Xunit;
+
+namespace NuGetUpdater.Core.Test.Run.UpdateHandlers;
+
+public class UpdateHandlersTestsBase : TestBase
+{
+    protected static JobSource CreateJobSource(string directory, params string[] additionalDirectories) => new JobSource()
+    {
+        Provider = "github",
+        Repo = "test/repo",
+        Directories = [directory, .. additionalDirectories],
+    };
+
+    protected Task TestAsync(
+        Job job,
+        IUpdateHandler expectedUpdateHandler,
+        object[] expectedApiMessages,
+        (string Name, string Contents)[] files,
+        MockNuGetPackage[]? packages = null,
+        IDiscoveryWorker? discoveryWorker = null,
+        IAnalyzeWorker? analyzeWorker = null,
+        IUpdaterWorker? updaterWorker = null,
+        ExperimentsManager? experimentsManager = null
+    )
+    {
+        // first ensure we're using the correct updater
+        var actualUpdateHandler = RunWorker.GetUpdateHandler(job);
+        Assert.Equal(actualUpdateHandler.GetType(), expectedUpdateHandler.GetType());
+
+        // the new runner doesn't report this result object so we can expect an empty one
+        var expectedResult = new RunResult()
+        {
+            Base64DependencyFiles = [],
+            BaseCommitSha = "TEST-COMMIT-SHA",
+        };
+        experimentsManager ??= new ExperimentsManager();
+        experimentsManager = experimentsManager with { UseLegacyUpdateHandler = false };
+        return RunWorkerTests.RunAsync(job, files, discoveryWorker, analyzeWorker, updaterWorker, expectedResult, expectedApiMessages, packages, experimentsManager);
+    }
+}

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Run/UpdatedDependencyListTests.cs

@@ -89,7 +89,7 @@ public class UpdatedDependencyListTests
                 ]
             }
         };
-        var updatedDependencyList = RunWorker.GetUpdatedDependencyListFromDiscovery(discovery, pathToContents: temp.DirectoryPath);
+        var updatedDependencyList = RunWorker.GetUpdatedDependencyListFromDiscovery(discovery);
         var expectedDependencyList = new UpdatedDependencyList()
         {
             Dependencies =
@@ -213,7 +213,7 @@ public class UpdatedDependencyListTests
         };
 
         // act
-        var updatedDependencyList = RunWorker.GetUpdatedDependencyListFromDiscovery(discovery, pathToContents: tempDir.DirectoryPath);
+        var updatedDependencyList = RunWorker.GetUpdatedDependencyListFromDiscovery(discovery);
         var expectedDependencyList = new UpdatedDependencyList()
         {
             Dependencies = [],

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Update/UpdateOperationBaseTests.cs

@@ -1,5 +1,9 @@
+using System.Text.Json;
+
 using NuGet.Versioning;
 
+using NuGetUpdater.Core.Run;
+using NuGetUpdater.Core.Run.ApiModel;
 using NuGetUpdater.Core.Test.Utilities;
 using NuGetUpdater.Core.Updater;
 
@@ -21,19 +25,28 @@ public class UpdateOperationBaseTests
                 NewVersion = NuGetVersion.Parse("1.0.0"),
                 UpdatedFiles = ["file/a.txt"]
             },
-            new PinnedUpdate()
+            new DirectUpdate()
             {
                 DependencyName = "Package.B",
+                OldVersion = NuGetVersion.Parse("0.2.0"),
                 NewVersion = NuGetVersion.Parse("2.0.0"),
                 UpdatedFiles = ["file/b.txt"]
             },
-            new ParentUpdate()
+            new PinnedUpdate()
             {
                 DependencyName = "Package.C",
+                OldVersion = NuGetVersion.Parse("0.3.0"),
                 NewVersion = NuGetVersion.Parse("3.0.0"),
-                UpdatedFiles = ["file/c.txt"],
-                ParentDependencyName = "Package.D",
-                ParentNewVersion = NuGetVersion.Parse("4.0.0"),
+                UpdatedFiles = ["file/c.txt"]
+            },
+            new ParentUpdate()
+            {
+                DependencyName = "Package.D",
+                OldVersion = NuGetVersion.Parse("0.4.0"),
+                NewVersion = NuGetVersion.Parse("4.0.0"),
+                UpdatedFiles = ["file/d.txt"],
+                ParentDependencyName = "Package.E",
+                ParentNewVersion = NuGetVersion.Parse("5.0.0"),
             },
         };
 
@@ -44,8 +57,9 @@ public class UpdateOperationBaseTests
         var expectedReport = """
             Performed the following updates:
             - Updated Package.A to 1.0.0 in file/a.txt
-            - Pinned Package.B at 2.0.0 in file/b.txt
-            - Updated Package.C to 3.0.0 indirectly via Package.D/4.0.0 in file/c.txt
+            - Updated Package.B from 0.2.0 to 2.0.0 in file/b.txt
+            - Pinned Package.C at 3.0.0 in file/c.txt
+            - Updated Package.D to 4.0.0 indirectly via Package.E/5.0.0 in file/d.txt
             """.Replace("\r", "");
         Assert.Equal(expectedReport, actualReport);
     }
@@ -60,12 +74,14 @@ public class UpdateOperationBaseTests
             new DirectUpdate()
             {
                 DependencyName = "Dependency.Direct",
+                OldVersion = NuGetVersion.Parse("0.1.0"),
                 NewVersion = NuGetVersion.Parse("1.0.0"),
                 UpdatedFiles = ["/repo/root/file/a.txt"]
             },
             new PinnedUpdate()
             {
                 DependencyName = "Dependency.Pinned",
+                OldVersion = NuGetVersion.Parse("0.2.0"),
                 NewVersion = NuGetVersion.Parse("2.0.0"),
                 UpdatedFiles = ["/repo/root/file/b.txt"]
             },
@@ -73,12 +89,14 @@ public class UpdateOperationBaseTests
             new DirectUpdate()
             {
                 DependencyName = "Dependency.Direct",
+                OldVersion = NuGetVersion.Parse("0.1.0"),
                 NewVersion = NuGetVersion.Parse("1.0.0"),
                 UpdatedFiles = ["/repo/root/file/a.txt"]
             },
             new ParentUpdate()
             {
                 DependencyName = "Dependency.Parent",
+                OldVersion = NuGetVersion.Parse("0.3.0"),
                 NewVersion = NuGetVersion.Parse("3.0.0"),
                 UpdatedFiles = ["/repo/root/file/c.txt"],
                 ParentDependencyName = "Dependency.Root",
@@ -106,12 +124,14 @@ public class UpdateOperationBaseTests
             new DirectUpdate()
             {
                 DependencyName = "Dependency.Direct",
+                OldVersion = NuGetVersion.Parse("0.1.0"),
                 NewVersion = NuGetVersion.Parse("1.0.0"),
                 UpdatedFiles = ["/repo/root/file/b.txt"]
             },
             new DirectUpdate()
             {
                 DependencyName = "Dependency.Direct",
+                OldVersion = NuGetVersion.Parse("0.1.0"),
                 NewVersion = NuGetVersion.Parse("1.0.0"),
                 UpdatedFiles = ["/repo/root/file/a.txt"]
             },
@@ -127,4 +147,98 @@ public class UpdateOperationBaseTests
         Assert.Equal(NuGetVersion.Parse("1.0.0"), directUpdate.NewVersion);
         AssertEx.Equal(["/file/a.txt", "/file/b.txt"], directUpdate.UpdatedFiles);
     }
+
+    [Theory]
+    [MemberData(nameof(ToReportedDependencyTestData))]
+    public void ToReportedDependency(UpdateOperationBase updateOperation, ReportedDependency[] previouslyReportedDependencies, Dependency[] updatedDependencies, ReportedDependency expectedReportedDependency)
+    {
+        var actualReportedDependency = updateOperation.ToReportedDependency("project.csproj", previouslyReportedDependencies, updatedDependencies);
+
+        var actualReportedJson = JsonSerializer.Serialize(actualReportedDependency, RunWorker.SerializerOptions);
+        var expectedReportedJson = JsonSerializer.Serialize(expectedReportedDependency, RunWorker.SerializerOptions);
+        Assert.Equal(expectedReportedJson, actualReportedJson);
+    }
+
+    public static IEnumerable<object[]> ToReportedDependencyTestData()
+    {
+        // direct mapping
+        yield return
+        [
+            // updateOperation
+            new DirectUpdate()
+            {
+                DependencyName = "Some.Package",
+                NewVersion = NuGetVersion.Parse("2.0.0"),
+                UpdatedFiles = ["project.csproj"]
+            },
+            // previouslyReportedDependencies
+            new ReportedDependency[]
+            {
+                new()
+                {
+                    Name = "Some.Package",
+                    Version = "1.0.0",
+                    Requirements = [
+                        new() { Requirement = "1.0.0", File = "project.csproj" }
+                    ]
+                }
+            },
+            // updatedDependencies
+            new Dependency[]
+            {
+                new("Some.Package", "2.0.0", DependencyType.Unknown, InfoUrl: "https://nuget.example.com/Some.Package"),
+            },
+            // expectedReportedDependency
+            new ReportedDependency()
+            {
+                Name = "Some.Package",
+                Version = "2.0.0",
+                Requirements = [
+                    new() { Requirement = "2.0.0", File = "project.csproj", Source = new() { SourceUrl = "https://nuget.example.com/Some.Package" } }
+                ],
+                PreviousVersion = "1.0.0",
+                PreviousRequirements = [
+                    new() { Requirement = "1.0.0", File = "project.csproj" }
+                ],
+            },
+        ];
+
+        // updated dependency brought in new package not previously known
+        yield return
+        [
+            // updateOperation
+            new DirectUpdate()
+            {
+                DependencyName = "Transitive.Package",
+                NewVersion = NuGetVersion.Parse("3.0.0"),
+                UpdatedFiles = ["project.csproj"]
+            },
+            // previouslyReportedDependencies
+            new ReportedDependency[]
+            {
+                new()
+                {
+                    Name = "Some.Package",
+                    Version = "1.0.0",
+                    Requirements = [
+                        new() { Requirement = "1.0.0", File = "project.csproj" }
+                    ]
+                }
+            },
+            // updatedDependencies
+            new Dependency[]
+            {
+                new("Transitive.Package", "3.0.0", DependencyType.Unknown),
+            },
+            // expectedReportedDependency
+            new ReportedDependency()
+            {
+                Name = "Transitive.Package",
+                Version = "3.0.0",
+                Requirements = [
+                    new() { Requirement = "3.0.0", File = "project.csproj", Source = new() { SourceUrl = null } }
+                ],
+            },
+        ];
+    }
 }

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Update/UpdateWorkerTests.Mixed.cs

@@ -54,18 +54,21 @@ public partial class UpdateWorkerTests
                     new DirectUpdate()
                     {
                         DependencyName = "Package.A",
+                        OldVersion = NuGetVersion.Parse("0.1.0"),
                         NewVersion = NuGetVersion.Parse("1.0.0"),
                         UpdatedFiles = ["a.txt"]
                     },
                     new PinnedUpdate()
                     {
                         DependencyName = "Package.B",
+                        OldVersion = NuGetVersion.Parse("0.2.0"),
                         NewVersion = NuGetVersion.Parse("2.0.0"),
                         UpdatedFiles = ["b.txt"]
                     },
                     new ParentUpdate()
                     {
                         DependencyName = "Package.C",
+                        OldVersion = NuGetVersion.Parse("0.3.0"),
                         NewVersion = NuGetVersion.Parse("3.0.0"),
                         UpdatedFiles = ["c.txt"],
                         ParentDependencyName = "Package.D",
@@ -80,6 +83,7 @@ public partial class UpdateWorkerTests
                     {
                       "Type": "DirectUpdate",
                       "DependencyName": "Package.A",
+                      "OldVersion": "0.1.0",
                       "NewVersion": "1.0.0",
                       "UpdatedFiles": [
                         "a.txt"
@@ -88,6 +92,7 @@ public partial class UpdateWorkerTests
                     {
                       "Type": "PinnedUpdate",
                       "DependencyName": "Package.B",
+                      "OldVersion": "0.2.0",
                       "NewVersion": "2.0.0",
                       "UpdatedFiles": [
                         "b.txt"
@@ -98,6 +103,7 @@ public partial class UpdateWorkerTests
                       "ParentDependencyName": "Package.D",
                       "ParentNewVersion": "4.0.0",
                       "DependencyName": "Package.C",
+                      "OldVersion": "0.3.0",
                       "NewVersion": "3.0.0",
                       "UpdatedFiles": [
                         "c.txt"

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Update/UpdateWorkerTests.PackagesConfig.cs

@@ -2576,7 +2576,7 @@ public partial class UpdateWorkerTests
                     """,
                 expectedResult: new()
                 {
-                    ErrorRegex = "Response status code does not indicate success",
+                    Error = new PrivateSourceBadResponse([$"{http.BaseUrl.TrimEnd('/')}/index.json"]),
                     UpdateOperations = [],
                 }
             );
@@ -2654,7 +2654,7 @@ public partial class UpdateWorkerTests
                     """,
                 expectedResult: new()
                 {
-                    Error = new DependencyNotFound("Unrelated.Package.1.0.0"),
+                    Error = new DependencyNotFound("Unrelated.Package"),
                     UpdateOperations = [],
                 }
             );

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Utilities/MSBuildHelperTests.cs

@@ -1789,6 +1789,38 @@ public class MSBuildHelperTests : TestBase
             new PrivateSourceAuthenticationFailure(["http://localhost/test-feed"]),
         ];
 
+        yield return
+        [
+            // output
+            "Response status code does not indicate success: 500 (Internal Server Error).",
+            // expectedError
+            new PrivateSourceBadResponse(["http://localhost/test-feed"]),
+        ];
+
+        yield return
+        [
+            // output
+            "The response ended prematurely. (ResponseEnded)",
+            // expectedError
+            new PrivateSourceBadResponse(["http://localhost/test-feed"]),
+        ];
+
+        yield return
+        [
+            // output
+            "The file is not a valid nupkg.",
+            // expectedError
+            new PrivateSourceBadResponse(["http://localhost/test-feed"]),
+        ];
+
+        yield return
+        [
+            // output
+            "The content at 'http://localhost/test-feed/Packages(Id='Some.Package',Version='1.2.3')' is not valid XML.",
+            // expectedError
+            new PrivateSourceBadResponse(["http://localhost/test-feed"]),
+        ];
+
         yield return
         [
             // output
@@ -1829,6 +1861,14 @@ public class MSBuildHelperTests : TestBase
             new DependencyNotFound("missing-sdk"),
         ];
 
+        yield return
+        [
+            // output
+            "Unable to find package 'Some.Package'. Existing packages must be restored before performing an install or update",
+            // expectedError
+            new DependencyNotFound("Some.Package"),
+        ];
+
         yield return
         [
             // output
@@ -1884,6 +1924,17 @@ public class MSBuildHelperTests : TestBase
             // expectedError
             new DependencyFileNotParseable("/path/to/packages.config", "Some error message."),
         ];
+
+        yield return
+        [
+            // output
+            """
+            NuGet.Config is not valid XML. Path: '/path/to/NuGet.Config'.
+              Some error message.
+            """,
+            // expectedError
+            new DependencyFileNotParseable("/path/to/NuGet.Config", "Some error message."),
+        ];
     }
 
     public static IEnumerable<object[]> GetTopLevelPackageDependencyInfosTestData()

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Utilities/MarkdownListBuilderTests.cs

@@ -0,0 +1,42 @@
+using NuGetUpdater.Core.Utilities;
+
+using Xunit;
+
+namespace NuGetUpdater.Core.Test.Utilities;
+
+public class MarkdownListBuilderTests
+{
+    [Theory]
+    [MemberData(nameof(ListCreationTestData))]
+    public void ListCreation(object obj, string expected)
+    {
+        expected = expected.Replace("\r", "");
+        var actual = MarkdownListBuilder.FromObject(obj).Replace("\r", "");
+        Assert.Equal(expected, actual);
+    }
+
+    public static IEnumerable<object[]> ListCreationTestData()
+    {
+        yield return
+        [
+            new Dictionary<string, object>()
+            {
+                ["key1"] = "value1",
+                ["key2"] = new[]
+                {
+                    new Dictionary<string, object>()
+                    {
+                        ["key11"] = "value11",
+                        ["key12"] = "value12"
+                    }
+                }
+            },
+            """
+            - key1: value1
+            - key2:
+              - - key11: value11
+                - key12: value12
+            """
+        ];
+    }
+}