dependabot-nuget 0.321.1 → 0.321.3

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

@@ -0,0 +1,181 @@
+using Xunit;
+
+namespace NuGetUpdater.Core.Test.Update;
+
+public class DotNetToolsJsonUpdaterTests
+{
+    [Fact]
+    public async Task UpdateDependency_MaintainComments()
+    {
+        await TestAsync(
+            dotnetToolsContent: """
+                {
+                  // this is a comment
+                  "version": 1,
+                  "isRoot": true,
+                  "tools": {
+                    "some.dotnet.tool": {
+                      // this is a deep comment
+                      "version": "1.0.0",
+                      "commands": [
+                        "some.dotnet.tool"
+                      ]
+                    },
+                    "some-other-tool": {
+                      "version": "2.1.3",
+                      "commands": [
+                        "some-other-tool"
+                      ]
+                    }
+                  }
+                }
+                """,
+            dependencyName: "Some.DotNet.Tool",
+            previousDependencyVersion: "1.0.0",
+            newDependencyVersion: "1.1.0",
+            expectedUpdatedDotnetToolsContent: """
+                {
+                  // this is a comment
+                  "version": 1,
+                  "isRoot": true,
+                  "tools": {
+                    "some.dotnet.tool": {
+                      // this is a deep comment
+                      "version": "1.1.0",
+                      "commands": [
+                        "some.dotnet.tool"
+                      ]
+                    },
+                    "some-other-tool": {
+                      "version": "2.1.3",
+                      "commands": [
+                        "some-other-tool"
+                      ]
+                    }
+                  }
+                }
+                """
+        );
+    }
+
+    [Fact]
+    public async Task UpdateDependency_TrailingCommaInOriginal()
+    {
+        await TestAsync(
+            dotnetToolsContent: """
+                {
+                  "version": 1,
+                  "isRoot": true,
+                  "tools": {
+                    "some.dotnet.tool": {
+                      "version": "1.0.0",
+                      "commands": [
+                        "some.dotnet.tool"
+                      ],
+                    },
+                    "some-other-tool": {
+                      "version": "2.1.3",
+                      "commands": [
+                        "some-other-tool"
+                      ],
+                    }
+                  }
+                }
+                """,
+            dependencyName: "Some.DotNet.Tool",
+            previousDependencyVersion: "1.0.0",
+            newDependencyVersion: "1.1.0",
+            expectedUpdatedDotnetToolsContent: """
+                {
+                  "version": 1,
+                  "isRoot": true,
+                  "tools": {
+                    "some.dotnet.tool": {
+                      "version": "1.1.0",
+                      "commands": [
+                        "some.dotnet.tool"
+                      ]
+                    },
+                    "some-other-tool": {
+                      "version": "2.1.3",
+                      "commands": [
+                        "some-other-tool"
+                      ]
+                    }
+                  }
+                }
+                """
+        );
+    }
+
+    [Fact]
+    public async Task MissingDependency_NoUpdatePerformed()
+    {
+        await TestAsync(
+            dotnetToolsContent: """
+                {
+                  "version": 1,
+                  "isRoot": true,
+                  "tools": {
+                    "some-other-tool": {
+                      "version": "2.1.3",
+                      "commands": [
+                        "some-other-tool"
+                      ]
+                    }
+                  }
+                }
+                """,
+            dependencyName: "Some.DotNet.Tool",
+            previousDependencyVersion: "1.0.0",
+            newDependencyVersion: "1.1.0",
+            expectedUpdatedDotnetToolsContent: """
+                {
+                  "version": 1,
+                  "isRoot": true,
+                  "tools": {
+                    "some-other-tool": {
+                      "version": "2.1.3",
+                      "commands": [
+                        "some-other-tool"
+                      ]
+                    }
+                  }
+                }
+                """
+        );
+    }
+
+    private async Task TestAsync(
+        string dotnetToolsContent,
+        string dependencyName,
+        string previousDependencyVersion,
+        string newDependencyVersion,
+        string expectedUpdatedDotnetToolsContent,
+        string workspaceDirectory = "/",
+        string dotnetToolsJsonPath = ".config/dotnet-tools.json"
+    )
+    {
+        // arrange
+        using var tempDir = await TemporaryDirectory.CreateWithContentsAsync(
+            (dotnetToolsJsonPath, dotnetToolsContent)
+        );
+        var logger = new TestLogger();
+
+        // act
+        var updatedFilePath = await DotNetToolsJsonUpdater.UpdateDependencyAsync(tempDir.DirectoryPath, workspaceDirectory, dependencyName, previousDependencyVersion, newDependencyVersion, logger);
+
+        // assert
+        var expectedUpdateToHappen = dotnetToolsContent.Replace("\r", "") != expectedUpdatedDotnetToolsContent.Replace("\r", "");
+        if (expectedUpdateToHappen)
+        {
+            Assert.NotNull(updatedFilePath);
+            var relativeUpdatedFilePath = Path.GetRelativePath(tempDir.DirectoryPath, updatedFilePath).NormalizePathToUnix();
+            Assert.Equal(dotnetToolsJsonPath, relativeUpdatedFilePath);
+        }
+
+        var actualFileContents = await tempDir.ReadFileContentsAsync([dotnetToolsJsonPath]);
+        var actualContent = actualFileContents.Single().Contents.Replace("\r", "");
+        Assert.Equal(expectedUpdatedDotnetToolsContent.Replace("\r", ""), actualContent);
+    }
+}

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

