Fixes #3947 Adds Fake driver and fixes fluent tests (iteration-zero) (#4225)

* Consider width2 chars that are not IsBmp

* Apply same fix in WindowsDriver

* Explicitly use type of local variable

* Revert changes to WindowsDriver

* Assume we are running in a terminal that supports true color by default unless user explicitly forces 16

* Switch to SetAttribute and WriteConsole instead of WriteConsoleOutput for 16 color mode

* Fix some cursor issues (WIP)

* Remove concept of 'dirty rows' from v2 as its never actually used

* Remove damageRegion as it does nothing

* Make string builder to console writing simpler

* Radically simplify Write method

* Simplify conditional logic

* Simplify restoring cursor position

* Reference local variable for console buffer

* Reduce calls to ConsoleWrite by accumulating till attribute changes

* When resizing v2 16 color mode on windows, recreate the back buffer to match its size

* Fixes for VTS enabled

* Fix _lastSize never being assigned

* Fixes VTS for Force16Colors

* Fixes force16Colors in VTS

* Fixes escape sequences always echoing in non-VTS

* Force Force16Colors in non-VTS. It have a bug in adding a newline in the last line

* WIP Add base class for NetOutput

* Abstract away how we change attribute

* WIP - Make WindowsOutput use base class

* WIP working to fix set cursor position

* Remove commented out code

* Fixes legacy output mode

* Fixes size with no alt buffer supported on VTS and size restore after maximized.

* Fix set cursor which also fixes the broken surrogate pairs

* Add force parameter

* Fixes an issue that only happens with Windows Terminal when paste surrogate pairs by press Ctrl+V

* In Windows escape sequences must be sent during the lifetime of the console which is created in input handle

* Ensure flush the input buffer before reset the console

* Flush input buffer before reset console in v2win

* Fixes issue in v2net not being refreshing the menu bar at start

* Only force layout and draw on size changed.

* Fix v2net issue not draw first line by forcing set cursor position

* Set _lastCursorPosition nullable and remove bool force from set cursor position

* Remove force parameter

* Add v2 version of fake driver attribute

* Make direct replacement and wire up window resizing events

* Update casts to use V2 fake driver instead

* Adjust interfaces to expose less internals

* Fix not raising iteration event in v2

* WIP investigate what it takes to do resize and redraw using TextAlignment_Centered as example

* Sketch adding component factory

* Create relevant fake component factories

* Add window size monitor into factory

* Fake size monitor injecting

* Add helper for faking console resize in AutoInitShutdown tests

* Fix size setting in FakeDriverV2

* Switch to new method

* Fix IsLegacy becoming false when using blank constructor

* Fix for Ready not being raised when showing same top twice also fixes garbage collection issue if running millions of top levels

* Fix tests

* Remove auto init

* Restore conditional compilation stuff

* Restore 'if running unit tests' logic

* Check only for the output being specific classes for the suppression

* Fix ShadowView blowing up with index out of bounds error

* Fix resize in fluent tests

* Fix for people using Iteration call directly

* Fix more calls to iteration to use
        AutoInitShutdownAttribute.RunIteration ();

* Add comment

* Remove assumption that Run with prior view not disposed should throw

* Fix timings in Dialog_Opened_From_Another_Dialog

* Fix Zero_Buttons_Works

* Standardize and fix Button_IsDefault_True_Return_His_Index_On_Accepting

* Fix iteration counts on MessageBoxTests

* Fix WizartTests and DrawTests_Ruler

* Implement SendKeys into ConsoleDriverFacade

* Fix SendKeys in console driver facade such that FileDialogTests works
Fix when Clip is null in popover

* Add missing dispose call to test

* Fix support for Esc in facade SendKeys

* Fix AutocompleteTests

* Fix various tests

* Replace LayoutAndDraw with run iteration

* Fix draw issues

* fix draw order

* Fix run iteration calls

* Fix unit tests

* Fix SendKeys in facade.

* Manipulate upper and lower cases.

* Add IsValidInput method to the interface.

* Fix SendKeys scenario

* Fixes surrogate pairs in the label

* Make tests more sensible - they are testing draw functionality.  Callbacks do not need to happen in Iteration method

