dependabot-nuget 0.289.0 → 0.291.0

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core/Utilities/NuGetHelper.cs

@@ -4,13 +4,13 @@ namespace NuGetUpdater.Core;
 
 internal static class NuGetHelper
 {
-    internal static async Task<bool> DownloadNuGetPackagesAsync(string repoRoot, string projectPath, IReadOnlyCollection<Dependency> packages, ILogger logger)
+    internal static async Task<bool> DownloadNuGetPackagesAsync(string repoRoot, string projectPath, IReadOnlyCollection<Dependency> packages, ExperimentsManager experimentsManager, ILogger logger)
     {
         var tempDirectory = Directory.CreateTempSubdirectory("msbuild_sdk_restore_");
         try
         {
             var tempProjectPath = await MSBuildHelper.CreateTempProjectAsync(tempDirectory, repoRoot, projectPath, "netstandard2.0", packages, logger, usePackageDownload: true);
-            var (exitCode, stdOut, stdErr) = await ProcessEx.RunAsync("dotnet", ["restore", tempProjectPath]);
+            var (exitCode, stdOut, stdErr) = await ProcessEx.RunDotnetWithoutMSBuildEnvironmentVariablesAsync(["restore", tempProjectPath], tempDirectory.FullName, experimentsManager);
 
             return exitCode == 0;
         }

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core/Utilities/ProcessExtensions.cs

@@ -5,19 +5,57 @@ namespace NuGetUpdater.Core;
 
 public static class ProcessEx
 {
-    public static Task<(int ExitCode, string Output, string Error)> RunAsync(string fileName, IEnumerable<string>? arguments = null, string? workingDirectory = null)
+    /// <summary>
+    /// Run the `dotnet` command with the given values.  This will exclude all `MSBuild*` environment variables from the execution.
+    /// </summary>
+    public static Task<(int ExitCode, string Output, string Error)> RunDotnetWithoutMSBuildEnvironmentVariablesAsync(IEnumerable<string> arguments, string workingDirectory, ExperimentsManager experimentsManager)
+    {
+        var environmentVariablesToUnset = new List<string>();
+        if (experimentsManager.InstallDotnetSdks)
+        {
+            // If using the SDK specified by a `global.json` file, these environment variables need to be unset to
+            // allow the new process to discover the correct MSBuild binaries to load, and not load the ones that
+            // this process is using.
+            environmentVariablesToUnset.Add("MSBuildExtensionsPath");
+            environmentVariablesToUnset.Add("MSBuildLoadMicrosoftTargetsReadOnly");
+            environmentVariablesToUnset.Add("MSBUILDLOGIMPORTS");
+            environmentVariablesToUnset.Add("MSBuildSDKsPath");
+            environmentVariablesToUnset.Add("MSBUILDTARGETOUTPUTLOGGING");
+            environmentVariablesToUnset.Add("MSBUILD_EXE_PATH");
+        }
+
+        var environmentVariableOverrides = environmentVariablesToUnset.Select(name => (name, (string?)null));
+        return RunAsync("dotnet",
+            arguments,
+            workingDirectory,
+            environmentVariableOverrides
+        );
+    }
+
+    public static Task<(int ExitCode, string Output, string Error)> RunAsync(
+        string fileName,
+        IEnumerable<string>? arguments = null,
+        string? workingDirectory = null,
+        IEnumerable<(string Name, string? Value)>? environmentVariableOverrides = null
+    )
     {
         var tcs = new TaskCompletionSource<(int, string, string)>();
 
         var redirectInitiated = new ManualResetEventSlim();
+        var psi = new ProcessStartInfo(fileName, arguments ?? [])
+        {
+            UseShellExecute = false, // required to redirect output and set environment variables
+            RedirectStandardOutput = true,
+            RedirectStandardError = true,
+        };
+        foreach (var (name, value) in environmentVariableOverrides ?? [])
+        {
+            psi.EnvironmentVariables[name] = value;
+        }
+
         var process = new Process
         {
-            StartInfo = new ProcessStartInfo(fileName, arguments ?? [])
-            {
-                UseShellExecute = false, // required to redirect output
-                RedirectStandardOutput = true,
-                RedirectStandardError = true,
-            },
+            StartInfo = psi,
             EnableRaisingEvents = true
         };
 

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core/Utilities/ProjectHelper.cs

@@ -74,7 +74,7 @@ internal static class ProjectHelper
     private static string? GetItemPathWithFileName(this ProjectRootElement projectRootElement, string itemFileName)
     {
         var projectDirectory = Path.GetDirectoryName(projectRootElement.FullPath)!;
-        var packagesConfigPath = projectRootElement.Items
+        var itemPath = projectRootElement.Items
             .Where(i => i.ElementName.Equals("None", StringComparison.OrdinalIgnoreCase) ||
                         i.ElementName.Equals("Content", StringComparison.OrdinalIgnoreCase))
             .Where(i => Path.GetFileName(i.Include).Equals(itemFileName, StringComparison.OrdinalIgnoreCase))
@@ -82,7 +82,7 @@ internal static class ProjectHelper
             .Where(File.Exists)
             .FirstOrDefault()
             ?.NormalizePathToUnix();
-        return packagesConfigPath;
+        return itemPath;
     }
 
     private static string? GetPathWithRegardsToProjectFile(string fullProjectPath, string fileName)

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Analyze/AnalyzeWorkerTestBase.cs

@@ -19,7 +19,9 @@ public class AnalyzeWorkerTestBase
         DependencyInfo dependencyInfo,
         ExpectedAnalysisResult expectedResult,
         MockNuGetPackage[]? packages = null,
-        TestFile[]? extraFiles = null)
+        TestFile[]? extraFiles = null,
+        ExperimentsManager? experimentsManager = null
+    )
     {
         var relativeDependencyPath = $"./dependabot/dependency/{dependencyInfo.Name}.json";
 
@@ -28,6 +30,7 @@ public class AnalyzeWorkerTestBase
             (relativeDependencyPath, JsonSerializer.Serialize(dependencyInfo, AnalyzeWorker.SerializerOptions)),
         ];
 
+        experimentsManager ??= new ExperimentsManager();
         var allFiles = files.Concat(extraFiles ?? []).ToArray();
         var actualResult = await RunAnalyzerAsync(dependencyInfo.Name, allFiles, async directoryPath =>
         {
@@ -36,7 +39,7 @@ public class AnalyzeWorkerTestBase
             var discoveryPath = Path.GetFullPath(DiscoveryWorker.DiscoveryResultFileName, directoryPath);
             var dependencyPath = Path.GetFullPath(relativeDependencyPath, directoryPath);
 
-            var worker = new AnalyzeWorker(new TestLogger());
+            var worker = new AnalyzeWorker(experimentsManager, new TestLogger());
             var result = await worker.RunWithErrorHandlingAsync(directoryPath, discoveryPath, dependencyPath);
             return result;
         });

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Discover/DiscoveryWorkerTests.DotNetToolsJson.cs

@@ -50,6 +50,50 @@ public partial class DiscoveryWorkerTests
             );
         }
 
