Files
Terminal.Gui/UnitTests/Application/KeyboardTests.cs
Tig d2ad11248f Fixes #3127 - View Layout improvements - Redefines how LayoutStyle works. Fixes AutoSize etc... (#3130)
* Removes CheckAbsoulte and updates unit tests to match

* Fixed code that was dependent on ToString behavior vs. direct test for null

* Dim/Pos != null WIP

* Moved AutoSize specific tests out of Pos/Dim tests

* Broke out AutoSize = false tests to new file

* Commented test TODOs

* New test

* Removed unused API and cleaned up code

* Removed unused API and cleaned up code

* Cleaned up code

* Cleaned up code

* reorg'd Toplevel tests

* Fixed Create and related unit tests

* Added test from #3136

* Removed TopLevel.Create

* Fixed SetCurrentOverlappedAsTop

* Updated pull request template

* Updated pull request template

* Revert "Updated pull request template"

This reverts commit d807190dd9.

* reverting

* re-reverting

* Fixed every thing but autosize scenarios??

* Fixed hexview

* Fixed contextmenu

* Fixed more minor issues in tests

* Fixed more minor issues in tests

* Debugging Dialog test failure

* Fixed bad Dialog test. Was cleary invalid

* Fixed OnResizeNeeded bug

* Fixed OnResizeNeeded bug

* Fixed UICatalog to not eat exceptions

* Fixed TextView

* Removed Frame overrides

* Made Frame non-virtual

* Fixed radioGroup

* Fixed TabView

* Hcked ScrolLBarView unit tests to pass

* All AutoSize tests pass!

* All tests pass!!!!!!!

* Updated API docs. Cleaned up code.

* Fixed ColorPicker

* Added 'Bounds =' unit tests

* Refactored TextFormatter.Size setting logic

* Cleaned up OnResizeNeeded (api docs and usages)

* Merges in #3019 changes. Makes OnResizeNeeded non-virtual. If we find a use-case where someone wants to override it we can change this back.

* Fixed FileDialog bounds warning

* Removed resharper settings from editorconfig

* Added Pos.Center test to AllViewsTests.cs.
Modernized RadioGroup.
Fixed ProgressBar.

* Reverted formatting

* Reverted formatting

* Reverted formatting

* Reverted formatting

* Reverted formatting

* Reverted formatting

* Reverted formatting

* Code cleanup

* Code cleanup

* Code cleanup

* Code cleanup

* Code cleanup

* Code cleanup

* Code cleanup

* Code cleanup

* Reverted formatting
2024-01-12 17:43:35 -07:00

396 lines
12 KiB
C#

