using TerminalGuiFluentTesting;
using TerminalGuiFluentTestingXunit;
using Xunit.Abstractions;
namespace IntegrationTests.FluentTests;
///
/// Integration tests for GuiTestContext keyboard event handling (EnqueueKeyEvent).
///
public class GuiTestContextKeyEventTests (ITestOutputHelper outputHelper)
{
private readonly TextWriter _out = new TestOutputWriter (outputHelper);
[Theory]
[ClassData (typeof (TestDrivers))]
public void QuitKey_ViaApplication_Stops (TestDriver d)
{
using GuiTestContext context = With.A (40, 10, d);
Assert.True (context.App?.Current!.IsRunning);
Toplevel? top = context.App?.Current;
context.Then ((_) => context!.App?.Keyboard.RaiseKeyDownEvent (Application.QuitKey));
Assert.False (top!.IsRunning);
}
[Theory]
[ClassData (typeof (TestDrivers))]
public void QuitKey_ViaEnqueueKey_Stops (TestDriver d)
{
using GuiTestContext context = With.A (40, 10, d, _out);
Assert.True (context.App?.Current!.IsRunning);
Toplevel? top = context.App?.Current;
context.EnqueueKeyEvent (Application.QuitKey);
Assert.False (top!.IsRunning);
}
[Theory]
[ClassData (typeof (TestDrivers))]
public void EnqueueKey_AfterResizeConsole_StillWorks (TestDriver d)
{
var keyReceived = false;
var view = new View { CanFocus = true };
view.KeyDown += (s, e) => keyReceived = true;
using GuiTestContext context = With.A (40, 10, d, _out)
.Add (view)
.Then ((_) => view.SetFocus ())
.ResizeConsole (50, 20)
.EnqueueKeyEvent (Key.A);
Assert.True (keyReceived);
}
[Theory]
[ClassData (typeof (TestDrivers))]
public void EnqueueKey_Backspace_DeletesCharacter (TestDriver d)
{
var textField = new TextField { Text = "TEST", Width = 20 };
using GuiTestContext context = With.A (40, 10, d, _out)
.Add (textField)
.Focus (textField)
.Then ((_) => textField.CursorPosition = textField.Text.Length)
.EnqueueKeyEvent (Key.Backspace)
.EnqueueKeyEvent (Key.Backspace);
Assert.Equal ("TE", textField.Text);
}
[Theory]
[ClassData (typeof (TestDrivers))]
public void EnqueueKey_ChainedWithOtherOperations_WorksCorrectly (TestDriver d)
{
var textField = new TextField { Width = 20 };
var clickedCount = 0;
var button = new Button { Text = "Click Me" };
button.Accepting += (s, e) => clickedCount++;
using GuiTestContext context = With.A (40, 10, d, _out)
.Add (textField)
.Add (button)
.Then ((_) => textField.SetFocus ())
.EnqueueKeyEvent (Key.T.WithShift)
.EnqueueKeyEvent (Key.E)
.EnqueueKeyEvent (Key.S)
.EnqueueKeyEvent (Key.T)
.AssertEqual ("Test", textField.Text)
.EnqueueKeyEvent (Key.Tab)
.Then ((_) => Assert.True (button.HasFocus))
.EnqueueKeyEvent (Key.Enter)
.AssertEqual (1, clickedCount);
}
[Theory]
[ClassData (typeof (TestDrivers))]
public void EnqueueKey_EnqueuesKeyAndProcessesIt (TestDriver d)
{
var keyReceived = false;
var receivedKey = Key.Empty;
var view = new View { CanFocus = true };
view.KeyDown += (s, e) =>
{
keyReceived = true;
receivedKey = e;
};
using GuiTestContext context = With.A (40, 10, d, _out)
.Add (view)
.Then ((_) => view.SetFocus ())
.EnqueueKeyEvent (Key.A);
Assert.True (keyReceived, "Key was not received by the view");
Assert.Equal (Key.A, receivedKey);
}
[Theory]
[ClassData (typeof (TestDrivers))]
public void EnqueueKey_FunctionKeys_ProcessesCorrectly (TestDriver d)
{
List keysReceived = [];
var view = new View { CanFocus = true };
view.KeyDown += (s, e) => keysReceived.Add (e);
using GuiTestContext context = With.A (40, 10, d, _out)
.Add (view)
.Then ((_) => view.SetFocus ())
.EnqueueKeyEvent (Key.F1)
.EnqueueKeyEvent (Key.F5)
.EnqueueKeyEvent (Key.F12);
Assert.Equal (3, keysReceived.Count);
Assert.Equal (Key.F1, keysReceived [0]);
Assert.Equal (Key.F5, keysReceived [1]);
Assert.Equal (Key.F12, keysReceived [2]);
}
[Theory]
[ClassData (typeof (TestDrivers))]
public void EnqueueKey_MultipleKeys_ProcessesInOrder (TestDriver d)
{
List keysReceived = [];
var view = new View { CanFocus = true };
view.KeyDown += (s, e) => keysReceived.Add (e);
using GuiTestContext context = With.A (40, 10, d, _out)
.Add (view)
.Then ((_) => view.SetFocus ())
.EnqueueKeyEvent (Key.A)
.EnqueueKeyEvent (Key.B)
.EnqueueKeyEvent (Key.C);
Assert.Equal (3, keysReceived.Count);
Assert.Equal (Key.A, keysReceived [0]);
Assert.Equal (Key.B, keysReceived [1]);
Assert.Equal (Key.C, keysReceived [2]);
}
[Theory]
[ClassData (typeof (TestDrivers))]
public void EnqueueKey_NavigationKeys_ChangeFocus (TestDriver d)
{
var view1 = new View { Id = "view1", CanFocus = true };
var view2 = new View { Id = "view2", CanFocus = true };
using GuiTestContext context = With.A (40, 10, d, _out)
.Add (view1)
.Add (view2)
.Then ((_) => view1.SetFocus ())
.AssertTrue (view1.HasFocus)
.AssertFalse (view2.HasFocus)
.EnqueueKeyEvent (Key.Tab)
.AssertFalse (view1.HasFocus)
.AssertTrue (view2.HasFocus)
.EnqueueKeyEvent (Key.Tab.WithShift)
.AssertTrue (view1.HasFocus)
.AssertFalse (view2.HasFocus);
}
[Theory]
[ClassData (typeof (TestDrivers))]
public void EnqueueKey_NumericKeys_ProcessesCorrectly (TestDriver d)
{
var textField = new TextField { Width = 20 };
using GuiTestContext context = With.A (40, 10, d, _out)
.Add (textField)
.Then ((_) => textField.SetFocus ())
.EnqueueKeyEvent (Key.D1)
.EnqueueKeyEvent (Key.D2)
.EnqueueKeyEvent (Key.D3)
.EnqueueKeyEvent (Key.D4)
.EnqueueKeyEvent (Key.D5);
Assert.Equal ("12345", textField.Text);
}
[Theory]
[ClassData (typeof (TestDrivers))]
public void EnqueueKey_RapidSequence_ProcessesAllKeys (TestDriver d)
{
List keysReceived = [];
var view = new View { CanFocus = true };
view.KeyDown += (s, e) => keysReceived.Add (e);
using GuiTestContext context = With.A (40, 10, d, _out)
.Add (view)
.Then ((_) => view.SetFocus ());
// Send 10 keys rapidly
for (var i = 0; i < 10; i++)
{
context.EnqueueKeyEvent ((Key)(Key.A.KeyCode + (uint)i));
}
Assert.Equal (10, keysReceived.Count);
for (var i = 0; i < 10; i++)
{
Assert.Equal ((Key)(Key.A.KeyCode + (uint)i), keysReceived [i]);
}
}
[Theory]
[ClassData (typeof (TestDrivers))]
public void EnqueueKey_SpecialKeys_ProcessesCorrectly (TestDriver d)
{
List keysReceived = [];
var view = new View { CanFocus = true };
view.KeyDown += (s, e) => keysReceived.Add (e);
using GuiTestContext context = With.A (40, 10, d, _out)
.Add (view)
.Then ((_) => view.SetFocus ())
.EnqueueKeyEvent (Key.Enter)
.EnqueueKeyEvent (Key.Tab)
.EnqueueKeyEvent (Key.CursorUp)
.EnqueueKeyEvent (Key.CursorDown)
.EnqueueKeyEvent (Key.Esc);
Assert.Equal (5, keysReceived.Count);
Assert.Equal (Key.Enter, keysReceived [0]);
Assert.Equal (Key.Tab, keysReceived [1]);
Assert.Equal (Key.CursorUp, keysReceived [2]);
Assert.Equal (Key.CursorDown, keysReceived [3]);
Assert.Equal (Key.Esc, keysReceived [4]);
}
[Theory]
[ClassData (typeof (TestDrivers))]
public void EnqueueKey_WithListView_NavigatesItems (TestDriver d)
{
var listView = new ListView
{
Width = Dim.Fill (),
Height = Dim.Fill ()
};
listView.SetSource (["Item1", "Item2", "Item3", "Item4", "Item5"]);
listView.SelectedItem = 0;
using GuiTestContext context = With.A (40, 10, d, _out)
.Add (listView)
.Then ((_) => listView.SetFocus ())
.AssertEqual (0, listView.SelectedItem)
.EnqueueKeyEvent (Key.CursorDown)
.AssertEqual (1, listView.SelectedItem)
.EnqueueKeyEvent (Key.CursorDown)
.AssertEqual (2, listView.SelectedItem)
.EnqueueKeyEvent (Key.CursorUp)
.AssertEqual (1, listView.SelectedItem);
}
[Theory]
[ClassData (typeof (TestDrivers))]
public void EnqueueKey_WithModifiers_ProcessesCorrectly (TestDriver d)
{
var keyReceived = false;
var receivedKey = Key.Empty;
var view = new View { CanFocus = true };
view.KeyDown += (s, e) =>
{
keyReceived = true;
receivedKey = e;
};
using GuiTestContext context = With.A (40, 10, d, _out)
.Add (view)
.Then ((_) => view.SetFocus ())
.EnqueueKeyEvent (Key.A.WithCtrl);
Assert.True (keyReceived);
Assert.Equal (Key.A.WithCtrl, receivedKey);
Assert.True (receivedKey.IsCtrl);
}
[Theory]
[ClassData (typeof (TestDrivers))]
public void EnqueueKey_WithTextField_UpdatesText (TestDriver d)
{
var textField = new TextField { Width = 20 };
using GuiTestContext context = With.A (40, 10, d, _out)
.Add (textField)
.EnqueueKeyEvent (Key.H.WithShift)
.EnqueueKeyEvent (Key.E)
.EnqueueKeyEvent (Key.L)
.EnqueueKeyEvent (Key.L)
.EnqueueKeyEvent (Key.O);
//Assert.Equal ("Hello", textField.Text);
}
}