mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-27 00:07:58 +01:00
* Initial plan * Add ScreenChanged event, SetScreenSize method, and fix FakeDriver buffer initialization Co-authored-by: tig <585482+tig@users.noreply.github.com> * Add comprehensive tests for ScreenChanged event and buffer integrity Co-authored-by: tig <585482+tig@users.noreply.github.com> * Replace obsolete SizeChanged usage with ScreenChanged in core and tests Co-authored-by: tig <585482+tig@users.noreply.github.com> * Refactor terminal size event handling Replaced `ScreenChanged` with `SizeChanged` across the codebase to standardize naming and improve clarity. Updated event handling logic, including subscriptions, unsubscriptions, and raising methods. Removed deprecated `ScreenChanged` event and backward compatibility code. Refactored driver initialization to handle legacy `IConsoleDriver` types separately. Updated tests and mock implementations to align with the new `SizeChanged` event. Improved documentation and comments to reflect these changes. These updates enhance maintainability, consistency, and modernize the architecture. * Refactor & Code Cleanup: Replace IWindowSizeMonitor with IConsoleSizeMonitor Renamed `IWindowSizeMonitor` to `IConsoleSizeMonitor` across the codebase, updating all references, method signatures, and event handlers. Replaced the `WindowSizeMonitor` class with the new `ConsoleSizeMonitor` implementation, which includes improved terminal size change handling via the `Poll` method. Enabled nullable reference types in several files to enhance code safety. Updated test cases to reflect the new `IConsoleSizeMonitor` interface. Removed redundant code, simplified null checks, and corrected minor typos in comments. Streamlined the codebase by removing the obsolete `WindowSizeMonitor` class and its interface. * Code cleanup - Refactor and enhance ShadowView and FakeDriverTests Updated ShadowView.cs to use null-conditional operators and added null checks for safer access to `ScreenContents`. Refined XML documentation in View.Layout.cs for clarity and consistency. Refactored FakeDriverTests.cs to leverage modern C# features, including shorthand object instantiation, inline lambdas, and tuple-like syntax for `Size` and `Rectangle`. Removed redundant tests and improved test readability and reliability. Enhanced error handling with null checks and ensured backward compatibility for deprecated events. Improved test coverage for resizing, clipboard operations, and invalid coordinates. Verified buffer integrity and screen updates after resizing. General improvements include replacing explicit type declarations with `var`, removing unused imports, and aligning code formatting for better readability. Refactor and improve code quality and test coverage Updated `ShadowView` for null safety using null-conditional operators. Simplified object initializations and modernized syntax across the codebase, including shorthand initializations and inline lambdas. Enhanced event handling logic and ensured compatibility with obsolete members. Refactored `FakeDriverTests` by removing redundant code, standardizing formatting, and improving test setup. Suppressed obsolete warnings where necessary. Improved XML documentation in `View.Layout.cs` for clarity and removed outdated references. Performed general cleanup, including removing unused namespaces, redundant comments, and ensuring consistent formatting. These changes enhance readability, maintainability, and runtime safety. * Code cleanup Refactor TimedEventsTests for readability and consistency Improved code readability and maintainability: - Enabled nullable reference types with `#nullable enable`. - Removed unused `using System.Diagnostics;`. - Updated namespace to `UnitTests.ApplicationTests`. - Replaced `Terminal.Gui.App.TimedEvents` with `TimedEvents`. - Reformatted XML documentation comments for alignment. - Used `var` and target-typed new expressions for consistency. - Reformatted `Parallel.For` loops and lambdas for clarity. - Added `Thread.Sleep(10)` to prevent excessive CPU usage in tests. - Improved assertions and event handler formatting in tests. Aligned with modern C# coding practices. * Code Cleanup - No more driver warnings. Refactor codebase and introduce FakeClipboard - Adjusted `.editorconfig` to change severity levels for CS0612, CS0618, and CS0672 diagnostics. - Replaced `FakeDriver.FakeClipboard` with a new `FakeClipboard` class for testing purposes, supporting exception handling and clipboard data manipulation. - Removed redundant methods (`MakeColor`, `MapKey`) and unused classes (`MockConsoleDriver`) to streamline the codebase. - Refactored `ConsoleDriverFacade` and `FakeDriver` to simplify logic and improve maintainability. - Updated tests to use `CreateFakeDriver` and removed or commented out obsolete tests. - Reformatted and cleaned up code for readability across multiple files. * Refactor FakeDriver - Code Cleanup Standardized console size management by replacing `WindowSizeMonitor` with `ConsoleSizeMonitor` across the codebase. Updated methods `GetWindowSize` and `SetWindowSize` to `GetSize` and `SetSize` for consistency. Refactored `FakeDriver` to use `SetScreenSize` and removed redundant methods. Simplified driver initialization by removing legacy `InternalInit` logic. Standardized ANSI escape sequences by replacing `CSI_ReportTerminalSizeInChars` with `CSI_ReportWindowSizeInChars`. Updated test cases to align with the new `ConsoleSizeMonitor` and `SetScreenSize` methods. Removed obsolete test utilities like `FakeSizeMonitor` and `FakeWindowSizeMonitor`. Performed general code cleanup, including removing unused classes, redundant code, and improving formatting. Fixed resizing logic issues and improved exception handling in driver methods. * Update Terminal.Gui/Drivers/OutputBuffer.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Terminal.Gui/Drivers/MouseButtonStateEx.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Terminal.Gui/App/MainLoop/IApplicationMainLoop.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Tests/UnitTests/Views/ToplevelTests.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Terminal.Gui/ViewBase/View.Layout.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Moved all Drawing tests to Paralleizable - proving Fakedriver works Enhanced `Ruler` and `Thickness` classes by adding an optional `IConsoleDriver? driver` parameter to decouple rendering from the default `Application.Driver`, improving flexibility and testability. Updated `DriverAssert` to support nullable drivers and added defensive checks. Refactored and expanded test cases for `Ruler`, `Thickness`, `LineCanvas`, and `StraightLineExtensions` to ensure comprehensive coverage, including zero-length intersections, line rendering, and exclusion logic. Migrated rendering-dependent tests to a parallelizable namespace. Removed redundant tests, improved naming conventions, and updated documentation for better maintainability and clarity. * Fixed Run<T> startup hang. Refactor: Simplify driver logic and update SetSize methods Removed FakeDriver safeguard in unit tests to simplify CreateDriver logic. Updated SetSize methods in NetOutput, UnixOutput, and WindowsOutput to do nothing instead of throwing NotImplementedException. Modified SizeChanged event in ConsoleDriverFacade to call SetScreenSize directly. Commented out unnecessary debug validation in DimAuto. These changes improve maintainability and reduce complexity. * Fixed intermittent unit test bug. Refactored `_cachedRunStateToplevel` to `CachedRunStateToplevel` as an internal static property, delegating its management to `ApplicationImpl` for improved encapsulation. Updated all references to use the new property and centralized its handling in `ApplicationImpl`. Removed the `MouseGrabHandler` property from `ApplicationImpl` and simplified driver-related assignments by replacing `Application.ForceDriver` and `Application.Screen` with direct references. Reset `CachedRunStateToplevel` during cleanup to ensure proper state management. Updated the `Invoke` method to use `Top` directly, aligning with the refactored design. Improved debug assertions and performed general cleanup to enhance code readability and maintainability. * Fixed intermittent bug an massive code cleanup of warnings. Refactor and enhance codebase for maintainability - Applied null-conditional operator (`!`) to improve null-safety. - Refactored tests for clarity, added new cases, and removed redundancies. - Introduced `FakeApplicationFactory` and `FakeSizeMonitor` for testing. - Removed unused code, including legacy `DecodeEscSeq` logic. - Reformatted code for readability and consistency. - Updated assertions for more accurate validation in tests. - Fixed potential null reference issues across multiple files. - Improved event handling with proper null checks. - Enhanced documentation for new classes and methods. - Modernized code with C# features like `record struct` and `nullable enable`. --------- 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> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
260 lines
9.8 KiB
C#
260 lines
9.8 KiB
C#
using System.Text;
|
|
using Xunit.Abstractions;
|
|
|
|
// Alias Console to MockConsole so we don't accidentally use Console
|
|
using Console = Terminal.Gui.Drivers.FakeConsole;
|
|
|
|
namespace UnitTests.DriverTests;
|
|
|
|
public class ConsoleDriverTests
|
|
{
|
|
private readonly ITestOutputHelper _output;
|
|
|
|
public ConsoleDriverTests (ITestOutputHelper output)
|
|
{
|
|
ConsoleDriver.RunningUnitTests = true;
|
|
_output = output;
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData (typeof (FakeDriver))]
|
|
//[InlineData (typeof (DotNetDriver))]
|
|
|
|
//[InlineData (typeof (ANSIDriver))]
|
|
//[InlineData (typeof (WindowsDriver))]
|
|
//[InlineData (typeof (UnixDriver))]
|
|
public void End_Cleans_Up (Type driverType)
|
|
{
|
|
var driver = (IConsoleDriver)Activator.CreateInstance (driverType);
|
|
driver.Init ();
|
|
driver.End ();
|
|
}
|
|
|
|
// NOTE: These tests were removed because they use legacy FakeDriver patterns that don't work with modern architecture:
|
|
// 1. They use Console.MockKeyPresses which is a legacy FakeDriver pattern
|
|
// 2. Application.Run() with the legacy FakeDriver doesn't properly process MockKeyPresses in modern architecture
|
|
// 3. These tests should be rewritten to use the modern FakeComponentFactory with predefined input
|
|
// 4. Key press handling should be tested through the input processor layer, not driver tests
|
|
//
|
|
// [Theory]
|
|
// [InlineData (typeof (FakeDriver))]
|
|
// public void FakeDriver_MockKeyPresses (Type driverType)
|
|
|
|
[Theory]
|
|
[InlineData (typeof (FakeDriver))]
|
|
//[InlineData (typeof (DotNetDriver))]
|
|
|
|
//[InlineData (typeof (ANSIDriver))]
|
|
//[InlineData (typeof (WindowsDriver))]
|
|
//[InlineData (typeof (UnixDriver))]
|
|
public void Init_Inits (Type driverType)
|
|
{
|
|
var driver = (IConsoleDriver)Activator.CreateInstance (driverType);
|
|
driver.Init ();
|
|
// Note: MainLoop is no longer returned from Init() as part of legacy MainLoop removal
|
|
Assert.NotNull (driver.Clipboard);
|
|
Console.ForegroundColor = ConsoleColor.Red;
|
|
Assert.Equal (ConsoleColor.Red, Console.ForegroundColor);
|
|
Console.BackgroundColor = ConsoleColor.Green;
|
|
Assert.Equal (ConsoleColor.Green, Console.BackgroundColor);
|
|
|
|
driver.End ();
|
|
}
|
|
|
|
//[Theory]
|
|
//[InlineData (typeof (FakeDriver))]
|
|
//public void FakeDriver_MockKeyPresses_Press_AfterTimeOut (Type driverType)
|
|
//{
|
|
// var driver = (IConsoleDriver)Activator.CreateInstance (driverType);
|
|
// Application.Init (driver);
|
|
|
|
// // Simulating pressing of QuitKey after a short period of time
|
|
// uint quitTime = 100;
|
|
// Func<MainLoop, bool> closeCallback = (MainLoop loop) => {
|
|
// // Prove the scenario is using Application.QuitKey correctly
|
|
// output.WriteLine ($" {quitTime}ms elapsed; Simulating keypresses...");
|
|
// FakeConsole.PushMockKeyPress (Key.F);
|
|
// FakeConsole.PushMockKeyPress (Key.U);
|
|
// FakeConsole.PushMockKeyPress (Key.C);
|
|
// FakeConsole.PushMockKeyPress (Key.K);
|
|
// return false;
|
|
// };
|
|
// output.WriteLine ($"Add timeout to simulate key presses after {quitTime}ms");
|
|
// _ = Application.AddTimeout (TimeSpan.FromMilliseconds (quitTime), closeCallback);
|
|
|
|
// // If Top doesn't quit within abortTime * 5 (500ms), this will force it
|
|
// uint abortTime = quitTime * 5;
|
|
// Func<MainLoop, bool> forceCloseCallback = (MainLoop loop) => {
|
|
// Application.RequestStop ();
|
|
// Assert.Fail ($" failed to Quit after {abortTime}ms. Force quit.");
|
|
// return false;
|
|
// };
|
|
// output.WriteLine ($"Add timeout to force quit after {abortTime}ms");
|
|
// _ = Application.AddTimeout (TimeSpan.FromMilliseconds (abortTime), forceCloseCallback);
|
|
|
|
// Key key = Key.Unknown;
|
|
|
|
// Application.Top.KeyPress += (e) => {
|
|
// key = e.Key;
|
|
// output.WriteLine ($" Application.Top.KeyPress: {key}");
|
|
// e.Handled = true;
|
|
|
|
// };
|
|
|
|
// int iterations = 0;
|
|
// Application.Iteration += (s, a) => {
|
|
// output.WriteLine ($" iteration {++iterations}");
|
|
|
|
// if (Console.MockKeyPresses.Count == 0) {
|
|
// output.WriteLine ($" No more MockKeyPresses; RequestStop");
|
|
// Application.RequestStop ();
|
|
// }
|
|
// };
|
|
|
|
// Application.Run ();
|
|
|
|
// // Shutdown must be called to safely clean up Application if Init has been called
|
|
// Application.Shutdown ();
|
|
//}
|
|
|
|
[Theory]
|
|
[InlineData (typeof (FakeDriver))]
|
|
//[InlineData (typeof (DotNetDriver))]
|
|
|
|
//[InlineData (typeof (ANSIDriver))]
|
|
//[InlineData (typeof (WindowsDriver))]
|
|
//[InlineData (typeof (UnixDriver))]
|
|
public void TerminalResized_Simulation (Type driverType)
|
|
{
|
|
var driver = (IConsoleDriver)Activator.CreateInstance (driverType);
|
|
driver?.Init ();
|
|
driver.Cols = 80;
|
|
driver.Rows = 25;
|
|
|
|
var wasTerminalResized = false;
|
|
|
|
driver.SizeChanged += (s, e) =>
|
|
{
|
|
wasTerminalResized = true;
|
|
Assert.Equal (120, e.Size.GetValueOrDefault ().Width);
|
|
Assert.Equal (40, e.Size.GetValueOrDefault ().Height);
|
|
};
|
|
|
|
Assert.Equal (80, driver.Cols);
|
|
Assert.Equal (25, driver.Rows);
|
|
Assert.False (wasTerminalResized);
|
|
|
|
driver.Cols = 120;
|
|
driver.Rows = 40;
|
|
|
|
((ConsoleDriver)driver).OnSizeChanged (new SizeChangedEventArgs (new (driver.Cols, driver.Rows)));
|
|
Assert.Equal (120, driver.Cols);
|
|
Assert.Equal (40, driver.Rows);
|
|
Assert.True (wasTerminalResized);
|
|
driver.End ();
|
|
}
|
|
|
|
// Disabled due to test error - Change Task.Delay to an await
|
|
// [Fact, AutoInitShutdown]
|
|
// public void Write_Do_Not_Change_On_ProcessKey ()
|
|
// {
|
|
// var win = new Window ();
|
|
// Application.Begin (win);
|
|
// Application.Driver!.SetScreenSize ( (20, 8);
|
|
|
|
// System.Threading.Tasks.Task.Run (() => {
|
|
// System.Threading.Tasks.Task.Delay (500).Wait ();
|
|
// Application.Invoke (() => {
|
|
// var lbl = new Label ("Hello World") { X = Pos.Center () };
|
|
// var dlg = new Dialog ();
|
|
// dlg.Add (lbl);
|
|
// Application.Begin (dlg);
|
|
|
|
// var expected = @"
|
|
//┌──────────────────┐
|
|
//│┌───────────────┐ │
|
|
//││ Hello World │ │
|
|
//││ │ │
|
|
//││ │ │
|
|
//││ │ │
|
|
//│└───────────────┘ │
|
|
//└──────────────────┘
|
|
//";
|
|
|
|
// var pos = DriverAsserts.AssertDriverContentsWithFrameAre (expected, output);
|
|
// Assert.Equal (new (0, 0, 20, 8), pos);
|
|
|
|
// Assert.True (dlg.ProcessKey (new (Key.Tab)));
|
|
// dlg.Draw ();
|
|
|
|
// expected = @"
|
|
//┌──────────────────┐
|
|
//│┌───────────────┐ │
|
|
//││ Hello World │ │
|
|
//││ │ │
|
|
//││ │ │
|
|
//││ │ │
|
|
//│└───────────────┘ │
|
|
//└──────────────────┘
|
|
//";
|
|
|
|
// pos = DriverAsserts.AssertDriverContentsWithFrameAre (expected, output);
|
|
// Assert.Equal (new (0, 0, 20, 8), pos);
|
|
|
|
// win.RequestStop ();
|
|
// });
|
|
// });
|
|
|
|
// Application.Run (win);
|
|
// Application.Shutdown ();
|
|
// }
|
|
|
|
// NOTE: This test was removed because:
|
|
// 1. It hangs indefinitely - the Application.Run loop never exits properly with modern architecture
|
|
// 2. It's testing general surrogate pair/input handling, not FakeDriver-specific functionality
|
|
// 3. It uses legacy FakeDriver patterns (Console.MockKeyPresses) that don't work correctly with modern architecture
|
|
// 4. Surrogate pair handling should be tested in input processor tests, not driver tests
|
|
// 5. The test accesses private field _highSurrogate which is an implementation detail
|
|
//
|
|
// [Theory]
|
|
// [InlineData ('\ud83d', '\udcc4')] // This seems right sequence but Stack is LIFO
|
|
// [InlineData ('\ud83d', '\ud83d')]
|
|
// [InlineData ('\udcc4', '\udcc4')]
|
|
// public void FakeDriver_IsValidInput_Wrong_Surrogate_Sequence (char c1, char c2)
|
|
|
|
// NOTE: This test was also removed for the same reasons as FakeDriver_IsValidInput_Wrong_Surrogate_Sequence:
|
|
// 1. It hangs indefinitely - the Application.Run loop never exits properly with modern architecture
|
|
// 2. It's testing general surrogate pair/input handling, not FakeDriver-specific functionality
|
|
// 3. It uses legacy FakeDriver patterns (Console.MockKeyPresses) that don't work correctly with modern architecture
|
|
// 4. Surrogate pair handling should be tested in input processor tests, not driver tests
|
|
//
|
|
// [Fact]
|
|
// public void FakeDriver_IsValidInput_Correct_Surrogate_Sequence ()
|
|
|
|
/// <summary>
|
|
/// Tests that when ConsoleDriver.RunningUnitTests is true, Application.Init() without
|
|
/// parameters uses FakeDriver instead of platform-specific drivers.
|
|
/// This prevents intermittent failures on macOS where kernel32.dll might be referenced.
|
|
/// </summary>
|
|
[Fact]
|
|
public void Application_Init_Without_Params_Uses_FakeDriver_When_RunningUnitTests ()
|
|
{
|
|
// Arrange
|
|
ConsoleDriver.RunningUnitTests = true;
|
|
Application.ResetState (true);
|
|
|
|
// Act
|
|
Application.Init ();
|
|
|
|
// Assert
|
|
Assert.NotNull (Application.Driver);
|
|
// In the modern v2 architecture, the driver will be a ConsoleDriverFacade wrapping FakeDriver
|
|
// The key is that it's not attempting to use Windows/Unix platform-specific drivers
|
|
Assert.True (Application.Initialized);
|
|
|
|
// Cleanup
|
|
Application.Shutdown ();
|
|
Application.ResetState (true);
|
|
}
|
|
}
|