Files
Terminal.Gui/Tests/UnitTestsParallelizable/Application/MouseTests.cs
Copilot 4974343e74 Fixes #4317 - Refactor Application.Mouse for decoupling and parallelism (#4318)
* Initial plan

* Refactor Application.Mouse - Create IMouse interface and Mouse implementation

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add enhanced documentation for Application.Mouse property

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add parallelizable unit tests for IMouse interface

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Refactor Application.Mouse for decoupling and parallelism

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Move HandleMouseGrab method to IMouseGrabHandler interface

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add parallelizable tests for IMouse and IMouseGrabHandler interfaces

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add MouseEventRoutingTests - 27 parallelizable tests for View mouse event handling

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Fix terminology: Replace parent/child with superView/subView in MouseEventRoutingTests

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Fix coding standards: Use explicit types and target-typed new() in test files

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update coding standards documentation with explicit var and target-typed new() guidance

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Refactor Application classes and improve maintainability

Refactored `Sixel` property to be immutable, enhancing thread safety.
Cleaned up `ApplicationImpl` by removing redundant fields, restructuring
methods (`CreateDriver`, `CreateSubcomponents`), and improving exception
handling. Updated `Run<T>` and `Shutdown` methods for consistency.

Standardized logging/debugging messages and fixed formatting issues.
Reorganized `IApplication` interface, added detailed XML documentation,
and grouped related methods logically.

Performed general code cleanup, including fixing typos, improving
readability, and removing legacy/unnecessary code to reduce technical debt.

* Code cleanup

* Remove unreferenced LayoutAndDraw method from ApplicationImpl

* Code cleanup and TODOs

- Updated namespaces to reflect the new structure.
- Added `Driver`, `Force16Colors`, and `ForceDriver` properties.
- Introduced `Sixel` collection for sixel image management.
- Added lifecycle methods: `GetDriverTypes`, `Shutdown`, and events.
- Refactored `Init` to support legacy and modern drivers.
- Improved driver event handling and screen abstraction.
- Updated `Run` method to align with the application lifecycle.
- Simplified `IConsoleDriver` documentation.
- Removed redundant methods and improved code readability.

* Refactor LayoutAndDraw logic for better encapsulation

Refactored `Application.Run` to delegate `LayoutAndDraw` to
`ApplicationImpl.Instance.LayoutAndDraw`, improving separation
of concerns. Renamed `forceDraw` to `forceRedraw` for clarity
and moved `LayoutAndDraw` implementation to `ApplicationImpl`.

Added a new `LayoutAndDraw` method in `ApplicationImpl` to
handle layout and drawing, including managing `TopLevels`,
handling active popovers, and refreshing the screen. Updated
the `IApplication` interface to reflect the new method and
improved its documentation.

Implemented `RequestStop` in `ApplicationImpl` and fixed
formatting inconsistencies in `Run<T>`. Added TODOs for future
refactoring to encapsulate `Top` and `TopLevels` into an
`IViewHierarchy` and move certain properties to `IApplication`.

* Refactor ApplicationImpl to enhance mouse and keyboard support

Added a new `Mouse` property to the `ApplicationImpl` class,
replacing its previous declaration, to improve mouse
functionality. Updated `MouseGrabHandler` to initialize with
a default instance of `MouseGrabHandler`.

Added comments to ensure the preservation of existing keyboard
settings (`QuitKey`, `ArrangeKey`, `NextTabKey`) for backward
compatibility. These changes enhance clarity, functionality,
and maintainability of the class.

* Merge IMouseGrabHandler into IMouse - consolidate mouse handling into single interface

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Rename Mouse to MouseImpl and Keyboard to KeyboardImpl for consistency

Co-authored-by: tig <585482+tig@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: tig <585482+tig@users.noreply.github.com>
Co-authored-by: Tig <tig@users.noreply.github.com>
2025-10-25 08:48:26 -06:00

