dependabot-nuget 0.265.0 → 0.267.0

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

@@ -4,7 +4,7 @@ using NuGetUpdater.Core.Discover;
 
 namespace NuGetUpdater.Core.Test.Discover;
 
-public record ExpectedWorkspaceDiscoveryResult
+public record ExpectedWorkspaceDiscoveryResult : NativeResult
 {
     public required string Path { get; init; }
     public bool IsSuccess { get; init; } = true;

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

@@ -1,3 +1,4 @@
+using System.Collections.Immutable;
 using System.IO.Compression;
 using System.Security.Cryptography;
 using System.Text;
@@ -95,7 +96,7 @@ namespace NuGetUpdater.Core.Test
         /// Creates a mock NuGet package with a single assembly in the appropriate `lib/` directory.  The assembly will
         /// contain the appropriate `AssemblyVersion` attribute and nothing else.
         /// </summary>
-        public static MockNuGetPackage CreatePackageWithAssembly(string id, string version, string targetFramework, string assemblyVersion, (string? TargetFramework, (string Id, string Version)[] Packages)[]? dependencyGroups = null)
+        public static MockNuGetPackage CreatePackageWithAssembly(string id, string version, string targetFramework, string assemblyVersion, ImmutableArray<byte>? assemblyPublicKey = null, (string? TargetFramework, (string Id, string Version)[] Packages)[]? dependencyGroups = null)
         {
             return new(
                 id,
@@ -104,7 +105,7 @@ namespace NuGetUpdater.Core.Test
                 DependencyGroups: dependencyGroups,
                 Files:
                 [
-                    ($"lib/{targetFramework}/{id}.dll", CreateAssembly(id, assemblyVersion))
+                    ($"lib/{targetFramework}/{id}.dll", CreateAssembly(id, assemblyVersion, assemblyPublicKey))
                 ]
             );
         }
@@ -130,19 +131,14 @@ namespace NuGetUpdater.Core.Test
             );
         }
 
