cleanup a bit

Author: Wayfarer

CommonLibraryGui.Tests/AuroraTests.cs

@@ -18,45 +18,40 @@
 namespace CommonLibraryGuiTests
 {
     /// <summary>
-    ///     Some Basic tests for the Aurora Engine and the image Combining
+    /// Some Basic tests for the Aurora Engine and the image Combining
     /// </summary>
-    [TestFixture] // Added for explicit NUnit discovery
+    [TestFixture]
+    [Apartment(ApartmentState.STA)]
     public sealed class AuroraTests
     {
-        /// <summary>
-        ///     The codebase
-        /// </summary>
-        private static readonly string Codebase = Directory.GetCurrentDirectory();
-
-        /// <summary>
-        ///     The executable folder
-        /// </summary>
-        private static readonly DirectoryInfo ExeFolder = new(Path.GetDirectoryName(Codebase) ?? string.Empty);
+        private string _sampleImagesFolder;
 
-        /// <summary>
-        ///     The project folder
-        /// </summary>
-        private static readonly DirectoryInfo ProjectFolder = ExeFolder.Parent?.Parent;
+        [SetUp]
+        public void Setup()
+        {
+            // Resolve the path dynamically based on the test execution directory
+            var baseDirectory = TestContext.CurrentContext.TestDirectory;
+            _sampleImagesFolder = Path.Combine(baseDirectory, "Image");
 
-        /// <summary>
-        ///     The sample images folder
-        /// </summary>
-        private static readonly DirectoryInfo SampleImagesFolder = new(Path.Combine(ProjectFolder.FullName, "Image"));
+            if (!Directory.Exists(_sampleImagesFolder))
+            {
+                Assert.Ignore($"The Image folder could not be found at: {_sampleImagesFolder}. " +
+                              "Ensure the 'Image' folder is set to 'Copy to Output Directory'.");
+            }
+        }
 
         /// <summary>
-        ///     Test Aurora.
+        /// Test Aurora.
         /// </summary>
         [Test]
-        [Apartment(ApartmentState.STA)]
         public void Aurora()
         {
-            var bmResultLayerOther = new Bitmap(Path.Combine(SampleImagesFolder.FullName, "result_layer_other.png"));
-            var bmResultBase = new Bitmap(Path.Combine(SampleImagesFolder.FullName, "result_base.png"));
+            using var bmResultLayerOther = LoadBitmap("result_layer_other.png");
+            using var bmResultBase = LoadBitmap("result_base.png");
 
             var compare = new ImageAnalysis();
 
-            //new Test with UI
-            //generate texture Dictionary, and all the other data;
+            // Generate texture Dictionary, and all the other data
             var map = new Dictionary<int, List<int>>
             {
                 { 0, new List<int> { 0 } },
@@ -71,40 +66,20 @@ public void Aurora()
             {
                 AuroraTextures = new Dictionary<int, Texture>
                 {
-                    {
-                        0,
-                        new Texture
-                        {
-                            Layer = 0, Id = 0, Path = Path.Combine(SampleImagesFolder.FullName, "Tile.png")
-                        }
-                    },
-                    {
-                        1,
-                        new Texture
-                        {
-                            Layer = 1, Id = 1, Path = Path.Combine(SampleImagesFolder.FullName, "layerOne.png")
-                        }
-                    },
-                    {
-                        2,
-                        new Texture
-                        {
-                            Layer = 1, Id = 1, Path = Path.Combine(SampleImagesFolder.FullName, "LayerTwo.png")
-                        }
-                    }
+                    { 0, new Texture { Layer = 0, Id = 0, Path = Path.Combine(_sampleImagesFolder, "Tile.png") } },
+                    { 1, new Texture { Layer = 1, Id = 1, Path = Path.Combine(_sampleImagesFolder, "layerOne.png") } },
+                    { 2, new Texture { Layer = 1, Id = 1, Path = Path.Combine(_sampleImagesFolder, "LayerTwo.png") } }
                 },
                 AuroraTextureSize = 100,
                 AuroraHeight = 2,
                 AuroraWidth = 3,
                 AuroraMap = map
             };
 
-            //way hacky but works for for now....
             aurora.Initiate();
 
             var data = compare.CompareImages(bmResultBase, aurora.BitmapLayerOne);
 
-            // NUnit Syntax: Assert.That(actual, Is.EqualTo(expected))
             Assert.That(data.Similarity, Is.EqualTo(100), $"Map was not correct: {data.Similarity}");
 
             map = new Dictionary<int, List<int>>
@@ -120,13 +95,13 @@ public void Aurora()
             aurora.AuroraMap = map;
             aurora.Initiate();
 
-            aurora.BitmapLayerOne.Save($"{SampleImagesFolder}/example.png", ImageFormat.Png);
+            aurora.BitmapLayerOne.Save(Path.Combine(_sampleImagesFolder, "example.png"), ImageFormat.Png);
 
             data = compare.CompareImages(bmResultLayerOther, aurora.BitmapLayerOne);
 
             Assert.That(data.Similarity, Is.EqualTo(100), $"Aurora Map was not correct: {data.Similarity}");
 
-            //test remove
+            // Test remove
             aurora.AuroraRemove = new KeyValuePair<int, int>(0, 2);
             aurora.AuroraRemove = new KeyValuePair<int, int>(0, 1);
             aurora.AuroraRemove = new KeyValuePair<int, int>(1, 1);
@@ -137,55 +112,39 @@ public void Aurora()
 
             data = compare.CompareImages(bmResultBase, aurora.BitmapLayerOne);
 
-            aurora.BitmapLayerOne.Save($"{SampleImagesFolder}/example.png", ImageFormat.Png);
+            aurora.BitmapLayerOne.Save(Path.Combine(_sampleImagesFolder, "example.png"), ImageFormat.Png);
 
             Assert.That(data.Similarity, Is.EqualTo(100), $"Aurora Map remove was not correct: {data.Similarity}");
         }
 
         /// <summary>
-        ///     Test Polaris.
+        /// Test Polaris.
         /// </summary>
         [Test]
-        [Apartment(ApartmentState.STA)]
         public void Polaris()
         {
-            var bmResultLayerOther = new Bitmap(Path.Combine(SampleImagesFolder.FullName, "result_layer_other.png"));
-            var bmResultBase = new Bitmap(Path.Combine(SampleImagesFolder.FullName, "result_base.png"));
+            using var bmResultLayerOther = LoadBitmap("result_layer_other.png");
+            using var bmResultBase = LoadBitmap("result_base.png");
 
             var compare = new ImageAnalysis();
 
             var polaris = new Polaris
             {
                 PolarisTextures = new Dictionary<int, Texture>
                 {
-                    {
-                        0,
-                        new Texture
-                        {
-                            Layer = 0, Id = 0, Path = Path.Combine(SampleImagesFolder.FullName, "Tile.png")
-                        }
-                    },
-                    {
-                        1,
-                        new Texture
-                        {
-                            Layer = 1, Id = 1, Path = Path.Combine(SampleImagesFolder.FullName, "layerOne.png")
-                        }
-                    },
-                    {
-                        2,
-                        new Texture
-                        {
-                            Layer = 1, Id = 1, Path = Path.Combine(SampleImagesFolder.FullName, "LayerTwo.png")
-                        }
-                    }
+                    { 0, new Texture { Layer = 0, Id = 0, Path = Path.Combine(_sampleImagesFolder, "Tile.png") } },
+                    { 1, new Texture { Layer = 1, Id = 1, Path = Path.Combine(_sampleImagesFolder, "layerOne.png") } },
+                    { 2, new Texture { Layer = 1, Id = 1, Path = Path.Combine(_sampleImagesFolder, "LayerTwo.png") } }
                 },
                 PolarisTextureSize = 100,
                 PolarisHeight = 2,
                 PolarisWidth = 3
             };
 
             polaris.Initiate();
+
+            // Note: If BitmapLayerThree is managed by Polaris and needs disposal, 
+            // do not dispose it here while it is in use.
             var blank = polaris.BitmapLayerThree;
 
             // 0
@@ -207,7 +166,7 @@ public void Polaris()
             // 5
             polaris.AddTile(new KeyValuePair<int, int>(5, 0));
 
-            polaris.BitmapLayerOne.Save($"{SampleImagesFolder}/example Polaris.png", ImageFormat.Png);
+            polaris.BitmapLayerOne.Save(Path.Combine(_sampleImagesFolder, "example Polaris.png"), ImageFormat.Png);
 
             var data = compare.CompareImages(bmResultLayerOther, polaris.BitmapLayerOne);
             Assert.That(data.Similarity, Is.EqualTo(100), $"Map Polaris was not correct: {data.Similarity}");
@@ -239,7 +198,7 @@ public void Polaris()
                 var check = lst.Equal(map[i], EnumerableCompare.IgnoreOrder);
                 if (!check)
                 {
-                    Assert.Fail("wrong map"); // Native NUnit Fail
+                    Assert.Fail("wrong map");
                 }
             }
 
@@ -255,7 +214,7 @@ public void Polaris()
             data = compare.CompareImages(blank, polaris.BitmapLayerThree);
             Assert.That(data.Similarity, Is.EqualTo(100), $"Map Polaris was not correct: {data.Similarity}");
 
-            // this is a duplicate so this should not be added
+            // This is a duplicate so this should not be added
             polaris.AddDisplay(new KeyValuePair<int, int>(0, 0));
 
             for (var i = 0; i <= 5; i++)
@@ -268,5 +227,36 @@ public void Polaris()
                 }
             }
         }