126 lines
3.7 KiB
C#

using Terminal.Gui.App;
using Xunit.Abstractions;
namespace UnitTests_Parallelizable.ApplicationTests;
/// <summary>
/// Tests for the <see cref="IMouse"/> interface and <see cref="MouseImpl"/> implementation.
/// These tests demonstrate the decoupled mouse handling that enables parallel test execution.
/// </summary>
public class MouseTests (ITestOutputHelper output)
{
private readonly ITestOutputHelper _output = output;
[Fact]
public void Mouse_Instance_CreatedSuccessfully ()
{
// Arrange & Act
MouseImpl mouse = new ();
// Assert
Assert.NotNull (mouse);
Assert.False (mouse.IsMouseDisabled);
Assert.Null (mouse.LastMousePosition);
}
[Fact]
public void Mouse_LastMousePosition_CanBeSetAndRetrieved ()
{
// Arrange
MouseImpl mouse = new ();
Point expectedPosition = new (10, 20);
// Act
mouse.LastMousePosition = expectedPosition;
Point? actualPosition = mouse.GetLastMousePosition ();
// Assert
Assert.Equal (expectedPosition, actualPosition);
}
[Fact]
public void Mouse_IsMouseDisabled_CanBeSetAndRetrieved ()
{
// Arrange
MouseImpl mouse = new ();
// Act
mouse.IsMouseDisabled = true;
// Assert
Assert.True (mouse.IsMouseDisabled);
}
[Fact]
public void Mouse_CachedViewsUnderMouse_InitializedEmpty ()
{
// Arrange
MouseImpl mouse = new ();
// Assert
Assert.NotNull (mouse.CachedViewsUnderMouse);
Assert.Empty (mouse.CachedViewsUnderMouse);
}
[Fact]
public void Mouse_ResetState_ClearsEventAndCachedViews ()
{
// Arrange
MouseImpl mouse = new ();
var eventFired = false;
mouse.MouseEvent += (sender, args) => eventFired = true;
mouse.CachedViewsUnderMouse.Add (new View ());
// Act
mouse.ResetState ();
// Assert - CachedViewsUnderMouse should be cleared
Assert.Empty (mouse.CachedViewsUnderMouse);
// Event handlers should be cleared
MouseEventArgs mouseEvent = new () { ScreenPosition = new Point (0, 0), Flags = MouseFlags.Button1Pressed };
mouse.RaiseMouseEvent (mouseEvent);
Assert.False (eventFired, "Event should not fire after ResetState");
}
[Fact]
public void Mouse_RaiseMouseEvent_DoesNotUpdateLastPositionWhenNotInitialized ()
{
// Arrange
MouseImpl mouse = new ();
MouseEventArgs mouseEvent = new () { ScreenPosition = new Point (5, 10), Flags = MouseFlags.Button1Pressed };
// Act - Application is not initialized, so LastMousePosition should not be set
mouse.RaiseMouseEvent (mouseEvent);
// Assert
// Since Application.Initialized is false, LastMousePosition should remain null
// This behavior matches the original implementation
Assert.Null (mouse.LastMousePosition);
}
[Fact]
public void Mouse_MouseEvent_CanBeSubscribedAndUnsubscribed ()
{
// Arrange
MouseImpl mouse = new ();
var eventCount = 0;
EventHandler<MouseEventArgs> handler = (sender, args) => eventCount++;
// Act - Subscribe
mouse.MouseEvent += handler;
MouseEventArgs mouseEvent = new () { ScreenPosition = new Point (0, 0), Flags = MouseFlags.Button1Pressed };
mouse.RaiseMouseEvent (mouseEvent);
// Assert - Event fired once
Assert.Equal (1, eventCount);
// Act - Unsubscribe
mouse.MouseEvent -= handler;
mouse.RaiseMouseEvent (mouseEvent);
// Assert - Event count unchanged
Assert.Equal (1, eventCount);
}
}