+        [Fact]
+        public async Task DiscoversDependenciesTrailingComma()
+        {
+            await TestDiscoveryAsync(
+                packages: [],
+                workspacePath: "",
+                files: [
+                    (".config/dotnet-tools.json", """
+                        {
+                          "version": 1,
+                          "isRoot": true,
+                          "tools": {
+                            "botsay": {
+                              "version": "1.0.0",
+                              "commands": [
+                                "botsay"
+                              ],
+                            },
+                            "dotnetsay": {
+                              "version": "1.0.0",
+                              "commands": [
+                                "dotnetsay"
+                              ],
+                            }
+                          }
+                        }
+                        """),
+                ],
+                expectedResult: new()
+                {
+                    Path = "",
+                    DotNetToolsJson = new()
+                    {
+                        FilePath = ".config/dotnet-tools.json",
+                        Dependencies = [
+                            new("botsay", "1.0.0", DependencyType.DotNetTool),
+                            new("dotnetsay", "1.0.0", DependencyType.DotNetTool),
+                        ]
+                    },
+                    ExpectedProjectCount = 0,
+                }
+            );
+        }
+
         [Fact]
         public async Task ReportsFailure()
         {
@@ -74,7 +118,7 @@ public partial class DiscoveryWorkerTests
                                 "dotnetsay"
                               ]
                             }
