dependabot-nuget 0.240.0 → 0.241.0

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

@@ -0,0 +1,147 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Threading.Tasks;
+
+using Xunit;
+
+namespace NuGetUpdater.Core.Test.Update;
+
+public abstract class UpdateWorkerTestBase
+{
+    protected static Task TestNoChangeforProject(
+        string dependencyName,
+        string oldVersion,
+        string newVersion,
+        string projectContents,
+        bool isTransitive = false,
+        (string Path, string Content)[]? additionalFiles = null,
+        string projectFilePath = "test-project.csproj")
+        => TestUpdateForProject(dependencyName, oldVersion, newVersion, (projectFilePath, projectContents), expectedProjectContents: projectContents, isTransitive, additionalFiles, additionalFilesExpected: additionalFiles);
+
+    protected static Task TestUpdateForProject(
+        string dependencyName,
+        string oldVersion,
+        string newVersion,
+        string projectContents,
+        string expectedProjectContents,
+        bool isTransitive = false,
+        (string Path, string Content)[]? additionalFiles = null,
+        (string Path, string Content)[]? additionalFilesExpected = null,
+        string projectFilePath = "test-project.csproj")
+    {
+        var projectFile = (Path: projectFilePath, Content: projectContents);
+        return TestUpdateForProject(dependencyName, oldVersion, newVersion, projectFile, expectedProjectContents, isTransitive, additionalFiles, additionalFilesExpected);
+    }
+
+    protected static async Task TestUpdateForProject(
+        string dependencyName,
+        string oldVersion,
+        string newVersion,
+        (string Path, string Content) projectFile,
+        string expectedProjectContents,
+        bool isTransitive = false,
+        (string Path, string Content)[]? additionalFiles = null,
+        (string Path, string Content)[]? additionalFilesExpected = null)
+    {
+        additionalFiles ??= Array.Empty<(string Path, string Content)>();
+        additionalFilesExpected ??= Array.Empty<(string Path, string Content)>();
+
+        var projectFilePath = projectFile.Path;
+        var projectName = Path.GetFileNameWithoutExtension(projectFilePath);
+        var slnName = "test-solution.sln";
+        var slnContent = $$"""
+            Microsoft Visual Studio Solution File, Format Version 12.00
+            # Visual Studio 14
+            VisualStudioVersion = 14.0.22705.0
+            MinimumVisualStudioVersion = 10.0.40219.1
+            Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "{{projectName}}", "{{projectFilePath}}", "{782E0C0A-10D3-444D-9640-263D03D2B20C}"
+            EndProject
+            Global
+              GlobalSection(SolutionConfigurationPlatforms) = preSolution
+                Debug|Any CPU = Debug|Any CPU
+                Release|Any CPU = Release|Any CPU
+              EndGlobalSection
+              GlobalSection(ProjectConfigurationPlatforms) = postSolution
+                {782E0C0A-10D3-444D-9640-263D03D2B20C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+                {782E0C0A-10D3-444D-9640-263D03D2B20C}.Debug|Any CPU.Build.0 = Debug|Any CPU
+                {782E0C0A-10D3-444D-9640-263D03D2B20C}.Release|Any CPU.ActiveCfg = Release|Any CPU
+                {782E0C0A-10D3-444D-9640-263D03D2B20C}.Release|Any CPU.Build.0 = Release|Any CPU
+              EndGlobalSection
+              GlobalSection(SolutionProperties) = preSolution
+                HideSolutionNode = FALSE
+              EndGlobalSection
+            EndGlobal
+            """;
+        var testFiles = new[] { (slnName, slnContent), projectFile }.Concat(additionalFiles).ToArray();
+
+        var actualResult = await RunUpdate(testFiles, async (temporaryDirectory) =>
+        {
+            var slnPath = Path.Combine(temporaryDirectory, slnName);
+            var worker = new UpdaterWorker(new Logger(verbose: true));
+            await worker.RunAsync(temporaryDirectory, slnPath, dependencyName, oldVersion, newVersion, isTransitive);
+        });
+
+        var expectedResult = additionalFilesExpected.Prepend((projectFilePath, expectedProjectContents)).ToArray();
+
+        AssertContainsFiles(expectedResult, actualResult);
+    }
+
+    protected static async Task<(string Path, string Content)[]> RunUpdate((string Path, string Content)[] files, Func<string, Task> action)
+    {
+        // write initial files
+        using var tempDir = new TemporaryDirectory();
+        foreach (var file in files)
+        {
+            var localPath = file.Path.StartsWith("/") ? file.Path[1..] : file.Path; // remove path rooting character
+            var filePath = Path.Combine(tempDir.DirectoryPath, localPath);
+            var directoryPath = Path.GetDirectoryName(filePath);
+            Directory.CreateDirectory(directoryPath!);
+            await File.WriteAllTextAsync(filePath, file.Content);
+        }
+
+        // run update
+        await action(tempDir.DirectoryPath);
+
+        // gather results
+        var expectedFiles = new HashSet<string>(files.Select(f => f.Path));
+        var result = new List<(string Path, string Content)>();
+        foreach (var file in Directory.GetFiles(tempDir.DirectoryPath, "*.*", SearchOption.AllDirectories))
+        {
+            var localPath = file.StartsWith(tempDir.DirectoryPath)
+                ? file[tempDir.DirectoryPath.Length..]
+                : file; // how did this happen?
+            localPath = localPath.NormalizePathToUnix();
+            if (localPath.StartsWith('/'))
+            {
+                localPath = localPath[1..];
+            }
+
+            if (expectedFiles.Contains(localPath))
+            {
+                var content = await File.ReadAllTextAsync(file);
+                result.Add((localPath, content));
+            }
+        }
+
+        return result.ToArray();
+    }
+
+    protected static void AssertEqualFiles((string Path, string Content)[] expected, (string Path, string Content)[] actual)
+    {
+        Assert.Equal(expected.Length, actual.Length);
+        AssertContainsFiles(expected, actual);
+    }
+
+    protected static void AssertContainsFiles((string Path, string Content)[] expected, (string Path, string Content)[] actual)
+    {
+        var actualContents = actual.ToDictionary(pair => pair.Path, pair => pair.Content);
+        foreach (var expectedPair in expected)
+        {
+            var actualContent = actualContents[expectedPair.Path];
+            var expectedContent = expectedPair.Content;
+            Assert.Equal(expectedContent.Replace("\r", ""), actualContent.Replace("\r", "")); // normalize line endings
+        }
+    }
+}

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

