Files
Terminal.Gui/UnitTests/Views/TextValidateFieldTests.cs
Tig dcb3b359ad Fixes #2926 - Refactor KeyEvent and KeyEventEventArgs to simplify (#2927)
* Adds basic MainLoop unit tests

* Remove WinChange action from Curses

* Remove WinChange action from Curses

* Remove ProcessInput action from Windows MainLoop

* Simplified MainLoop/ConsoleDriver by making MainLoop internal and moving impt fns to Application

* Modernized Terminal resize events

* Modernized Terminal resize events

* Removed un used property

* for _isWindowsTerminal devenv->wininit; not sure what changed

* Modernized mouse/keyboard events (Action->EventHandler)

* Updated OnMouseEvent API docs

* Using WT_SESSION to detect WT

* removes hacky GetParentProcess

* Updates to fix #2634 (clear last line)

* removes hacky GetParentProcess2

* Addressed mac resize issue

* Addressed mac resize issue

* Removes ConsoleDriver.PrepareToRun, has Init return MainLoop

* Removes unneeded Attribute methods

* Removed GetProcesssName

* Removed GetProcesssName

* Refactored KeyEvent and KeyEventEventArgs into a single class

* Revert "Refactored KeyEvent and KeyEventEventArgs into a single class"

This reverts commit 88a00658db.

* Fixed key repeat issue; reverted stupidity on 1049/1047 confusion

* Updated CSI API Docs

* merge

* Rearranged Event.cs to Keyboard.cs and Mouse.cs

* Renamed KeyEventEventArgs KeyEventArgs

* temp renamed KeyEvent OldKeyEvent

* Merged KeyEvent into KeyEventArgs

* Renamed Application.ProcessKey members

* Renamed Application.ProcessKey members

* Renamed Application.ProcessKey members

* Added Responder.KeyPressed

* Removed unused references

* Fixed arg naming

* InvokeKeybindings->InvokeKeyBindings

* InvokeKeybindings->InvokeKeyBindings

* Fixed unit tests fail

* More progress on refactoring key input; still broken and probably wrong

* Moved OnKeyPressed out of Responder and made ProcessKeyPrssed non-virtual

* Updated API docs

* Moved key handling from Responder to View

* Updated API docs

* Updated HotKey API docs

* Updated shortcut API docs

* Fixed responder unit tests

* Removed Shortcut from View as it is not used

* Removed unneeded OnHotKey override from Button

* Fixed BackTab logic

* Button now uses Key Bindings exclusively

* Button now uses Key Bindings exclusively

* Updated keyboard.md docs

* Fixed unit tests to account for Toplevel handling default button

* Added View.InvokeCommand API

* Modernized RadioGroup

* Removed ColdKey

* Modernized (partially) StatusBar

* Worked around FileDialog issue with Ctrl-F

* Fixed driver unit test; view must be focused to reciev key pressed

* Application code cleanup

* Start on updaing menu

* Menu now mostly works

* Menu Select refinement

* Fixed known menu bugs!

* Enabled HotKey to cause focus- experimental

* Fixes #3022 & adds unit test to prove it

* Actually Fixes #3022 & adds unit test to prove it

* Working through hotkey issues

* Misc fixes

* removed hot/cold key stuff from Keys scenario

* Fixed scenarios

* Simplified shortcut string handling

* Modernized Checkbox

* Modernized TileView

* Updated API docs

* Updated API docs

* attempting to publish v2 docs

* Revert "attempting to publish v2 docs"

This reverts commit 59dcec111b.

* Playing with api docs

* Removed Key.BackTab

* Removed Caps/Scroll/Numlock

* Partial removal of keymodifiers - unit tests pass

* Partial removal of keymodifiers - broke netdriver somewhere

* WindowsDriver & added KeyEventArgsTests

* Fixing menu shortcut/hotkeys - broke Menu.cs into separate files

* Fixed MenuBar!

* Finished modernizing Menu/MenuBar

* Removed Key.a-z. Broke lots of stuff

* checkout@v4

* progress on key mapping and formatting

* VK tests are still failing

