Fixes #3930 - Splits tests to Tests/UnitTests, Tests/IntegrationTests, Tests/StressTests (#3954)

* Tons of API doc updates

* Removed stale test

* Removed stale tests

* Fixed Skipped Shadow test 1

* Fixed Skipped Shadow test 2

* Fixed Skipped Shadow test 3

* Removed stale test

* Removed stale test2

* Explicit unregister of event handler on Application.Driver!.ClearedContents

* Added Toplevels to dict

* code cleanup

* spelling error

* Removed stale test3

* Removed stale test4

* Removed stale test5

* added script

* tweaked script

* tweaked script

* Created StressTests project; moved some tests

* Created IntegrationTests project; moved some tests

* New yml

* made old yml just unit tests

* Tweaked Button_IsDefault_Raises_Accepted_Correctly

* tweaked script

* cleaned up ymls

* tweakled up ymls

* stress tests...

* stress tests on ubuntu only

* Fixed WindowsDriver in InvokeLeakTest

* Fixed WindowsDriver in InvokeLeakTest2

* Added Directory.Packages.props.
Added Directory.Build.props

* Shortened StressTest time

* Removed dupe file.

* DemoFiles

* Moved all tests to ./Tests dir.

* Fixed release build issue

* Fixed .sln file

* Fixed .sl* files

* Fixing ymls

* Fixing interation tests

* Create link to the file TestHelpers.

* Created Tests/UnitTestsParallelizable.
Moved all obviously parallelizable tests.
Updated yml.

* fixing logs

* fixing logs2

* fixing logs3

* don't require stress to pass for PRs

* Fix a failure?

* tweaked script

* Coudl this be it?

* Moved tons of tests to parallelizable

* Fixed some stuff

* Script to find duplicate tests

* Testing workflows

* Updated to v4

* Fix RelativeBasePath issue

* Replace powershell to pwsh

* Add ignore projects.

* Removed dupe unit tests

* Code cleanup of tests

* Cleaned up test warnings

* yml tweak

* Moved setter

* tweak ymls

* just randomly throwing spaghetti at a wall

* Enable runing 5 test runners in par

* Turned off DEBUG_DISPOSABLE for par tests

* RunningUnitTests=true

* code cleanup (forcing more Action runs)

* DISABLE_DEBUG_IDISPOSABLE

* Added View.DebugIDisposable. False by default.

* Remobed bogus tareet

* Remobed bogus tareet2

* fixed warning

* added api doc

* fixed warning

* fixed warning

* fixed warning2

* fixed warning3

* fixed warning4

---------

Co-authored-by: BDisp <bd.bdisp@gmail.com>
This commit is contained in:
Tig
2025-03-05 23:44:27 -07:00
committed by GitHub
parent 64b216b1e8
commit b0f32811eb
303 changed files with 11531 additions and 11883 deletions

View File

@@ -0,0 +1,10 @@
using Terminal.Gui.EnumExtensions;
using Xunit.Abstractions;
namespace Terminal.Gui.InputTests;
public class KeyBindingTests ()
{
// TODO: Add tests for KeyBinding
}

View File