-                          }
+                          } INVALID JSON
                         }
                         """),
                 ],

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Discover/DiscoveryWorkerTests.GlobalJson.cs

@@ -40,6 +40,40 @@ public partial class DiscoveryWorkerTests
             );
         }
 
+        [Fact]
+        public async Task DiscoversDependencies_HandlesTrailingComma()
+        {
+            await TestDiscoveryAsync(
+                packages: [],
+                workspacePath: "",
+                files: [
+                    ("global.json", """
+                        {
+                          "sdk": {
+                            "version": "2.2.104"
+                          },
+                          "msbuild-sdks": {
+                            "Microsoft.Build.Traversal": "1.0.45"
+                          },
+                        }
+                        """),
+                ],
+                expectedResult: new()
+                {
+                    Path = "",
+                    GlobalJson = new()
+                    {
+                        FilePath = "global.json",
+                        Dependencies = [
+                            new("Microsoft.NET.Sdk", "2.2.104", DependencyType.MSBuildSdk),
+                            new("Microsoft.Build.Traversal", "1.0.45", DependencyType.MSBuildSdk),
+                        ]
+                    },
+                    ExpectedProjectCount = 0,
+                }
+            );
+        }
+
         [Fact]
         public async Task ReportsFailure()
         {
@@ -50,7 +84,7 @@ public partial class DiscoveryWorkerTests
                     ("global.json", """
                         {
                           "sdk": {
-                            "version": "2.2.104",
+                            "version": "2.2.104", INVALID JSON
                           },
                           "msbuild-sdks": {
                             "Microsoft.Build.Traversal": "1.0.45"

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Discover/DiscoveryWorkerTests.Project.cs

@@ -441,8 +441,6 @@ public partial class DiscoveryWorkerTests
                             ReferencedProjectPaths = [],
                             ImportedFiles = [
                                 "Directory.Build.targets",
-                                "NUGET_PACKAGES/microsoft.build.centralpackageversions/2.1.3/Sdk/Sdk.props", // this is an artifact of the package cache existing next to the csproj
-                                "NUGET_PACKAGES/microsoft.build.centralpackageversions/2.1.3/Sdk/Sdk.targets", // this is an artifact of the package cache existing next to the csproj
                                 "Packages.props",
                             ],
                             AdditionalFiles = [],
@@ -513,8 +511,6 @@ public partial class DiscoveryWorkerTests
                             ReferencedProjectPaths = [],
                             ImportedFiles = [
                                 "Directory.Build.targets",
-                                "NUGET_PACKAGES/microsoft.build.centralpackageversions/2.1.3/Sdk/Sdk.props", // this is an artifact of the package cache existing next to the csproj
-                                "NUGET_PACKAGES/microsoft.build.centralpackageversions/2.1.3/Sdk/Sdk.targets", // this is an artifact of the package cache existing next to the csproj
                                 "Packages.props",
                             ],
                             AdditionalFiles = [],

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Discover/DiscoveryWorkerTests.cs

@@ -1094,6 +1094,47 @@ public partial class DiscoveryWorkerTests : DiscoveryWorkerTestBase
         );
     }
 