-        public static MockNuGetPackage CreateDotNetToolPackage(string id, string version, string targetFramework)
+        public static MockNuGetPackage CreateDotNetToolPackage(string id, string version, string targetFramework, XElement[]? additionalMetadata = null)
         {
+            var packageMetadata = new XElement("packageTypes", new XElement("packageType", new XAttribute("name", "DotnetTool")));
+            var allMetadata = new[] { packageMetadata }.Concat(additionalMetadata ?? []).ToArray();
             return new(
                 id,
                 version,
-                AdditionalMetadata:
-                [
-                    new XElement("packageTypes",
-                        new XElement("packageType",
-                            new XAttribute("name", "DotnetTool")
-                        )
-                    )
-                ],
+                AdditionalMetadata: allMetadata,
                 Files:
                 [
                     ($"tools/{targetFramework}/any/DotnetToolSettings.xml", Encoding.UTF8.GetBytes($"""
@@ -157,8 +153,10 @@ namespace NuGetUpdater.Core.Test
             );
         }
 
-        public static MockNuGetPackage CreateMSBuildSdkPackage(string id, string version, string? sdkPropsContent = null, string? sdkTargetsContent = null)
+        public static MockNuGetPackage CreateMSBuildSdkPackage(string id, string version, string? sdkPropsContent = null, string? sdkTargetsContent = null, XElement[]? additionalMetadata = null)
         {
+            var packageMetadata = new XElement("packageTypes", new XElement("packageType", new XAttribute("name", "MSBuildSdk")));
+            var allMetadata = new[] { packageMetadata }.Concat(additionalMetadata ?? []).ToArray();
             sdkPropsContent ??= """
                 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
                 </Project>
@@ -170,14 +168,7 @@ namespace NuGetUpdater.Core.Test
             return new(
                 id,
                 version,
-                AdditionalMetadata:
-                [
-                    new XElement("packageTypes",
-                        new XElement("packageType",
-                            new XAttribute("name", "MSBuildSdk")
-                        )
-                    )
-                ],
+                AdditionalMetadata: additionalMetadata,
                 Files:
                 [
                     ("Sdk/Sdk.props", Encoding.UTF8.GetBytes(sdkPropsContent)),
@@ -245,7 +236,7 @@ namespace NuGetUpdater.Core.Test
             );
         }
 
-        private Stream GetZipStream()
+        public Stream GetZipStream()
         {
             if (_stream is null)
             {
@@ -271,9 +262,13 @@ namespace NuGetUpdater.Core.Test
             return _stream;
         }
 
-        private static byte[] CreateAssembly(string assemblyName, string assemblyVersion)
+        private static byte[] CreateAssembly(string assemblyName, string assemblyVersion, ImmutableArray<byte>? assemblyPublicKey = null)
         {
             CSharpCompilationOptions compilationOptions = new(OutputKind.DynamicallyLinkedLibrary);
+            if (assemblyPublicKey is not null)
+            {
+                compilationOptions = compilationOptions.WithCryptoPublicKey(assemblyPublicKey.Value);
+            }
             CSharpCompilation compilation = CSharpCompilation.Create(assemblyName, options: compilationOptions)
                 .AddReferences(MetadataReference.CreateFromFile(typeof(object).Assembly.Location))
                 .AddSyntaxTrees(CSharpSyntaxTree.ParseText($"[assembly: System.Reflection.AssemblyVersionAttribute(\"{assemblyVersion}\")]"));

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

@@ -0,0 +1,81 @@
+using System.Net;
+using System.Net.Sockets;
+using System.Text;
+
+namespace NuGetUpdater.Core.Test
+{
+    public class TestHttpServer : IDisposable
+    {
+        private readonly Func<string, (int, byte[])> _requestHandler;
+        private readonly HttpListener _listener;
+        private bool _runServer = true;
+
+        public string BaseUrl { get; }
+
+        private TestHttpServer(string baseurl, Func<string, (int, byte[])> requestHandler)
+        {
+            BaseUrl = baseurl;
+            _requestHandler = requestHandler;
+            _listener = new HttpListener();
+            _listener.Prefixes.Add(baseurl);
+        }
+
+        private void Start()
+        {
+            _listener.Start();
+            Task.Factory.StartNew(HandleResponses);
+        }
+
+        public void Dispose()
+        {
+            _runServer = false;
+            _listener.Stop();
+        }
+
+        private async Task HandleResponses()
+        {
+            while (_runServer)
+            {
+                var context = await _listener.GetContextAsync();
+                var (statusCode, response) = _requestHandler(context.Request.Url!.AbsoluteUri);
+                context.Response.StatusCode = statusCode;
+                await context.Response.OutputStream.WriteAsync(response);
+                context.Response.Close();
+            }
+        }
+
+        private static readonly object PortGate = new();
+
+        public static TestHttpServer CreateTestServer(Func<string, (int, byte[])> requestHandler)
+        {
+            // static lock to ensure the port is not recycled after `FindFreePort()` and before we can start the real server
+            lock (PortGate)
+            {
+                var port = FindFreePort();
+                var baseUrl = $"http://localhost:{port}/";
+                var server = new TestHttpServer(baseUrl, requestHandler);
+                server.Start();
+                return server;
+            }
+        }
+
+        public static TestHttpServer CreateTestStringServer(Func<string, (int, string)> requestHandler)
+        {
+            Func<string, (int, byte[])> bytesRequestHandler = url =>
+            {
+                var (statusCode, response) = requestHandler(url);
+                return (statusCode, Encoding.UTF8.GetBytes(response));
+            };
+            return CreateTestServer(bytesRequestHandler);
+        }
+
+        private static int FindFreePort()
+        {
+            var tcpListener = new TcpListener(IPAddress.Loopback, 0);
+            tcpListener.Start();
+            var port = ((IPEndPoint)tcpListener.LocalEndpoint).Port;
+            tcpListener.Stop();
+            return port;
+        }
+    }
+}

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

@@ -1,3 +1,7 @@
+using System.Text.Json;
+
+using NuGetUpdater.Core.Updater;
+
 using Xunit;
 
 namespace NuGetUpdater.Core.Test.Update;
@@ -88,7 +92,8 @@ public abstract class UpdateWorkerTestBase : TestBase
         TestFile[]? additionalFiles = null,
         TestFile[]? additionalFilesExpected = null,
         MockNuGetPackage[]? packages = null,
-        string projectFilePath = "test-project.csproj")
+        string projectFilePath = "test-project.csproj",
+        UpdateOperationResult? expectedResult = null)
         => TestUpdateForProject(
             dependencyName,
             oldVersion,
@@ -98,7 +103,8 @@ public abstract class UpdateWorkerTestBase : TestBase
             isTransitive,
             additionalFiles,
             additionalFilesExpected,
-            packages);
+            packages,
+            expectedResult);
 
     protected static async Task TestUpdateForProject(
         string dependencyName,
@@ -109,7 +115,8 @@ public abstract class UpdateWorkerTestBase : TestBase
         bool isTransitive = false,
         TestFile[]? additionalFiles = null,
         TestFile[]? additionalFilesExpected = null,
-        MockNuGetPackage[]? packages = null)
+        MockNuGetPackage[]? packages = null,
+        UpdateOperationResult? expectedResult = null)
     {
         additionalFiles ??= [];
         additionalFilesExpected ??= [];
@@ -130,16 +137,29 @@ public abstract class UpdateWorkerTestBase : TestBase
             // run update
             var worker = new UpdaterWorker(new Logger(verbose: true));
             var projectPath = placeFilesInSrc ? $"src/{projectFilePath}" : projectFilePath;
-            await worker.RunAsync(temporaryDirectory, projectPath, dependencyName, oldVersion, newVersion, isTransitive);
+            var updateResultFile = Path.Combine(temporaryDirectory, "update-result.json");
+            await worker.RunAsync(temporaryDirectory, projectPath, dependencyName, oldVersion, newVersion, isTransitive, updateResultFile);
+            var actualResultContents = await File.ReadAllTextAsync(updateResultFile);
+            var actualResult = JsonSerializer.Deserialize<UpdateOperationResult>(actualResultContents, UpdaterWorker.SerializerOptions);
+            if (expectedResult is { })
+            {
+                ValidateUpdateOperationResult(expectedResult, actualResult!);
+            }
         });
 
-        var expectedResult = additionalFilesExpected.Prepend((projectFilePath, expectedProjectContents)).ToArray();
+        var expectedResultFiles = additionalFilesExpected.Prepend((projectFilePath, expectedProjectContents)).ToArray();
         if (placeFilesInSrc)
         {
-            expectedResult = expectedResult.Select(er => ($"src/{er.Item1}", er.Item2)).ToArray();
+            expectedResultFiles = expectedResultFiles.Select(er => ($"src/{er.Item1}", er.Item2)).ToArray();
         }
 
-        AssertContainsFiles(expectedResult, actualResult);
+        AssertContainsFiles(expectedResultFiles, actualResult);
+    }
+
+    protected static void ValidateUpdateOperationResult(UpdateOperationResult expectedResult, UpdateOperationResult actualResult)
+    {
+        Assert.Equal(expectedResult.ErrorType, actualResult.ErrorType);
+        Assert.Equal(expectedResult.ErrorDetails, actualResult.ErrorDetails);
     }
 
     protected static Task TestNoChangeforSolution(

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

@@ -1,3 +1,7 @@
+using System.Text.Json;
+
+using NuGetUpdater.Core.Updater;
+
 using Xunit;
 
 namespace NuGetUpdater.Core.Test.Update;
@@ -6,6 +10,34 @@ public partial class UpdateWorkerTests
 {
     public class Mixed : UpdateWorkerTestBase
     {
+        [Fact]
+        public async Task ResultFileHasCorrectShapeForAuthenticationFailure()
+        {
+            using var temporaryDirectory = await TemporaryDirectory.CreateWithContentsAsync([]);
+            var result = new UpdateOperationResult()
+            {
+                ErrorType = ErrorType.AuthenticationFailure,
+                ErrorDetails = "<some package feed>",
+            };
+            var resultFilePath = Path.Combine(temporaryDirectory.DirectoryPath, "update-result.json");
+            await UpdaterWorker.WriteResultFile(result, resultFilePath, new Logger(false));
+            var resultContent = await File.ReadAllTextAsync(resultFilePath);
+
+            // raw result file should look like this:
+            // {
+            //   ...
+            //   "ErrorType": "AuthenticationFailure",
+            //   "ErrorDetails": "<some package feed>",
+            //   ...
+            // }
+            var jsonDocument = JsonDocument.Parse(resultContent);
+            var errorType = jsonDocument.RootElement.GetProperty("ErrorType");
+            var errorDetails = jsonDocument.RootElement.GetProperty("ErrorDetails");
+
+            Assert.Equal("AuthenticationFailure", errorType.GetString());
+            Assert.Equal("<some package feed>", errorDetails.GetString());
+        }
+
         [Fact]
         public async Task ForPackagesProject_UpdatePackageReference_InBuildProps()
         {