Files
Terminal.Gui/Tests/UnitTestsParallelizable/Application/Mouse/MouseInterfaceTests.cs
Tig 5da7e59aa2 Fixes #4456 - Clear MouseGrabView in App.End (#4460)
* Fixed MouseGrabView bug.

Added extensive test coverage for `Keyboard`, `Mouse`, `Timeout`, and `Popover` functionalities, including edge cases and concurrent access. Introduced parameterized and data-driven tests to reduce redundancy and improve clarity.

Refactored codebase for modularity and maintainability,
introducing new namespaces and reorganizing classes. Enhanced `MouseImpl`, `KeyboardImpl`, and `Runnable` implementations with improved event handling, thread safety, and support for the Terminal.Gui Cancellable Work Pattern (CWP).

Removed deprecated code and legacy tests, such as `LogarithmicTimeout` and `SmoothAcceleratingTimeout`. Fixed bugs related to mouse grabbing during drag operations and unbalanced `ApplicationImpl.Begin/End` calls. Improved documentation and code readability with modern C# features.

* Code cleanup.

* Update Tests/UnitTestsParallelizable/Application/Runnable/RunnableIntegrationTests.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Improve null handling and simplify test setup

In `MouseImpl.cs`, added an early `return` after the `UngrabMouse()`
call within the `if (view is null)` block to prevent further execution
when `view` is `null`, improving null reference handling.

In `RunnableIntegrationTests.cs`, removed the initialization of the
`IApplication` object (`app`) from the `MultipleRunnables_IndependentResults`
test method, simplifying the test setup and focusing on runnable behavior.

* Code cleanup

* API doc link cleanup

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-12-07 13:01:19 -07:00

444 lines
11 KiB
C#

