dependabot-nuget 0.309.0 → 0.311.0

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

@@ -0,0 +1,355 @@
+using System.Text;
+
+using NuGetUpdater.Core.Run.ApiModel;
+using NuGetUpdater.Core.Run;
+using Xunit;
+using NuGetUpdater.Core.Analyze;
+
+namespace NuGetUpdater.Core.Test.Run;
+
+public class EndToEndTests
+{
+    [Fact]
+    public async Task UpdatePackageWithDifferentVersionsInDifferentDirectories()
+    {
+        // this test passes `null` for discovery, analyze, and update workers to fully test the desired behavior
+
+        // the same dependency Some.Package is reported for 3 cases:
+        //   library1.csproj - top level dependency, already up to date
+        //   library2.csproj - top level dependency, needs direct update
+        //   library3.csproj - transitive dependency, needs pin
+        await RunWorkerTests.RunAsync(
+            experimentsManager: new ExperimentsManager() { UseDirectDiscovery = true },
+            packages: [
+                MockNuGetPackage.CreateSimplePackage("Some.Package", "1.0.0", "net8.0"),
+                MockNuGetPackage.CreateSimplePackage("Some.Package", "2.0.0", "net8.0"),
+                MockNuGetPackage.CreateSimplePackage("Package.With.Transitive.Dependency", "0.1.0", "net8.0", [(null, [("Some.Package", "1.0.0")])]),
+            ],
+            job: new Job()
+            {
+                AllowedUpdates = [new() { UpdateType = UpdateType.Security }],
+                SecurityAdvisories =
+                [
+                    new()
+                    {
+                        DependencyName = "Some.Package",
+                        AffectedVersions = [Requirement.Parse("= 1.0.0")]
+                    }
+                ],
+                Source = new()
+                {
+                    Provider = "github",
+                    Repo = "test/repo",
+                    Directory = "/"
+                }
+            },
+            files: [
+                ("dirs.proj", """
+                    <Project>
+                      <ItemGroup>
+                        <ProjectFile Include="library1\library1.csproj" />
+                        <ProjectFile Include="library2\library2.csproj" />
+                        <ProjectFile Include="library3\library3.csproj" />
+                      </ItemGroup>
+                    </Project>
+                    """),
+                ("Directory.Build.props", "<Project />"),
+                ("Directory.Build.targets", "<Project />"),
+                ("Directory.Packages.props", """
+                    <Project>
+                      <PropertyGroup>
+                        <ManagePackageVersionsCentrally>false</ManagePackageVersionsCentrally>
+                      </PropertyGroup>
+                    </Project>
+                    """),
+                ("library1/library1.csproj", """
+                    <Project Sdk="Microsoft.NET.Sdk">
+                      <PropertyGroup>
+                        <TargetFramework>net8.0</TargetFramework>
+                      </PropertyGroup>
+                      <ItemGroup>
+                        <PackageReference Include="Some.Package" Version="2.0.0" />
+                      </ItemGroup>
+                    </Project>
+                    """),
+                ("library2/library2.csproj", """
+                    <Project Sdk="Microsoft.NET.Sdk">
+                      <PropertyGroup>
+                        <TargetFramework>net8.0</TargetFramework>
+                      </PropertyGroup>
+                      <ItemGroup>
+                        <PackageReference Include="Some.Package" Version="1.0.0" />
+                      </ItemGroup>
+                    </Project>
+                    """),
+                ("library3/library3.csproj", """
+                    <Project Sdk="Microsoft.NET.Sdk">
+                      <PropertyGroup>
+                        <TargetFramework>net8.0</TargetFramework>
+                      </PropertyGroup>
+                      <ItemGroup>
+                        <PackageReference Include="Package.With.Transitive.Dependency" Version="0.1.0" />
+                      </ItemGroup>
+                    </Project>
+                    """),
+            ],
+            discoveryWorker: null,
+            analyzeWorker: null,
+            updaterWorker: null,
+            expectedResult: new RunResult()
+            {
+                Base64DependencyFiles =
+                [
+                    new DependencyFile()
+                    {
+                        Directory = "/",
+                        Name = "Directory.Build.props",
+                        Content = Convert.ToBase64String(Encoding.UTF8.GetBytes("<Project />")),
+                        ContentEncoding = "base64",
+                    },
+                    new DependencyFile()
+                    {
+                        Directory = "/",
+                        Name = "Directory.Build.targets",
+                        Content = Convert.ToBase64String(Encoding.UTF8.GetBytes("<Project />")),
+                        ContentEncoding = "base64",
+                    },
+                    new DependencyFile()
+                    {
+                        Directory = "/",
+                        Name = "Directory.Packages.props",
+                        Content = Convert.ToBase64String(Encoding.UTF8.GetBytes("""
+                            <Project>
+                              <PropertyGroup>
+                                <ManagePackageVersionsCentrally>false</ManagePackageVersionsCentrally>
+                              </PropertyGroup>
+                            </Project>
+                            """)),
+                        ContentEncoding = "base64",
+                    },
+                    new DependencyFile()
+                    {
+                        Directory = "/library1",
+                        Name = "library1.csproj",
+                        Content = Convert.ToBase64String(Encoding.UTF8.GetBytes("""
+                            <Project Sdk="Microsoft.NET.Sdk">
+                              <PropertyGroup>
+                                <TargetFramework>net8.0</TargetFramework>
+                              </PropertyGroup>
+                              <ItemGroup>
+                                <PackageReference Include="Some.Package" Version="2.0.0" />
+                              </ItemGroup>
+                            </Project>
+                            """)),
+                        ContentEncoding = "base64",
+                    },
+                    new DependencyFile()
+                    {
+                        Directory = "/library2",
+                        Name = "library2.csproj",
+                        Content = Convert.ToBase64String(Encoding.UTF8.GetBytes("""
+                            <Project Sdk="Microsoft.NET.Sdk">
+                              <PropertyGroup>
+                                <TargetFramework>net8.0</TargetFramework>
+                              </PropertyGroup>
+                              <ItemGroup>
+                                <PackageReference Include="Some.Package" Version="1.0.0" />
+                              </ItemGroup>
+                            </Project>
+                            """)),
+                        ContentEncoding = "base64",
+                    },
+                    new DependencyFile()
+                    {
+                        Directory = "/library3",
+                        Name = "library3.csproj",
+                        Content = Convert.ToBase64String(Encoding.UTF8.GetBytes("""
+                            <Project Sdk="Microsoft.NET.Sdk">
+                              <PropertyGroup>
+                                <TargetFramework>net8.0</TargetFramework>
+                              </PropertyGroup>
+                              <ItemGroup>
+                                <PackageReference Include="Package.With.Transitive.Dependency" Version="0.1.0" />
+                              </ItemGroup>
+                            </Project>
+                            """)),
+                        ContentEncoding = "base64",
+                    }
+                ],
+                BaseCommitSha = "TEST-COMMIT-SHA",
+            },
+            expectedApiMessages: [
+                new UpdatedDependencyList()
+                {
+                    Dependencies = [
+                        new()
+                        {
+                            Name = "Some.Package",
+                            Version = "2.0.0",
+                            Requirements = [
+                                new()
+                                {
+                                    Requirement = "2.0.0",
+                                    File = "/library1/library1.csproj",
+                                    Groups = ["dependencies"],
+                                }
+                            ]
+                        },
+                        new()
+                        {
+                            Name = "Some.Package",
+                            Version = "1.0.0",
+                            Requirements = [
+                                new()
+                                {
+                                    Requirement = "1.0.0",
+                                    File = "/library2/library2.csproj",
+                                    Groups = ["dependencies"],
+                                }
+                            ]
+                        },
+                        new()
+                        {
+                            Name = "Package.With.Transitive.Dependency",
+                            Version = "0.1.0",
+                            Requirements = [
+                                new()
+                                {
+                                    Requirement = "0.1.0",
+                                    File = "/library3/library3.csproj",
+                                    Groups = ["dependencies"],
+                                }
+                            ]
+                        },
+                        new()
+                        {
+                            Name = "Some.Package",
+                            Version = "1.0.0",
+                            Requirements = [
+                                new()
+                                {
+                                    Requirement = "1.0.0",
+                                    File = "/library3/library3.csproj",
+                                    Groups = ["dependencies"],
+                                }
+                            ]
+                        },
+                    ],
+                    DependencyFiles = [
+                        "/Directory.Build.props",
+                        "/Directory.Build.targets",
+                        "/Directory.Packages.props",
+                        "/library1/library1.csproj",
+                        "/library2/library2.csproj",
+                        "/library3/library3.csproj",
+                    ],
+                },
+                new IncrementMetric()
+                {
+                    Metric = "updater.started",
+                    Tags = new()
+                    {
+                        ["operation"] = "create_security_pr"
+                    }
+                },
+                new CreatePullRequest()
+                {
+                    Dependencies = [
+                        new()
+                        {
+                            Name = "Some.Package",
+                            Version = "2.0.0",
+                            Requirements = [
+                                new()
+                                {
+                                    Requirement = "2.0.0",
+                                    File = "/library2/library2.csproj",
+                                    Groups = ["dependencies"],
+                                    Source = new()
+                                    {
+                                        SourceUrl = null,
+                                        Type = "nuget_repo",
+                                    }
+                                }
+                            ],
+                            PreviousVersion = "1.0.0",
+                            PreviousRequirements = [
+                                new()
+                                {
+                                    Requirement = "1.0.0",
+                                    File = "/library2/library2.csproj",
+                                    Groups = ["dependencies"],
+                                }
+                            ],
+                        },
+                        new()
+                        {
+                            Name = "Some.Package",
+                            Version = "2.0.0",
+                            Requirements = [
+                                new()
+                                {
+                                    Requirement = "2.0.0",
+                                    File = "/library3/library3.csproj",
+                                    Groups = ["dependencies"],
+                                    Source = new()
+                                    {
+                                        SourceUrl = null,
+                                        Type = "nuget_repo",
+                                    }
+                                }
+                            ],
+                            PreviousVersion = "1.0.0",
+                            PreviousRequirements = [
+                                new()
+                                {
+                                    Requirement = "1.0.0",
+                                    File = "/library3/library3.csproj",
+                                    Groups = ["dependencies"],
+                                }
+                            ],
+                        },
+                    ],
+                    UpdatedDependencyFiles = [
+                        new()
+                        {
+                            Directory = "/library2",
+                            Name = "library2.csproj",
+                            Content = """
+                                <Project Sdk="Microsoft.NET.Sdk">
+                                  <PropertyGroup>
+                                    <TargetFramework>net8.0</TargetFramework>
+                                  </PropertyGroup>
+                                  <ItemGroup>
+                                    <PackageReference Include="Some.Package" Version="2.0.0" />
+                                  </ItemGroup>
+                                </Project>
+                                """
+                        },
+                        new()
+                        {
+                            Directory = "/library3",
+                            Name = "library3.csproj",
+                            Content = """
+                                <Project Sdk="Microsoft.NET.Sdk">
+                                  <PropertyGroup>
+                                    <TargetFramework>net8.0</TargetFramework>
+                                  </PropertyGroup>
+                                  <ItemGroup>
+                                    <PackageReference Include="Package.With.Transitive.Dependency" Version="0.1.0" />
+                                    <PackageReference Include="Some.Package" Version="2.0.0" />
+                                  </ItemGroup>
+                                </Project>
+                                """
+                        }
+                    ],
+                    BaseCommitSha = "TEST-COMMIT-SHA",
+                    CommitMessage = RunWorkerTests.TestPullRequestCommitMessage,
+                    PrTitle = RunWorkerTests.TestPullRequestTitle,
+                    PrBody = RunWorkerTests.TestPullRequestBody
+                },
+                new MarkAsProcessed("TEST-COMMIT-SHA")
+            ]
+        );
+    }
+}

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