+    [Theory]
+    [InlineData(true)]
+    [InlineData(false)]
+    public async Task DiscoveryReportsDependencyFileNotParseable(bool useDirectDiscovery)
+    {
+        var experimentsManager = new ExperimentsManager() { UseDirectDiscovery = useDirectDiscovery };
+        await TestDiscoveryAsync(
+            experimentsManager: experimentsManager,
+            workspacePath: "",
+            files:
+            [
+                ("project.csproj", """
+                    <Project Sdk="Microsoft.NET.Sdk">
+                      <PropertyGroup>
+                        <TargetFramework>net8.0</TargetFramework>
+                      </PropertyGroup>
+                      <ItemGroup>
+                        <PackageReference Include="Some.Package" Version="1.2.3" />
+                      </ItemGroup>
+                    </Project>
+                    """),
+                  ("project2.csproj", """
+                    <Project Sdk="Microsoft.NET.Sdk">
+                      <PropertyGroup>
+                        <TargetFramework>net8.0</TargetFramework>
+                      </PropertyGroup>
+                      <ItemGroup>
+                        <PackageReference: Include="Some.Package2" Version="1.2.3" />
+                      </ItemGroup>
+                    </Project>
+                    """),
+            ],
+            expectedResult: new()
+            {
+                Path = "",
+                Projects = [],
+                ErrorType = ErrorType.DependencyFileNotParseable,
+                ErrorDetails = "project2.csproj",
+            });
+    }
+
     [Fact]
     public async Task ResultFileHasCorrectShapeForAuthenticationFailure()
     {

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Discover/ExpectedDiscoveryResults.cs

@@ -21,6 +21,7 @@ public record ExpectedSdkProjectDiscoveryResult : ExpectedDependencyDiscoveryRes
     public required ImmutableArray<string> ReferencedProjectPaths { get; init; }
     public required ImmutableArray<string> ImportedFiles { get; init; }
     public required ImmutableArray<string> AdditionalFiles { get; init; }
+    public string? ErrorDetails { get; init; }
 }
 
 public record ExpectedDependencyDiscoveryResult : IDiscoveryResultWithDependencies

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Discover/SdkProjectDiscoveryTests.cs

@@ -488,7 +488,7 @@ public class SdkProjectDiscoveryTests : DiscoveryWorkerTestBase
         var logger = new TestLogger();
         var fullProjectPath = Path.Combine(testDirectory.DirectoryPath, projectPath);
         var experimentsManager = new ExperimentsManager() { UseDirectDiscovery = true }; // the following method is direct discovery; this just makes the call to Validate... happy
-        var projectDiscovery = await SdkProjectDiscovery.DiscoverWithBinLogAsync(testDirectory.DirectoryPath, Path.GetDirectoryName(fullProjectPath)!, fullProjectPath, logger);
+        var projectDiscovery = await SdkProjectDiscovery.DiscoverWithBinLogAsync(testDirectory.DirectoryPath, Path.GetDirectoryName(fullProjectPath)!, fullProjectPath, experimentsManager, logger);
         ValidateProjectResults(expectedProjects, projectDiscovery, experimentsManager);
     }
 }

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/MockNuGetPackage.cs

