dependabot-nuget 0.330.0 → 0.331.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f873f613d2174dfdf82367b571a8f389e332d02f2dfb0f3e37e7db656bcb0442
-  data.tar.gz: fa66bffbadf7e9e8d51dd2d7fabfa60562504315b2c03fe5722aad203e582982
+  metadata.gz: ccdc340808fa9270ad530b71725c46f34208a49a2548adc2cb7fe3ffe7a1bd2b
+  data.tar.gz: d031c05ffd08ab81b2718757e7071940f70d2248b76ac473009a66f83aca3d22
 SHA512:
-  metadata.gz: b45f0eb1a0fc68119d181985244952bd0527d344ef54265bc3d8810e30083f3f6aff61225e4d813d195a723905b77e9fd76f18b0a7c99c06978a028d8d56b82c
-  data.tar.gz: 68f201f704f413c26db73bb7a6fa6235013761189153585adf6822cdc6cca93a0ce6bd88c89997b3f34a0502df1636a36f7e23be216b648273ec5caef692c919
+  metadata.gz: 96afb97242edf3a29a84e0f76854f08cbcda2f33c270e9ea98e319446c717317be0e816c09afbc149857f69f95a1ddae032e5926af3187ea86a289303881cdbf
+  data.tar.gz: f04a2e9d50460056ae64df2bc73cae5f80bc32ba328f0f88367eb88fb640405261c916e4a9d636ad2c7fb7980dfae0257d642b799963ec378bb8d0be00412b99

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core/Files/ProjectBuildFile.cs

@@ -149,14 +149,60 @@ internal sealed class ProjectBuildFile : XmlBuildFile
 
     public void NormalizeDirectorySeparatorsInProject()
     {
+        // `//Reference/HintPath`
         var hintPathNodes = Contents.Descendants()
             .Where(e =>
                 e.Name.Equals("HintPath", StringComparison.OrdinalIgnoreCase) &&
-                e.Parent.Name.Equals("Reference", StringComparison.OrdinalIgnoreCase))
-            .Select(e => (XmlElementSyntax)e.AsNode);
+                (e.Parent?.Name ?? "").Equals("Reference", StringComparison.OrdinalIgnoreCase))
+            .Select(e => e.AsNode)
+            .OfType<XmlElementSyntax>();
         var updatedXml = Contents.ReplaceNodes(hintPathNodes,
             (_, n) => n.WithContent(n.GetContentValue().Replace("/", "\\")).AsNode);
         Update(updatedXml);
+
+        // `//Target/Error[starts-with(@Condition, '!Exists(' and Text)]`
+        var errorsWithConditions = Contents.Descendants()
+            .Where(e =>
+                e.Name.Equals("Error", StringComparison.OrdinalIgnoreCase) &&
+                (e.Parent?.Name ?? "").Equals("Target", StringComparison.OrdinalIgnoreCase) &&
+                e.GetAttributeValue("Condition")?.StartsWith("!Exists(") == true &&
+                e.GetAttribute("Text") is not null)
+            .Select(e => e.AsNode)
+            .OfType<XmlEmptyElementSyntax>();
+        updatedXml = Contents.ReplaceNodes(errorsWithConditions,
+            (_, n) =>
+            {
+                var conditionAttr = n.GetAttribute("Condition");
+                var newConditionAttr = conditionAttr.WithValue(conditionAttr.Value.Replace("/", "\\"));
+                n = (XmlEmptyElementSyntax)n.ReplaceAttribute(conditionAttr, newConditionAttr).AsNode;
+
+                var textAttr = n.GetAttribute("Text");
+                var newTextAttr = textAttr.WithValue(textAttr.Value.Replace("/", "\\"));
+                return n.ReplaceAttribute(textAttr, newTextAttr).AsNode;
+            });
+        Update(updatedXml);
+
+        // `/Project/Import[starts-with(@Condition, 'Exists(') and Project]`
+        var importsWithConditions = Contents.Descendants()
+            .Where(e =>
+                e.Name.Equals("Import", StringComparison.OrdinalIgnoreCase) &&
+                (e.Parent?.Name ?? "").Equals("Project", StringComparison.OrdinalIgnoreCase) &&
+                e.GetAttributeValue("Condition")?.StartsWith("Exists(") == true &&
+                e.GetAttribute("Project") is not null)
+            .Select(e => e.AsNode)
+            .OfType<XmlEmptyElementSyntax>();
+        updatedXml = Contents.ReplaceNodes(importsWithConditions,
+            (_, n) =>
+            {
+                var projectAttr = n.GetAttribute("Project");
+                var newProjectAttr = projectAttr.WithValue(projectAttr.Value.Replace("/", "\\"));
+                n = (XmlEmptyElementSyntax)n.ReplaceAttribute(projectAttr, newProjectAttr).AsNode;
+
+                var conditionAttr = n.GetAttribute("Condition");
+                var newConditionAttr = conditionAttr.WithValue(conditionAttr.Value.Replace("/", "\\"));
+                return n.ReplaceAttribute(conditionAttr, newConditionAttr).AsNode;
+            });
+        Update(updatedXml);
     }
 
     public ProjectBuildFileType GetFileType()

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core/Updater/PackagesConfigUpdater.cs

