Files
Terminal.Gui/Tests/UnitTests/ConsoleDrivers/V2/ApplicationV2Tests.cs
BDisp b3aa9c5717 Fixes #4223. SendKeys scenario is broken and does not support surrogate pairs (#4224)
* Fixes #4223. SendKeys scenario is broken and does not support surrogate pairs

* Fix v2 application tests

* Fixes v2 _input being null before initialization

* Add a limit of iterations to avoid loop forever

* Simplify unit tests failure fix

* 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>

* Fixes #4231. NativeAot project throws when running the published executable (#4232)

* Fixes #4231. NativeAot project throws when running the published executable

* Code cleanup

---------

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

* Fixes #4236. CursesDriver erase the previous text under the cursor when moving if Force16Colors is true (#4237)

* Fixes #4236. CursesDriver erase the previous text under the cursor when moving if Force16Colors is true

* Still trying to fix fluent unit tests

* Fix nullable issue

---------

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

* Need to use KeyCode to return the desired effect with control keys

* Revert v2 drivers changes

* Fix nullable warnings

* Fixes #4025. Application.Driver.SendKeys should be retired

---------

Co-authored-by: Tig <tig@users.noreply.github.com>
Co-authored-by: Thomas Nind <31306100+tznind@users.noreply.github.com>
2025-09-12 20:21:51 -06:00

623 lines
20 KiB
C#