@@ -318,7 +318,8 @@ namespace NuGetUpdater.Core.Test
                     </Project>
                     """
                 );
-                var (exitCode, stdout, stderr) = ProcessEx.RunAsync("dotnet", ["msbuild", projectPath, "/t:_ReportCurrentSdkVersion"]).Result;
+                var experimentsManager = new ExperimentsManager();
+                var (exitCode, stdout, stderr) = ProcessEx.RunDotnetWithoutMSBuildEnvironmentVariablesAsync(["msbuild", projectPath, "/t:_ReportCurrentSdkVersion"], projectDir.FullName, experimentsManager).Result;
                 if (exitCode != 0)
                 {
                     throw new Exception($"Failed to report the current SDK version:\n{stdout}\n{stderr}");

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

@@ -0,0 +1,85 @@
+using NuGet.Versioning;
+
+using NuGetUpdater.Core.Analyze;
+using NuGetUpdater.Core.Run;
+using NuGetUpdater.Core.Run.ApiModel;
+
+using Xunit;
+
+namespace NuGetUpdater.Core.Test.Run;
+
+public class MiscellaneousTests
+{
+    [Theory]
+    [MemberData(nameof(RequirementsFromIgnoredVersionsData))]
+    public void RequirementsFromIgnoredVersions(string dependencyName, Condition[] ignoreConditions, Requirement[] expectedRequirements)
+    {
+        var job = new Job()
+        {
+            Source = new()
+            {
+                Provider = "github",
+                Repo = "some/repo"
+            },
+            IgnoreConditions = ignoreConditions
+        };
+        var actualRequirements = RunWorker.GetIgnoredRequirementsForDependency(job, dependencyName);
+        var actualRequirementsStrings = string.Join("|", actualRequirements.Select(r => r.ToString()));
+        var expectedRequirementsStrings = string.Join("|", expectedRequirements.Select(r => r.ToString()));
+        Assert.Equal(expectedRequirementsStrings, actualRequirementsStrings);
+    }
+
+    public static IEnumerable<object?[]> RequirementsFromIgnoredVersionsData()
+    {
+        yield return
+        [
+            // dependencyName
+            "Some.Package",
+            // ignoredConditions
+            new Condition[]
+            {
+                new()
+                {
+                    DependencyName = "SOME.PACKAGE",
+                    VersionRequirement = Requirement.Parse("> 1.2.3")
+                },
+                new()
+                {
+                    DependencyName = "some.package",
+                    VersionRequirement = Requirement.Parse("<= 2.0.0")
+                },
+                new()
+                {
+                    DependencyName = "Unrelated.Package",
+                    VersionRequirement = Requirement.Parse("= 3.4.5")
+                }
+            },
+            // expectedRequirements
+            new Requirement[]
+            {
+                new IndividualRequirement(">", NuGetVersion.Parse("1.2.3")),
+                new IndividualRequirement("<=", NuGetVersion.Parse("2.0.0")),
+            }
+        ];
+
+        // version requirement is null => ignore all
+        yield return
+        [
+            // dependencyName
+            "Some.Package",
+            // ignoredConditions
+            new Condition[]
+            {
+                new()
+                {
+                    DependencyName = "Some.Package"
+                }
+            },
+            // expectedRequirements
+            new Requirement[]
+            {
+                new IndividualRequirement(">", NuGetVersion.Parse("0.0.0"))
+            }
+        ];
+    }
+}

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

@@ -30,11 +30,7 @@ public class RunWorkerTests
                     Provider = "github",
                     Repo = "test/repo",
                     Directory = "some-dir",
-                },
-                AllowedUpdates =
-                [
-                    new() { UpdateType = "all" }
-                ]
+                }
             },
             files:
             [
@@ -237,11 +233,7 @@ public class RunWorkerTests
                     Provider = "github",
                     Repo = "test/repo",
                     Directory = "some-dir",
-                },
-                AllowedUpdates =
-                [
-                    new() { UpdateType = "all" }
-                ]
+                }
             },
             files:
             [
@@ -483,11 +475,7 @@ public class RunWorkerTests
                     Provider = "github",
                     Repo = "test/repo",
                     Directory = "/",
-                },
-                AllowedUpdates =
-                [
-                    new() { UpdateType = "all" }
-                ]
+                }
             },
             files:
             [
@@ -550,11 +538,7 @@ public class RunWorkerTests
                     Provider = "github",
                     Repo = "test/repo",
                     Directory = "some-dir",
-                },
-                AllowedUpdates =
-                [
-                    new() { UpdateType = "all" }
-                ]
+                }
             },
             files:
             [
@@ -886,11 +870,7 @@ public class RunWorkerTests
                     Provider = "github",
                     Repo = "test/repo",
                     Directory = "some-dir/ProjectA",
-                },
-                AllowedUpdates =
-                [
-                    new() { UpdateType = "all" }
-                ]
+                }
             },
             files:
             [
@@ -1438,11 +1418,7 @@ public class RunWorkerTests
                     Provider = "github",
                     Repo = "test/repo",
                     Directory = "/",
-                },
-                AllowedUpdates =
-                [
-                    new() { UpdateType = "all" }
-                ]
+                }
             },
             packages:
             [
@@ -1754,7 +1730,7 @@ public class RunWorkerTests
         var testApiHandler = new TestApiHandler();
         var logger = new TestLogger();
         discoveryWorker ??= new DiscoveryWorker(experimentsManager, logger);
-        analyzeWorker ??= new AnalyzeWorker(logger);
+        analyzeWorker ??= new AnalyzeWorker(experimentsManager, logger);
         updaterWorker ??= new UpdaterWorker(experimentsManager, logger);
 
         var worker = new RunWorker(testApiHandler, discoveryWorker, analyzeWorker, updaterWorker, logger);