* Fix tests and harden cleanup in AutoInitShutdownAttribute v2 lifecycle dispose

* Delete extra create input call

* Fix mocks and order of exceptions thrown in Run when things are not initialized

* Revert use of `MapConsoleKeyInfoToKeyCode`

* Ignore casing as it is not what test is really about

* Clear application top and top levels before each auto init shutdown test

* Fix for unstable tests

* Restore actually working SendKeys code

* option to pass logger in fluent ctor

* restore ToArray

* Fix SendKeys method and add extension to unit test

* Leverage the EscSeqUtils.MapConsoleKeyInfo method to avoid duplicate code

* Remove unnecessary hack

* Using only KeyCode for rKeys

* Recover modifier keys in surrogate pairs

* Reformat

* Remove iteration limit for benchmarking in v2

* remove iteration delay to identify bugs

* Remove nudge to unique key and make Then run on UI thread

* fix fluid assertions

* Ensure UI operations all happen on UI thread

* Add explicit error for WaitIteration during an invoke

* Remove timeout added for debug

* Catch failing asserts better

* Fix screenshot

* Fix null ref

* Fix race condition in processing input

* Test fixing

* Standardize asserts

* Remove calls to layout and draw, remove pointless lock and enable reading Cancelled from Dialog even if it is disposed

* fix bad merge

* Make logs access threadsafe

* add extra wait to remove race between iteration end and assert

* Code cleanup

* Remove test for crash on access Cancelled after dispose as this is no longer a restriction

* Change resize console to run on UI thread - fixing race condition with redrawing

* Restore original frame rate after test

* Restore nudge to unique key

* Code Cleanup

* Fix for cascading failures when an assert fails in a specific test

* fix for bad merge

* Address PR feedback

* Move classes to seperate files and add xmldoc

* xml doc warnings

* More xml comments docs

* Fix spelling

---------

Co-authored-by: BDisp <bd.bdisp@gmail.com>
This commit is contained in:
Thomas Nind
2025-09-10 17:01:57 +01:00
committed by GitHub
parent 00aaefb962
commit 51dda7e69f
85 changed files with 1783 additions and 1130 deletions

View File

@@ -235,7 +235,7 @@ public class ConsoleDriverTests
// {
// var win = new Window ();
// Application.Begin (win);
// ((FakeDriver)Application.Driver!).SetBufferSize (20, 8);
// AutoInitShutdownAttribute.FakeResize(new Size ( (20, 8);
// System.Threading.Tasks.Task.Run (() => {
// System.Threading.Tasks.Task.Delay (500).Wait ();

View File