@@ -0,0 +1,225 @@
+using System.Threading.Tasks;
+
+using Xunit;
+
+namespace NuGetUpdater.Core.Test.Update;
+
+public partial class UpdateWorkerTests
+{
+    public class DotNetTools : UpdateWorkerTestBase
+    {
+        public DotNetTools()
+        {
+            MSBuildHelper.RegisterMSBuild();
+        }
+
+        [Fact]
+        public async Task NoChangeWhenDotNetToolsJsonNotFound()
+        {
+            await TestNoChangeforProject("Microsoft.BotSay", "1.0.0", "1.1.0",
+                // initial
+                projectContents: """
+                <Project Sdk="Microsoft.NET.Sdk">
+                  <PropertyGroup>
+                    <TargetFramework>netstandard2.0</TargetFramework>
+                  </PropertyGroup>
+
+                  <ItemGroup>
+                    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+                  </ItemGroup>
+                </Project>
+                """);
+        }
+
+        [Fact]
+        public async Task NoChangeWhenDependencyNotFound()
+        {
+            await TestNoChangeforProject("Microsoft.BotSay", "1.0.0", "1.1.0",
+                // initial
+                projectContents: """
+                <Project Sdk="Microsoft.NET.Sdk">
+                  <PropertyGroup>
+                    <TargetFramework>netstandard2.0</TargetFramework>
+                  </PropertyGroup>
+
+                  <ItemGroup>
+                    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+                  </ItemGroup>
+                </Project>
+                """,
+                additionalFiles: new[]
+                {
+                    (".config/dotnet-tools.json", """
+                      {
+                        "version": 1,
+                        "isRoot": true,
+                        "tools": {
+                          "dotnetsay": {
+                            "version": "2.1.3",
+                            "commands": [
+                              "dotnetsay"
+                            ]
+                          }
+                        }
+                      }
+                      """)
+                });
+        }
+
+        [Fact]
+        public async Task UpdateSingleDependencyInDirsProj()
+        {
+            await TestUpdateForProject("Microsoft.BotSay", "1.0.0", "1.1.0",
+                // initial
+                projectContents: """
+                <Project Sdk="Microsoft.NET.Sdk">
+                  <PropertyGroup>
+                    <TargetFramework>netstandard2.0</TargetFramework>
+                  </PropertyGroup>
+
+                  <ItemGroup>
+                    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+                  </ItemGroup>
+                </Project>
+                """,
+                additionalFiles: new[]
+                {
+                    (".config/dotnet-tools.json", """
+                      {
+                        "version": 1,
+                        "isRoot": true,
+                        "tools": {
+                          "microsoft.botsay": {
+                            "version": "1.0.0",
+                            "commands": [
+                              "botsay"
+                            ]
+                          },
+                          "dotnetsay": {
+                            "version": "2.1.3",
+                            "commands": [
+                              "dotnetsay"
+                            ]
+                          }
+                        }
+                      }
+                      """)
+                },
+                // expected
+                expectedProjectContents: """
+                <Project Sdk="Microsoft.NET.Sdk">
+                  <PropertyGroup>
+                    <TargetFramework>netstandard2.0</TargetFramework>
+                  </PropertyGroup>
+
+                  <ItemGroup>
+                    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+                  </ItemGroup>
+                </Project>
+                """,
+                additionalFilesExpected: new[]
+                {
+                    (".config/dotnet-tools.json", """
+                      {
+                        "version": 1,
+                        "isRoot": true,
+                        "tools": {
+                          "microsoft.botsay": {
+                            "version": "1.1.0",
+                            "commands": [
+                              "botsay"
+                            ]
+                          },
+                          "dotnetsay": {
+                            "version": "2.1.3",
+                            "commands": [
+                              "dotnetsay"
+                            ]
+                          }
+                        }
+                      }
+                      """)
+                });
+        }
+
+        [Fact]
+        public async Task UpdateSingleDependencyWithComments()
+        {
+            await TestUpdateForProject("Microsoft.BotSay", "1.0.0", "1.1.0",
+                // initial
+                projectContents: """
+                <Project Sdk="Microsoft.NET.Sdk">
+                  <PropertyGroup>
+                    <TargetFramework>netstandard2.0</TargetFramework>
+                  </PropertyGroup>
+
+                  <ItemGroup>
+                    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+                  </ItemGroup>
+                </Project>
+                """,
+                additionalFiles: new[]
+                {
+                    (".config/dotnet-tools.json", """
+                      {
+                        // this is a comment
+                        "version": 1,
+                        "isRoot": true,
+                        "tools": {
+                          "microsoft.botsay": {
+                            // this is a deep comment
+                            "version": "1.0.0",
+                            "commands": [
+                              "botsay"
+                            ]
+                          },
+                          "dotnetsay": {
+                            "version": "2.1.3",
+                            "commands": [
+                              "dotnetsay"
+                            ]
+                          }
+                        }
+                      }
+                      """)
+                },
+                // expected
+                expectedProjectContents: """
+                <Project Sdk="Microsoft.NET.Sdk">
+                  <PropertyGroup>
+                    <TargetFramework>netstandard2.0</TargetFramework>
+                  </PropertyGroup>
+
+                  <ItemGroup>
+                    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+                  </ItemGroup>
+                </Project>
+                """,
+                additionalFilesExpected: new[]
+                {
+                    (".config/dotnet-tools.json", """
+                      {
+                        // this is a comment
+                        "version": 1,
+                        "isRoot": true,
+                        "tools": {
+                          "microsoft.botsay": {
+                            // this is a deep comment
+                            "version": "1.1.0",
+                            "commands": [
+                              "botsay"
+                            ]
+                          },
+                          "dotnetsay": {
+                            "version": "2.1.3",
+                            "commands": [
+                              "dotnetsay"
+                            ]
+                          }
+                        }
+                      }
+                      """)
+                });
+        }
+    }
+}

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