using Xunit.Abstractions;
namespace ApplicationTests.Mouse;
/// <summary>
/// Parallelizable tests for IMouse interface.
/// Tests the decoupled mouse handling without Application.Init or global state.
/// </summary>
[Trait ("Category", "Input")]
public class MouseInterfaceTests (ITestOutputHelper output)
{
private readonly ITestOutputHelper _output = output;
#region IMouse Basic Properties
[Fact]
public void Mouse_LastMousePosition_InitiallyNull ()
{
// Arrange
MouseImpl mouse = new ();
// Act & Assert
Assert.Null (mouse.LastMousePosition);
}
[Theory]
[InlineData (0, 0)]
[InlineData (10, 20)]
[InlineData (-5, -10)]
[InlineData (100, 200)]
public void Mouse_LastMousePosition_CanBeSetAndRetrieved (int x, int y)
{
// Arrange
MouseImpl mouse = new ();
Point testPosition = new (x, y);
// Act
mouse.LastMousePosition = testPosition;
// Assert
Assert.Equal (testPosition, mouse.LastMousePosition);
Assert.Equal (testPosition, mouse.LastMousePosition);
}
[Fact]
public void Mouse_IsMouseDisabled_DefaultsFalse ()
{
// Arrange
MouseImpl mouse = new ();
// Act & Assert
Assert.False (mouse.IsMouseDisabled);
}
[Theory]
[InlineData (true)]
[InlineData (false)]
public void Mouse_IsMouseDisabled_CanBeSetAndRetrieved (bool disabled)
{
// Arrange
MouseImpl mouse = new ();
// Act
mouse.IsMouseDisabled = disabled;
// Assert
Assert.Equal (disabled, mouse.IsMouseDisabled);
}
[Fact]
public void Mouse_CachedViewsUnderMouse_InitiallyEmpty ()
{
// Arrange
MouseImpl mouse = new ();
// Act & Assert
Assert.NotNull (mouse.CachedViewsUnderMouse);
Assert.Empty (mouse.CachedViewsUnderMouse);
}
#endregion
#region IMouse Event Handling
[Fact]
public void Mouse_MouseEvent_CanSubscribeAndFire ()
{
// Arrange
MouseImpl mouse = new ();
var eventFired = false;
MouseEventArgs? capturedArgs = null;
mouse.MouseEvent += (sender, args) =>
{
eventFired = true;
capturedArgs = args;
};
MouseEventArgs testEvent = new ()
{
ScreenPosition = new (5, 10),
Flags = MouseFlags.Button1Pressed
};
// Act
mouse.RaiseMouseEvent (testEvent);
// Assert
Assert.True (eventFired);
Assert.NotNull (capturedArgs);
Assert.Equal (testEvent.ScreenPosition, capturedArgs.ScreenPosition);
Assert.Equal (testEvent.Flags, capturedArgs.Flags);
}
[Fact]
public void Mouse_MouseEvent_CanUnsubscribe ()
{
// Arrange
MouseImpl mouse = new ();
var eventCount = 0;
void Handler (object? sender, MouseEventArgs args) { eventCount++; }
mouse.MouseEvent += Handler;
MouseEventArgs testEvent = new ()
{
ScreenPosition = new (0, 0),
Flags = MouseFlags.Button1Pressed
};
// Act - Fire once
mouse.RaiseMouseEvent (testEvent);
Assert.Equal (1, eventCount);
// Unsubscribe
mouse.MouseEvent -= Handler;
// Fire again
mouse.RaiseMouseEvent (testEvent);
// Assert - Count should not increase
Assert.Equal (1, eventCount);
}
[Fact]
public void Mouse_RaiseMouseEvent_WithDisabledMouse_DoesNotFireEvent ()
{
// Arrange
MouseImpl mouse = new ();
var eventFired = false;
mouse.MouseEvent += (sender, args) => { eventFired = true; };
mouse.IsMouseDisabled = true;
MouseEventArgs testEvent = new ()
{
ScreenPosition = new (0, 0),
Flags = MouseFlags.Button1Pressed
};
// Act
mouse.RaiseMouseEvent (testEvent);
// Assert
Assert.False (eventFired);
}
[Theory]
[InlineData (MouseFlags.Button1Pressed)]
[InlineData (MouseFlags.Button1Released)]
[InlineData (MouseFlags.Button1Clicked)]
[InlineData (MouseFlags.Button2Pressed)]
[InlineData (MouseFlags.WheeledUp)]
[InlineData (MouseFlags.ReportMousePosition)]
public void Mouse_RaiseMouseEvent_CorrectlyPassesFlags (MouseFlags flags)
{
// Arrange
MouseImpl mouse = new ();
MouseFlags? capturedFlags = null;
mouse.MouseEvent += (sender, args) => { capturedFlags = args.Flags; };
MouseEventArgs testEvent = new ()
{
ScreenPosition = new (5, 5),
Flags = flags
};
// Act
mouse.RaiseMouseEvent (testEvent);
// Assert
Assert.NotNull (capturedFlags);
Assert.Equal (flags, capturedFlags.Value);
}
#endregion
#region IMouse ResetState
[Fact]
public void Mouse_ResetState_ClearsCachedViews ()
{
// Arrange
MouseImpl mouse = new ();
View testView = new () { Width = 10, Height = 10 };
mouse.CachedViewsUnderMouse.Add (testView);
Assert.Single (mouse.CachedViewsUnderMouse);
// Act
mouse.ResetState ();
// Assert
Assert.Empty (mouse.CachedViewsUnderMouse);
testView.Dispose ();
}
[Fact]
public void Mouse_ResetState_ClearsEventHandlers ()
{
// Arrange
MouseImpl mouse = new ();
var eventCount = 0;
mouse.MouseEvent += (sender, args) => eventCount++;
MouseEventArgs testEvent = new ()
{
ScreenPosition = new (0, 0),
Flags = MouseFlags.Button1Pressed
};
// Verify event fires before reset
mouse.RaiseMouseEvent (testEvent);
Assert.Equal (1, eventCount);
// Act
mouse.ResetState ();
// Raise event again
mouse.RaiseMouseEvent (testEvent);
// Assert - Event count should not increase after reset
Assert.Equal (1, eventCount);
}
[Fact]
public void Mouse_ResetState_DoesNotClearLastMousePosition ()
{
// Arrange
MouseImpl mouse = new ();
Point testPosition = new (42, 84);
mouse.LastMousePosition = testPosition;
// Act
mouse.ResetState ();
// Assert - LastMousePosition should NOT be cleared (per design)
Assert.Equal (testPosition, mouse.LastMousePosition);
}
#endregion
#region IMouse Isolation
[Fact]
public void Mouse_Instances_AreIndependent ()
{
// Arrange
MouseImpl mouse1 = new ();
MouseImpl mouse2 = new ();
// Act
mouse1.IsMouseDisabled = true;
mouse1.LastMousePosition = new Point (10, 10);
// Assert - mouse2 should be unaffected
Assert.False (mouse2.IsMouseDisabled);
Assert.Null (mouse2.LastMousePosition);
}
[Fact]
public void Mouse_Events_AreIndependent ()
{
// Arrange
MouseImpl mouse1 = new ();
var mouse1EventCount = 0;
MouseImpl mouse2 = new ();
var mouse2EventCount = 0;
mouse1.MouseEvent += (sender, args) => mouse1EventCount++;
mouse2.MouseEvent += (sender, args) => mouse2EventCount++;
MouseEventArgs testEvent = new ()
{
ScreenPosition = new (0, 0),
Flags = MouseFlags.Button1Pressed
};
// Act
mouse1.RaiseMouseEvent (testEvent);
// Assert
Assert.Equal (1, mouse1EventCount);
Assert.Equal (0, mouse2EventCount);
}
[Fact]
public void Mouse_CachedViews_AreIndependent ()
{
// Arrange
MouseImpl mouse1 = new ();
MouseImpl mouse2 = new ();
View view1 = new ();
View view2 = new ();
// Act
mouse1.CachedViewsUnderMouse.Add (view1);
mouse2.CachedViewsUnderMouse.Add (view2);
// Assert
Assert.Single (mouse1.CachedViewsUnderMouse);
Assert.Single (mouse2.CachedViewsUnderMouse);
Assert.Contains (view1, mouse1.CachedViewsUnderMouse);
Assert.Contains (view2, mouse2.CachedViewsUnderMouse);
Assert.DoesNotContain (view2, mouse1.CachedViewsUnderMouse);
Assert.DoesNotContain (view1, mouse2.CachedViewsUnderMouse);
view1.Dispose ();
view2.Dispose ();
}
#endregion
#region Mouse Grab Tests
[Fact]
public void Mouse_GrabMouse_SetsMouseGrabView ()
{
// Arrange
MouseImpl mouse = new ();
View testView = new ();
// Act
mouse.GrabMouse (testView);
// Assert
Assert.Equal (testView, mouse.MouseGrabView);
}
[Fact]
public void Mouse_UngrabMouse_ClearsMouseGrabView ()
{
// Arrange
MouseImpl mouse = new ();
View testView = new ();
mouse.GrabMouse (testView);
// Act
mouse.UngrabMouse ();
// Assert
Assert.Null (mouse.MouseGrabView);
}
[Fact]
public void Mouse_GrabbingMouse_CanBeCanceled ()
{
// Arrange
MouseImpl mouse = new ();
View testView = new ();
var eventFired = false;
mouse.GrabbingMouse += (sender, args) =>
{
eventFired = true;
args.Cancel = true;
};
// Act
mouse.GrabMouse (testView);
// Assert
Assert.True (eventFired);
Assert.Null (mouse.MouseGrabView); // Should not be set because it was cancelled
}
[Fact]
public void Mouse_GrabbedMouse_EventFired ()
{
// Arrange
MouseImpl mouse = new ();
View testView = new ();
var eventFired = false;
View? eventView = null;
mouse.GrabbedMouse += (sender, args) =>
{
eventFired = true;
eventView = args.View;
};
// Act
mouse.GrabMouse (testView);
// Assert
Assert.True (eventFired);
Assert.Equal (testView, eventView);
}
[Fact]
public void Mouse_UnGrabbedMouse_EventFired ()
{
// Arrange
MouseImpl mouse = new ();
View testView = new ();
mouse.GrabMouse (testView);
var eventFired = false;
View? eventView = null;
mouse.UnGrabbedMouse += (sender, args) =>
{
eventFired = true;
eventView = args.View;
};
// Act
mouse.UngrabMouse ();
// Assert
Assert.True (eventFired);
Assert.Equal (testView, eventView);
}
#endregion
}