@@ -0,0 +1,348 @@
using Terminal.Gui.EnumExtensions;
using Xunit.Abstractions;
using static Unix.Terminal.Delegates;
namespace Terminal.Gui.InputTests;
public class KeyBindingsTests ()
{
[Fact]
public void Add_Adds ()
{
var keyBindings = new KeyBindings (new ());
Command [] commands = { Command.Right, Command.Left };
var key = new Key (Key.A);
keyBindings.Add (Key.A, commands);
KeyBinding binding = keyBindings.Get (key);
Assert.Contains (Command.Right, binding.Commands);
Assert.Contains (Command.Left, binding.Commands);
binding = keyBindings.Get (key);
Assert.Contains (Command.Right, binding.Commands);
Assert.Contains (Command.Left, binding.Commands);
Command [] resultCommands = keyBindings.GetCommands (key);
Assert.Contains (Command.Right, resultCommands);
Assert.Contains (Command.Left, resultCommands);
}
[Fact]
public void Add_Invalid_Key_Throws ()
{
var keyBindings = new KeyBindings (new View ());
List<Command> commands = new ();
Assert.Throws<ArgumentException> (() => keyBindings.Add (Key.Empty, Command.Accept));
}
[Fact]
public void Add_Multiple_Commands_Adds ()
{
var keyBindings = new KeyBindings (new ());
Command [] commands = [Command.Right, Command.Left];
keyBindings.Add (Key.A, commands);
Command [] resultCommands = keyBindings.GetCommands (Key.A);
Assert.Contains (Command.Right, resultCommands);
Assert.Contains (Command.Left, resultCommands);
keyBindings.Add (Key.B, commands);
resultCommands = keyBindings.GetCommands (Key.B);
Assert.Contains (Command.Right, resultCommands);
Assert.Contains (Command.Left, resultCommands);
}
[Fact]
public void Add_No_Commands_Throws ()
{
var keyBindings = new KeyBindings (new ());
List<Command> commands = new ();
Assert.Throws<ArgumentException> (() => keyBindings.Add (Key.A, commands.ToArray ()));
}
[Fact]
public void Add_Single_Command_Adds ()
{
var keyBindings = new KeyBindings (new ());
keyBindings.Add (Key.A, Command.HotKey);
Command [] resultCommands = keyBindings.GetCommands (Key.A);
Assert.Contains (Command.HotKey, resultCommands);
keyBindings.Add (Key.B, Command.HotKey);
resultCommands = keyBindings.GetCommands (Key.B);
Assert.Contains (Command.HotKey, resultCommands);
}
// Add should not allow duplicates
[Fact]
public void Add_Throws_If_Exists ()
{
var keyBindings = new KeyBindings (new View ());
keyBindings.Add (Key.A, Command.HotKey);
Assert.Throws<InvalidOperationException> (() => keyBindings.Add (Key.A, Command.Accept));
Command [] resultCommands = keyBindings.GetCommands (Key.A);
Assert.Contains (Command.HotKey, resultCommands);
keyBindings = new (new View ());
keyBindings.Add (Key.A, Command.HotKey);
Assert.Throws<InvalidOperationException> (() => keyBindings.Add (Key.A, Command.Accept));
resultCommands = keyBindings.GetCommands (Key.A);
Assert.Contains (Command.HotKey, resultCommands);
keyBindings = new (new View ());
keyBindings.Add (Key.A, Command.HotKey);
Assert.Throws<InvalidOperationException> (() => keyBindings.Add (Key.A, Command.Accept));
resultCommands = keyBindings.GetCommands (Key.A);
Assert.Contains (Command.HotKey, resultCommands);
keyBindings = new (new View ());
keyBindings.Add (Key.A, Command.Accept);
Assert.Throws<InvalidOperationException> (() => keyBindings.Add (Key.A, Command.ScrollDown));
resultCommands = keyBindings.GetCommands (Key.A);
Assert.Contains (Command.Accept, resultCommands);
keyBindings = new (new View ());
keyBindings.Add (Key.A, new KeyBinding ([Command.HotKey]));
Assert.Throws<InvalidOperationException> (() => keyBindings.Add (Key.A, new KeyBinding (new [] { Command.Accept })));
resultCommands = keyBindings.GetCommands (Key.A);
Assert.Contains (Command.HotKey, resultCommands);
}
// Clear
[Fact]
public void Clear_Clears ()
{
var keyBindings = new KeyBindings (new ());
keyBindings.Add (Key.B, Command.HotKey);
keyBindings.Clear ();
Command [] resultCommands = keyBindings.GetCommands (Key.A);
Assert.Empty (resultCommands);
resultCommands = keyBindings.GetCommands (Key.B);
Assert.Empty (resultCommands);
}
[Fact]
public void Defaults ()
{
var keyBindings = new KeyBindings (new ());
Assert.Empty (keyBindings.GetBindings ());
Assert.Null (keyBindings.GetFirstFromCommands (Command.Accept));
Assert.NotNull (keyBindings.Target);
}
[Fact]
public void Get_Binding_Not_Found_Throws ()
{
var keyBindings = new KeyBindings (new ());
Assert.Throws<InvalidOperationException> (() => keyBindings.Get (Key.A));
Assert.Throws<InvalidOperationException> (() => keyBindings.Get (Key.B));
}
// GetCommands
[Fact]
public void GetCommands_Unknown_ReturnsEmpty ()
{
var keyBindings = new KeyBindings (new ());
Command [] resultCommands = keyBindings.GetCommands (Key.A);
Assert.Empty (resultCommands);
}
[Fact]
public void GetCommands_WithCommands_ReturnsCommands ()
{
var keyBindings = new KeyBindings (new ());
keyBindings.Add (Key.A, Command.HotKey);
Command [] resultCommands = keyBindings.GetCommands (Key.A);
Assert.Contains (Command.HotKey, resultCommands);
}
[Fact]
public void GetCommands_WithMultipleBindings_ReturnsCommands ()
{
var keyBindings = new KeyBindings (new ());
Command [] commands = { Command.Right, Command.Left };
keyBindings.Add (Key.A, commands);
keyBindings.Add (Key.B, commands);
Command [] resultCommands = keyBindings.GetCommands (Key.A);
Assert.Contains (Command.Right, resultCommands);
Assert.Contains (Command.Left, resultCommands);
resultCommands = keyBindings.GetCommands (Key.B);
Assert.Contains (Command.Right, resultCommands);
Assert.Contains (Command.Left, resultCommands);
}
[Fact]
public void GetCommands_WithMultipleCommands_ReturnsCommands ()
{
var keyBindings = new KeyBindings (new ());
Command [] commands = { Command.Right, Command.Left };
keyBindings.Add (Key.A, commands);
Command [] resultCommands = keyBindings.GetCommands (Key.A);
Assert.Contains (Command.Right, resultCommands);
Assert.Contains (Command.Left, resultCommands);
}
[Fact]
public void GetKeyFromCommands_MultipleCommands ()
{
var keyBindings = new KeyBindings (new ());
Command [] commands1 = { Command.Right, Command.Left };
keyBindings.Add (Key.A, commands1);
Command [] commands2 = { Command.Up, Command.Down };
keyBindings.Add (Key.B, commands2);
Key key = keyBindings.GetFirstFromCommands (commands1);
Assert.Equal (Key.A, key);
key = keyBindings.GetFirstFromCommands (commands2);
Assert.Equal (Key.B, key);
}
[Fact]
public void GetKeyFromCommands_OneCommand ()
{
var keyBindings = new KeyBindings (new ());
keyBindings.Add (Key.A, Command.Right);
Key key = keyBindings.GetFirstFromCommands (Command.Right);
Assert.Equal (Key.A, key);
}
// GetKeyFromCommands
[Fact]
public void GetKeyFromCommands_Unknown_Returns_Key_Empty ()
{
var keyBindings = new KeyBindings (new ());
Assert.Null (keyBindings.GetFirstFromCommands (Command.Accept));
}
[Fact]
public void GetKeyFromCommands_WithCommands_ReturnsKey ()
{
var keyBindings = new KeyBindings (new ());
keyBindings.Add (Key.A, Command.HotKey);
Key resultKey = keyBindings.GetFirstFromCommands (Command.HotKey);
Assert.Equal (Key.A, resultKey);
}
[Fact]
public void ReplaceKey_Replaces ()
{
var keyBindings = new KeyBindings (new ());
keyBindings.Add (Key.A, Command.HotKey);
keyBindings.Add (Key.B, Command.HotKey);
keyBindings.Add (Key.C, Command.HotKey);
keyBindings.Add (Key.D, Command.HotKey);
keyBindings.Replace (Key.A, Key.E);
Assert.Empty (keyBindings.GetCommands (Key.A));
Assert.Contains (Command.HotKey, keyBindings.GetCommands (Key.E));
keyBindings.Replace (Key.B, Key.F);
Assert.Empty (keyBindings.GetCommands (Key.B));
Assert.Contains (Command.HotKey, keyBindings.GetCommands (Key.F));
keyBindings.Replace (Key.C, Key.G);
Assert.Empty (keyBindings.GetCommands (Key.C));
Assert.Contains (Command.HotKey, keyBindings.GetCommands (Key.G));
keyBindings.Replace (Key.D, Key.H);
Assert.Empty (keyBindings.GetCommands (Key.D));
Assert.Contains (Command.HotKey, keyBindings.GetCommands (Key.H));
}
[Fact]
public void ReplaceKey_Replaces_Leaves_Old_Binding ()
{
var keyBindings = new KeyBindings (new ());
keyBindings.Add (Key.A, Command.Accept);
keyBindings.Add (Key.B, Command.HotKey);
keyBindings.Replace (keyBindings.GetFirstFromCommands (Command.Accept), Key.C);
Assert.Empty (keyBindings.GetCommands (Key.A));
Assert.Contains (Command.Accept, keyBindings.GetCommands (Key.C));
}
[Fact]
public void ReplaceKey_Adds_If_DoesNotContain_Old ()
{
var keyBindings = new KeyBindings (new ());
keyBindings.Replace (Key.A, Key.B);
Assert.True (keyBindings.TryGet (Key.B, out _));
}
[Fact]
public void ReplaceKey_Throws_If_New_Is_Empty ()
{
var keyBindings = new KeyBindings (new ());
keyBindings.Add (Key.A, Command.HotKey);
Assert.Throws<ArgumentException> (() => keyBindings.Replace (Key.A, Key.Empty));
}
[Fact]
public void Get_Gets ()
{
var keyBindings = new KeyBindings (new ());
Command [] commands = [Command.Right, Command.Left];
var key = new Key (Key.A);
keyBindings.Add (key, commands);
KeyBinding binding = keyBindings.Get (key);
Assert.Contains (Command.Right, binding.Commands);
Assert.Contains (Command.Left, binding.Commands);
binding = keyBindings.Get (key);
Assert.Contains (Command.Right, binding.Commands);
Assert.Contains (Command.Left, binding.Commands);
}
// TryGet
[Fact]
public void TryGet_Succeeds ()
{
var keyBindings = new KeyBindings (new ());
keyBindings.Add (Key.Q.WithCtrl, Command.HotKey);
var key = new Key (Key.Q.WithCtrl);
bool result = keyBindings.TryGet (key, out KeyBinding _);
Assert.True (result); ;
}
[Fact]
public void TryGet_Unknown_ReturnsFalse ()
{
var keyBindings = new KeyBindings (new ());
bool result = keyBindings.TryGet (Key.A, out KeyBinding _);
Assert.False (result);
}
[Fact]
public void TryGet_WithCommands_ReturnsTrue ()
{
var keyBindings = new KeyBindings (new ());
keyBindings.Add (Key.A, Command.HotKey);
bool result = keyBindings.TryGet (Key.A, out KeyBinding bindings);
Assert.True (result);
Assert.Contains (Command.HotKey, bindings.Commands);
}
[Fact]
public void ReplaceCommands_Replaces ()
{
var keyBindings = new KeyBindings (new ());
keyBindings.Add (Key.A, Command.Accept);
keyBindings.ReplaceCommands (Key.A, Command.Refresh);
bool result = keyBindings.TryGet (Key.A, out KeyBinding bindings);
Assert.True (result);
Assert.Contains (Command.Refresh, bindings.Commands);
}
}