@@ -0,0 +1,232 @@
+using NuGetUpdater.Core.Run.ApiModel;
+
+using Xunit;
+
+namespace NuGetUpdater.Core.Test.Run;
+
+public class MessageReportTests
+{
+    [Fact]
+    public void AllMessagesAreTested()
+    {
+        var untestedTypes = typeof(MessageBase).Assembly.GetTypes()
+            .Where(t => t.IsSubclassOf(typeof(MessageBase)))
+            .Where(t => t != typeof(JobErrorBase)) // this is an abstract class and can't be directly tested
+            .ToHashSet();
+        foreach (var data in MessageBaseTestData())
+        {
+            var testedMessageType = data[0]!.GetType();
+            untestedTypes.Remove(testedMessageType);
+        }
+
+        Assert.Empty(untestedTypes.Select(t => t.Name));
+    }
+
+    [Theory]
+    [MemberData(nameof(MessageBaseTestData))]
+    public void MessageBase(MessageBase message, string expected)
+    {
+        var actual = message.GetReport().Replace("\r", "");
+        Assert.Equal(expected.Replace("\r", ""), actual);
+    }
+
+    public static IEnumerable<object[]> MessageBaseTestData()
+    {
+        yield return
+        [
+            // message
+            new BadRequirement("unparseable"),
+            // expected
+            """
+            Error type: illformed_requirement
+            - message: unparseable
+            """
+        ];
+
+        yield return
+        [
+            // message
+            new ClosePullRequest()
+            {
+                DependencyNames = ["Dependency1", "Dependency2"]
+            },
+            // expected
+            """
+            ClosePullRequest: up_to_date
+            - Dependency1
+            - Dependency2
+            """
+        ];
+
+        yield return
+        [
+            // message
+            new CreatePullRequest()
+            {
+                Dependencies = [
+                    new()
+                    {
+                        Name = "Dependency1",
+                        Version = "1.2.3",
+                        Requirements = [], // unused
+                    },
+                    new()
+                    {
+                        Name = "Dependency2",
+                        Version = "4.5.6",
+                        Requirements = [], // unused
+                    }
+                ],
+                UpdatedDependencyFiles = [], // unused
+                BaseCommitSha = "unused",
+                CommitMessage = "unused",
+                PrTitle = "unused",
+                PrBody = "unused",
+            },
+            // expected
+            """
+            CreatePullRequest
+            - Dependency1/1.2.3
+            - Dependency2/4.5.6
+            """
+        ];
+
+        yield return
+        [
+            // message
+            new DependencyFileNotFound("path/to/file.txt", "custom message"),
+            // expected
+            """
+            Error type: dependency_file_not_found
+            - message: custom message
+            - file-path: path/to/file.txt
+            """
+        ];
+
+        yield return
+        [
+            // message
+            new DependencyFileNotParseable("path/to/file.txt", "custom message"),
+            // expected
+            """
+            Error type: dependency_file_not_parseable
+            - message: custom message
+            - file-path: path/to/file.txt
+            """
+        ];
+
+        yield return
+        [
+            // message
+            new DependencyNotFound("Some.Dependency"),
+            // expected
+            """
+            Error type: dependency_not_found
+            - source: Some.Dependency
+            """
+        ];
+
+        yield return
+        [
+            // message
+            new JobRepoNotFound("custom message"),
+            // expected
+            """
+            Error type: job_repo_not_found
+            - message: custom message
+            """
+        ];
+
+        yield return
+        [
+            // message
+            new PrivateSourceAuthenticationFailure(["url1", "url2"]),
+            // expected
+            """
+            Error type: private_source_authentication_failure
+            - source: (url1|url2)
+            """
+        ];
+
+        yield return
+        [
+            // message
+            new PrivateSourceBadResponse(["url1", "url2"]),
+            // expected
+            """
+            Error type: private_source_bad_response
+            - source: (url1|url2)
+            """
+        ];
+
+        yield return
+        [
+            // message
+            new PullRequestExistsForLatestVersion("Some.Dependency", "1.2.3"),
+            // expected
+            """
+            Error type: pull_request_exists_for_latest_version
+            - dependency-name: Some.Dependency
+            - dependency-version: 1.2.3
+            """
+        ];
+
+        yield return
+        [
+            // message
+            new SecurityUpdateNotNeeded("Some.Dependency"),
+            // expected
+            """
+            Error type: security_update_not_needed
+            - dependency-name: Some.Dependency
+            """
+        ];
+
+        yield return
+        [
+            // message
+            new UnknownError(new NotImplementedException("error message"), "TEST-JOB-ID"),
+            // expected
+            """
+            Error type: unknown_error
+            - error-class: NotImplementedException
+            - error-message: error message
+            - error-backtrace: <unknown>
+            - package-manager: nuget
+            - job-id: TEST-JOB-ID
+            """
+        ];
+
+        yield return
+        [
+            // message
+            new UpdateNotPossible(["Dependency1", "Dependency2"]),
+            // expected
+            """
+            Error type: update_not_possible
+            - dependencies: Dependency1, Dependency2
+            """
+        ];
+
+        yield return
+        [
+            // message
+            new UpdatePullRequest()
+            {
+                DependencyNames = ["Dependency1", "Dependency2"],
+                UpdatedDependencyFiles = [], // unused
+                BaseCommitSha = "unused",
+                CommitMessage = "unused",
+                PrTitle = "unused",
+                PrBody = "unused",
+                DependencyGroup = "unused",
+            },
+            // expected
+            """
+            UpdatePullRequest
+            - Dependency1
+            - Dependency2
+            """
+        ];
+    }
+}

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

