Files
Terminal.Gui/Tests/UnitTests/Text/AutocompleteTests.cs
Thomas Nind 51dda7e69f 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>
2025-09-10 10:01:57 -06:00

307 lines
13 KiB
C#

using System.Text.RegularExpressions;
using UnitTests;
using Xunit.Abstractions;
namespace Terminal.Gui.TextTests;
public class AutocompleteTests (ITestOutputHelper output)
{
[Fact]
[AutoInitShutdown]
public void CursorLeft_CursorRight_Mouse_Button_Pressed_Does_Not_Show_Popup ()
{
AutoInitShutdownAttribute.FakeResize (new Size (50,5));
var tv = new TextView { Width = 50, Height = 5, Text = "This a long line and against TextView." };
var g = (SingleWordSuggestionGenerator)tv.Autocomplete.SuggestionGenerator;
g.AllSuggestions = Regex.Matches (tv.Text, "\\w+")
.Select (s => s.Value)
.Distinct ()
.ToList ();
Toplevel top = new ();
top.Add (tv);
RunState rs = Application.Begin (top);
for (var i = 0; i < 7; i++)
{
Assert.True (tv.NewKeyDownEvent (Key.CursorRight));
top.SetNeedsDraw ();
AutoInitShutdownAttribute.RunIteration ();
if (i < 4 || i > 5)
{
DriverAssert.AssertDriverContentsWithFrameAre (
@"
This a long line and against TextView.",
output
);
}
else
{
DriverAssert.AssertDriverContentsWithFrameAre (
@"
This a long line and against TextView.
and
against ",
output
);
}
}
Assert.True (
tv.NewMouseEvent (
new () { Position = new (6, 0), Flags = MouseFlags.Button1Pressed }
)
);
top.SetNeedsDraw ();
AutoInitShutdownAttribute.RunIteration ();
DriverAssert.AssertDriverContentsWithFrameAre (
@"
This a long line and against TextView.
and
against ",
output
);
Assert.True (tv.NewKeyDownEvent (Key.G));
top.SetNeedsDraw ();
AutoInitShutdownAttribute.RunIteration ();
DriverAssert.AssertDriverContentsWithFrameAre (
@"
This ag long line and against TextView.
against ",
output
);
Assert.True (tv.NewKeyDownEvent (Key.CursorLeft));
top.SetNeedsDraw ();
AutoInitShutdownAttribute.RunIteration ();
DriverAssert.AssertDriverContentsWithFrameAre (
@"
This ag long line and against TextView.
against ",
output
);
Assert.True (tv.NewKeyDownEvent (Key.CursorLeft));
top.SetNeedsDraw ();
AutoInitShutdownAttribute.RunIteration ();
DriverAssert.AssertDriverContentsWithFrameAre (
@"
This ag long line and against TextView.
against ",
output
);
Assert.True (tv.NewKeyDownEvent (Key.CursorLeft));
top.SetNeedsDraw ();
AutoInitShutdownAttribute.RunIteration ();
DriverAssert.AssertDriverContentsWithFrameAre (
@"
This ag long line and against TextView.",
output
);
for (var i = 0; i < 3; i++)
{
Assert.True (tv.NewKeyDownEvent (Key.CursorRight));
top.SetNeedsDraw ();
AutoInitShutdownAttribute.RunIteration ();
DriverAssert.AssertDriverContentsWithFrameAre (
@"
This ag long line and against TextView.
against ",
output
);
}
Assert.True (tv.NewKeyDownEvent (Key.Backspace));
top.SetNeedsDraw ();
AutoInitShutdownAttribute.RunIteration ();
DriverAssert.AssertDriverContentsWithFrameAre (
@"
This a long line and against TextView.
and
against ",
output
);
Assert.True (tv.NewKeyDownEvent (Key.N));
top.SetNeedsDraw ();
AutoInitShutdownAttribute.RunIteration ();
DriverAssert.AssertDriverContentsWithFrameAre (
@"
This an long line and against TextView.
and ",
output
);
Assert.True (tv.NewKeyDownEvent (Key.CursorRight));
top.SetNeedsDraw ();
AutoInitShutdownAttribute.RunIteration ();
DriverAssert.AssertDriverContentsWithFrameAre (
@"
This an long line and against TextView.",
output
);
Assert.Empty (tv.Autocomplete.Suggestions);
Assert.False (((PopupAutocomplete)tv.Autocomplete)._popup.Visible);
top.Dispose ();
}
[Fact]
[AutoInitShutdown]
public void KeyBindings_Command ()
{
var tv = new TextView { Width = 10, Height = 2, Text = " Fortunately super feature." };
Toplevel top = new ();
top.Add (tv);
Application.Begin (top);
Assert.Equal (Point.Empty, tv.CursorPosition);
Assert.NotNull (tv.Autocomplete);
var g = (SingleWordSuggestionGenerator)tv.Autocomplete.SuggestionGenerator;
Assert.Empty (g.AllSuggestions);
g.AllSuggestions = Regex.Matches (tv.Text, "\\w+")
.Select (s => s.Value)
.Distinct ()
.ToList ();
Assert.Equal (3, g.AllSuggestions.Count);
Assert.Equal ("Fortunately", g.AllSuggestions [0]);
Assert.Equal ("super", g.AllSuggestions [1]);
Assert.Equal ("feature", g.AllSuggestions [^1]);
Assert.Equal (0, tv.Autocomplete.SelectedIdx);
Assert.Empty (tv.Autocomplete.Suggestions);
Assert.True (tv.NewKeyDownEvent (Key.F.WithShift));
top.Draw ();
Assert.Equal ("F Fortunately super feature.", tv.Text);
Assert.Equal (new (1, 0), tv.CursorPosition);
Assert.Equal (2, tv.Autocomplete.Suggestions.Count);
Assert.Equal ("Fortunately", tv.Autocomplete.Suggestions [0].Replacement);
Assert.Equal ("feature", tv.Autocomplete.Suggestions [^1].Replacement);
Assert.Equal (0, tv.Autocomplete.SelectedIdx);
Assert.Equal ("Fortunately", tv.Autocomplete.Suggestions [tv.Autocomplete.SelectedIdx].Replacement);
Assert.True (tv.NewKeyDownEvent (Key.CursorDown));
top.Draw ();
Assert.Equal ("F Fortunately super feature.", tv.Text);
Assert.Equal (new (1, 0), tv.CursorPosition);
Assert.Equal (2, tv.Autocomplete.Suggestions.Count);
Assert.Equal ("Fortunately", tv.Autocomplete.Suggestions [0].Replacement);
Assert.Equal ("feature", tv.Autocomplete.Suggestions [^1].Replacement);
Assert.Equal (1, tv.Autocomplete.SelectedIdx);
Assert.Equal ("feature", tv.Autocomplete.Suggestions [tv.Autocomplete.SelectedIdx].Replacement);
Assert.True (tv.NewKeyDownEvent (Key.CursorDown));
top.Draw ();
Assert.Equal ("F Fortunately super feature.", tv.Text);
Assert.Equal (new (1, 0), tv.CursorPosition);
Assert.Equal (2, tv.Autocomplete.Suggestions.Count);
Assert.Equal ("Fortunately", tv.Autocomplete.Suggestions [0].Replacement);
Assert.Equal ("feature", tv.Autocomplete.Suggestions [^1].Replacement);
Assert.Equal (0, tv.Autocomplete.SelectedIdx);
Assert.Equal ("Fortunately", tv.Autocomplete.Suggestions [tv.Autocomplete.SelectedIdx].Replacement);
Assert.True (tv.NewKeyDownEvent (Key.CursorUp));
top.Draw ();
Assert.Equal ("F Fortunately super feature.", tv.Text);
Assert.Equal (new (1, 0), tv.CursorPosition);
Assert.Equal (2, tv.Autocomplete.Suggestions.Count);
Assert.Equal ("Fortunately", tv.Autocomplete.Suggestions [0].Replacement);
Assert.Equal ("feature", tv.Autocomplete.Suggestions [^1].Replacement);
Assert.Equal (1, tv.Autocomplete.SelectedIdx);
Assert.Equal ("feature", tv.Autocomplete.Suggestions [tv.Autocomplete.SelectedIdx].Replacement);
Assert.True (tv.NewKeyDownEvent (Key.CursorUp));
top.Draw ();
Assert.Equal ("F Fortunately super feature.", tv.Text);
Assert.Equal (new (1, 0), tv.CursorPosition);
Assert.Equal (2, tv.Autocomplete.Suggestions.Count);
Assert.Equal ("Fortunately", tv.Autocomplete.Suggestions [0].Replacement);
Assert.Equal ("feature", tv.Autocomplete.Suggestions [^1].Replacement);
Assert.Equal (0, tv.Autocomplete.SelectedIdx);
Assert.Equal ("Fortunately", tv.Autocomplete.Suggestions [tv.Autocomplete.SelectedIdx].Replacement);
Assert.True (tv.Autocomplete.Visible);
top.Draw ();
Assert.True (tv.NewKeyDownEvent (new (tv.Autocomplete.CloseKey)));
Assert.Equal ("F Fortunately super feature.", tv.Text);
Assert.Equal (new (1, 0), tv.CursorPosition);
Assert.Empty (tv.Autocomplete.Suggestions);
Assert.Equal (3, g.AllSuggestions.Count);
Assert.False (tv.Autocomplete.Visible);
tv.PositionCursor ();
Assert.True (tv.NewKeyDownEvent (new (tv.Autocomplete.Reopen)));
Assert.Equal ("F Fortunately super feature.", tv.Text);
Assert.Equal (new (1, 0), tv.CursorPosition);
Assert.Equal (2, tv.Autocomplete.Suggestions.Count);
Assert.Equal (3, g.AllSuggestions.Count);
Assert.True (tv.NewKeyDownEvent (new (tv.Autocomplete.SelectionKey)));
tv.PositionCursor ();
Assert.Equal ("Fortunately Fortunately super feature.", tv.Text);
Assert.Equal (new (11, 0), tv.CursorPosition);
Assert.Empty (tv.Autocomplete.Suggestions);
Assert.Equal (3, g.AllSuggestions.Count);
Assert.False (tv.Autocomplete.Visible);
top.Dispose ();
}
[Fact]
public void Test_GenerateSuggestions_Simple ()
{
var ac = new TextViewAutocomplete ();
((SingleWordSuggestionGenerator)ac.SuggestionGenerator).AllSuggestions =
new () { "fish", "const", "Cobble" };
var tv = new TextView ();
tv.InsertText ("co");
ac.HostControl = tv;
ac.GenerateSuggestions (
new (
Cell.ToCellList (tv.Text),
2
)
);
Assert.Equal (2, ac.Suggestions.Count);
Assert.Equal ("const", ac.Suggestions [0].Title);
Assert.Equal ("Cobble", ac.Suggestions [1].Title);
}
[Fact]
public void TestSettingSchemeOnAutocomplete ()
{
var tv = new TextView ();
// to begin with we should be using the default menu scheme
Assert.Same (SchemeManager.GetSchemes () ["Menu"], tv.Autocomplete.Scheme);
// allocate a new custom scheme
tv.Autocomplete.Scheme = new ()
{
Normal = new (Color.Black, Color.Blue), Focus = new (Color.Black, Color.Cyan)
};
// should be separate instance
Assert.NotSame (SchemeManager.GetSchemes () ["Menu"], tv.Autocomplete.Scheme);
// with the values we set on it
Assert.Equal (new (Color.Black), tv.Autocomplete.Scheme.Normal.Foreground);
Assert.Equal (new (Color.Blue), tv.Autocomplete.Scheme.Normal.Background);
Assert.Equal (new (Color.Black), tv.Autocomplete.Scheme.Focus.Foreground);
Assert.Equal (new (Color.Cyan), tv.Autocomplete.Scheme.Focus.Background);
}
}