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>
This commit is contained in:
BDisp
2025-09-13 03:21:51 +01:00
committed by GitHub
parent 18b602e980
commit b3aa9c5717
13 changed files with 80 additions and 660 deletions

View File

@@ -182,6 +182,7 @@ public class ApplicationV2Tests
})
.Verifiable (Times.Once);
}
private void SetupRunInputMockMethodToBlock (Mock<INetInput> netInput)
{
netInput.Setup (r => r.Run (It.IsAny<CancellationToken> ()))
@@ -361,7 +362,6 @@ public class ApplicationV2Tests
ApplicationImpl.ChangeInstance (orig);
}
[Fact]
public void InitRunShutdown_QuitKey_Quits ()
{
@@ -407,7 +407,6 @@ public class ApplicationV2Tests
ApplicationImpl.ChangeInstance (orig);
}
[Fact]
public void InitRunShutdown_Generic_IdleForExit ()
{
@@ -511,7 +510,6 @@ public class ApplicationV2Tests
v2.Init (null, "v2net");
v2.Shutdown ();
v2.Shutdown ();
outputMock!.Verify (o => o.Dispose (), Times.Once);

View File

@@ -22,17 +22,15 @@ public class FileDialogTests ()
//pressing enter will complete the current selection
// unless the event cancels the confirm
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
Assert.Equal (cancel, dlg.Canceled);
dlg.Dispose ();
}
[Theory]
[InlineData ("Bob", "csv")]
[InlineData ("𝔹ob", "CSV")]
[Fact]
[AutoInitShutdown]
public void DirectTyping_Allowed (string path, string extension)
public void DirectTyping_Allowed ()
{
FileDialog dlg = GetInitializedFileDialog ();
TextField tf = dlg.SubViews.OfType<TextField> ().First (t => t.HasFocus);
@@ -48,15 +46,15 @@ public class FileDialogTests ()
);
// continue typing the rest of the path
Send (path);
Send ('.', ConsoleKey.OemPeriod);
Send (extension);
Send ("Bob");
Application.RaiseKeyDownEvent ('.');
Send ("csv");
Assert.True (dlg.Canceled);
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
Assert.False (dlg.Canceled);
Assert.Equal ($"{path}.{extension}", Path.GetFileName (dlg.Path));
Assert.Equal ("Bob.csv", Path.GetFileName (dlg.Path));
dlg.Dispose ();
}
@@ -81,14 +79,14 @@ public class FileDialogTests ()
Assert.Equal ("x", Path.GetFileName (dlg.Path));
// complete auto typing
Send ('\t', ConsoleKey.Tab);
Application.RaiseKeyDownEvent ('\t');
// but do not close dialog
Assert.True (dlg.Canceled);
Assert.EndsWith ("xx" + Path.DirectorySeparatorChar, dlg.Path);
// press enter again to confirm the dialog
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
Assert.False (dlg.Canceled);
Assert.EndsWith ("xx" + Path.DirectorySeparatorChar, dlg.Path);
dlg.Dispose ();
@@ -115,15 +113,15 @@ public class FileDialogTests ()
Assert.True (dlg.Canceled);
//pressing enter while search focused should not confirm path
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
Assert.True (dlg.Canceled);
// tabbing out of search
Send ('\t', ConsoleKey.Tab);
Application.RaiseKeyDownEvent ('\t');
//should allow enter to confirm path
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
// Dialog has not yet been confirmed with a choice
Assert.False (dlg.Canceled);
@@ -194,21 +192,21 @@ public class FileDialogTests ()
Assert.IsType<TableView> (dlg.MostFocused);
// Try to toggle '..'
Send (' ', ConsoleKey.Spacebar);
Send ('v', ConsoleKey.DownArrow);
Application.RaiseKeyDownEvent (' ');
Application.RaiseKeyDownEvent (Key.CursorDown);
// Toggle subfolder
Send (' ', ConsoleKey.Spacebar);
Application.RaiseKeyDownEvent (' ');
Assert.True (dlg.Canceled);
if (acceptWithEnter)
{
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
}
else
{
Send ('O', ConsoleKey.O, false, true);
Application.RaiseKeyDownEvent ('O');
}
Assert.False (dlg.Canceled);
@@ -250,20 +248,20 @@ public class FileDialogTests ()
Assert.IsType<TableView> (dlg.MostFocused);
// Move selection to subfolder
Send ('v', ConsoleKey.DownArrow);
Application.RaiseKeyDownEvent (Key.CursorDown);
// Toggle subfolder
Send (' ', ConsoleKey.Spacebar);
Application.RaiseKeyDownEvent (' ');
Assert.True (dlg.Canceled);
if (acceptWithEnter)
{
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
}
else
{
Send ('O', ConsoleKey.O, false, true);
Application.RaiseKeyDownEvent (Key.O.WithAlt);
}
Assert.False (dlg.Canceled);
@@ -303,9 +301,9 @@ public class FileDialogTests ()
Assert.IsType<TableView> (dlg.MostFocused);
// Move selection to subfolder
Send ('v', ConsoleKey.DownArrow);
Application.RaiseKeyDownEvent (Key.CursorDown);
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
// Path should update to the newly opened folder
AssertIsTheSubfolder (dlg.Path);
@@ -347,13 +345,13 @@ public class FileDialogTests ()
Assert.IsType<TableView> (dlg.MostFocused);
// Should be selecting ..
Send ('v', ConsoleKey.DownArrow);
Application.RaiseKeyDownEvent (Key.CursorDown);
// Down to the directory
Assert.True (dlg.Canceled);
// Alt+O to open (enter would just navigate into the child dir)
Send ('O', ConsoleKey.O, false, true);
Application.RaiseKeyDownEvent (Key.O.WithAlt);
Assert.False (dlg.Canceled);
AssertIsTheSubfolder (dlg.Path);
@@ -374,8 +372,8 @@ public class FileDialogTests ()
// whe first opening the text field will have select all on
// so to add to current path user must press End or right
Send ('>', ConsoleKey.LeftArrow);
Send ('>', ConsoleKey.RightArrow);
Application.RaiseKeyDownEvent (Key.CursorLeft);
Application.RaiseKeyDownEvent (Key.CursorRight);
Send ("subfolder");
@@ -383,7 +381,7 @@ public class FileDialogTests ()
Assert.True (dlg.Canceled);
// Now it has
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
Assert.False (dlg.Canceled);
AssertIsTheSubfolder (dlg.Path);
dlg.Dispose ();
@@ -765,23 +763,11 @@ public class FileDialogTests ()
private bool IsWindows () { return RuntimeInformation.IsOSPlatform (OSPlatform.Windows); }
private void Send (char ch, ConsoleKey ck, bool shift = false, bool alt = false, bool control = false)
{
Application.Driver?.SendKeys (ch, ck, shift, alt, control);
}
private void Send (string chars)
{
foreach (char ch in chars)
{
ConsoleKeyInfo consoleKeyInfo = EscSeqUtils.MapConsoleKeyInfo (new (ch, ConsoleKey.None, false, false, false));
Application.Driver?.SendKeys (
ch,
consoleKeyInfo.Key,
(consoleKeyInfo.Modifiers & ConsoleModifiers.Shift) != 0,
(consoleKeyInfo.Modifiers & ConsoleModifiers.Alt) != 0,
(consoleKeyInfo.Modifiers & ConsoleModifiers.Control) != 0);
Application.RaiseKeyDownEvent (ch);
}
}
@@ -789,11 +775,11 @@ public class FileDialogTests ()
{
if (Path.DirectorySeparatorChar == '/')
{
Send ('/', ConsoleKey.Separator);
Application.RaiseKeyDownEvent ('/');
}
else
{
Send ('\\', ConsoleKey.Separator);
Application.RaiseKeyDownEvent ('\\');
}
}