using System;
using System.Linq;
using Xunit;
using Xunit.Abstractions;
namespace Terminal.Gui.ApplicationTests;
public class KeyboardTests {
readonly ITestOutputHelper _output;
public KeyboardTests (ITestOutputHelper output)
{
this._output = output;
#if DEBUG_IDISPOSABLE
Responder.Instances.Clear ();
RunState.Instances.Clear ();
#endif
}
[Fact]
public void KeyUp_Event ()
{
Application.Init (new FakeDriver ());
// Setup some fake keypresses (This)
var input = "Tests";
// Put a control-q in at the end
FakeConsole.MockKeyPresses.Push (new ConsoleKeyInfo ('Q', ConsoleKey.Q, shift: false, alt: false, control: true));
foreach (var c in input.Reverse ()) {
if (char.IsLetter (c)) {
FakeConsole.MockKeyPresses.Push (new ConsoleKeyInfo (c, (ConsoleKey)char.ToUpper (c), shift: char.IsUpper (c), alt: false, control: false));
} else {
FakeConsole.MockKeyPresses.Push (new ConsoleKeyInfo (c, (ConsoleKey)c, shift: false, alt: false, control: false));
}
}
int stackSize = FakeConsole.MockKeyPresses.Count;
int iterations = 0;
Application.Iteration += (s, a) => {
iterations++;
// Stop if we run out of control...
if (iterations > 10) {
Application.RequestStop ();
}
};
int keyUps = 0;
var output = string.Empty;
Application.Top.KeyUp += (object sender, Key args) => {
if (args.KeyCode != (KeyCode.CtrlMask | KeyCode.Q)) {
output += args.AsRune;
}
keyUps++;
};
Application.Run (Application.Top);
// Input string should match output
Assert.Equal (input, output);
// # of key up events should match stack size
//Assert.Equal (stackSize, keyUps);
// We can't use numbers variables on the left side of an Assert.Equal/NotEqual,
// it must be literal (Linux only).
Assert.Equal (6, keyUps);
// # of key up events should match # of iterations
Assert.Equal (stackSize, iterations);
Application.Shutdown ();
Assert.Null (Application.Current);
Assert.Null (Application.Top);
Assert.Null (Application.MainLoop);
Assert.Null (Application.Driver);
}
[Fact]
public void AlternateForwardKey_AlternateBackwardKey_Tests ()
{
Application.Init (new FakeDriver ());
var top = Application.Top;
var w1 = new Window ();
var v1 = new TextField ();
var v2 = new TextView ();
w1.Add (v1, v2);
var w2 = new Window ();
var v3 = new CheckBox ();
var v4 = new Button ();
w2.Add (v3, v4);
top.Add (w1, w2);
Application.Iteration += (s, a) => {
Assert.True (v1.HasFocus);
// Using default keys.
top.NewKeyDownEvent (new (KeyCode.CtrlMask | KeyCode.Tab));
Assert.True (v2.HasFocus);
top.NewKeyDownEvent (new (KeyCode.CtrlMask | KeyCode.Tab));
Assert.True (v3.HasFocus);
top.NewKeyDownEvent (new (KeyCode.CtrlMask | KeyCode.Tab));
Assert.True (v4.HasFocus);
top.NewKeyDownEvent (new (KeyCode.CtrlMask | KeyCode.Tab));
Assert.True (v1.HasFocus);
top.NewKeyDownEvent (new (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.Tab));
Assert.True (v4.HasFocus);
top.NewKeyDownEvent (new (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.Tab));
Assert.True (v3.HasFocus);
top.NewKeyDownEvent (new (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.Tab));
Assert.True (v2.HasFocus);
top.NewKeyDownEvent (new (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.Tab));
Assert.True (v1.HasFocus);
top.NewKeyDownEvent (new (KeyCode.CtrlMask | KeyCode.PageDown));
Assert.True (v2.HasFocus);
top.NewKeyDownEvent (new (KeyCode.CtrlMask | KeyCode.PageDown));
Assert.True (v3.HasFocus);
top.NewKeyDownEvent (new (KeyCode.CtrlMask | KeyCode.PageDown));
Assert.True (v4.HasFocus);
top.NewKeyDownEvent (new (KeyCode.CtrlMask | KeyCode.PageDown));
Assert.True (v1.HasFocus);
top.NewKeyDownEvent (new (KeyCode.CtrlMask | KeyCode.PageUp));
Assert.True (v4.HasFocus);
top.NewKeyDownEvent (new (KeyCode.CtrlMask | KeyCode.PageUp));
Assert.True (v3.HasFocus);
top.NewKeyDownEvent (new (KeyCode.CtrlMask | KeyCode.PageUp));
Assert.True (v2.HasFocus);
top.NewKeyDownEvent (new (KeyCode.CtrlMask | KeyCode.PageUp));
Assert.True (v1.HasFocus);
// Using another's alternate keys.
Application.AlternateForwardKey = KeyCode.F7;
Application.AlternateBackwardKey = KeyCode.F6;
top.NewKeyDownEvent (new (KeyCode.F7));
Assert.True (v2.HasFocus);
top.NewKeyDownEvent (new (KeyCode.F7));
Assert.True (v3.HasFocus);
top.NewKeyDownEvent (new (KeyCode.F7));
Assert.True (v4.HasFocus);
top.NewKeyDownEvent (new (KeyCode.F7));
Assert.True (v1.HasFocus);
top.NewKeyDownEvent (new (KeyCode.F6));
Assert.True (v4.HasFocus);
top.NewKeyDownEvent (new (KeyCode.F6));
Assert.True (v3.HasFocus);
top.NewKeyDownEvent (new (KeyCode.F6));
Assert.True (v2.HasFocus);
top.NewKeyDownEvent (new (KeyCode.F6));
Assert.True (v1.HasFocus);
Application.RequestStop ();
};
Application.Run (top);
// Replacing the defaults keys to avoid errors on others unit tests that are using it.
Application.AlternateForwardKey = KeyCode.PageDown | KeyCode.CtrlMask;
Application.AlternateBackwardKey = KeyCode.PageUp | KeyCode.CtrlMask;
Application.QuitKey = KeyCode.Q | KeyCode.CtrlMask;
Assert.Equal (KeyCode.PageDown | KeyCode.CtrlMask, Application.AlternateForwardKey.KeyCode);
Assert.Equal (KeyCode.PageUp | KeyCode.CtrlMask, Application.AlternateBackwardKey.KeyCode);
Assert.Equal (KeyCode.Q | KeyCode.CtrlMask, Application.QuitKey.KeyCode);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
[AutoInitShutdown]
public void QuitKey_Getter_Setter ()
{
var top = Application.Top;
var isQuiting = false;
top.Closing += (s, e) => {
isQuiting = true;
e.Cancel = true;
};
Application.Begin (top);
top.Running = true;
Assert.Equal (KeyCode.Q | KeyCode.CtrlMask, Application.QuitKey.KeyCode);
Application.Driver.SendKeys ('Q', ConsoleKey.Q, false, false, true);
Assert.True (isQuiting);
isQuiting = false;
Application.OnKeyDown (new Key (KeyCode.Q | KeyCode.CtrlMask));
Assert.True (isQuiting);
isQuiting = false;
Application.QuitKey = KeyCode.C | KeyCode.CtrlMask;
Application.Driver.SendKeys ('Q', ConsoleKey.Q, false, false, true);
Assert.False (isQuiting);
Application.OnKeyDown (new Key (KeyCode.Q | KeyCode.CtrlMask));
Assert.False (isQuiting);
Application.OnKeyDown (Application.QuitKey);
Assert.True (isQuiting);
// Reset the QuitKey to avoid throws errors on another tests
Application.QuitKey = KeyCode.Q | KeyCode.CtrlMask;
}
[Fact]
[AutoInitShutdown]
public void EnsuresTopOnFront_CanFocus_True_By_Keyboard_And_Mouse ()
{
var top = Application.Top;
var win = new Window () { Title = "win", X = 0, Y = 0, Width = 20, Height = 10 };
var tf = new TextField () { Width = 10 };
win.Add (tf);
var win2 = new Window () { Title = "win2", X = 22, Y = 0, Width = 20, Height = 10 };
var tf2 = new TextField () { Width = 10 };
win2.Add (tf2);
top.Add (win, win2);
Application.Begin (top);
Assert.True (win.CanFocus);
Assert.True (win.HasFocus);
Assert.True (win2.CanFocus);
Assert.False (win2.HasFocus);
Assert.Equal ("win2", ((Window)top.Subviews [top.Subviews.Count - 1]).Title);
top.NewKeyDownEvent (new (KeyCode.CtrlMask | KeyCode.Tab));
Assert.True (win.CanFocus);
Assert.False (win.HasFocus);
Assert.True (win2.CanFocus);
Assert.True (win2.HasFocus);
Assert.Equal ("win2", ((Window)top.Subviews [top.Subviews.Count - 1]).Title);
top.NewKeyDownEvent (new (KeyCode.CtrlMask | KeyCode.Tab));
Assert.True (win.CanFocus);
Assert.True (win.HasFocus);
Assert.True (win2.CanFocus);
Assert.False (win2.HasFocus);
Assert.Equal ("win", ((Window)top.Subviews [top.Subviews.Count - 1]).Title);
win2.MouseEvent (new MouseEvent () { Flags = MouseFlags.Button1Pressed });
Assert.True (win.CanFocus);
Assert.False (win.HasFocus);
Assert.True (win2.CanFocus);
Assert.True (win2.HasFocus);
Assert.Equal ("win2", ((Window)top.Subviews [top.Subviews.Count - 1]).Title);
win2.MouseEvent (new MouseEvent () { Flags = MouseFlags.Button1Released });
Assert.Null (Toplevel._dragPosition);
}
[Fact]
[AutoInitShutdown]
public void EnsuresTopOnFront_CanFocus_False_By_Keyboard_And_Mouse ()
{
var top = Application.Top;
var win = new Window () { Title = "win", X = 0, Y = 0, Width = 20, Height = 10 };
var tf = new TextField () { Width = 10 };
win.Add (tf);
var win2 = new Window () { Title = "win2", X = 22, Y = 0, Width = 20, Height = 10 };
var tf2 = new TextField () { Width = 10 };
win2.Add (tf2);
top.Add (win, win2);
Application.Begin (top);
Assert.True (win.CanFocus);
Assert.True (win.HasFocus);
Assert.True (win2.CanFocus);
Assert.False (win2.HasFocus);
Assert.Equal ("win2", ((Window)top.Subviews [top.Subviews.Count - 1]).Title);
win.CanFocus = false;
Assert.False (win.CanFocus);
Assert.False (win.HasFocus);
Assert.True (win2.CanFocus);
Assert.True (win2.HasFocus);
Assert.Equal ("win2", ((Window)top.Subviews [top.Subviews.Count - 1]).Title);
top.NewKeyDownEvent (new (KeyCode.CtrlMask | KeyCode.Tab));
Assert.True (win2.CanFocus);
Assert.False (win.HasFocus);
Assert.True (win2.CanFocus);
Assert.True (win2.HasFocus);
Assert.Equal ("win2", ((Window)top.Subviews [top.Subviews.Count - 1]).Title);
top.NewKeyDownEvent (new (KeyCode.CtrlMask | KeyCode.Tab));
Assert.False (win.CanFocus);
Assert.False (win.HasFocus);
Assert.True (win2.CanFocus);
Assert.True (win2.HasFocus);
Assert.Equal ("win2", ((Window)top.Subviews [top.Subviews.Count - 1]).Title);
win.MouseEvent (new MouseEvent () { Flags = MouseFlags.Button1Pressed });
Assert.False (win.CanFocus);
Assert.False (win.HasFocus);
Assert.True (win2.CanFocus);
Assert.True (win2.HasFocus);
Assert.Equal ("win2", ((Window)top.Subviews [top.Subviews.Count - 1]).Title);
win2.MouseEvent (new MouseEvent () { Flags = MouseFlags.Button1Released });
Assert.Null (Toplevel._dragPosition);
}
// test Application key Bindings
public class ScopedKeyBindingView : View {
public bool ApplicationCommand { get; set; }
public bool HotKeyCommand { get; set; }
public bool FocusedCommand { get; set; }
public ScopedKeyBindingView ()
{
AddCommand (Command.Save, () => ApplicationCommand = true);
AddCommand (Command.Default, () => HotKeyCommand = true);
AddCommand (Command.Left, () => FocusedCommand = true);
KeyBindings.Add (KeyCode.A, KeyBindingScope.Application, Command.Save);
HotKey = KeyCode.H;
KeyBindings.Add (KeyCode.F, KeyBindingScope.Focused, Command.Left);
}
}
[Fact]
[AutoInitShutdown]
public void OnKeyDown_Application_KeyBinding ()
{
var view = new ScopedKeyBindingView ();
var invoked = false;
view.InvokingKeyBindings += (s, e) => invoked = true;
Application.Top.Add (view);
Application.Begin (Application.Top);
Application.OnKeyDown (new (KeyCode.A));
Assert.True (invoked);
Assert.True (view.ApplicationCommand);
invoked = false;
view.ApplicationCommand = false;
view.KeyBindings.Remove (KeyCode.A);
Application.OnKeyDown (new (KeyCode.A)); // old
Assert.False (invoked);
Assert.False (view.ApplicationCommand);
view.KeyBindings.Add (KeyCode.A | KeyCode.CtrlMask, KeyBindingScope.Application, Command.Save);
Application.OnKeyDown (new (KeyCode.A)); // old
Assert.False (invoked);
Assert.False (view.ApplicationCommand);
Application.OnKeyDown (new (KeyCode.A | KeyCode.CtrlMask)); // new
Assert.True (invoked);
Assert.True (view.ApplicationCommand);
invoked = false;
Application.OnKeyDown (new (KeyCode.H));
Assert.True (invoked);
invoked = false;
Assert.False (view.HasFocus);
Application.OnKeyDown (new (KeyCode.F));
Assert.False (invoked);
Assert.True (view.ApplicationCommand);
Assert.True (view.HotKeyCommand);
Assert.False (view.FocusedCommand);
}
[Fact]
[AutoInitShutdown]
public void OnKeyDown_Application_KeyBinding_Negative ()
{
var view = new ScopedKeyBindingView ();
var invoked = false;
view.InvokingKeyBindings += (s, e) => invoked = true;
Application.Top.Add (view);
Application.Begin (Application.Top);
Application.OnKeyDown (new (KeyCode.A | KeyCode.CtrlMask));
Assert.False (invoked);
Assert.False (view.ApplicationCommand);
Assert.False (view.HotKeyCommand);
Assert.False (view.FocusedCommand);
invoked = false;
Assert.False (view.HasFocus);
Application.OnKeyDown (new (KeyCode.Z));
Assert.False (invoked);
Assert.False (view.ApplicationCommand);
Assert.False (view.HotKeyCommand);
Assert.False (view.FocusedCommand);
}
}