@@ -12,6 +12,26 @@ namespace NuGetUpdater.Core.Test.Run;
 
 public class PullRequestTextTests
 {
+    [Fact]
+    public void LongPullRequestTitleIsTrimmed()
+    {
+        var job = FromCommitOptions(null);
+        var updateOperations = new List<UpdateOperationBase>();
+        for (int i = 1; i <= 10; i++)
+        {
+            updateOperations.Add(new DirectUpdate()
+            {
+                DependencyName = $"Package{i}",
+                NewVersion = NuGetVersion.Parse($"{i}.0.0"),
+                UpdatedFiles = ["file.txt"],
+            });
+        }
+
+        var actualTitle = PullRequestTextGenerator.GetPullRequestTitle(job, [.. updateOperations], dependencyGroupName: null);
+        var expectedTitle = "Update Package1 and 9 other dependencies";
+        Assert.Equal(expectedTitle, actualTitle);
+    }
+
     [Theory]
     [MemberData(nameof(GetPullRequestTextTestData))]
     public void PullRequestText(
@@ -58,7 +78,7 @@ public class PullRequestTextTests
             // expectedBody
             """
             Performed the following updates:
-                - Updated Some.Package to 1.2.3 in a.txt
+            - Updated Some.Package to 1.2.3 in a.txt
             """
         ];
 
@@ -82,11 +102,11 @@ public class PullRequestTextTests
             // expectedTitle
             "[SECURITY] Update Some.Package to 1.2.3",
             // expectedCommitMessage
-            "[SECURITY] Update Some.Package to 1.2.3",
+            "Update Some.Package to 1.2.3",
             // expectedBody
             """
             Performed the following updates:
-                - Updated Some.Package to 1.2.3 in a.txt
+            - Updated Some.Package to 1.2.3 in a.txt
             """
         ];
 
@@ -128,14 +148,18 @@ public class PullRequestTextTests
             // expectedTitle
             "Update Package.A to 1.0.0, 2.0.0; Package.B to 3.0.0, 4.0.0",
             // expectedCommitMessage
-            "Update Package.A to 1.0.0, 2.0.0; Package.B to 3.0.0, 4.0.0",
+            """
+            Update:
+            - Package.A to 1.0.0, 2.0.0
+            - Package.B to 3.0.0, 4.0.0
+            """,
             // expectedBody
             """
             Performed the following updates:
-                - Updated Package.A to 1.0.0 in a1.txt
-                - Updated Package.A to 2.0.0 in a2.txt
-                - Updated Package.B to 3.0.0 in b1.txt
-                - Updated Package.B to 4.0.0 in b2.txt
+            - Updated Package.A to 1.0.0 in a1.txt
+            - Updated Package.A to 2.0.0 in a2.txt
+            - Updated Package.B to 3.0.0 in b1.txt
+            - Updated Package.B to 4.0.0 in b2.txt
             """
         ];
     }