View File

@@ -12,7 +12,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
TextField tf = GetTextFieldsInViewSuggesting ("fish");
// f is typed and suggestion is "fish"
Application.Driver?.SendKeys ('f', ConsoleKey.F, false, false, false);
Application.RaiseKeyDownEvent ('f');
View.SetClipToScreen ();
tf.Draw ();
View.SetClipToScreen ();
@@ -21,7 +21,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Equal ("f", tf.Text);
// When cancelling autocomplete
Application.Driver?.SendKeys ('e', ConsoleKey.Escape, false, false, false);
Application.RaiseKeyDownEvent (Key.Esc);
// Suggestion should disappear
tf.Draw ();
@@ -33,7 +33,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Same (tf, Application.Top.Focused);
// But can tab away
Application.Driver?.SendKeys ('\t', ConsoleKey.Tab, false, false, false);
Application.RaiseKeyDownEvent ('\t');
Assert.NotSame (tf, Application.Top.Focused);
Application.Top.Dispose ();
}
@@ -45,7 +45,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
TextField tf = GetTextFieldsInViewSuggesting ("fish");
// f is typed and suggestion is "fish"
Application.Driver?.SendKeys ('f', ConsoleKey.F, false, false, false);
Application.RaiseKeyDownEvent ('f');
View.SetClipToScreen ();
tf.Draw ();
View.SetClipToScreen ();
@@ -54,7 +54,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Equal ("f", tf.Text);
// When cancelling autocomplete
Application.Driver?.SendKeys ('\0', ConsoleKey.Escape, false, false, false);
Application.RaiseKeyDownEvent (Key.Esc);
// Suggestion should disappear
tf.Draw ();
@@ -62,7 +62,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Equal ("f", tf.Text);
// Should reappear when you press next letter
Application.Driver?.SendKeys ('i', ConsoleKey.I, false, false, false);
Application.RaiseKeyDownEvent (Key.I);
View.SetClipToScreen ();
tf.Draw ();
View.SetClipToScreen ();
@@ -74,14 +74,14 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
[Theory]
[AutoInitShutdown]
[InlineData (ConsoleKey.UpArrow)]
[InlineData (ConsoleKey.DownArrow)]
public void TestAutoAppend_CycleSelections (ConsoleKey cycleKey)
[InlineData (KeyCode.CursorUp)]
[InlineData (KeyCode.CursorDown)]
public void TestAutoAppend_CycleSelections (KeyCode cycleKey)
{
TextField tf = GetTextFieldsInViewSuggesting ("fish", "friend");
// f is typed and suggestion is "fish"
Application.Driver?.SendKeys ('f', ConsoleKey.F, false, false, false);
Application.RaiseKeyDownEvent ('f');
View.SetClipToScreen ();
tf.Draw ();
View.SetClipToScreen ();
@@ -90,7 +90,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Equal ("f", tf.Text);
// When cycling autocomplete
Application.Driver?.SendKeys (' ', cycleKey, false, false, false);
Application.RaiseKeyDownEvent (cycleKey);
View.SetClipToScreen ();
tf.Draw ();
@@ -100,7 +100,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Equal ("f", tf.Text);
// Should be able to cycle in circles endlessly
Application.Driver?.SendKeys (' ', cycleKey, false, false, false);
Application.RaiseKeyDownEvent (cycleKey);
View.SetClipToScreen ();
tf.Draw ();
View.SetClipToScreen ();
@@ -117,7 +117,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
TextField tf = GetTextFieldsInViewSuggesting ("fish");
// f is typed and suggestion is "fish"
Application.Driver?.SendKeys ('f', ConsoleKey.F, false, false, false);
Application.RaiseKeyDownEvent ('f');
View.SetClipToScreen ();
tf.Draw ();
View.SetClipToScreen ();
@@ -126,8 +126,8 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Equal ("f", tf.Text);
// add a space then go back 1
Application.Driver?.SendKeys (' ', ConsoleKey.Spacebar, false, false, false);
Application.Driver?.SendKeys ('<', ConsoleKey.LeftArrow, false, false, false);
Application.RaiseKeyDownEvent (' ');
Application.RaiseKeyDownEvent (Key.CursorLeft);
View.SetClipToScreen ();
tf.Draw ();
@@ -143,7 +143,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
TextField tf = GetTextFieldsInViewSuggesting ("fish");
// f is typed and suggestion is "fish"
Application.Driver?.SendKeys ('f', ConsoleKey.F, false, false, false);
Application.RaiseKeyDownEvent ('f');
View.SetClipToScreen ();
tf.Draw ();
View.SetClipToScreen ();
@@ -152,7 +152,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Equal ("f", tf.Text);
// x is typed and suggestion should disappear
Application.Driver?.SendKeys ('x', ConsoleKey.X, false, false, false);
Application.RaiseKeyDownEvent (Key.X);
View.SetClipToScreen ();
tf.Draw ();
DriverAssert.AssertDriverContentsAre ("fx", output);
@@ -190,7 +190,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Equal ("my f", tf.Text);
// When tab completing the case of the whole suggestion should be applied
Application.Driver?.SendKeys ('\t', ConsoleKey.Tab, false, false, false);
Application.RaiseKeyDownEvent ('\t');
View.SetClipToScreen ();
tf.Draw ();
DriverAssert.AssertDriverContentsAre ("my FISH", output);
@@ -223,7 +223,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
DriverAssert.AssertDriverContentsAre ("fish", output);
Assert.Equal ("f", tf.Text);
Application.Driver?.SendKeys ('\t', ConsoleKey.Tab, false, false, false);
Application.RaiseKeyDownEvent ('\t');
View.SetClipToScreen ();
tf.Draw ();
@@ -234,7 +234,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Same (tf, Application.Top.Focused);
// Second tab should move focus (nothing to autocomplete)
Application.Driver?.SendKeys ('\t', ConsoleKey.Tab, false, false, false);
Application.RaiseKeyDownEvent ('\t');
Assert.NotSame (tf, Application.Top.Focused);
Application.Top.Dispose ();
}
@@ -249,7 +249,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
TextField tf = GetTextFieldsInViewSuggesting (overspillUsing);
// f is typed we should only see 'f' up to size of View (10)
Application.Driver?.SendKeys ('f', ConsoleKey.F, false, false, false);
Application.RaiseKeyDownEvent ('f');
View.SetClipToScreen ();
tf.Draw ();
View.SetClipToScreen ();