* Fixed some unit tests

* Added Hotkey and Keybinding unit tests

* fixed unit test

* All unit tests pass again...

* Fixed broken unit tests

* KeyEventArgs.KeyValue -> AsRune

* Fixed bugs. Still some broken

* Added KeyEventArgs.IsAlpha. Added KeyEventArgs.cast ops. Fixed bugs. Unit tests pass

* Fixed WindowsDriver

* Oops.

* Refactoring based on bdisp's help. Not complete!

* removed calling into subviews from OnKeyBindings

* removed calling into subviews from OnKeyBindings

* Improved View KeyEvent unit tests

* More hotkey unit tests

* BIg change - Got rid of KeyPress w/in Application/Drivers

* Unit tests now pass again

* Refreshed API docs

* Better HotKey logic. More progress. Getting close.

* Fixed handling of shifted chars like ö

* Minor code cleanup

* Minor code cleanup2

* Why is build Action failing?

* Why is build Action failing??

* upgraded to .net8 to try to fix weird CI/CD build errors

* upgraded to .net8 to try to fix weird CI/CD build errors2

* Disabling TextViewTests to diagnose build errors

* reenable TextViewTests to diagnose build errors

* Arrrrrrg

* Merged v2_develop

* Fixed uppercase accented keys in WindowsDriver

* Fixed key binding api docs

* Experimental impl of CommandScope.SubViews for MenuBar

* Removed dead code from application.cs

* Removed dead code from application.cs

* Removed dead code from ConsoleDriver.cs

* Cleaned up some key binding stuff

* Disabled Alt to activate menu for now

* Updated label commands

* Fixed menu bugs. Upgraded menu unit tests

* Fixed unit tests

* Working on NetDriver

* fixed netdriver

* Fixed issues called out by @bdisp CR

* fixed CursesDriver

* added todo to netdriver

* Cherry picked treeview test fix 1b415e5

* Fix NetDriver.

* CommandScope->KeyBindingScope

* Address some tznind feedback

* Refactored KeyBindings big time!

* Added key consts to KeyEventArgs and renamed Key to ConsoleDriverKey

* Fixed some API docs

* Moved ConsoleDriverKey to ConsoleDriver.cs

* Renamed Key->ConsoleDriverKey

* Renamed Key->ConsoleDriverKey

* Renamed Key->ConsoleDriverKey

* renamed file I forgot to rename before

* Updated name and API docs of KeyEventArgs.isAlpha

* Fixed issues with OnKeyUp not doing the right thing.

* Fixed MainLoop.Running never being used

* Fixed MainLoop.Running never being used - unit tests

* Claned up BUGBUG comments

* Disabled a unit test to see why ci/cd tests are failing

* Removed defunct commented code

* Removed more defunct commented code

* Re-eanbled unit test; jsut removing one test case...

* Disabled more...

* Renambed Global->Applicaton and updated scope API docs

* Disabled more unit tests...

* Removed dead code

* Disabled more unit tests...2

* Disabled more unit tests...3

* Renambed Global->Applicaton and updated scope API docs 2

* Added more KeyBinding scope tests

* Added more KeyBinding scope tests2

* ConsoleDriverKey too long. Key too ambiguous. Settled on KeyCode. (Partialy because eventually I want to intro a class named Key).

* KeyEventArgs improvements. cast to Rune must be explicit as it's lossy

* Fixed warnings

* Renamed KeyEventArgs to Key... progress on fixing broken stuff that resulted

* Fix ConsoleKeyMapping bugs.

* Fix NetDriver issue from converting a lower case to a upper case.

* Started migration to Key from KeyCode - e.g. made HotKeys all consistent.

* Fixed build warnings

* Added key defns to Key

* KeyBindings now uses Key vs. KeyCode

* Verified by tweaking UICatalog

* Fixed treeview test ... again

* Renamed ProcessKeyDown/Up to NewKeyDown/Up and OnKeyPressed to OnProcessKeyDown to make things more clear

* Added test AllViews_KeyDown_All_EventsFire unit tests and fixed a few Views that were wrong

