Fixes #4391. Weird situation where ForceDriver with args doesn't persists on open scenario (#4395)

* Fixes #4391. Weird situation where ForceDriver with args doesn't persists on open scenario

* Prevents change ForceDriver if app it's already initialized and allowing also initialize with driver instead of only by driver name.

* Add dispose into FakeDriverBase and reset ForceDriver

* Moving test to Application folder

* Fix unit test

* Remove unnecessary GlobalTestSetup

* Add GC.SuppressFinalize

* Revert "Add GC.SuppressFinalize"

This reverts commit 2bd7cd7.

* Reset MouseGrabView

* Avoid CI warnings

* Add GlobalTestSetup in all test that use Application

* Trying to fix unit test

* Reverting scope changes

* Remove UICatalog testing Run

* Force re-run CI test

* Fix merge errors

* Fix ansi for the red background color code

* Fix more ANSI color code unit tests

---------

Co-authored-by: Tig <tig@users.noreply.github.com>

Author: BDisp

Examples/UICatalog/UICatalog.cs

@@ -55,7 +55,9 @@ namespace UICatalog;
 /// </remarks>
 public class UICatalog
 {
-    private static string? _forceDriver = null;
+    private static string? _forceDriver;
+    private static string? _uiCatalogDriver;
+    private static string? _scenarioDriver;
 
     public static string LogFilePath { get; set; } = string.Empty;
     public static LoggingLevelSwitch LogLevelSwitch { get; } = new ();
@@ -194,6 +196,8 @@ private static int Main (string [] args)
 
         UICatalogMain (Options);
 
+        Debug.Assert (Application.ForceDriver == string.Empty);
+
         return 0;
     }
 
@@ -255,7 +259,9 @@ private static Scenario RunUICatalogTopLevel ()
 
         Application.Init (driverName: _forceDriver);
 
-        var top = Application.Run<UICatalogTop> ();
+        _uiCatalogDriver = Application.Driver!.GetName ();
+
+        Toplevel top = Application.Run<UICatalogTop> ();
         top.Dispose ();
         Application.Shutdown ();
         VerifyObjectsWereDisposed ();
@@ -421,6 +427,8 @@ private static void UICatalogMain (UICatalogCommandLineOptions options)
             Application.InitializedChanged += ApplicationOnInitializedChanged;
 #endif
 
+            Application.ForceDriver = _forceDriver;
+
             scenario.Main ();
             scenario.Dispose ();
 
@@ -439,6 +447,8 @@ void ApplicationOnInitializedChanged (object? sender, EventArgs<bool> e)
                 if (e.Value)
                 {
                     sw.Start ();
+                    _scenarioDriver = Application.Driver!.GetName ();
+                    Debug.Assert (_scenarioDriver == _uiCatalogDriver);
                 }
                 else
                 {

Terminal.Gui/App/Application.Driver.cs

@@ -28,7 +28,21 @@ public static bool Force16Colors
     public static string ForceDriver
     {
         get => ApplicationImpl.Instance.ForceDriver;
-        set => ApplicationImpl.Instance.ForceDriver = value;
+        set
+        {
+            if (!string.IsNullOrEmpty (ApplicationImpl.Instance.ForceDriver) && value != Driver?.GetName ())
+            {
+                // ForceDriver cannot be changed if it has a valid value
+                return;
+            }
+
+            if (ApplicationImpl.Instance.Initialized && value != Driver?.GetName ())
+            {
+                throw new InvalidOperationException ($"The {nameof (ForceDriver)} can only be set before initialized.");
+            }
+
+            ApplicationImpl.Instance.ForceDriver = value;
+        }
     }
 
     /// <inheritdoc cref="IApplication.Sixel"/>

Terminal.Gui/App/ApplicationImpl.Driver.cs

@@ -34,7 +34,7 @@ private void CreateDriver (string? driverName)
         bool factoryIsFake = _componentFactory is IComponentFactory<ConsoleKeyInfo>;
 
         // Then check driverName
-        bool nameIsWindows = driverName?.Contains ("win", StringComparison.OrdinalIgnoreCase) ?? false;
+        bool nameIsWindows = driverName?.Contains ("windows", StringComparison.OrdinalIgnoreCase) ?? false;
         bool nameIsDotNet = driverName?.Contains ("dotnet", StringComparison.OrdinalIgnoreCase) ?? false;
         bool nameIsUnix = driverName?.Contains ("unix", StringComparison.OrdinalIgnoreCase) ?? false;
         bool nameIsFake = driverName?.Contains ("fake", StringComparison.OrdinalIgnoreCase) ?? false;

Terminal.Gui/App/ApplicationImpl.Lifecycle.cs

@@ -33,8 +33,8 @@ public void Init (string? driverName = null)
             _driverName = ForceDriver;
         }
 
-       // Debug.Assert (Navigation is null);
-       // Navigation = new ();
+        // Debug.Assert (Navigation is null);
+        // Navigation = new ();
 
         //Debug.Assert (Popover is null);
         //Popover = new ();
@@ -62,7 +62,7 @@ public void Init (string? driverName = null)
             _keyboard.PrevTabGroupKey = existingPrevTabGroupKey;
         }
 
-        CreateDriver (driverName ?? _driverName);
+        CreateDriver (_driverName);
         Screen = Driver!.Screen;
         Initialized = true;
 