@@ -0,0 +1,217 @@
+using System.Threading.Tasks;
+
+using Xunit;
+
+namespace NuGetUpdater.Core.Test.Update;
+
+public partial class UpdateWorkerTests
+{
+    public class GlobalJson : UpdateWorkerTestBase
+    {
+        public GlobalJson()
+        {
+            MSBuildHelper.RegisterMSBuild();
+        }
+
+        [Fact]
+        public async Task NoChangeWhenGlobalJsonNotFound()
+        {
+            await TestNoChangeforProject("Microsoft.Build.Traversal", "3.2.0", "4.1.0",
+                // initial
+                projectContents: """
+                <Project Sdk="Microsoft.NET.Sdk">
+                  <PropertyGroup>
+                    <TargetFramework>netstandard2.0</TargetFramework>
+                  </PropertyGroup>
+
+                  <ItemGroup>
+                    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+                  </ItemGroup>
+                </Project>
+                """);
+        }
+
+        [Fact]
+        public async Task NoChangeWhenDependencyNotFound()
+        {
+            await TestNoChangeforProject("Microsoft.Build.Traversal", "3.2.0", "4.1.0",
+                // initial
+                projectContents: """
+                <Project Sdk="Microsoft.NET.Sdk">
+                  <PropertyGroup>
+                    <TargetFramework>netstandard2.0</TargetFramework>
+                  </PropertyGroup>
+
+                  <ItemGroup>
+                    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+                  </ItemGroup>
+                </Project>
+                """,
+                additionalFiles: new[]
+                {
+                    ("global.json", """
+                        {
+                          "sdk": {
+                            "version": "6.0.405",
+                            "rollForward": "latestPatch"
+                          }
+                        }
+                        """)
+                });
+        }
+
+        [Fact]
+        public async Task NoChangeWhenGlobalJsonInUnexpectedLocation()
+        {
+            await TestNoChangeforProject("Microsoft.Build.Traversal", "3.2.0", "4.1.0",
+                // initial
+                projectFilePath: "src/project/project.csproj",
+                projectContents: """
+                <Project Sdk="Microsoft.NET.Sdk">
+                  <PropertyGroup>
+                    <TargetFramework>netstandard2.0</TargetFramework>
+                  </PropertyGroup>
+
+                  <ItemGroup>
+                    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+                  </ItemGroup>>
+                </Project>
+                """,
+                additionalFiles: new[]
+                {
+                    ("eng/global.json", """
+                        {
+                          "sdk": {
+                            "version": "6.0.405",
+                            "rollForward": "latestPatch"
+                          },
+                          "msbuild-sdks": {
+                            "Microsoft.Build.Traversal": "3.2.0"
+                          }
+                        }
+                        """)
+                });
+        }
+
+        [Fact]
+        public async Task UpdateSingleDependency()
+        {
+            await TestUpdateForProject("Microsoft.Build.Traversal", "3.2.0", "4.1.0",
+                // initial
+                projectFilePath: "src/project/project.csproj",
+                projectContents: """
+                <Project Sdk="Microsoft.NET.Sdk">
+                  <PropertyGroup>
+                    <TargetFramework>netstandard2.0</TargetFramework>
+                  </PropertyGroup>
+
+                  <ItemGroup>
+                    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+                  </ItemGroup>
+                </Project>
+                """,
+                additionalFiles: new[]
+                {
+                    ("src/global.json", """
+                        {
+                          "sdk": {
+                            "version": "6.0.405",
+                            "rollForward": "latestPatch"
+                          },
+                          "msbuild-sdks": {
+                            "Microsoft.Build.Traversal": "3.2.0"
+                          }
+                        }
+                        """)
+                },
+                // expected
+                expectedProjectContents: """
+                <Project Sdk="Microsoft.NET.Sdk">
+                  <PropertyGroup>
+                    <TargetFramework>netstandard2.0</TargetFramework>
+                  </PropertyGroup>
+
+                  <ItemGroup>
+                    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+                  </ItemGroup>
+                </Project>
+                """,
+                additionalFilesExpected: new[]
+                {
+                    ("src/global.json", """
+                        {
+                          "sdk": {
+                            "version": "6.0.405",
+                            "rollForward": "latestPatch"
+                          },
+                          "msbuild-sdks": {
+                            "Microsoft.Build.Traversal": "4.1.0"
+                          }
+                        }
+                        """)
+                });
+        }
+
+        [Fact]
+        public async Task UpdateDependencyWithComments()
+        {
+            await TestUpdateForProject("Microsoft.Build.Traversal", "3.2.0", "4.1.0",
+                // initial
+                projectContents: """
+                <Project Sdk="Microsoft.NET.Sdk">
+                  <PropertyGroup>
+                    <TargetFramework>netstandard2.0</TargetFramework>
+                  </PropertyGroup>
+
+                  <ItemGroup>
+                    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+                  </ItemGroup>
+                </Project>
+                """,
+                additionalFiles: new[]
+                {
+                    ("global.json", """
+                        {
+                          // this is a comment
+                          "sdk": {
+                            "version": "6.0.405",
+                            "rollForward": "latestPatch"
+                          },
+                          "msbuild-sdks": {
+                            // this is a deep comment
+                            "Microsoft.Build.Traversal": "3.2.0"
+                          }
+                        }
+                        """)
+                },
+                // expected
+                expectedProjectContents: """
+                <Project Sdk="Microsoft.NET.Sdk">
+                  <PropertyGroup>
+                    <TargetFramework>netstandard2.0</TargetFramework>
+                  </PropertyGroup>
+
+                  <ItemGroup>
+                    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+                  </ItemGroup>
+                </Project>
+                """,
+                additionalFilesExpected: new[]
+                {
+                    ("global.json", """
+                        {
+                          // this is a comment
+                          "sdk": {
+                            "version": "6.0.405",
+                            "rollForward": "latestPatch"
+                          },
+                          "msbuild-sdks": {
+                            // this is a deep comment
+                            "Microsoft.Build.Traversal": "4.1.0"
+                          }
+                        }
+                        """)
+                });
+        }
+    }
+}

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