* fixed stupid KeyUp event bug

* If key not handled, return false for datefield

* dotnet test --no-restore --verbosity diag

* dotnet test --blame

* run tests on windows

* Fix TestVKPacket unit test and move it to ConsoleKeyMappingTests.cs file.

* Remove unnecessary commented code.

* Tweaked unit tests and removed Key.BareKey

* Fixed little details and updated api docs

* updated api docs

* AddKeyBindingsForHotKey: KeyCode->Key

* Cleaned up more old KeyCode usages. Added TODOs

---------

Co-authored-by: BDisp <bd.bdisp@gmail.com>
2023-12-16 12:04:23 -07:00

568 lines
16 KiB
C#

using System;
using System.Reflection;
using System.Text.RegularExpressions;
using Terminal.Gui.TextValidateProviders;
using Xunit;
namespace Terminal.Gui.ViewsTests {
// TODO: These tests shouild not rely on AutoInitShutdown / Application
public class TextValidateField_NET_Provider_Tests {
[Fact]
[AutoInitShutdown]
public void Initialized_With_Cursor_On_First_Editable_Character ()
{
// *
// 0123456789
var field = new TextValidateField (new NetMaskedTextProvider ("--(0000)--")) {
TextAlignment = TextAlignment.Centered,
Width = 20
};
field.NewKeyDownEvent (new (KeyCode.D1));
Assert.Equal ("--(1___)--", field.Provider.DisplayText);
Assert.Equal ("--(1 )--", field.Text);
}
[Fact]
[AutoInitShutdown]
public void Input_Ilegal_Character ()
{
// *
// 0123456789
var field = new TextValidateField (new NetMaskedTextProvider ("--(0000)--")) {
TextAlignment = TextAlignment.Centered,
Width = 20
};
field.NewKeyDownEvent (new (KeyCode.A));
Assert.Equal ("--( )--", field.Text);
Assert.Equal ("--(____)--", field.Provider.DisplayText);
Assert.False (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void Home_Key_First_Editable_Character ()
{
// *
// 0123456789
var field = new TextValidateField (new NetMaskedTextProvider ("--(0000)--")) {
TextAlignment = TextAlignment.Centered,
Width = 20
};
field.NewKeyDownEvent (new (KeyCode.CursorRight));
field.NewKeyDownEvent (new (KeyCode.CursorRight));
field.NewKeyDownEvent (new (KeyCode.Home));
field.NewKeyDownEvent (new (KeyCode.D1));
Assert.Equal ("--(1___)--", field.Provider.DisplayText);
Assert.Equal ("--(1 )--", field.Text);
Assert.False (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void End_Key_Last_Editable_Character ()
{
// *
// 0123456789
var field = new TextValidateField (new NetMaskedTextProvider ("--(0000)--")) {
TextAlignment = TextAlignment.Centered,
Width = 20
};
field.NewKeyDownEvent (new (KeyCode.End));
field.NewKeyDownEvent (new (KeyCode.D1));
Assert.Equal ("--(___1)--", field.Provider.DisplayText);
Assert.Equal ("--( 1)--", field.Text);
Assert.False (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void Right_Key_Stops_In_Last_Editable_Character ()
{
// *
// 0123456789
var field = new TextValidateField (new NetMaskedTextProvider ("--(0000)--")) {
TextAlignment = TextAlignment.Centered,
Width = 20
};
for (int i = 0; i < 10; i++) {
field.NewKeyDownEvent (new (KeyCode.CursorRight));
}
field.NewKeyDownEvent (new (KeyCode.D1));
Assert.Equal ("--(___1)--", field.Provider.DisplayText);
Assert.Equal ("--( 1)--", field.Text);
Assert.False (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void Left_Key_Stops_In_First_Editable_Character ()
{
// *
// 0123456789
var field = new TextValidateField (new NetMaskedTextProvider ("--(0000)--")) {
TextAlignment = TextAlignment.Centered,
Width = 20
};
for (int i = 0; i < 10; i++) {
field.NewKeyDownEvent (new (KeyCode.CursorLeft));
}
field.NewKeyDownEvent (new (KeyCode.D1));
Assert.Equal ("--(1___)--", field.Provider.DisplayText);
Assert.Equal ("--(1 )--", field.Text);
Assert.False (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void When_Valid_Is_Valid_True ()
{
// ****
// 0123456789
var field = new TextValidateField (new NetMaskedTextProvider ("--(0000)--")) {
TextAlignment = TextAlignment.Centered,
Width = 20
};
field.NewKeyDownEvent (new (KeyCode.D1));
Assert.Equal ("--(1 )--", field.Text);
Assert.False (field.IsValid);
field.NewKeyDownEvent (new (KeyCode.D2));
Assert.Equal ("--(12 )--", field.Text);
Assert.False (field.IsValid);
field.NewKeyDownEvent (new (KeyCode.D3));
Assert.Equal ("--(123 )--", field.Text);
Assert.False (field.IsValid);
field.NewKeyDownEvent (new (KeyCode.D4));
Assert.Equal ("--(1234)--", field.Text);
Assert.True (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void Insert_Skips_Non_Editable_Characters ()
{
// ** **
// 01234567890
var field = new TextValidateField (new NetMaskedTextProvider ("--(00-00)--")) {
TextAlignment = TextAlignment.Centered,
Width = 20
};
field.NewKeyDownEvent (new (KeyCode.D1));
Assert.Equal ("--(1_-__)--", field.Provider.DisplayText);
Assert.False (field.IsValid);
field.NewKeyDownEvent (new (KeyCode.D2));
Assert.Equal ("--(12-__)--", field.Provider.DisplayText);
Assert.False (field.IsValid);
field.NewKeyDownEvent (new (KeyCode.D3));
Assert.Equal ("--(12-3_)--", field.Provider.DisplayText);
Assert.False (field.IsValid);
field.NewKeyDownEvent (new (KeyCode.D4));
Assert.Equal ("--(12-34)--", field.Provider.DisplayText);
Assert.True (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void Initial_Value_Exact_Valid ()
{
// ****
// 0123456789
var field = new TextValidateField (new NetMaskedTextProvider ("--(0000)--") { Text = "1234" }) {
TextAlignment = TextAlignment.Centered,
Width = 20
};
Assert.Equal ("--(1234)--", field.Text);
Assert.True (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void Initial_Value_Bigger_Than_Mask_Discarded ()
{
// ****
// 0123456789
var field = new TextValidateField (new NetMaskedTextProvider ("--(0000)--") { Text = "12345" }) {
TextAlignment = TextAlignment.Centered,
Width = 20
};
Assert.Equal ("--(____)--", field.Provider.DisplayText);
Assert.Equal ("--( )--", field.Text);
Assert.False (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void Initial_Value_Smaller_Than_Mask_Accepted ()
{
// ****
// 0123456789
var field = new TextValidateField (new NetMaskedTextProvider ("--(0000)--") { Text = "123" }) {
TextAlignment = TextAlignment.Centered,
Width = 20
};
Assert.Equal ("--(123_)--", field.Provider.DisplayText);
Assert.Equal ("--(123 )--", field.Text);
Assert.False (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void Delete_Key_Doesnt_Move_Cursor ()
{
// ****
// 0123456789
var field = new TextValidateField (new NetMaskedTextProvider ("--(0000)--") { Text = "1234" }) {
TextAlignment = TextAlignment.Centered,
Width = 20
};
Assert.Equal ("--(1234)--", field.Provider.DisplayText);
Assert.True (field.IsValid);
field.NewKeyDownEvent (new (KeyCode.Delete));
field.NewKeyDownEvent (new (KeyCode.Delete));
field.NewKeyDownEvent (new (KeyCode.Delete));
Assert.Equal ("--(_234)--", field.Provider.DisplayText);
Assert.False (field.IsValid);
field.NewKeyDownEvent (new (KeyCode.CursorRight));
field.NewKeyDownEvent (new (KeyCode.CursorRight));
field.NewKeyDownEvent (new (KeyCode.Delete));
field.NewKeyDownEvent (new (KeyCode.Delete));
field.NewKeyDownEvent (new (KeyCode.Delete));
Assert.Equal ("--(_2_4)--", field.Provider.DisplayText);
Assert.False (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void Backspace_Key_Deletes_Previous_Character ()
{
// ****
// 0123456789
var field = new TextValidateField (new NetMaskedTextProvider ("--(0000)--") { Text = "1234" }) {
TextAlignment = TextAlignment.Centered,
Width = 20
};
// Go to the end.
field.NewKeyDownEvent (new (KeyCode.End));
field.NewKeyDownEvent (new (KeyCode.Backspace));
Assert.Equal ("--(12_4)--", field.Provider.DisplayText);
Assert.False (field.IsValid);
field.NewKeyDownEvent (new (KeyCode.Backspace));
Assert.Equal ("--(1__4)--", field.Provider.DisplayText);
Assert.False (field.IsValid);
field.NewKeyDownEvent (new (KeyCode.Backspace));
Assert.Equal ("--(___4)--", field.Provider.DisplayText);
Assert.False (field.IsValid);
// One more
field.NewKeyDownEvent (new (KeyCode.Backspace));
Assert.Equal ("--(___4)--", field.Provider.DisplayText);
Assert.False (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void Set_Text_After_Initialization ()
{
// ****
// 0123456789
var field = new TextValidateField (new NetMaskedTextProvider ("--(0000)--")) {
TextAlignment = TextAlignment.Left,
Width = 30
};
field.Text = "1234";
Assert.Equal ("--(1234)--", field.Text);
Assert.True (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void Changing_The_Mask_Tries_To_Keep_The_Previous_Text ()
{
// ****
// 0123456789
var field = new TextValidateField (new NetMaskedTextProvider ("--(0000)--")) {
TextAlignment = TextAlignment.Left,
Width = 30
};
field.Text = "1234";
Assert.Equal ("--(1234)--", field.Text);
Assert.True (field.IsValid);
var provider = field.Provider as NetMaskedTextProvider;
provider.Mask = "--------(00000000)--------";
Assert.Equal ("--------(1234____)--------", field.Provider.DisplayText);
Assert.False (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void MouseClick_Right_X_Greater_Than_Text_Width_Goes_To_Last_Editable_Position ()
{
// ****
// 0123456789
var field = new TextValidateField (new NetMaskedTextProvider ("--(0000)--")) {
TextAlignment = TextAlignment.Left,
Width = 30
};
field.NewKeyDownEvent (new (KeyCode.D1));
Assert.Equal ("--(1___)--", field.Provider.DisplayText);
Assert.False (field.IsValid);
field.MouseEvent (new MouseEvent () { X = 25, Flags = MouseFlags.Button1Pressed });
field.NewKeyDownEvent (new (KeyCode.D1));
Assert.Equal ("--(1__1)--", field.Provider.DisplayText);
Assert.False (field.IsValid);
}
}
public class TextValidateField_Regex_Provider_Tests {
[Fact]
[AutoInitShutdown]
public void Input_Without_Validate_On_Input ()
{
var field = new TextValidateField (new TextRegexProvider ("^[0-9][0-9][0-9]$") { ValidateOnInput = false }) {
Width = 20
};
field.NewKeyDownEvent (new (KeyCode.D1));
Assert.Equal ("1", field.Text);
Assert.False (field.IsValid);
field.NewKeyDownEvent (new (KeyCode.D2));
Assert.Equal ("12", field.Text);
Assert.False (field.IsValid);
field.NewKeyDownEvent (new (KeyCode.D3));
Assert.Equal ("123", field.Text);
Assert.True (field.IsValid);
field.NewKeyDownEvent (new (KeyCode.D4));
Assert.Equal ("1234", field.Text);
Assert.False (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void Input_With_Validate_On_Input_Set_Text ()
{
var field = new TextValidateField (new TextRegexProvider ("^[0-9][0-9][0-9]$")) {
Width = 20
};
// Input dosen't validates the pattern.
field.NewKeyDownEvent (new (KeyCode.D1));
Assert.Equal ("", field.Text);
Assert.False (field.IsValid);
// Dosen't match
field.Text = "12356";
Assert.Equal ("", field.Text);
Assert.False (field.IsValid);
// Yes.
field.Text = "123";
Assert.Equal ("123", field.Text);
Assert.True (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void Text_With_All_Charset ()
{
var field = new TextValidateField (new TextRegexProvider ("^[0-9][0-9][0-9]$")) {
Width = 20
};
var text = "";
for (int i = 0; i < 255; i++) {
text += (char)i;
}
field.Text = text;
Assert.False (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void Mask_With_Invalid_Pattern_Exception ()
{
// Regex Exception
// Maybe it's not the right behaviour.
var mask = "";
for (int i = 0; i < 255; i++) {
mask += (char)i;
}
try {
var field = new TextValidateField (new TextRegexProvider (mask)) {
Width = 20
};
} catch (RegexParseException ex) {
Assert.True (true, ex.Message);
return;
}
Assert.True (false);
}
[Fact]
[AutoInitShutdown]
public void Home_Key_First_Editable_Character ()
{
// Range 0 to 1000
// Accepts 001 too.
var field = new TextValidateField (new TextRegexProvider ("^[0-9]?[0-9]?[0-9]|1000$")) {
Width = 20
};
field.NewKeyDownEvent (new (KeyCode.D1));
field.NewKeyDownEvent (new (KeyCode.D0));
field.NewKeyDownEvent (new (KeyCode.D0));
field.NewKeyDownEvent (new (KeyCode.D0));
Assert.Equal ("1000", field.Text);
Assert.True (field.IsValid);
// HOME KEY
field.NewKeyDownEvent (new (KeyCode.Home));
// DELETE
field.NewKeyDownEvent (new (KeyCode.Delete));
Assert.Equal ("000", field.Text);
Assert.True (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void End_Key_End_Of_Input ()
{
// Exactly 5 numbers
var field = new TextValidateField (new TextRegexProvider ("^[0-9]{5}$") { ValidateOnInput = false }) {
Width = 20
};
for (int i = 0; i < 4; i++) {
field.NewKeyDownEvent (new (KeyCode.D0));
}
Assert.Equal ("0000", field.Text);
Assert.False (field.IsValid);
// HOME KEY
field.NewKeyDownEvent (new (KeyCode.Home));
// END KEY
field.NewKeyDownEvent (new (KeyCode.End));
// Insert 9
field.NewKeyDownEvent (new (KeyCode.D9));
Assert.Equal ("00009", field.Text);
Assert.True (field.IsValid);
// Insert 9
field.NewKeyDownEvent (new (KeyCode.D9));
Assert.Equal ("000099", field.Text);
Assert.False (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void Right_Key_Stops_At_End_And_Insert ()
{
var field = new TextValidateField (new TextRegexProvider ("^[0-9][0-9][0-9]$") { ValidateOnInput = false }) {
TextAlignment = TextAlignment.Centered,
Width = 20
};
field.Text = "123";
for (int i = 0; i < 10; i++) {
field.NewKeyDownEvent (new (KeyCode.CursorRight));
}
Assert.Equal ("123", field.Text);
Assert.True (field.IsValid);
// Insert 4
field.NewKeyDownEvent (new (KeyCode.D4));
Assert.Equal ("1234", field.Text);
Assert.False (field.IsValid);
}
[Fact]
[AutoInitShutdown]
public void Left_Key_Stops_At_Start_And_Insert ()
{
var field = new TextValidateField (new TextRegexProvider ("^[0-9][0-9][0-9]$") { ValidateOnInput = false }) {
TextAlignment = TextAlignment.Centered,
Width = 20
};
field.Text = "123";
for (int i = 0; i < 10; i++) {
field.NewKeyDownEvent (new (KeyCode.CursorLeft));
}
Assert.Equal ("123", field.Text);
Assert.True (field.IsValid);
// Insert 4
field.NewKeyDownEvent (new (KeyCode.D4));
Assert.Equal ("4123", field.Text);
Assert.False (field.IsValid);
}
}
}