@@ -145,9 +145,13 @@ private static void AssertNoEventSubscribers (string eventName, Delegate? eventD
     }
 #endif
 
+    private bool _isResetingState;
+
     /// <inheritdoc/>
     public void ResetState (bool ignoreDisposed = false)
     {
+        _isResetingState = true;
+
         // Shutdown is the bookend for Init. As such it needs to clean up all resources
         // Init created. Apps that do any threading will need to code defensively for this.
         // e.g. see Issue #537
@@ -231,7 +235,14 @@ public void ResetState (bool ignoreDisposed = false)
         // === 9. Clear graphics ===
         Sixel.Clear ();
 
-        // === 10. Reset synchronization context ===
+        // === 10. Reset ForceDriver ===
+        // Note: ForceDriver and Force16Colors are reset
+        // If they need to persist across Init/Shutdown cycles
+        // then the user of the library should manage that state
+        Force16Colors = false;
+        ForceDriver = string.Empty;
+
+        // === 11. Reset synchronization context ===
         // IMPORTANT: Always reset sync context, even if not initialized
         // This ensures cleanup works correctly even if Shutdown is called without Init
         // Reset synchronization context to allow the user to run async/await,
@@ -240,8 +251,7 @@ public void ResetState (bool ignoreDisposed = false)
         // (https://github.com/gui-cs/Terminal.Gui/issues/1084).
         SynchronizationContext.SetSynchronizationContext (null);
 
-        // Note: ForceDriver and Force16Colors are NOT reset; 
-        // they need to persist across Init/Shutdown cycles
+        _isResetingState = false;
     }
 
     /// <summary>

Terminal.Gui/App/Mouse/MouseImpl.cs

@@ -254,6 +254,7 @@ public void ResetState ()
         // Do not clear LastMousePosition; Popover's require it to stay set with last mouse pos.
         CachedViewsUnderMouse.Clear ();
         MouseEvent = null;
+        MouseGrabView = null;
     }
 
     // Mouse grab functionality merged from MouseGrabHandler

Tests/UnitTests/FakeDriverBase.cs

@@ -4,7 +4,7 @@ namespace UnitTests;
 ///     Enables tests to create a FakeDriver for testing purposes.
 /// </summary>
 [Collection ("Global Test Setup")]
-public abstract class FakeDriverBase
+public abstract class FakeDriverBase : IDisposable
 {
     /// <summary>
     ///     Creates a new FakeDriver instance with the specified buffer size.
@@ -19,14 +19,20 @@ protected static IDriver CreateFakeDriver (int width = 80, int height = 25)
         var output = new FakeOutput ();
 
         DriverImpl driver = new (
-                                                          new FakeInputProcessor (null),
-                                                          new OutputBufferImpl (),
-                                                          output,
-                                                          new AnsiRequestScheduler (new AnsiResponseParser ()),
-                                                          new SizeMonitorImpl (output));
+                                 new FakeInputProcessor (null),
+                                 new OutputBufferImpl (),
+                                 output,
+                                 new AnsiRequestScheduler (new AnsiResponseParser ()),
+                                 new SizeMonitorImpl (output));
 
         driver.SetScreenSize (width, height);
 
         return driver;
     }
+
+    /// <inheritdoc />
+    public void Dispose ()
+    {
+        Application.ResetState (true);
+    }
 }

Tests/UnitTests/TestsAllViews.cs

@@ -1,6 +1,5 @@
 #nullable enable
 using System.Reflection;
-using System.Drawing;
 
 namespace UnitTests;
 

Tests/UnitTestsParallelizable/Application/ApplicationForceDriverTests.cs

@@ -0,0 +1,41 @@
+using UnitTests;
+
+namespace UnitTests_Parallelizable.ApplicationTests;
+
+public class ApplicationForceDriverTests : FakeDriverBase
+{
+    [Fact]
+    public void ForceDriver_Does_Not_Changes_If_It_Has_Valid_Value ()
+    {
+        Assert.False (Application.Initialized);
+        Assert.Null (Application.Driver);
+        Assert.Equal (string.Empty, Application.ForceDriver);
+
+        Application.ForceDriver = "fake";
+        Assert.Equal ("fake", Application.ForceDriver);
+
+        Application.ForceDriver = "dotnet";
+        Assert.Equal ("fake", Application.ForceDriver);
+    }
+
+    [Fact]
+    public void ForceDriver_Throws_If_Initialized_Changed_To_Another_Value ()
+    {
+        IDriver driver = CreateFakeDriver ();
+
+        Assert.False (Application.Initialized);
+        Assert.Null (Application.Driver);
+        Assert.Equal (string.Empty, Application.ForceDriver);
+
+        Application.Init (driverName: "fake");
+        Assert.True (Application.Initialized);
+        Assert.NotNull (Application.Driver);
+        Assert.Equal ("fake", Application.Driver.GetName ());
+        Assert.Equal (string.Empty, Application.ForceDriver);
+
+        Assert.Throws<InvalidOperationException> (() => Application.ForceDriver = "dotnet");
+
+        Application.ForceDriver = "fake";
+        Assert.Equal ("fake", Application.ForceDriver);
+    }
+}

Tests/UnitTestsParallelizable/Application/ApplicationPopoverTests.cs

@@ -1,4 +1,4 @@
-#nullable enable
+#nullable enable
 using Moq;
 using Terminal.Gui.App;