@@ -0,0 +1,61 @@
+using System.Collections.Immutable;
+
+using NuGetUpdater.Core.Updater.FileWriters;
+
+using Xunit;
+
+namespace NuGetUpdater.Core.Test.Update.FileWriters;
+
+public abstract class FileWriterTestsBase
+{
+    public abstract IFileWriter FileWriter { get; }
+
+    protected async Task TestAsync(
+        (string path, string contents)[] files,
+        ImmutableArray<string> initialProjectDependencyStrings,
+        ImmutableArray<string> requiredDependencyStrings,
+        (string path, string contents)[] expectedFiles,
+        bool useCentralPackageTransitivePinning = false
+    )
+    {
+        using var tempDir = await TemporaryDirectory.CreateWithContentsAsync(files);
+        var repoContentsPath = new DirectoryInfo(tempDir.DirectoryPath);
+        var initialProjectDependencies = initialProjectDependencyStrings.Select(s => new Dependency(s.Split('/')[0], s.Split('/')[1], DependencyType.Unknown)).ToImmutableArray();
+        var requiredDependencies = requiredDependencyStrings.Select(s => new Dependency(s.Split('/')[0], s.Split('/')[1], DependencyType.Unknown)).ToImmutableArray();
+        var addPackageReferenceElementForPinnedPackages = !useCentralPackageTransitivePinning;
+        var success = await FileWriter.UpdatePackageVersionsAsync(repoContentsPath, [.. files.Select(f => f.path)], initialProjectDependencies, requiredDependencies, addPackageReferenceElementForPinnedPackages);
+        Assert.True(success);
+
+        var expectedFileNames = expectedFiles.Select(f => f.path).ToHashSet();
+        var actualFiles = (await tempDir.ReadFileContentsAsync(expectedFileNames)).ToDictionary(f => f.Path, f => f.Contents);
+        foreach (var (expectedPath, expectedContents) in expectedFiles)
+        {
+            Assert.True(actualFiles.TryGetValue(expectedPath, out var actualContents), $"Expected file {expectedPath} not found.");
+            Assert.Equal(expectedContents.Replace("\r", ""), actualContents.Replace("\r", ""));
+        }
+    }
+
+    protected async Task TestNoChangeAsync(
+        (string path, string contents)[] files,
+        ImmutableArray<string> initialProjectDependencyStrings,
+        ImmutableArray<string> requiredDependencyStrings,
+        bool useCentralPackageTransitivePinning = false
+    )
+    {
+        using var tempDir = await TemporaryDirectory.CreateWithContentsAsync(files);
+        var repoContentsPath = new DirectoryInfo(tempDir.DirectoryPath);
+        var initialProjectDependencies = initialProjectDependencyStrings.Select(s => new Dependency(s.Split('/')[0], s.Split('/')[1], DependencyType.Unknown)).ToImmutableArray();
+        var requiredDependencies = requiredDependencyStrings.Select(s => new Dependency(s.Split('/')[0], s.Split('/')[1], DependencyType.Unknown)).ToImmutableArray();
+        var addPackageReferenceElementForPinnedPackages = !useCentralPackageTransitivePinning;
+        var success = await FileWriter.UpdatePackageVersionsAsync(repoContentsPath, [.. files.Select(f => f.path)], initialProjectDependencies, requiredDependencies, addPackageReferenceElementForPinnedPackages);
+        Assert.False(success);
+
+        var expectedFileNames = files.Select(f => f.path).ToHashSet();
+        var actualFiles = (await tempDir.ReadFileContentsAsync(expectedFileNames)).ToDictionary(f => f.Path, f => f.Contents);
+        foreach (var (expectedPath, expectedContents) in files)
+        {
+            Assert.True(actualFiles.TryGetValue(expectedPath, out var actualContents), $"Expected file {expectedPath} not found.");
+            Assert.Equal(expectedContents.Replace("\r", ""), actualContents.Replace("\r", ""));
+        }
+    }
+}