#nullable enable
using System.Collections.Concurrent;
using System.Runtime.CompilerServices;
using Microsoft.Extensions.Logging;
using Moq;
using TerminalGuiFluentTesting;
namespace UnitTests.ConsoleDrivers.V2;
public class ApplicationV2Tests
{
public ApplicationV2Tests ()
{
ConsoleDriver.RunningUnitTests = true;
}
private ApplicationV2 NewApplicationV2 (V2TestDriver driver = V2TestDriver.V2Net)
{
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]
public void Init_CreatesKeybindings ()
{
var orig = ApplicationImpl.Instance;
var v2 = NewApplicationV2 ();
ApplicationImpl.ChangeInstance (v2);
Application.KeyBindings.Clear ();
Assert.Empty (Application.KeyBindings.GetBindings ());
v2.Init ();
Assert.NotEmpty (Application.KeyBindings.GetBindings ());
v2.Shutdown ();
ApplicationImpl.ChangeInstance (orig);
}
[Fact]
public void Init_DriverIsFacade ()
{
var orig = ApplicationImpl.Instance;
var v2 = NewApplicationV2 ();
ApplicationImpl.ChangeInstance (v2);
Assert.Null (Application.Driver);
v2.Init ();
Assert.NotNull (Application.Driver);
var type = Application.Driver.GetType ();
Assert.True (type.IsGenericType);
Assert.True (type.GetGenericTypeDefinition () == typeof (ConsoleDriverFacade<>));
v2.Shutdown ();
Assert.Null (Application.Driver);
ApplicationImpl.ChangeInstance (orig);
}
/*
[Fact]
public void Init_ExplicitlyRequestWin ()
{
var orig = ApplicationImpl.Instance;
Assert.Null (Application.Driver);
var netInput = new Mock<INetInput> (MockBehavior.Strict);
var netOutput = new Mock<IConsoleOutput> (MockBehavior.Strict);
var winInput = new Mock<IWindowsInput> (MockBehavior.Strict);
var winOutput = new Mock<IConsoleOutput> (MockBehavior.Strict);
winInput.Setup (i => i.Initialize (It.IsAny<ConcurrentQueue<WindowsConsole.InputRecord>> ()))
.Verifiable (Times.Once);
SetupRunInputMockMethodToBlock (winInput);
winInput.Setup (i => i.Dispose ())
.Verifiable (Times.Once);
winOutput.Setup (i => i.Dispose ())
.Verifiable (Times.Once);
var v2 = new ApplicationV2 (
() => netInput.Object,
() => netOutput.Object,
() => winInput.Object,
() => winOutput.Object);
ApplicationImpl.ChangeInstance (v2);
Assert.Null (Application.Driver);
v2.Init (null, "v2win");
Assert.NotNull (Application.Driver);
var type = Application.Driver.GetType ();
Assert.True (type.IsGenericType);
Assert.True (type.GetGenericTypeDefinition () == typeof (ConsoleDriverFacade<>));
v2.Shutdown ();
Assert.Null (Application.Driver);
winInput.VerifyAll ();
ApplicationImpl.ChangeInstance (orig);
}
[Fact]
public void Init_ExplicitlyRequestNet ()
{
var orig = ApplicationImpl.Instance;
var netInput = new Mock<INetInput> (MockBehavior.Strict);
var netOutput = new Mock<IConsoleOutput> (MockBehavior.Strict);
var winInput = new Mock<IWindowsInput> (MockBehavior.Strict);
var winOutput = new Mock<IConsoleOutput> (MockBehavior.Strict);
netInput.Setup (i => i.Initialize (It.IsAny<ConcurrentQueue<ConsoleKeyInfo>> ()))
.Verifiable (Times.Once);
SetupRunInputMockMethodToBlock (netInput);
netInput.Setup (i => i.Dispose ())
.Verifiable (Times.Once);
netOutput.Setup (i => i.Dispose ())
.Verifiable (Times.Once);
var v2 = new ApplicationV2 (
() => netInput.Object,
() => netOutput.Object,
() => winInput.Object,
() => winOutput.Object);
ApplicationImpl.ChangeInstance (v2);
Assert.Null (Application.Driver);
v2.Init (null, "v2net");
Assert.NotNull (Application.Driver);
var type = Application.Driver.GetType ();
Assert.True (type.IsGenericType);
Assert.True (type.GetGenericTypeDefinition () == typeof (ConsoleDriverFacade<>));
v2.Shutdown ();
Assert.Null (Application.Driver);
netInput.VerifyAll ();
ApplicationImpl.ChangeInstance (orig);
}
*/
private void SetupRunInputMockMethodToBlock (Mock<IConsoleInput<WindowsConsole.InputRecord>> winInput)
{
winInput.Setup (r => r.Run (It.IsAny<CancellationToken> ()))
.Callback<CancellationToken> (token =>
{
// Simulate an infinite loop that checks for cancellation
while (!token.IsCancellationRequested)
{
// Perform the action that should repeat in the loop
// This could be some mock behavior or just an empty loop depending on the context
}
})
.Verifiable (Times.Once);
}
private void SetupRunInputMockMethodToBlock (Mock<INetInput> netInput)
{
netInput.Setup (r => r.Run (It.IsAny<CancellationToken> ()))
.Callback<CancellationToken> (token =>
{
// Simulate an infinite loop that checks for cancellation
while (!token.IsCancellationRequested)
{
// Perform the action that should repeat in the loop
// This could be some mock behavior or just an empty loop depending on the context
}
})
.Verifiable (Times.Once);
}
[Fact]
public void NoInitThrowOnRun ()
{
var orig = ApplicationImpl.Instance;
Assert.Null (Application.Driver);
var app = NewApplicationV2 ();
ApplicationImpl.ChangeInstance (app);
var ex = Assert.Throws<NotInitializedException> (() => app.Run (new Window ()));
Assert.Equal ("Run cannot be accessed before Initialization", ex.Message);
app.Shutdown();
ApplicationImpl.ChangeInstance (orig);
}
[Fact]
public void InitRunShutdown_Top_Set_To_Null_After_Shutdown ()
{
var orig = ApplicationImpl.Instance;
var v2 = NewApplicationV2 ();
ApplicationImpl.ChangeInstance (v2);
v2.Init ();
var timeoutToken = v2.AddTimeout (TimeSpan.FromMilliseconds (150),
() =>
{
if (Application.Top != null)
{
Application.RequestStop ();
return false;
}
return false;
}
);
Assert.Null (Application.Top);
// Blocks until the timeout call is hit
v2.Run (new Window ());
// We returned false above, so we should not have to remove the timeout
Assert.False(v2.RemoveTimeout (timeoutToken));
Assert.NotNull (Application.Top);
Application.Top?.Dispose ();
v2.Shutdown ();
Assert.Null (Application.Top);
ApplicationImpl.ChangeInstance (orig);
}
[Fact]
public void InitRunShutdown_Running_Set_To_False ()
{
var orig = ApplicationImpl.Instance;
var v2 = NewApplicationV2 ();
ApplicationImpl.ChangeInstance (v2);
v2.Init ();
Toplevel top = new Window ()
{
Title = "InitRunShutdown_Running_Set_To_False"
};
var timeoutToken = v2.AddTimeout (TimeSpan.FromMilliseconds (150),
() =>
{
Assert.True (top!.Running);
if (Application.Top != null)
{
Application.RequestStop ();
return false;
}
return false;
}
);
Assert.False (top!.Running);
// Blocks until the timeout call is hit
v2.Run (top);
// We returned false above, so we should not have to remove the timeout
Assert.False (v2.RemoveTimeout (timeoutToken));
Assert.False (top!.Running);
// BUGBUG: Shutdown sets Top to null, not End.
//Assert.Null (Application.Top);
Application.Top?.Dispose ();
v2.Shutdown ();
ApplicationImpl.ChangeInstance (orig);
}
[Fact]
public void InitRunShutdown_End_Is_Called ()
{
var orig = ApplicationImpl.Instance;
var v2 = NewApplicationV2 ();
ApplicationImpl.ChangeInstance (v2);
Assert.Null (Application.Top);
Assert.Null (Application.Driver);
v2.Init ();
Toplevel top = new Window ();
// BUGBUG: Both Closed and Unloaded are called from End; what's the difference?
int closedCount = 0;
top.Closed
+= (_, a) =>
{
closedCount++;
};
int unloadedCount = 0;
top.Unloaded
+= (_, a) =>
{
unloadedCount++;
};
var timeoutToken = v2.AddTimeout (TimeSpan.FromMilliseconds (150),
() =>
{
Assert.True (top!.Running);
if (Application.Top != null)
{
Application.RequestStop ();
return false;
}
return false;
}
);
Assert.Equal (0, closedCount);
Assert.Equal (0, unloadedCount);
// Blocks until the timeout call is hit
v2.Run (top);
Assert.Equal (1, closedCount);
Assert.Equal (1, unloadedCount);
// We returned false above, so we should not have to remove the timeout
Assert.False (v2.RemoveTimeout (timeoutToken));
Application.Top?.Dispose ();
v2.Shutdown ();
Assert.Equal (1, closedCount);
Assert.Equal (1, unloadedCount);
ApplicationImpl.ChangeInstance (orig);
}
[Fact]
public void InitRunShutdown_QuitKey_Quits ()
{
var orig = ApplicationImpl.Instance;
var v2 = NewApplicationV2 ();
ApplicationImpl.ChangeInstance (v2);
v2.Init ();
Toplevel top = new Window ()
{
Title = "InitRunShutdown_QuitKey_Quits"
};
var timeoutToken = v2.AddTimeout (TimeSpan.FromMilliseconds (150),
() =>
{
Assert.True (top!.Running);
if (Application.Top != null)
{
Application.RaiseKeyDownEvent (Application.QuitKey);
}
return false;
}
);
Assert.False (top!.Running);
// Blocks until the timeout call is hit
v2.Run (top);
// We returned false above, so we should not have to remove the timeout
Assert.False (v2.RemoveTimeout (timeoutToken));
Assert.False (top!.Running);
Assert.NotNull (Application.Top);
top.Dispose ();
v2.Shutdown ();
Assert.Null (Application.Top);
ApplicationImpl.ChangeInstance (orig);
}
[Fact]
public void InitRunShutdown_Generic_IdleForExit ()
{
var orig = ApplicationImpl.Instance;
var v2 = NewApplicationV2 ();
ApplicationImpl.ChangeInstance (v2);
v2.Init ();
v2.AddTimeout (TimeSpan.Zero, IdleExit);
Assert.Null (Application.Top);
// Blocks until the timeout call is hit
v2.Run<Window> ();
Assert.NotNull (Application.Top);
Application.Top?.Dispose ();
v2.Shutdown ();
Assert.Null (Application.Top);
ApplicationImpl.ChangeInstance (orig);
}
[Fact]
public void Shutdown_Closing_Closed_Raised ()
{
var orig = ApplicationImpl.Instance;
var v2 = NewApplicationV2 ();
ApplicationImpl.ChangeInstance (v2);
v2.Init ();
int closing = 0;
int closed = 0;
var t = new Toplevel ();
t.Closing
+= (_, a) =>
{
// Cancel the first time
if (closing == 0)
{
a.Cancel = true;
}
closing++;
Assert.Same (t, a.RequestingTop);
};
t.Closed
+= (_, a) =>
{
closed++;
Assert.Same (t, a.Toplevel);
};
v2.AddTimeout(TimeSpan.Zero, IdleExit);
// Blocks until the timeout call is hit
v2.Run (t);
Application.Top?.Dispose ();
v2.Shutdown ();
ApplicationImpl.ChangeInstance (orig);
Assert.Equal (2, closing);
Assert.Equal (1, closed);
}
private bool IdleExit ()
{
if (Application.Top != null)
{
Application.RequestStop ();
return true;
}
return true;
}
/*
[Fact]
public void Shutdown_Called_Repeatedly_DoNotDuplicateDisposeOutput ()
{
var orig = ApplicationImpl.Instance;
var netInput = new Mock<INetInput> ();
SetupRunInputMockMethodToBlock (netInput);
Mock<IConsoleOutput>? outputMock = null;
var v2 = new ApplicationV2 (
() => netInput.Object,
() => (outputMock = new Mock<IConsoleOutput> ()).Object,
Mock.Of<IWindowsInput>,
Mock.Of<IConsoleOutput>);
ApplicationImpl.ChangeInstance (v2);
v2.Init (null, "v2net");
v2.Shutdown ();
outputMock!.Verify (o => o.Dispose (), Times.Once);
ApplicationImpl.ChangeInstance (orig);
}
*/
[Fact]
public void Init_Called_Repeatedly_WarnsAndIgnores ()
{
var orig = ApplicationImpl.Instance;
var v2 = NewApplicationV2 ();
ApplicationImpl.ChangeInstance (v2);
Assert.Null (Application.Driver);
v2.Init ();
Assert.NotNull (Application.Driver);
var mockLogger = new Mock<ILogger> ();
var beforeLogger = Logging.Logger;
Logging.Logger = mockLogger.Object;
v2.Init ();
v2.Init ();
mockLogger.Verify (
l => l.Log (LogLevel.Error,
It.IsAny<EventId> (),
It.Is<It.IsAnyType> ((v, t) => v.ToString () == "Init called multiple times without shutdown, ignoring."),
It.IsAny<Exception> (),
It.IsAny<Func<It.IsAnyType, Exception, string>> ()!)
, Times.Exactly (2));
v2.Shutdown ();
// Restore the original null logger to be polite to other tests
Logging.Logger = beforeLogger;
ApplicationImpl.ChangeInstance (orig);
}
[Fact]
public void Open_Calls_ContinueWith_On_UIThread ()
{
var orig = ApplicationImpl.Instance;
var v2 = NewApplicationV2 ();
ApplicationImpl.ChangeInstance (v2);
v2.Init ();
var b = new Button ();
bool result = false;
b.Accepting +=
(_, _) =>
{
Task.Run (() =>
{
Task.Delay (300).Wait ();
}).ContinueWith (
(t, _) =>
{
// no longer loading
Application.Invoke (() =>
{
result = true;
Application.RequestStop ();
});
},
TaskScheduler.FromCurrentSynchronizationContext ());
};
v2.AddTimeout (TimeSpan.FromMilliseconds (150),
() =>
{
// Run asynchronous logic inside Task.Run
if (Application.Top != null)
{
b.NewKeyDownEvent (Key.Enter);
b.NewKeyUpEvent (Key.Enter);
}
return false;
});
Assert.Null (Application.Top);
var w = new Window ()
{
Title = "Open_CallsContinueWithOnUIThread"
};
w.Add (b);
// Blocks until the timeout call is hit
v2.Run (w);
Assert.NotNull (Application.Top);
Application.Top?.Dispose ();
v2.Shutdown ();
Assert.Null (Application.Top);
ApplicationImpl.ChangeInstance (orig);
Assert.True (result);
}
}