+
+        /// <summary>
+        /// Loads the bitmap.
+        /// </summary>
+        /// <param name="fileName">Name of the file.</param>
+        /// <returns>A new Bitmap object.</returns>
+        /// <exception cref="FileNotFoundException">Thrown if the file does not exist.</exception>
+        private Bitmap LoadBitmap(string fileName)
+        {
+            var path = Path.Combine(_sampleImagesFolder, fileName);
+
+            if (!File.Exists(path))
+            {
+                throw new FileNotFoundException($"Bitmap file not found: {path}");
+            }
+
+            // Check if file is empty
+            var fileInfo = new FileInfo(path);
+            if (fileInfo.Length == 0)
+            {
+                throw new InvalidDataException($"The file is 0 bytes and cannot be loaded as an image: {path}");
+            }
+
+            // Open with FileShare.ReadWrite to prevent locking issues
+            using (var stream = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.ReadWrite))
+            {
+                // We create a copy so the stream can be closed immediately
+                var bitmap = new Bitmap(stream);
+                return new Bitmap(bitmap);
+            }
+        }
     }
 }

CommonLibraryGui.Tests/Image/example Polaris.png

@@ -74,7 +74,7 @@ private async Task<bool> TrySendTcpMessageAsync(int port, string message)
                     await using var stream = client.GetStream();
                     // Important: Add NewLine (\n) so ReadLineAsync fires!
                     var data = Encoding.UTF8.GetBytes(message + Environment.NewLine);
