Files
Terminal.Gui/UnitTests/Views/TextValidateFieldTests.cs
BDisp a3627aed5e Fixes #3189. TextValidateField doesn't show the cursor and doesn't have TextChanged event. (#3190)
* Prefix private fields with underscore and code cleanup.

* Rename to SetInitialProperties and fix a typo.

* Cleaning code and some adjustments.

* Fix default width for view.

* Enable cursor visibility.

* Reduces indentation and remove AutoInitShutdown.

* Add unit test for default Width is always equal to the provider DisplayText.Length.

* Also prevents showing the cursor if position is less than 0.

* Add OnTextChanged method and TextChanged event.

* Remove unnecessary TextChanged.
2024-01-24 22:53:34 -07:00

595 lines
17 KiB
C#

using System.Text.RegularExpressions;
using Terminal.Gui.TextValidateProviders;
using Xunit;
namespace Terminal.Gui.ViewsTests;
public class TextValidateField_NET_Provider_Tests {
[Fact]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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);
Assert.Equal ("--(1 )--", field.Provider.Text);
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);
Assert.Equal ("--(1 1)--", field.Provider.Text);
}
[Fact]
public void Default_Width_Is_Always_Equal_To_The_Provider_DisplayText_Length ()
{
// 9-Digit or space, optional. 0-Digit, required. L-Letter, required.
// > Shift up. Converts all characters that follow to uppercase.
// | Disable a previous shift up or shift down.
// A-Alphanumeric, required. a-Alphanumeric, optional.
var field = new TextValidateField (new NetMaskedTextProvider ("999 000 LLL >LLL |AAA aaa"));
Assert.Equal (field.Bounds.Width, field.Provider.DisplayText.Length);
Assert.NotEqual (field.Provider.DisplayText.Length, field.Provider.Text.Length);
Assert.Equal (new string (' ', field.Text.Length), field.Provider.Text);
}
[Fact]
public void OnTextChanged_TextChanged_Event ()
{
var wasTextChanged = false;
var field = new TextValidateField (new NetMaskedTextProvider ("--(0000)--")) {
TextAlignment = TextAlignment.Left,
Width = 30
};
field.Provider.TextChanged += (sender, e) => wasTextChanged = true;
field.NewKeyDownEvent (new (KeyCode.D1));
Assert.Equal ("--(1___)--", field.Provider.DisplayText);
Assert.False (field.IsValid);
Assert.Equal ("--(1 )--", field.Provider.Text);
Assert.True (wasTextChanged);
}
}
public class TextValidateField_Regex_Provider_Tests {
[Fact]
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]
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]
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]
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]
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]
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]
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]
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);
}
[Fact]
public void OnTextChanged_TextChanged_Event ()
{
var wasTextChanged = false;
var field = new TextValidateField (new TextRegexProvider ("^[0-9][0-9][0-9]$") { ValidateOnInput = false }) {
TextAlignment = TextAlignment.Centered,
Width = 20
};
field.Provider.TextChanged += (sender, e) => wasTextChanged = true;
field.NewKeyDownEvent (new (KeyCode.D1));
Assert.Equal ("1", field.Provider.DisplayText);
Assert.False (field.IsValid);
Assert.Equal ("1", field.Provider.Text);
Assert.True (wasTextChanged);
}
}