@@ -3,6 +3,7 @@ using System.Collections.Concurrent;
using System.Runtime.CompilerServices;
using Microsoft.Extensions.Logging;
using Moq;
using TerminalGuiFluentTesting;
namespace UnitTests.ConsoleDrivers.V2;
public class ApplicationV2Tests
@@ -12,18 +13,34 @@ public class ApplicationV2Tests
ConsoleDriver.RunningUnitTests = true;
}
private ApplicationV2 NewApplicationV2 ()
private ApplicationV2 NewApplicationV2 (V2TestDriver driver = V2TestDriver.V2Net)
{
var netInput = new Mock<INetInput> ();
SetupRunInputMockMethodToBlock (netInput);
var winInput = new Mock<IWindowsInput> ();
SetupRunInputMockMethodToBlock (winInput);
return new (
() => netInput.Object,
Mock.Of<IConsoleOutput>,
() => winInput.Object,
Mock.Of<IConsoleOutput>);
if (driver == V2TestDriver.V2Net)
{
var netInput = new Mock<INetInput> ();
SetupRunInputMockMethodToBlock (netInput);
var m = new Mock<IComponentFactory<ConsoleKeyInfo>> ();
m.Setup (f => f.CreateInput ()).Returns (netInput.Object);
m.Setup (f => f.CreateInputProcessor (It.IsAny<ConcurrentQueue<ConsoleKeyInfo>> ())).Returns (Mock.Of <IInputProcessor> ());
m.Setup (f => f.CreateOutput ()).Returns (Mock.Of<IConsoleOutput> ());
m.Setup (f => f.CreateWindowSizeMonitor (It.IsAny<IConsoleOutput> (),It.IsAny<IOutputBuffer> ())).Returns (Mock.Of<IWindowSizeMonitor> ());
return new (m.Object);
}
else
{
var winInput = new Mock<IConsoleInput<WindowsConsole.InputRecord>> ();
SetupRunInputMockMethodToBlock (winInput);
var m = new Mock<IComponentFactory<WindowsConsole.InputRecord>> ();
m.Setup (f => f.CreateInput ()).Returns (winInput.Object);
m.Setup (f => f.CreateInputProcessor (It.IsAny<ConcurrentQueue<WindowsConsole.InputRecord>> ())).Returns (Mock.Of<IInputProcessor> ());
m.Setup (f => f.CreateOutput ()).Returns (Mock.Of<IConsoleOutput> ());
m.Setup (f => f.CreateWindowSizeMonitor (It.IsAny<IConsoleOutput> (), It.IsAny<IOutputBuffer> ())).Returns (Mock.Of<IWindowSizeMonitor> ());
return new (m.Object);
}
}
[Fact]
@@ -68,7 +85,7 @@ public class ApplicationV2Tests
ApplicationImpl.ChangeInstance (orig);
}
/*
[Fact]
public void Init_ExplicitlyRequestWin ()
{
@@ -150,8 +167,8 @@ public class ApplicationV2Tests
ApplicationImpl.ChangeInstance (orig);
}
private void SetupRunInputMockMethodToBlock (Mock<IWindowsInput> winInput)
*/
private void SetupRunInputMockMethodToBlock (Mock<IConsoleInput<WindowsConsole.InputRecord>> winInput)
{
winInput.Setup (r => r.Run (It.IsAny<CancellationToken> ()))
.Callback<CancellationToken> (token =>
@@ -473,7 +490,7 @@ public class ApplicationV2Tests
return true;
}
/*
[Fact]
public void Shutdown_Called_Repeatedly_DoNotDuplicateDisposeOutput ()
{
@@ -500,6 +517,7 @@ public class ApplicationV2Tests
ApplicationImpl.ChangeInstance (orig);
}
*/
[Fact]
public void Init_Called_Repeatedly_WarnsAndIgnores ()

View File

@@ -14,15 +14,15 @@ public class MainLoopCoordinatorTests
var beforeLogger = Logging.Logger;
Logging.Logger = mockLogger.Object;
var c = new MainLoopCoordinator<char> (new TimedEvents (),
// Runs on a separate thread (input thread)
() => throw new Exception ("Crash on boot"),
var m = new Mock<IComponentFactory<char>> ();
// Runs on a separate thread (input thread)
m.Setup (f => f.CreateInput ()).Throws (new Exception ("Crash on boot"));
var c = new MainLoopCoordinator<char> (new TimedEvents (),
// Rest runs on main thread
new ConcurrentQueue<char> (),
Mock.Of <IInputProcessor>(),
()=>Mock.Of<IConsoleOutput>(),
Mock.Of<IMainLoop<char>>());
Mock.Of<IMainLoop<char>>(),
m.Object);
// StartAsync boots the main loop and the input thread. But if the input class bombs
// on startup it is important that the exception surface at the call site and not lost

View File

@@ -18,10 +18,20 @@ public class MainLoopTTests
Assert.Throws<NotInitializedException> (() => m.AnsiRequestScheduler);
Assert.Throws<NotInitializedException> (() => m.WindowSizeMonitor);
var componentFactory = new Mock<IComponentFactory<int>> ();
componentFactory.Setup (
c => c.CreateWindowSizeMonitor (
It.IsAny<IConsoleOutput> (),
It.IsAny<IOutputBuffer> ()))
.Returns (Mock.Of <IWindowSizeMonitor>());
m.Initialize (new TimedEvents (),
new ConcurrentQueue<int> (),
Mock.Of <IInputProcessor>(),
Mock.Of<IConsoleOutput>());
Mock.Of<IConsoleOutput>(),
componentFactory.Object
);
Assert.NotNull (m.TimedEvents);
Assert.NotNull (m.InputBuffer);