@@ -54,6 +54,15 @@ internal static partial class PackagesConfigUpdater
         var packagesDirectory = PathHelper.JoinPath(projectDirectory, packagesSubDirectory);
         Directory.CreateDirectory(packagesDirectory);
 
+        var restoreArgs = new List<string>
+        {
+            "restore",
+            projectPath,
+            "-PackagesDirectory",
+            packagesDirectory,
+            "-NonInteractive",
+        };
+
         var updateArgs = new List<string>
         {
             "update",
@@ -67,20 +76,11 @@ internal static partial class PackagesConfigUpdater
             "-NonInteractive",
         };
 
-        var restoreArgs = new List<string>
-        {
-            "restore",
-            projectPath,
-            "-PackagesDirectory",
-            packagesDirectory,
-            "-NonInteractive",
-        };
-
         logger.Info("    Finding MSBuild...");
         var msbuildDirectory = MSBuildHelper.MSBuildPath;
         if (msbuildDirectory is not null)
         {
-            foreach (var args in new[] { updateArgs, restoreArgs })
+            foreach (var args in new[] { restoreArgs, updateArgs })
             {
                 args.Add("-MSBuildPath");
                 args.Add(msbuildDirectory); // e.g., /usr/share/dotnet/sdk/7.0.203
@@ -89,7 +89,7 @@ internal static partial class PackagesConfigUpdater
 
         using (new SpecialImportsConditionPatcher(projectPath))
         {
-            RunNugetUpdate(updateArgs, restoreArgs, projectDirectory ?? packagesDirectory, logger);
+            RunNugetUpdate([.. restoreArgs], [.. updateArgs], projectDirectory ?? packagesDirectory, logger);
         }
 
         projectBuildFile = ProjectBuildFile.Open(repoRootPath, projectPath);
@@ -110,7 +110,7 @@ internal static partial class PackagesConfigUpdater
         return [updateResult];
     }
 
-    private static void RunNugetUpdate(List<string> updateArgs, List<string> restoreArgs, string projectDirectory, ILogger logger)
+    private static void RunNugetUpdate(string[] restoreArgs, string[] updateArgs, string projectDirectory, ILogger logger)
     {
         var outputBuilder = new StringBuilder();
         var writer = new StringWriter(outputBuilder);
@@ -122,53 +122,26 @@ internal static partial class PackagesConfigUpdater
 
         var currentDir = Environment.CurrentDirectory;
         var existingSpawnedProcesses = GetLikelyNuGetSpawnedProcesses();
-        try
-        {
-            Environment.CurrentDirectory = projectDirectory;
-            var retryingAfterRestore = false;
 
-        doRestore:
-            logger.Info($"    Running NuGet.exe with args: {string.Join(" ", updateArgs)}");
+        void RunNuGetWithArguments(string[] args)
+        {
+            logger.Info($"    Running NuGet.exe with args: {string.Join(" ", args)}");
             outputBuilder.Clear();
-            var result = Program.Main(updateArgs.ToArray());
+            var exitCode = Program.Main(args);
             var fullOutput = outputBuilder.ToString();
-            logger.Info($"    Result: {result}");
-            logger.Info($"    Output:\n{fullOutput}");
-            if (result != 0)
+            if (exitCode != 0)
             {
-                // The initial `update` command can fail for several reasons:
-                // 1. One possibility is that the `packages.config` file contains a delisted package.  If that's the
-                //    case, `update` will fail with the message "Existing packages must be restored before performing
-                //    an install or update."
-                // 2. Another possibility is that the `update` command fails because the package contains no assemblies
-                //    and doesn't appear in the cache.  The message in this case will be "Could not install package
-                //    '<name> <version>'...the package does not contain any assembly references or content files that
-                //    are compatible with that framework.".
-                // 3. Yet another possibility is that the project explicitly imports a targets file without a condition
-                //    of `Exists(...)`.
-                // The solution in all cases is to run `restore` then try the update again.
-                if (!retryingAfterRestore && OutputIndicatesRestoreIsRequired(fullOutput))
-                {
-                    retryingAfterRestore = true;
-                    logger.Info($"    Running NuGet.exe with args: {string.Join(" ", restoreArgs)}");
-                    outputBuilder.Clear();
-                    var exitCodeAgain = Program.Main(restoreArgs.ToArray());
-                    var restoreOutput = outputBuilder.ToString();
-
-                    if (exitCodeAgain != 0)
-                    {
-                        MSBuildHelper.ThrowOnError(fullOutput);
-                        MSBuildHelper.ThrowOnError(restoreOutput);
-                        throw new Exception($"Unable to restore.\nOutput:\n${restoreOutput}\n");
-                    }
-
-                    goto doRestore;
-                }
-
                 MSBuildHelper.ThrowOnError(fullOutput);
-                throw new Exception(fullOutput);
+                throw new Exception($"Unable to run NuGet.exe with args: {string.Join(" ", args)}\nOutput:\n{fullOutput}\n");
             }
         }
+
+        try
+        {
+            Environment.CurrentDirectory = projectDirectory;
+            RunNuGetWithArguments(restoreArgs);
+            RunNuGetWithArguments(updateArgs);
+        }
         catch (Exception e)
         {
             logger.Info($"Error: {e}");
@@ -191,13 +164,6 @@ internal static partial class PackagesConfigUpdater
         }
     }
 
-    private static bool OutputIndicatesRestoreIsRequired(string output)
-    {
-        return output.Contains("Existing packages must be restored before performing an install or update.")
-            || output.Contains("the package does not contain any assembly references or content files that are compatible with that framework.")
-            || MSBuildHelper.GetMissingFile(output) is not null;
-    }
-
     private static Process[] GetLikelyNuGetSpawnedProcesses()
     {
         var processes = Process.GetProcesses().Where(p => p.ProcessName.StartsWith("CredentialProvider", StringComparison.OrdinalIgnoreCase) == true).ToArray();

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Files/ProjectBuildFileTests.cs

@@ -161,4 +161,32 @@ public class ProjectBuildFileTests
         buildFile.NormalizeDirectorySeparatorsInProject();
         Assert.Equal(expectedXml, buildFile.Contents.ToFullString());
     }
+
+    [Theory]
+    [InlineData(
+        // language=xml
+        """
+        <Project>
+          <Target>
+            <Error Condition="!Exists('../packages/Some.Package.1.0.0/build/Some.Package.targets')" Text="$([System.String]::Format('$(ErrorText)', '../packages/Some.Package.1.0.0/build/Some.Package.targets'))" />
+          </Target>
+          <Import Project="../packages/Some.Package.1.0.0/build/Some.Package.targets" Condition="Exists('../packages/Some.Package.1.0.0/build/Some.Package.targets')" />
+        </Project>
+        """,
+        // language=xml
+        """
+        <Project>
+          <Target>
+            <Error Condition="!Exists('..\packages\Some.Package.1.0.0\build\Some.Package.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\Some.Package.1.0.0\build\Some.Package.targets'))" />
+          </Target>
+          <Import Project="..\packages\Some.Package.1.0.0\build\Some.Package.targets" Condition="Exists('..\packages\Some.Package.1.0.0\build\Some.Package.targets')" />
+        </Project>
+        """
+    )]
+    public void ImportPathsCanBeNormalized(string originalXml, string expectedXml)
+    {
+        var buildFile = GetBuildFile(originalXml, "project.csproj");
+        buildFile.NormalizeDirectorySeparatorsInProject();
+        Assert.Equal(expectedXml, buildFile.Contents.ToFullString());
+    }
 }

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Update/FileWriters/FileWriterWorkerTests.cs

@@ -1,3 +1,4 @@
+using System.Text;
 using System.Text.Json;
 
 using NuGet.Versioning;
@@ -352,7 +353,7 @@ public class FileWriterWorkerTests : TestBase
     {
         // project is directly changed
         await TestAsync(
-            dependencyName: "Some.Dependency",
+            dependencyName: "Some.Package",
             oldDependencyVersion: "1.0.0",
             newDependencyVersion: "2.0.0",
             projectContents: """
@@ -365,25 +366,46 @@ public class FileWriterWorkerTests : TestBase
                     <None Include="packages.config" />
                   </ItemGroup>
                   <ItemGroup>
-                    <Reference Include="Some.Dependency">
-                      <HintPath>packages\Some.Dependency.1.0.0\lib\net45\Some.Dependency.dll</HintPath>
+                    <Reference Include="Some.Other.Package">
+                      <HintPath>..\packages\Some.Other.Package.3.0.0\lib\net45\Some.Other.Package.dll</HintPath>
+                      <Private>True</Private>
+                    </Reference>
+                    <Reference Include="Some.Package">
+                      <HintPath>..\packages\Some.Package.1.0.0\lib\net45\Some.Package.dll</HintPath>
                       <Private>True</Private>
                     </Reference>
                   </ItemGroup>
+                  <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
+                    <Error Condition="!Exists('..\packages\Some.Other.Package.3.0.0\build\Some.Other.Package.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\Some.Other.Package.3.0.0\build\Some.Other.Package.targets'))" />
+                    <Error Condition="!Exists('..\packages\Some.Package.1.0.0\build\Some.Package.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\Some.Package.1.0.0\build\Some.Package.targets'))" />
+                  </Target>
                   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+                  <Import Project="..\packages\Some.Other.Package.3.0.0\build\Some.Other.Package.targets" Condition="Exists('..\packages\Some.Other.Package.3.0.0\build\Some.Other.Package.targets')" />
+                  <Import Project="..\packages\Some.Package.1.0.0\build\Some.Package.targets" Condition="Exists('..\packages\Some.Package.1.0.0\build\Some.Package.targets')" />
                 </Project>
                 """,
             additionalFiles: [
                 ("packages.config", """
                     <?xml version="1.0" encoding="utf-8"?>
                     <packages>
-                      <package id="Some.Dependency" version="1.0.0" targetFramework="net45" />
+                      <package id="Some.Other.Package" version="3.0.0" targetFramework="net45" />
+                      <package id="Some.Package" version="1.0.0" targetFramework="net45" />
                     </packages>
                     """)
             ],
             packages: [
-                MockNuGetPackage.CreateSimplePackage("Some.Dependency", "1.0.0", "net45"),
-                MockNuGetPackage.CreateSimplePackage("Some.Dependency", "2.0.0", "net45"),
+                new MockNuGetPackage("Some.Package", "1.0.0", Files: [
+                    ("lib/net45/Some.Package.dll", Array.Empty<byte>()),
+                    ("build/Some.Package.targets", Encoding.UTF8.GetBytes("<Project />"))
+                ]),
+                new MockNuGetPackage("Some.Package", "2.0.0", Files: [
+                    ("lib/net45/Some.Package.dll", Array.Empty<byte>()),
+                    ("build/Some.Package.targets", Encoding.UTF8.GetBytes("<Project />"))
+                ]),
+                new MockNuGetPackage("Some.Other.Package", "3.0.0", Files: [
+                    ("lib/net45/Some.Other.Package.dll", Array.Empty<byte>()),
+                    ("build/Some.Other.Package.targets", Encoding.UTF8.GetBytes("<Project />"))
+                ]),
             ],
             discoveryWorker: null, // use real worker
             dependencySolver: null, // use real worker
@@ -398,24 +420,35 @@ public class FileWriterWorkerTests : TestBase
                     <None Include="packages.config" />
                   </ItemGroup>
                   <ItemGroup>
-                    <Reference Include="Some.Dependency">
-                      <HintPath>packages\Some.Dependency.2.0.0\lib\net45\Some.Dependency.dll</HintPath>
+                    <Reference Include="Some.Other.Package">
+                      <HintPath>..\packages\Some.Other.Package.3.0.0\lib\net45\Some.Other.Package.dll</HintPath>
+                      <Private>True</Private>
+                    </Reference>
+                    <Reference Include="Some.Package">
+                      <HintPath>..\packages\Some.Package.2.0.0\lib\net45\Some.Package.dll</HintPath>
                       <Private>True</Private>
                     </Reference>
                   </ItemGroup>
+                  <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
+                    <Error Condition="!Exists('..\packages\Some.Other.Package.3.0.0\build\Some.Other.Package.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\Some.Other.Package.3.0.0\build\Some.Other.Package.targets'))" />
+                    <Error Condition="!Exists('..\packages\Some.Package.2.0.0\build\Some.Package.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\Some.Package.2.0.0\build\Some.Package.targets'))" />
+                  </Target>
                   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+                  <Import Project="..\packages\Some.Other.Package.3.0.0\build\Some.Other.Package.targets" Condition="Exists('..\packages\Some.Other.Package.3.0.0\build\Some.Other.Package.targets')" />
+                  <Import Project="..\packages\Some.Package.2.0.0\build\Some.Package.targets" Condition="Exists('..\packages\Some.Package.2.0.0\build\Some.Package.targets')" />
                 </Project>
                 """,
             expectedAdditionalFiles: [
                 ("packages.config", """
                     <?xml version="1.0" encoding="utf-8"?>
                     <packages>
-                      <package id="Some.Dependency" version="2.0.0" targetFramework="net45" />
+                      <package id="Some.Other.Package" version="3.0.0" targetFramework="net45" />
+                      <package id="Some.Package" version="2.0.0" targetFramework="net45" />
                     </packages>
                     """)
             ],
             expectedOperations: [
-                new DirectUpdate() { DependencyName = "Some.Dependency", NewVersion = NuGetVersion.Parse("2.0.0"), UpdatedFiles = ["/packages.config", "/project.csproj"] }
+                new DirectUpdate() { DependencyName = "Some.Package", NewVersion = NuGetVersion.Parse("2.0.0"), UpdatedFiles = ["/packages.config", "/project.csproj"] }
             ]
         );
     }

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

@@ -1868,7 +1868,7 @@ public class PackagesConfigUpdaterTests : TestBase
         var error = JobErrorBase.ErrorFromException(notFoundException, "TEST-JOB-ID", temporaryDirectory.DirectoryPath);
         var notFound = Assert.IsType<DependencyNotFound>(error);
         var depName = Assert.IsType<string>(notFound.Details["source"]);
-        Assert.Equal("Unrelated.Package", depName);
+        Assert.Equal("Unrelated.Package.1.0.0", depName);
     }
 
     [Theory]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dependabot-nuget
 version: !ruby/object:Gem::Version
-  version: 0.330.0
+  version: 0.331.0
 platform: ruby
 authors:
 - Dependabot
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.330.0
+        version: 0.331.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.330.0
+        version: 0.331.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -551,7 +551,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/dependabot/dependabot-core/issues
-  changelog_uri: https://github.com/dependabot/dependabot-core/releases/tag/v0.330.0
+  changelog_uri: https://github.com/dependabot/dependabot-core/releases/tag/v0.331.0
 rdoc_options: []
 require_paths:
 - lib