-                    await stream.WriteAsync(data, 0, data.Length);
+                    await stream.WriteAsync(data);
                     await stream.FlushAsync();
 
                     return true; // Success!
@@ -110,7 +110,7 @@ public async Task InterfaceConstructor_ShouldUseProcessorClass()
             Assert.IsTrue(connected, "Could not connect to the server (Timeout).");
 
             // Wait for the processor to get the message (Polling with timeout)
-            string received = null;
+            string? received = null;
             for (var i = 0; i < 20; i++) // Try for 2 seconds (20 * 100ms)
             {
                 if (fakeProcessor.LastMessage != null)
@@ -167,8 +167,32 @@ public async Task Server_ShouldDisconnect_SlowClients()
 
             // Assert
             var buffer = new byte[10];
-            var bytesRead = await stream.ReadAsync(buffer, 0, buffer.Length);
-            Assert.AreEqual(0, bytesRead, "Server should have closed the connection due to timeout.");
+            var disconnected = false;
+            var timeout = DateTime.Now.AddSeconds(2);
+
+            // Poll for a bit to allow the TCP stack to finish the handshake
+            while (DateTime.Now < timeout)
+            {
+                // Try to read one byte; if the connection is closed, this will return 0 or throw
+                try
+                {
+                    var bytesRead = await stream.ReadAsync(buffer, 0, 1);
+                    if (bytesRead == 0)
+                    {
+                        disconnected = true;
+                        break;
+                    }
+                }
+                catch (Exception) // Socket might throw if connection is abruptly reset
+                {
+                    disconnected = true;
+                    break;
+                }
+
+                await Task.Delay(100); // Give the OS a moment to process the closing
+            }
+
+            Assert.IsTrue(disconnected, "Server failed to close the connection in time.");
         }
 
         /// <inheritdoc />
@@ -184,7 +208,7 @@ private class FakeLogProcessor : ILogProcessor
             /// <value>
             /// The last message.
             /// </value>
-            public string LastMessage { get; private set; }
+            public string? LastMessage { get; private set; }
 
             /// <summary>
             /// Processes the received message (e.g., save to DB, log to file).

CommonLibraryGui.Tests/Image/example.png

@@ -84,7 +84,7 @@ protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage
                 }
 
                 // Buffer content safely so we don't disrupt the stream
-                await request.Content.LoadIntoBufferAsync();
+                await request.Content.LoadIntoBufferAsync(cancellationToken);
                 var reqBody = await request.Content.ReadAsStringAsync();
                 if (!string.IsNullOrEmpty(reqBody))
                 {

Communication.Tests/SimpleLogServerTests.cs

@@ -27,21 +27,11 @@ namespace Communication
     /// </summary>
     public sealed class SimpleLogServer : IDisposable
     {
-        /// <summary>
-        /// The internal server
-        /// </summary>
-        private readonly LogCollectorServer _internalServer;
-
         /// <summary>
         /// The CTS
         /// </summary>
         private readonly CancellationTokenSource _cts;
 
-        /// <summary>
-        /// The server task
-        /// </summary>
-        private Task _serverTask;
-
         /// <summary>
         /// The TCP log server
         /// </summary>

Communication/HttpWireTracingHandler.cs

@@ -46,7 +46,7 @@ public sealed class FileLockScanner : ICommand, IRegistryProducer
         /// <summary>
         /// The store key
         /// </summary>
-        private string StoreKey = "lockedfiles";
+        private readonly string StoreKey = "lockedfiles";
 
         /// <summary>
         /// Initializes a new instance of the <see cref="FileLockScanner"/> class.