View File

@@ -146,7 +146,7 @@ public class TextFieldTests (ITestOutputHelper output)
// Caption has no effect when focused
tf.Caption = caption;
Application.Driver?.SendKeys ('\t', ConsoleKey.Tab, false, false, false);
Application.RaiseKeyDownEvent ('\t');
Assert.False (tf.HasFocus);
tf.Draw ();
@@ -166,7 +166,7 @@ public class TextFieldTests (ITestOutputHelper output)
TextField tf = GetTextFieldsInView ();
tf.Caption = caption;
Application.Driver?.SendKeys ('\t', ConsoleKey.Tab, false, false, false);
Application.RaiseKeyDownEvent ('\t');
Assert.False (tf.HasFocus);
tf.Draw ();
@@ -186,7 +186,7 @@ public class TextFieldTests (ITestOutputHelper output)
DriverAssert.AssertDriverContentsAre ("", output);
tf.Caption = "Enter txt";
Application.Driver?.SendKeys ('\t', ConsoleKey.Tab, false, false, false);
Application.RaiseKeyDownEvent ('\t');
// Caption should appear when not focused and no text
Assert.False (tf.HasFocus);
@@ -218,7 +218,7 @@ public class TextFieldTests (ITestOutputHelper output)
tf.Draw ();
DriverAssert.AssertDriverContentsAre ("", output);
Application.Driver?.SendKeys ('\t', ConsoleKey.Tab, false, false, false);
Application.RaiseKeyDownEvent ('\t');
Assert.False (tf.HasFocus);
View.SetClipToScreen ();