dependabot-nuget 0.240.0 → 0.241.0

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

@@ -0,0 +1,239 @@
+using System;
+using System.Collections.Generic;
+using NuGetUpdater.Core.Utilities;
+using Xunit;
+
+namespace NuGetUpdater.Core.Test.Utilities;
+
+public class JsonHelperTests
+{
+    [Theory]
+    [MemberData(nameof(JsonUpdaterTestData))]
+    public void UpdateJsonPreservingComments(string json, string[] propertyPath, string newValue, string expectedJson)
+    {
+        var updatedJson = JsonHelper.UpdateJsonProperty(json, propertyPath, newValue, StringComparison.OrdinalIgnoreCase).Replace("\r", string.Empty);
+        expectedJson = expectedJson.Replace("\r", string.Empty);
+        Assert.Equal(expectedJson, updatedJson);
+    }
+
+    public static IEnumerable<object[]> JsonUpdaterTestData()
+    {
+        yield return new object[]
+        {
+            // 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": [ // end of line comment
+                    "dotnetsay"
+                  ]
+                }
+              }
+            }
+            """,
+            // property path
+            new[]
+            {
+                "tools",
+                "microsoft.botsay",
+                "version"
+            },
+            // new value
+            "1.1.0",
+            // expected 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": [ // end of line comment
+                    "dotnetsay"
+                  ]
+                }
+              }
+            }
+            """
+        };
+
+        yield return new object[]
+        {
+            // json
+            """
+            {
+              // Defines version of MSBuild project SDKs to use
+              // https://docs.microsoft.com/en-us/visualstudio/msbuild/how-to-use-project-sdk?view=vs-2017#how-project-sdks-are-resolved
+              // https://docs.microsoft.com/en-us/dotnet/core/tools/global-json#globaljson-schema
+              "msbuild-sdks": {
+                "Microsoft.Build.Traversal": "4.1.0",
+                "Microsoft.Build.NoTargets": "3.6.0"
+              },
+              "sdk": {
+                "version": "6.0.400",
+                "rollForward": "latestMajor"
+              }
+            }
+            """,
+            // property path
+            new[]
+            {
+                "msbuild-sdks",
+                "Microsoft.Build.NoTargets"
+            },
+            // new value
+            "3.7.0",
+            // expected json
+            """
+            {
+              // Defines version of MSBuild project SDKs to use
+              // https://docs.microsoft.com/en-us/visualstudio/msbuild/how-to-use-project-sdk?view=vs-2017#how-project-sdks-are-resolved
+              // https://docs.microsoft.com/en-us/dotnet/core/tools/global-json#globaljson-schema
+              "msbuild-sdks": {
+                "Microsoft.Build.Traversal": "4.1.0",
+                "Microsoft.Build.NoTargets": "3.7.0"
+              },
+              "sdk": {
+                "version": "6.0.400",
+                "rollForward": "latestMajor"
+              }
+            }
+            """
+        };
+
+        // differing case between `propertyPath` and the actual property values
+        yield return new object[]
+        {
+            // json
+            """
+            {
+              "version": 1,
+              "isRoot": true,
+              "tools": {
+                "microsoft.botsay": {
+                  // some comment
+                  "version": "1.0.0",
+                  "commands": [
+                    "botsay"
+                  ]
+                },
+                "dotnetsay": {
+                  "version": "2.1.3",
+                  "commands": [
+                    "dotnetsay"
+                  ]
+                }
+              }
+            }
+            """,
+            // property path
+            new[]
+            {
+                "tools",
+                "Microsoft.BotSay",
+                "version"
+            },
+            // new value
+            "1.1.0",
+            // expected json
+            """
+            {
+              "version": 1,
+              "isRoot": true,
+              "tools": {
+                "microsoft.botsay": {
+                  // some comment
+                  "version": "1.1.0",
+                  "commands": [
+                    "botsay"
+                  ]
+                },
+                "dotnetsay": {
+                  "version": "2.1.3",
+                  "commands": [
+                    "dotnetsay"
+                  ]
+                }
+              }
+            }
+            """
+        };
+
+        // shallow property path
+        yield return new object[]
+        {
+            // original json
+            """
+            {
+              "path1": {
+                "subpath1": "value1",
+                "subpath2": "value2"
+              },
+              "path2": "old-value"
+            }
+            """,
+            // property path
+            new[]
+            {
+                "path2"
+            },
+            // new value
+            "new-value",
+            // expected json
+            """
+            {
+              "path1": {
+                "subpath1": "value1",
+                "subpath2": "value2"
+              },
+              "path2": "new-value"
+            }
+            """
+        };
+
+        // line comment after comma
+        yield return new object[]
+        {
+            // original json
+            """
+            {
+              "property1": "value1",
+              // some comment
+              "property2": "value2"
+            }
+            """,
+            // property path
+            new[] { "property2" },
+            // new value
+            "updated-value",
+            // expected json
+            """
+            {
+              "property1": "value1",
+              // some comment
+              "property2": "updated-value"
+            }
+            """
+        };
+    }
+}

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