View File

@@ -0,0 +1,561 @@
using System.Text;
using Xunit.Abstractions;
namespace Terminal.Gui.InputTests;
public class KeyTests
{
private readonly ITestOutputHelper _output;
public KeyTests (ITestOutputHelper output) { _output = output; }
// Via https://andrewlock.net/creating-parameterised-tests-in-xunit-with-inlinedata-classdata-and-memberdata/
public static TheoryData<string, Key> ValidStrings =>
new ()
{
{ "a", Key.A },
{ "Ctrl+A", Key.A.WithCtrl },
{ "Alt+A", Key.A.WithAlt },
{ "Shift+A", Key.A.WithShift },
{ "A", Key.A.WithShift },
{ "â", new ((KeyCode)'â') },
{ "Shift+â", new ((KeyCode)'â' | KeyCode.ShiftMask) },
{ "Shift+Â", new ((KeyCode)'Â' | KeyCode.ShiftMask) },
{ "Ctrl+Shift+CursorUp", Key.CursorUp.WithShift.WithCtrl },
{ "Ctrl+Alt+Shift+CursorUp", Key.CursorUp.WithShift.WithCtrl.WithAlt },
{ "ctrl+alt+shift+cursorup", Key.CursorUp.WithShift.WithCtrl.WithAlt },
{ "CTRL+ALT+SHIFT+CURSORUP", Key.CursorUp.WithShift.WithCtrl.WithAlt },
{ "Ctrl+Alt+Shift+Delete", Key.Delete.WithCtrl.WithAlt.WithShift },
{ "Ctrl+Alt+Shift+Enter", Key.Enter.WithCtrl.WithAlt.WithShift },
{ "Tab", Key.Tab },
{ "Shift+Tab", Key.Tab.WithShift },
{ "Ctrl+Tab", Key.Tab.WithCtrl },
{ "Alt+Tab", Key.Tab.WithAlt },
{ "Ctrl+Shift+Tab", Key.Tab.WithShift.WithCtrl },
{ "Ctrl+Alt+Tab", Key.Tab.WithAlt.WithCtrl },
{ "", Key.Empty },
{ " ", Key.Space },
{ "Space", Key.Space },
{ "Shift+Space", Key.Space.WithShift },
{ "Ctrl+Space", Key.Space.WithCtrl },
{ "Alt+Space", Key.Space.WithAlt },
{ "Shift+ ", Key.Space.WithShift },
{ "Ctrl+ ", Key.Space.WithCtrl },
{ "Alt+ ", Key.Space.WithAlt },
{ "F1", Key.F1 },
{ "0", Key.D0 },
{ "9", Key.D9 },
{ "D0", Key.D0 },
{ "65", Key.A.WithShift },
{ "97", Key.A },
{ "Shift", KeyCode.ShiftMask },
{ "Ctrl", KeyCode.CtrlMask },
{ "Ctrl-A", Key.A.WithCtrl },
{ "Alt-A", Key.A.WithAlt },
{ "A-Ctrl", Key.A.WithCtrl },
{ "Alt-A-Ctrl", Key.A.WithCtrl.WithAlt }
};
[Theory]
[InlineData ((KeyCode)'❿', '❿')]
[InlineData ((KeyCode)'☑', '☑')]
[InlineData ((KeyCode)'英', '英')]
[InlineData ((KeyCode)'{', '{')]
[InlineData ((KeyCode)'\'', '\'')]
[InlineData ((KeyCode)'ó', 'ó')]
[InlineData ((KeyCode)'ó' | KeyCode.ShiftMask, 'ó')]
[InlineData ((KeyCode)'Ó', 'Ó')]
[InlineData ((KeyCode)'ç' | KeyCode.ShiftMask | KeyCode.AltMask | KeyCode.CtrlMask, '\0')]
[InlineData (KeyCode.A, 97)] // 65 or equivalent to Key.A, but A-Z are mapped to lower case by drivers
//[InlineData (Key.A, 97)] // 65 equivalent to (Key)'A', but A-Z are mapped to lower case by drivers
[InlineData (KeyCode.ShiftMask | KeyCode.A, 65)]
[InlineData (KeyCode.CtrlMask | KeyCode.A, '\0')]
[InlineData (KeyCode.AltMask | KeyCode.A, '\0')]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.A, '\0')]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask | KeyCode.A, '\0')]
[InlineData (KeyCode.AltMask | KeyCode.CtrlMask | KeyCode.A, '\0')]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.A, '\0')]
[InlineData (KeyCode.Z, 'z')]
[InlineData (KeyCode.ShiftMask | KeyCode.Z, 'Z')]
[InlineData ((KeyCode)'1', '1')]
[InlineData (KeyCode.ShiftMask | KeyCode.D1, '1')]
[InlineData (KeyCode.CtrlMask | KeyCode.D1, '\0')]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.D1, '\0')]
[InlineData (KeyCode.F1, '\0')]
[InlineData (KeyCode.ShiftMask | KeyCode.F1, '\0')]
[InlineData (KeyCode.CtrlMask | KeyCode.F1, '\0')]
#pragma warning disable xUnit1025 // InlineData should be unique within the Theory it belongs to
[InlineData (KeyCode.Enter, '\r')]
#pragma warning restore xUnit1025 // InlineData should be unique within the Theory it belongs to
[InlineData (KeyCode.Tab, '\t')]
[InlineData (KeyCode.Esc, 0x1b)]
[InlineData (KeyCode.Space, ' ')]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.Enter, '\0')]
[InlineData (KeyCode.Null, '\0')]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.Null, '\0')]
[InlineData (KeyCode.CharMask, '\0')]
[InlineData (KeyCode.SpecialMask, '\0')]
public void AsRune_ShouldReturnCorrectIntValue (KeyCode key, uint expected)
{
var eventArgs = new Key (key);
Assert.Equal ((Rune)expected, eventArgs.AsRune);
}
[Theory]
[InlineData ('a', KeyCode.A)]
[InlineData ('A', KeyCode.A | KeyCode.ShiftMask)]
[InlineData ('z', KeyCode.Z)]
[InlineData ('Z', KeyCode.Z | KeyCode.ShiftMask)]
[InlineData (' ', KeyCode.Space)]
[InlineData ('1', KeyCode.D1)]
[InlineData ('!', (KeyCode)'!')]
[InlineData ('\r', KeyCode.Enter)]
[InlineData ('\t', KeyCode.Tab)]
[InlineData ('\n', (KeyCode)10)]
[InlineData ('ó', (KeyCode)'ó')]
[InlineData ('Ó', (KeyCode)'Ó')]
[InlineData ('❿', (KeyCode)'❿')]
[InlineData ('☑', (KeyCode)'☑')]
[InlineData ('英', (KeyCode)'英')]
[InlineData ('{', (KeyCode)'{')]
[InlineData ('\'', (KeyCode)'\'')]
[InlineData ('\xFFFF', (KeyCode)0xFFFF)]
[InlineData ('\x0', (KeyCode)0x0)]
public void Cast_Char_To_Key (char ch, KeyCode expectedKeyCode)
{
var key = (Key)ch;
Assert.Equal (expectedKeyCode, key.KeyCode);
}
[Fact]
public void Cast_Key_ToString ()
{
var str = (string)Key.Q.WithCtrl;
Assert.Equal ("Ctrl+Q", str);
}
[Theory]
[InlineData (KeyCode.Enter, KeyCode.Enter)]
[InlineData (KeyCode.Esc, KeyCode.Esc)]
[InlineData (KeyCode.A, KeyCode.A)]
[InlineData (KeyCode.A | KeyCode.ShiftMask, KeyCode.A | KeyCode.ShiftMask)]
[InlineData (KeyCode.Z, KeyCode.Z)]
[InlineData (KeyCode.Space, KeyCode.Space)]
public void Cast_KeyCode_To_Key (KeyCode cdk, KeyCode expected)
{
// explicit
var key = (Key)cdk;
Assert.Equal (((Key)expected).ToString (), key.ToString ());
// implicit
key = cdk;
Assert.Equal (((Key)expected).ToString (), key.ToString ());
}
// string cast operators
[Fact]
public void Cast_String_To_Key ()
{
var key = (Key)"Ctrl+Q";
Assert.Equal (KeyCode.Q | KeyCode.CtrlMask, key.KeyCode);
}
[Theory]
[InlineData (KeyCode.A, KeyCode.A)]
[InlineData (KeyCode.F1, KeyCode.F1)]
public void Casting_Between_Key_And_KeyCode (KeyCode keyCode, KeyCode key)
{
Assert.Equal (keyCode, (Key)key);
Assert.NotEqual (keyCode, ((Key)key).WithShift);
Assert.Equal ((uint)keyCode, (uint)(Key)key);
Assert.NotEqual ((uint)keyCode, (uint)((Key)key).WithShift);
}
[Theory]
[InlineData ('a', KeyCode.A)]
[InlineData ('A', KeyCode.A | KeyCode.ShiftMask)]
[InlineData ('z', KeyCode.Z)]
[InlineData ('Z', KeyCode.Z | KeyCode.ShiftMask)]
[InlineData (' ', KeyCode.Space)]
[InlineData ('1', KeyCode.D1)]
[InlineData ('!', (KeyCode)'!')]
[InlineData ('\r', KeyCode.Enter)]
[InlineData ('\t', KeyCode.Tab)]
[InlineData ('\n', (KeyCode)10)]
[InlineData ('ó', (KeyCode)'ó')]
[InlineData ('Ó', (KeyCode)'Ó')]
[InlineData ('❿', (KeyCode)'❿')]
[InlineData ('☑', (KeyCode)'☑')]
[InlineData ('英', (KeyCode)'英')]
[InlineData ('{', (KeyCode)'{')]
[InlineData ('\'', (KeyCode)'\'')]
[InlineData ('\xFFFF', (KeyCode)0xFFFF)]
[InlineData ('\x0', (KeyCode)0x0)]
public void Constructor_Char (char ch, KeyCode expectedKeyCode)
{
var key = new Key (ch);
Assert.Equal (expectedKeyCode, key.KeyCode);
}
[Fact]
public void Constructor_Default_ShouldSetKeyToNull ()
{
var eventArgs = new Key ();
Assert.Equal (KeyCode.Null, eventArgs.KeyCode);
}
[Theory]
[InlineData ("Barf")]
public void Constructor_String_Invalid_Throws (string keyString) { Assert.Throws<ArgumentException> (() => new Key (keyString)); }
[Theory]
[MemberData (nameof (ValidStrings))]
public void Constructor_String_Valid (string keyString, Key expected)
{
var key = new Key (keyString);
Assert.Equal (expected.ToString (), key.ToString ());
}
[Theory]
[InlineData (KeyCode.Enter)]
[InlineData (KeyCode.Esc)]
[InlineData (KeyCode.A)]
public void Constructor_WithKey_ShouldSetCorrectKey (KeyCode key)
{
var eventArgs = new Key (key);
Assert.Equal (key, eventArgs.KeyCode);
}
[Fact]
public void HandledProperty_ShouldBeFalseByDefault ()
{
var eventArgs = new Key ();
Assert.False (eventArgs.Handled);
}
[Theory]
[InlineData (KeyCode.AltMask, true)]
[InlineData (KeyCode.A, false)]
public void IsAlt_ShouldReturnCorrectValue (KeyCode key, bool expected)
{
var eventArgs = new Key (key);
Assert.Equal (expected, eventArgs.IsAlt);
}
[Theory]
[InlineData (KeyCode.A, true)]
[InlineData (KeyCode.A | KeyCode.ShiftMask, true)]
[InlineData (KeyCode.F, true)]
[InlineData (KeyCode.F | KeyCode.ShiftMask, true)]
// these have alt or ctrl modifiers or are not a..z
[InlineData (KeyCode.A | KeyCode.CtrlMask, false)]
[InlineData (KeyCode.A | KeyCode.AltMask, false)]
[InlineData (KeyCode.D0, false)]
[InlineData (KeyCode.Esc, false)]
[InlineData (KeyCode.Tab, false)]
public void IsKeyCodeAtoZ (KeyCode key, bool expected)
{
var eventArgs = new Key (key);
Assert.Equal (expected, eventArgs.IsKeyCodeAtoZ);
}
[Theory]
[InlineData (KeyCode.ShiftMask, true, false, false)]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask, true, true, false)]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask | KeyCode.CtrlMask, true, true, true)]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask, true, false, true)]
[InlineData (KeyCode.AltMask, false, true, false)]
[InlineData (KeyCode.AltMask | KeyCode.CtrlMask, false, true, true)]
[InlineData (KeyCode.CtrlMask, false, false, true)]
public void IsShift_IsAlt_IsCtrl (KeyCode keyCode, bool isShift, bool isAlt, bool isCtrl)
{
Assert.Equal (((Key)keyCode).IsShift, isShift);
Assert.Equal (((Key)keyCode).IsAlt, isAlt);
Assert.Equal (((Key)keyCode).IsCtrl, isCtrl);
}
// IsValid
[Theory]
[InlineData (KeyCode.A, true)]
[InlineData (KeyCode.B, true)]
[InlineData (KeyCode.F1 | KeyCode.ShiftMask, true)]
[InlineData (KeyCode.Null, false)]
[InlineData (KeyCode.ShiftMask, false)]
[InlineData (KeyCode.CtrlMask, false)]
[InlineData (KeyCode.AltMask, false)]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask, false)]
public void IsValid (KeyCode key, bool expected) { Assert.Equal (expected, ((Key)key).IsValid); }
[Fact]
public void NoShift_ShouldReturnCorrectValue ()
{
Key cad = Key.Delete.WithCtrl.WithAlt;
Assert.Equal (KeyCode.Delete | KeyCode.CtrlMask | KeyCode.AltMask, cad);
Assert.Equal (KeyCode.Delete | KeyCode.AltMask, cad.NoCtrl);
Key a = Key.A.WithCtrl.WithAlt.WithShift;
Assert.Equal (KeyCode.A, a.NoCtrl.NoShift.NoAlt);
Assert.Equal (KeyCode.A, a.NoAlt.NoShift.NoCtrl);
Assert.Equal (KeyCode.A, a.NoAlt.NoShift.NoCtrl.NoCtrl.NoAlt.NoShift);
Assert.Equal (Key.Delete, Key.Delete.WithCtrl.NoCtrl);
Assert.Equal ((KeyCode)Key.Delete.WithCtrl, Key.Delete.NoCtrl.WithCtrl);
}
[Fact]
public void Standard_Keys_Always_New ()
{
// Make two local keys, and grab Key.A, which is a reference to a singleton.
Key aKey1 = Key.A;
Key aKey2 = Key.A;
// Assert the starting state that is expected
Assert.False (aKey1.Handled);
Assert.False (aKey2.Handled);
Assert.False (Key.A.Handled);
// Now set Handled true on one of our local keys
aKey1.Handled = true;
// Assert the newly-expected case
// The last two assertions will fail, because we have actually modified a singleton
Assert.True (aKey1.Handled);
Assert.False (aKey2.Handled);
Assert.False (Key.A.Handled);
}
[Fact]
public void Standard_Keys_Should_Equal_KeyCode ()
{
Assert.Equal (KeyCode.A, Key.A);
Assert.Equal (KeyCode.Delete, Key.Delete);
}
[Theory]
[InlineData ((KeyCode)'☑', "☑")]
[InlineData ((KeyCode)'英', "英")]
[InlineData ((KeyCode)'{', "{")]
[InlineData ((KeyCode)'\'', "\'")]
[InlineData ((KeyCode)'ó', "ó")]
[InlineData ((KeyCode)'Ó' | KeyCode.ShiftMask, "Shift+Ó")]
[InlineData ((KeyCode)'ó' | KeyCode.ShiftMask, "Shift+ó")]
[InlineData ((KeyCode)'Ó', "Ó")]
[InlineData ((KeyCode)'ç' | KeyCode.ShiftMask | KeyCode.AltMask | KeyCode.CtrlMask, "Ctrl+Alt+Shift+ç")]
[InlineData ((KeyCode)'a', "a")] // 97 or Key.Space | Key.A
[InlineData ((KeyCode)'A', "a")] // 65 or equivalent to Key.A, but A-Z are mapped to lower case by drivers
[InlineData (KeyCode.ShiftMask | KeyCode.A, "A")]
[InlineData ((KeyCode)'a' | KeyCode.ShiftMask, "A")]
[InlineData (KeyCode.CtrlMask | KeyCode.A, "Ctrl+A")]
[InlineData (KeyCode.AltMask | KeyCode.A, "Alt+A")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.A, "Ctrl+Shift+A")]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask | KeyCode.A, "Alt+Shift+A")]
[InlineData (KeyCode.AltMask | KeyCode.CtrlMask | KeyCode.A, "Ctrl+Alt+A")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.A, "Ctrl+Alt+Shift+A")]
[InlineData (KeyCode.ShiftMask | KeyCode.Z, "Z")]
[InlineData (KeyCode.CtrlMask | KeyCode.Z, "Ctrl+Z")]
[InlineData (KeyCode.AltMask | KeyCode.Z, "Alt+Z")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.Z, "Ctrl+Shift+Z")]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask | KeyCode.Z, "Alt+Shift+Z")]
[InlineData (KeyCode.AltMask | KeyCode.CtrlMask | KeyCode.Z, "Ctrl+Alt+Z")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.Z, "Ctrl+Alt+Shift+Z")]
[InlineData ((KeyCode)'1', "1")]
[InlineData (KeyCode.ShiftMask | KeyCode.D1, "Shift+1")]
[InlineData (KeyCode.CtrlMask | KeyCode.D1, "Ctrl+1")]
[InlineData (KeyCode.AltMask | KeyCode.D1, "Alt+1")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.D1, "Ctrl+Shift+1")]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask | KeyCode.D1, "Alt+Shift+1")]
[InlineData (KeyCode.AltMask | KeyCode.CtrlMask | KeyCode.D1, "Ctrl+Alt+1")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.D1, "Ctrl+Alt+Shift+1")]
[InlineData (KeyCode.F1, "F1")]
[InlineData (KeyCode.ShiftMask | KeyCode.F1, "Shift+F1")]
[InlineData (KeyCode.CtrlMask | KeyCode.F1, "Ctrl+F1")]
[InlineData (KeyCode.AltMask | KeyCode.F1, "Alt+F1")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.F1, "Ctrl+Shift+F1")]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask | KeyCode.F1, "Alt+Shift+F1")]
[InlineData (KeyCode.AltMask | KeyCode.CtrlMask | KeyCode.F1, "Ctrl+Alt+F1")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.F1, "Ctrl+Alt+Shift+F1")]
[InlineData (KeyCode.Enter, "Enter")]
[InlineData (KeyCode.ShiftMask | KeyCode.Enter, "Shift+Enter")]
[InlineData (KeyCode.CtrlMask | KeyCode.Enter, "Ctrl+Enter")]
[InlineData (KeyCode.AltMask | KeyCode.Enter, "Alt+Enter")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.Enter, "Ctrl+Shift+Enter")]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask | KeyCode.Enter, "Alt+Shift+Enter")]
[InlineData (KeyCode.AltMask | KeyCode.CtrlMask | KeyCode.Enter, "Ctrl+Alt+Enter")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.Enter, "Ctrl+Alt+Shift+Enter")]
[InlineData (KeyCode.Delete, "Delete")]
[InlineData (KeyCode.ShiftMask | KeyCode.Delete, "Shift+Delete")]
[InlineData (KeyCode.CtrlMask | KeyCode.Delete, "Ctrl+Delete")]
[InlineData (KeyCode.AltMask | KeyCode.Delete, "Alt+Delete")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.Delete, "Ctrl+Shift+Delete")]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask | KeyCode.Delete, "Alt+Shift+Delete")]
[InlineData (KeyCode.AltMask | KeyCode.CtrlMask | KeyCode.Delete, "Ctrl+Alt+Delete")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.Delete, "Ctrl+Alt+Shift+Delete")]
[InlineData (KeyCode.CursorUp, "CursorUp")]
[InlineData (KeyCode.ShiftMask | KeyCode.CursorUp, "Shift+CursorUp")]
[InlineData (KeyCode.CtrlMask | KeyCode.CursorUp, "Ctrl+CursorUp")]
[InlineData (KeyCode.AltMask | KeyCode.CursorUp, "Alt+CursorUp")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.CursorUp, "Ctrl+Shift+CursorUp")]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask | KeyCode.CursorUp, "Alt+Shift+CursorUp")]
[InlineData (KeyCode.AltMask | KeyCode.CtrlMask | KeyCode.CursorUp, "Ctrl+Alt+CursorUp")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.CursorUp, "Ctrl+Alt+Shift+CursorUp")]
[InlineData (KeyCode.Space, "Space")]
[InlineData (KeyCode.Null, "Null")]
[InlineData (KeyCode.ShiftMask | KeyCode.Null, "Shift")]
[InlineData (KeyCode.CtrlMask | KeyCode.Null, "Ctrl")]
[InlineData (KeyCode.AltMask | KeyCode.Null, "Alt")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.Null, "Ctrl+Shift")]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask | KeyCode.Null, "Alt+Shift")]
[InlineData (KeyCode.AltMask | KeyCode.CtrlMask | KeyCode.Null, "Ctrl+Alt")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.Null, "Ctrl+Alt+Shift")]
[InlineData (KeyCode.CharMask, "CharMask")]
[InlineData (KeyCode.SpecialMask, "Ctrl+Alt+Shift")]
[InlineData ((KeyCode)'+', "+")]
[InlineData ((KeyCode)'+' | KeyCode.ShiftMask, "Shift++")]
[InlineData ((KeyCode)'+' | KeyCode.CtrlMask, "Ctrl++")]
[InlineData ((KeyCode)'+' | KeyCode.ShiftMask | KeyCode.CtrlMask, "Ctrl+Shift++")]
public void ToString_ShouldReturnFormattedString (KeyCode key, string expected) =>
Assert.Equal (expected, Key.ToString (key));
// TODO: Create equality operator for KeyCode
//Assert.Equal (KeyCode.DeleteChar, Key.Delete);
// Similar tests for IsShift and IsCtrl
[Fact]
public void ToString_ShouldReturnReadableString ()
{
Key eventArgs = Key.A.WithCtrl;
Assert.Equal ("Ctrl+A", eventArgs.ToString ());
}
[Theory]
[InlineData (KeyCode.CtrlMask | KeyCode.A, '+', "Ctrl+A")]
[InlineData (KeyCode.AltMask | KeyCode.B, '-', "Alt-B")]
public void ToStringWithSeparator_ShouldReturnFormattedString (KeyCode key, char separator, string expected)
{
Assert.Equal (expected, Key.ToString (key, (Rune)separator));
}
[Theory]
[InlineData ("aa")]
[InlineData ("-1")]
[InlineData ("Crtl")]
[InlineData ("99a")]
[InlineData ("a99")]
[InlineData ("#99")]
[InlineData ("x99")]
[InlineData ("0x99")]
[InlineData ("Ctrl-Ctrl")]
public void TryParse_ShouldReturnFalse_On_InvalidKey (string keyString) { Assert.False (Key.TryParse (keyString, out Key _)); }
// TryParse
[Theory]
[InlineData ("a", KeyCode.A)]
[InlineData ("Ctrl+A", KeyCode.A | KeyCode.CtrlMask)]
[InlineData ("Alt+A", KeyCode.A | KeyCode.AltMask)]
[InlineData ("Shift+A", KeyCode.A | KeyCode.ShiftMask)]
[InlineData ("A", KeyCode.A | KeyCode.ShiftMask)]
[InlineData ("â", (KeyCode)'â')]
[InlineData ("Shift+â", (KeyCode)'â' | KeyCode.ShiftMask)]
[InlineData ("Shift+Â", (KeyCode)'Â' | KeyCode.ShiftMask)]
[InlineData ("Ctrl+Shift+CursorUp", KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.CursorUp)]
[InlineData ("Ctrl+Alt+Shift+CursorUp", KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.CursorUp)]
[InlineData ("ctrl+alt+shift+cursorup", KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.CursorUp)]
[InlineData ("CTRL+ALT+SHIFT+CURSORUP", KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.CursorUp)]
[InlineData ("Ctrl+Alt+Shift+Delete", KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.Delete)]
[InlineData ("Ctrl+Alt+Shift+Enter", KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.Enter)]
[InlineData ("Tab", KeyCode.Tab)]
[InlineData ("Shift+Tab", KeyCode.Tab | KeyCode.ShiftMask)]
[InlineData ("Ctrl+Tab", KeyCode.Tab | KeyCode.CtrlMask)]
[InlineData ("Alt+Tab", KeyCode.Tab | KeyCode.AltMask)]
[InlineData ("Ctrl+Shift+Tab", KeyCode.Tab | KeyCode.ShiftMask | KeyCode.CtrlMask)]
[InlineData ("Ctrl+Alt+Tab", KeyCode.Tab | KeyCode.AltMask | KeyCode.CtrlMask)]
[InlineData ("", KeyCode.Null)]
[InlineData (" ", KeyCode.Space)]
[InlineData ("Space", KeyCode.Space)]
[InlineData ("Shift+Space", KeyCode.Space | KeyCode.ShiftMask)]
[InlineData ("Ctrl+Space", KeyCode.Space | KeyCode.CtrlMask)]
[InlineData ("Alt+Space", KeyCode.Space | KeyCode.AltMask)]
[InlineData ("Shift+ ", KeyCode.Space | KeyCode.ShiftMask)]
[InlineData ("Ctrl+ ", KeyCode.Space | KeyCode.CtrlMask)]
[InlineData ("Alt+ ", KeyCode.Space | KeyCode.AltMask)]
[InlineData ("F1", KeyCode.F1)]
[InlineData ("0", KeyCode.D0)]
[InlineData ("9", KeyCode.D9)]
[InlineData ("D0", KeyCode.D0)]
[InlineData ("65", KeyCode.A | KeyCode.ShiftMask)]
[InlineData ("97", KeyCode.A)]
[InlineData ("Shift", KeyCode.ShiftMask)]
[InlineData ("Ctrl", KeyCode.CtrlMask)]
[InlineData ("Ctrl-A", KeyCode.A | KeyCode.CtrlMask)]
[InlineData ("Alt-A", KeyCode.A | KeyCode.AltMask)]
[InlineData ("A-Ctrl", KeyCode.A | KeyCode.CtrlMask)]
[InlineData ("Alt-A-Ctrl", KeyCode.A | KeyCode.CtrlMask | KeyCode.AltMask)]
[InlineData ("120", KeyCode.X)]
[InlineData ("Ctrl@A", KeyCode.A | KeyCode.CtrlMask)]
public void TryParse_ShouldReturnTrue_WhenValidKey (string keyString, KeyCode expected)
{
Assert.True (Key.TryParse (keyString, out Key key));
Key expectedKey = expected;
Assert.Equal (expectedKey.ToString (), key.ToString ());
}
[Fact]
public void WithShift_ShouldReturnCorrectValue ()
{
Key a = Key.A;
Assert.Equal (KeyCode.A | KeyCode.ShiftMask, a.WithShift);
Key cad = Key.Delete.WithCtrl.WithAlt;
Assert.Equal (KeyCode.Delete | KeyCode.CtrlMask | KeyCode.AltMask, cad);
}
// Test Equals
[Fact]
public void Equals_ShouldReturnTrue_WhenEqual ()
{
Key a = Key.A;
Key b = Key.A;
Assert.True (a.Equals (b));
b.Handled = true;
Assert.False (a.Equals (b));
}
[Fact]
public void Equals_Handled_Changed_ShouldReturnTrue_WhenEqual ()
{
Key a = Key.A;
a.Handled = true;
Key b = Key.A;
b.Handled = true;
Assert.True (a.Equals (b));
}
[Fact]
public void Equals_Handled_Changed_ShouldReturnFalse_WhenNotEqual ()
{
Key a = Key.A;
a.Handled = true;
Key b = Key.A;
Assert.False (a.Equals (b));
}
[Fact]
public void Set_Key_Separator_With_Rune_Default_Ensure_Using_The_Default_Plus ()
{
Key key = new (Key.A.WithCtrl);
Assert.Equal ((Rune)'+', Key.Separator);
Assert.Equal ("Ctrl+A", key.ToString ());
Key.Separator = new ('-');
Assert.Equal ((Rune)'-', Key.Separator);
Assert.Equal ("Ctrl-A", key.ToString ());
Key.Separator = new ();
Assert.Equal ((Rune)'+', Key.Separator);
Assert.Equal ("Ctrl+A", key.ToString ());
}
}