@@ -0,0 +1,94 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+using Xunit;
+
+namespace NuGetUpdater.Core.Test.Update;
+
+public partial class UpdateWorkerTests
+{
+    public class Mixed : UpdateWorkerTestBase
+    {
+        public Mixed()
+        {
+            MSBuildHelper.RegisterMSBuild();
+        }
+
+        [Fact]
+        public async Task ForPackagesProject_UpdatePackageReference_InBuildProps()
+        {
+            // update Newtonsoft.Json from 7.0.1 to 13.0.1
+            await TestUpdateForProject("Newtonsoft.Json", "7.0.1", "13.0.1",
+                // existing
+                projectContents: """
+                <Project ToolsVersion="15.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+                  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
+                  <PropertyGroup>
+                    <TargetFrameworkVersion>v4.7.2</TargetFrameworkVersion>
+                  </PropertyGroup>
+                  <ItemGroup>
+                    <None Include="packages.config" />
+                  </ItemGroup>
+                  <ItemGroup>
+                    <Reference Include="Newtonsoft.Json, Version=13.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed">
+                      <HintPath>packages\Newtonsoft.Json.13.0.1\lib\net45\Newtonsoft.Json.dll</HintPath>
+                      <Private>True</Private>
+                    </Reference>
+                  </ItemGroup>
+                  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+                </Project>
+                """,
+                additionalFiles: new[]
+                {
+                    ("packages.config", """
+                        <?xml version="1.0" encoding="utf-8"?>
+                        <packages>
+                          <package id="Newtonsoft.Json" version="13.0.1" targetFramework="net45" />
+                        </packages>
+                        """),
+                    ("Directory.Build.props", """
+                        <Project>
+                          <ItemGroup>
+                            <PackageReference Include="Newtonsoft.Json" Version="7.0.1" />
+                          </ItemGroup>
+                        </Project>
+                        """),
+                },
+                // expected
+                expectedProjectContents: """
+                <Project ToolsVersion="15.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+                  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
+                  <PropertyGroup>
+                    <TargetFrameworkVersion>v4.7.2</TargetFrameworkVersion>
+                  </PropertyGroup>
+                  <ItemGroup>
+                    <None Include="packages.config" />
+                  </ItemGroup>
+                  <ItemGroup>
+                    <Reference Include="Newtonsoft.Json, Version=13.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed">
+                      <HintPath>packages\Newtonsoft.Json.13.0.1\lib\net45\Newtonsoft.Json.dll</HintPath>
+                      <Private>True</Private>
+                    </Reference>
+                  </ItemGroup>
+                  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+                </Project>
+                """,
+                additionalFilesExpected: new[]
+                {
+                    ("packages.config", """
+                        <?xml version="1.0" encoding="utf-8"?>
+                        <packages>
+                          <package id="Newtonsoft.Json" version="13.0.1" targetFramework="net45" />
+                        </packages>
+                        """),
+                    ("Directory.Build.props", """
+                        <Project>
+                          <ItemGroup>
+                            <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
+                          </ItemGroup>
+                        </Project>
+                        """),
+                });
+        }
+    }
+}