@@ -0,0 +1,394 @@
+using System;
+using System.Collections.Generic;
+using System.Collections.Immutable;
+using System.IO;
+using System.Linq;
+using System.Threading.Tasks;
+
+using Xunit;
+
+namespace NuGetUpdater.Core.Test.Utilities;
+
+public class MSBuildHelperTests
+{
+    public MSBuildHelperTests()
+    {
+        MSBuildHelper.RegisterMSBuild();
+    }
+
+    [Fact]
+    public void GetRootedValue_FindsValue()
+    {
+        // Arrange
+        var projectContents = """
+            <Project>
+                <PropertyGroup>
+                    <TargetFramework>netstandard2.0</TargetFramework>
+                </PropertyGroup>
+                <ItemGroup>
+                    <PackageReference Include="Newtonsoft.Json" Version="$(PackageVersion1)" />
+                </ItemGroup>
+            </Project>
+            """;
+        var propertyInfo = new Dictionary<string, string>
+        {
+            { "PackageVersion1", "1.1.1" },
+        };
+
+        // Act
+        var rootValue = MSBuildHelper.GetRootedValue(projectContents, propertyInfo);
+
+        // Assert
+        Assert.Equal("""
+            <Project>
+                <PropertyGroup>
+                    <TargetFramework>netstandard2.0</TargetFramework>
+                </PropertyGroup>
+                <ItemGroup>
+                    <PackageReference Include="Newtonsoft.Json" Version="1.1.1" />
+                </ItemGroup>
+            </Project>
+            """, rootValue);
+    }
+
+    [Fact(Timeout = 1000)]
+    public async Task GetRootedValue_DoesNotRecurseAsync()
+    {
+        // Arrange
+        var projectContents = """
+            <Project>
+                <PropertyGroup>
+                    <TargetFramework>netstandard2.0</TargetFramework>
+                </PropertyGroup>
+                <ItemGroup>
+                    <PackageReference Include="Newtonsoft.Json" Version="$(PackageVersion1)" />
+                </ItemGroup>
+            </Project>
+            """;
+        var propertyInfo = new Dictionary<string, string>
+        {
+            { "PackageVersion1", "$(PackageVersion2)" },
+            { "PackageVersion2", "$(PackageVersion1)" }
+        };
+        // This is needed to make the timeout work. Without that we could get caugth in an infinite loop.
+        await Task.Delay(1);
+
+        // Act
+        var ex = Assert.Throws<InvalidDataException>(() => MSBuildHelper.GetRootedValue(projectContents, propertyInfo));
+
+        // Assert
+        Assert.Equal("Property 'PackageVersion1' has a circular reference.", ex.Message);
+    }
+
+    [Theory]
+    [MemberData(nameof(SolutionProjectPathTestData))]
+    public void ProjectPathsCanBeParsedFromSolutionFiles(string solutionContent, string[] expectedProjectSubPaths)
+    {
+        var solutionPath = Path.GetTempFileName();
+        var solutionDirectory = Path.GetDirectoryName(solutionPath)!;
+        try
+        {
+            File.WriteAllText(solutionPath, solutionContent);
+            var actualProjectSubPaths = MSBuildHelper.GetProjectPathsFromSolution(solutionPath).ToArray();
+            var expectedPaths = expectedProjectSubPaths.Select(path => Path.Combine(solutionDirectory, path)).ToArray();
+            if (Environment.OSVersion.Platform == PlatformID.Win32NT)
+            {
+                // make the test happy when running on Windows
+                expectedPaths = expectedPaths.Select(p => p.Replace("/", "\\")).ToArray();
+            }
+
+            Assert.Equal(expectedPaths, actualProjectSubPaths);
+        }
+        finally
+        {
+            File.Delete(solutionPath);
+        }
+    }
+
+    [Theory]
+    [InlineData("<Project><PropertyGroup><TargetFramework>netstandard2.0</TargetFramework></PropertyGroup></Project>", "netstandard2.0", null)]
+    [InlineData("<Project><PropertyGroup><TargetFrameworks>netstandard2.0</TargetFrameworks></PropertyGroup></Project>", "netstandard2.0", null)]
+    [InlineData("<Project><PropertyGroup><TargetFrameworks>  ; netstandard2.0 ; </TargetFrameworks></PropertyGroup></Project>", "netstandard2.0", null)]
+    [InlineData("<Project><PropertyGroup><TargetFrameworks>netstandard2.0 ; netstandard2.1 ; </TargetFrameworks></PropertyGroup></Project>", "netstandard2.0", "netstandard2.1")]
+    public void TfmsCanBeDeterminedFromProjectContents(string projectContents, string? expectedTfm1, string? expectedTfm2)
+    {
+        var projectPath = Path.GetTempFileName();
+        try
+        {
+            File.WriteAllText(projectPath, projectContents);
+            var expectedTfms = new[] { expectedTfm1, expectedTfm2 }.Where(tfm => tfm is not null).ToArray();
+            var buildFile = ProjectBuildFile.Open(Path.GetDirectoryName(projectPath)!, projectPath);
+            var actualTfms = MSBuildHelper.GetTargetFrameworkMonikers(ImmutableArray.Create(buildFile));
+            Assert.Equal(expectedTfms, actualTfms);
+        }
+        finally
+        {
+            File.Delete(projectPath);
+        }
+    }
+
+    [Theory]
+    [MemberData(nameof(GetTopLevelPackageDependenyInfosTestData))]
+    public async Task TopLevelPackageDependenciesCanBeDetermined((string Path, string Content)[] buildFileContents, Dependency[] expectedTopLevelDependencies)
+    {
+        using var testDirectory = new TemporaryDirectory();
+        var buildFiles = new List<ProjectBuildFile>();
+        foreach (var (path, content) in buildFileContents)
+        {
+            var fullPath = Path.Combine(testDirectory.DirectoryPath, path);
+            await File.WriteAllTextAsync(fullPath, content);
+            buildFiles.Add(ProjectBuildFile.Parse(testDirectory.DirectoryPath, fullPath, content));
+        }
+
+        var actualTopLevelDependencies = MSBuildHelper.GetTopLevelPackageDependenyInfos(buildFiles.ToImmutableArray());
+        Assert.Equal(expectedTopLevelDependencies, actualTopLevelDependencies);
+    }
+
+    [Fact]
+    public async Task AllPackageDependenciesCanBeTraversed()
+    {
+        using var temp = new TemporaryDirectory();
+        var expectedDependencies = new Dependency[]
+        {
+            new("Microsoft.Bcl.AsyncInterfaces", "7.0.0", DependencyType.Unknown),
+            new("Microsoft.Extensions.DependencyInjection", "7.0.0", DependencyType.Unknown),
+            new("Microsoft.Extensions.DependencyInjection.Abstractions", "7.0.0", DependencyType.Unknown),
+            new("Microsoft.Extensions.Http", "7.0.0", DependencyType.Unknown),
+            new("Microsoft.Extensions.Logging", "7.0.0", DependencyType.Unknown),
+            new("Microsoft.Extensions.Logging.Abstractions", "7.0.0", DependencyType.Unknown),
+            new("Microsoft.Extensions.Options", "7.0.0", DependencyType.Unknown),
+            new("Microsoft.Extensions.Primitives", "7.0.0", DependencyType.Unknown),
+            new("System.Buffers", "4.5.1", DependencyType.Unknown),
+            new("System.ComponentModel.Annotations", "5.0.0", DependencyType.Unknown),
+            new("System.Diagnostics.DiagnosticSource", "7.0.0", DependencyType.Unknown),
+            new("System.Memory", "4.5.5", DependencyType.Unknown),
+            new("System.Numerics.Vectors", "4.4.0", DependencyType.Unknown),
+            new("System.Runtime.CompilerServices.Unsafe", "6.0.0", DependencyType.Unknown),
+            new("System.Threading.Tasks.Extensions", "4.5.4", DependencyType.Unknown),
+            new("NETStandard.Library", "2.0.3", DependencyType.Unknown),
+        };
+        var actualDependencies = await MSBuildHelper.GetAllPackageDependenciesAsync(temp.DirectoryPath, temp.DirectoryPath, "netstandard2.0", new[] { new Dependency("Microsoft.Extensions.Http", "7.0.0", DependencyType.Unknown) });
+        Assert.Equal(expectedDependencies, actualDependencies);
+    }
+
+    [Fact]
+    public async Task AllPackageDependenciesCanBeFoundWithNuGetConfig()
+    {
+        var nugetPackagesDirectory = Environment.GetEnvironmentVariable("NUGET_PACKAGES");
+        var nugetHttpCacheDirectory = Environment.GetEnvironmentVariable("NUGET_HTTP_CACHE_PATH");
+
+        try
+        {
+            using var temp = new TemporaryDirectory();
+
+            // It is important to have empty NuGet caches for this test, so override them with temp directories.
+            var tempNuGetPackagesDirectory = Path.Combine(temp.DirectoryPath, ".nuget", "packages");
+            Environment.SetEnvironmentVariable("NUGET_PACKAGES", tempNuGetPackagesDirectory);
+            var tempNuGetHttpCacheDirectory = Path.Combine(temp.DirectoryPath, ".nuget", "v3-cache");
+            Environment.SetEnvironmentVariable("NUGET_HTTP_CACHE_PATH", tempNuGetHttpCacheDirectory);
+
+            // First validate that we are unable to find dependencies for the package version without a NuGet.config.
+            var dependenciesNoNuGetConfig = await MSBuildHelper.GetAllPackageDependenciesAsync(temp.DirectoryPath, temp.DirectoryPath, "netstandard2.0", new[] { new Dependency("Microsoft.CodeAnalysis.Common", "4.8.0-3.23457.5", DependencyType.Unknown) });
+            Assert.Equal(Array.Empty<Dependency>(), dependenciesNoNuGetConfig);
+
+            // Write the NuGet.config and try again.
+            await File.WriteAllTextAsync(Path.Combine(temp.DirectoryPath, "NuGet.Config"), """
+                <?xml version="1.0" encoding="utf-8"?>
+                <configuration>
+                  <packageSources>
+                    <clear />
+                    <add key="dotnet-tools" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json" />
+                    <add key="dotnet-public" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-public/nuget/v3/index.json" />
+                  </packageSources>
+                </configuration>
+                """);
+
+            var expectedDependencies = new Dependency[]
+            {
+                new("Microsoft.CodeAnalysis.Common", "4.8.0-3.23457.5", DependencyType.Unknown),
+                new("System.Buffers", "4.5.1", DependencyType.Unknown),
+                new("System.Collections.Immutable", "7.0.0", DependencyType.Unknown),
+                new("System.Memory", "4.5.5", DependencyType.Unknown),
+                new("System.Numerics.Vectors", "4.4.0", DependencyType.Unknown),
+                new("System.Reflection.Metadata", "7.0.0", DependencyType.Unknown),
+                new("System.Runtime.CompilerServices.Unsafe", "6.0.0", DependencyType.Unknown),
+                new("System.Text.Encoding.CodePages", "7.0.0", DependencyType.Unknown),
+                new("System.Threading.Tasks.Extensions", "4.5.4", DependencyType.Unknown),
+                new("Microsoft.CodeAnalysis.Analyzers", "3.3.4", DependencyType.Unknown),
+                new("NETStandard.Library", "2.0.3", DependencyType.Unknown),
+            };
+            var actualDependencies = await MSBuildHelper.GetAllPackageDependenciesAsync(temp.DirectoryPath, temp.DirectoryPath, "netstandard2.0", new[] { new Dependency("Microsoft.CodeAnalysis.Common", "4.8.0-3.23457.5", DependencyType.Unknown) });
+            Assert.Equal(expectedDependencies, actualDependencies);
+        }
+        finally
+        {
+            // Restore the NuGet caches.
+            Environment.SetEnvironmentVariable("NUGET_PACKAGES", nugetPackagesDirectory);
+            Environment.SetEnvironmentVariable("NUGET_HTTP_CACHE_PATH", nugetHttpCacheDirectory);
+        }
+    }
+
+    public static IEnumerable<object[]> GetTopLevelPackageDependenyInfosTestData()
+    {
+        // simple case
+        yield return new object[]
+        {
+            // build file contents
+            new[]
+            {
+                ("project.csproj", """
+                    <Project Sdk="Microsoft.NET.Sdk">
+                      <ItemGroup>
+                        <PackageReference Include="Newtonsoft.Json" Version="12.0.1" />
+                      </ItemGroup>
+                    </Project>
+                    """)
+            },
+            // expected dependencies
+            new Dependency[]
+            {
+                new("Newtonsoft.Json", "12.0.1", DependencyType.Unknown)
+            }
+        };
+
+        // version is a child-node of the package reference
+        yield return new object[]
+        {
+            // build file contents
+            new[]
+            {
+                ("project.csproj", """
+                    <Project Sdk="Microsoft.NET.Sdk">
+                      <ItemGroup>
+                        <PackageReference Include="Newtonsoft.Json">
+                            <Version>12.0.1</Version>
+                        </PackageReference>
+                      </ItemGroup>
+                    </Project>
+                    """)
+            },
+            // expected dependencies
+            new Dependency[]
+            {
+                new("Newtonsoft.Json", "12.0.1", DependencyType.Unknown)
+            }
+        };
+
+        // version is in property in same file
+        yield return new object[]
+        {
+            // build file contents
+            new[]
+            {
+                ("project.csproj", """
+                    <Project Sdk="Microsoft.NET.Sdk">
+                      <PropertyGroup>
+                        <NewtonsoftJsonVersion>12.0.1</NewtonsoftJsonVersion>
+                      </PropertyGroup>
+                      <ItemGroup>
+                        <PackageReference Include="Newtonsoft.Json" Version="$(NewtonsoftJsonVersion)" />
+                      </ItemGroup>
+                    </Project>
+                    """)
+            },
+            // expected dependencies
+            new Dependency[]
+            {
+                new("Newtonsoft.Json", "12.0.1", DependencyType.Unknown)
+            }
+        };
+
+        // version is a property not triggered by a condition
+        yield return new object[]
+        {
+            // build file contents
+            new[]
+            {
+                ("project.csproj", """
+                    <Project Sdk="Microsoft.NET.Sdk">
+                      <PropertyGroup>
+                        <TargetFramework>netstandard2.0</TargetFramework>
+                        <NewtonsoftJsonVersion>12.0.1</NewtonsoftJsonVersion>
+                        <NewtonsoftJsonVersion Condition="$(PropertyThatDoesNotExist) == 'true'">13.0.1</NewtonsoftJsonVersion>
+                      </PropertyGroup>
+                      <ItemGroup>
+                        <PackageReference Include="Newtonsoft.Json" Version="$(NewtonsoftJsonVersion)" />
+                      </ItemGroup>
+                    </Project>
+                    """)
+            },
+            // expected dependencies
+            new Dependency[]
+            {
+                new("Newtonsoft.Json", "12.0.1", DependencyType.Unknown)
+            }
+        };
+
+        // version is a property with a condition checking for an empty string
+        yield return new object[]
+        {
+            // build file contents
+            new[]
+            {
+                ("project.csproj", """
+                    <Project Sdk="Microsoft.NET.Sdk">
+                      <PropertyGroup>
+                        <TargetFramework>netstandard2.0</TargetFramework>
+                        <NewtonsoftJsonVersion Condition="$(NewtonsoftJsonVersion) == ''">12.0.1</NewtonsoftJsonVersion>
+                        <NewtonsoftJsonVersion Condition="$(PropertyThatDoesNotExist) == 'true'">13.0.1</NewtonsoftJsonVersion>
+                      </PropertyGroup>
+                      <ItemGroup>
+                        <PackageReference Include="Newtonsoft.Json" Version="$(NewtonsoftJsonVersion)" />
+                      </ItemGroup>
+                    </Project>
+                    """)
+            },
+            // expected dependencies
+            new Dependency[]
+            {
+                new("Newtonsoft.Json", "12.0.1", DependencyType.Unknown)
+            }
+        };
+    }
+
+    public static IEnumerable<object[]> SolutionProjectPathTestData()
+    {
+        yield return new object[]
+        {
+            """
+            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}") = "Some.Project", "src\Some.Project\SomeProject.csproj", "{782E0C0A-10D3-444D-9640-263D03D2B20C}"
+            EndProject
+            Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Some.Project.Test", "src\Some.Project.Test\Some.Project.Test.csproj", "{5C15FD5B-1975-4CEA-8F1B-C0C9174C60A9}"
+            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
+            		{5C15FD5B-1975-4CEA-8F1B-C0C9174C60A9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+            		{5C15FD5B-1975-4CEA-8F1B-C0C9174C60A9}.Debug|Any CPU.Build.0 = Debug|Any CPU
+            		{5C15FD5B-1975-4CEA-8F1B-C0C9174C60A9}.Release|Any CPU.ActiveCfg = Release|Any CPU
+            		{5C15FD5B-1975-4CEA-8F1B-C0C9174C60A9}.Release|Any CPU.Build.0 = Release|Any CPU
+            	EndGlobalSection
+            	GlobalSection(SolutionProperties) = preSolution
+            		HideSolutionNode = FALSE
+            	EndGlobalSection
+            EndGlobal
+            """,
+            new[]
+            {
+                "src/Some.Project/SomeProject.csproj",
+                "src/Some.Project.Test/Some.Project.Test.csproj",
+            },
+        };
+    }
+}