mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-27 00:07:58 +01:00
* Initial plan * Remove legacy drivers and reorganize v2 architecture Co-authored-by: tig <585482+tig@users.noreply.github.com> * Extract Windows key helper utilities and fix build Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fix all test references to legacy drivers Co-authored-by: tig <585482+tig@users.noreply.github.com> * Update documentation to reflect new driver architecture Co-authored-by: tig <585482+tig@users.noreply.github.com> * Remove V2.cd diagram file Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fix test failures: support legacy drivers and update exception handling Co-authored-by: tig <585482+tig@users.noreply.github.com> * updated driver names * Move V2 tests from ConsoleDrivers/V2 to proper locations Co-authored-by: tig <585482+tig@users.noreply.github.com> * Rename ApplicationV2 to ModernApplicationImpl to remove v2 terminology Co-authored-by: tig <585482+tig@users.noreply.github.com> * Remove V2 terminology from test drivers and FakeDriver classes Co-authored-by: tig <585482+tig@users.noreply.github.com> * Merge ModernApplicationImpl into ApplicationImpl and move to App folder Co-authored-by: tig <585482+tig@users.noreply.github.com> * Create modern FakeDriver with component factory architecture in Terminal.Gui project Co-authored-by: tig <585482+tig@users.noreply.github.com> * Refactor: Move non-platform-dependent code from /Drivers to /App Co-authored-by: tig <585482+tig@users.noreply.github.com> * Code cleanup and org * Unit test reorg * Refactor MainLoop architecture: rename classes and enhance documentation for clarity Co-authored-by: tig <585482+tig@users.noreply.github.com> * Add comprehensive FakeDriver tests (WIP - some tests need fixes) Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fixed FakeDriver build failures * Fix all FakeDriver test failures - Application.Top creation and clipboard behaviors Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fixed FakeDriver build failures2 * Remove hanging legacy FakeDriver tests that use Console.MockKeyPresses Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fixed some tests * Fixed more tests * Fixed more tests * Fix bad copilot (#4277) * Update Terminal.Gui/Drivers/FakeDriver/FakeConsoleOutput.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Refactor Application Init and Update Tests Refactored `Application.Init` to improve initialization logic: - Added fallback to `ForceDriver` when `driverName` is null. - Changed repeated `Init` calls to throw `InvalidOperationException`. - Updated `_driverName` assignment logic for robustness. Enhanced `IConsoleDriver` with detailed remarks on implementations. Revised test cases to align with updated `Application.Init` behavior: - Replaced `FakeDriver` with `null` and `driverName: "fake"`. - Skipped or commented out tests incompatible with new logic. - Improved formatting and removed redundant setup code. Improved code style and consistency across the codebase: - Standardized parameter formatting and spacing. - Removed outdated comments and unused code. General cleanup to enhance readability and maintainability. * Warp fix copilot (#4278) * More fixes (#4279) * Fixes/works around test failures and temporarily disable failing test Updated `FakeDriver` to set `RunningUnitTests` to `true` and initialize dimensions using `FakeConsole`. Modified `TestRespondersDisposedAttribute` to set `ConsoleDriver.RunningUnitTests` in the `Before` method, ensuring proper behavior during unit tests. Temporarily disabled the `Button_CanFocus_False_Raises_Accepted_Correctly` test in `ViewCommandTests` by adding a `Skip` parameter to the `[Fact]` attribute, referencing issue #4270. * Allow all tests to run despite failures in UnitTests Modified the `dotnet test` command in the `Run UnitTestsParallelizable` step to set `xunit.stopOnFail` to `false`. This ensures that the test runner does not stop execution on the first failure, allowing all tests to execute regardless of individual test outcomes. * Refactor ApplicationScreenTests for cleaner setup/teardown Refactored `ClearContents_Called_When_Top_Frame_Changes` test: - Added `[AutoInitShutdown]` attribute for automatic lifecycle management. - Replaced manual `Application.Init` and `Application.Top` setup with `Application.Begin` and `RunState`. - Simplified event handling by defining `ClearedContents` handler inline. - Removed explicit cleanup logic, relying on `Application.End` for teardown. Updated `using` directives to include `UnitTests` namespace. * Attempt to fix intermittent local test failures. Update ApplicationImpl initialization parameter Changed the second parameter of the `impl.Init` method in the `FakeApplicationFactory` class from `"dotnet"` to `"fake"`. * Code cleanup to cause Action to re-run. * Stop tests on first failure in UnitTestsParallelizable Updated the `dotnet test` command in `unit-tests.yml` to set the `xunit.stopOnFail` parameter to `true`. This change ensures that test execution halts immediately upon encountering a failure, allowing quicker identification and resolution of issues. Note that this may prevent the full test suite from running in the event of a failure. * Allow all tests to run despite failures in CI Updated `unit-tests.yml` to set `xunit.stopOnFail` to `false` in both `Run UnitTests` and `Run UnitTestsParallelizable` steps. This ensures that the test runner does not stop execution on the first test failure, allowing all tests to complete even if some fail. * Enhance RuneExtensions docs and update user dictionary Updated the `<remarks>` section in `RuneExtensions.GetColumns` to include details about the `wcwidth` implementation and improved readability with `<para>` tags. Added `wcwidth` to the user dictionary in `Terminal.sln.DotSettings` to avoid spelling errors. * Improve XML doc formatting in RuneExtensions.cs Updated the remarks section of the `GetColumns` method in the `RuneExtensions` class to enhance readability by reformatting and properly indenting `<para>` tags. The content remains unchanged, describing the method's implementation via `wcwidth` and its role as a Terminal.Gui extension for `System.Text.Rune`. * Refactor drivers and improve clipboard handling Replaced legacy drivers (`CursesDriver`, `NetDriver`) with `UnixDriver` and `DotNetDriver` across the codebase, including comments, method names, and test cases. Updated documentation and remarks to reflect the new driver names and platforms. Revamped clipboard handling with new platform-specific implementations: `UnixClipboard` for Unix, `MacOSXClipboard` for macOS, and `WSLClipboard` for Linux under WSL. Removed the old `CursesClipboard` and consolidated clipboard logic. Updated test cases to align with the new drivers and clipboard implementations. Improved naming consistency and cleaned up redundant code. Updated the README and documentation to reflect these changes. * Remove `PlatformColor` from `Attribute` struct This commit removes the `PlatformColor` property from the `Attribute` struct, simplifying the codebase by eliminating platform-specific color handling. The following changes were made: - Removed `PlatformColor` from the `Attribute` struct, including its initialization, usage, and related comments. - Updated constructors to no longer initialize or use `PlatformColor`. - Modified `Equals` and `GetHashCode` methods to exclude `PlatformColor`. - Updated `UnixComponentFactory` documentation to remove references to "v2unix." - Renamed `v2TestDriver` to `testDriver` in the `With` class for clarity. - Removed `PlatformColor` references in `DriverAssert` and related error messages. - Deleted test cases in `AttributeTests` that relied on `PlatformColor`. - Cleaned up comments and TODOs related to `PlatformColor` and `UnixDriver`. These changes reflect a shift away from platform-dependent color management, improving code clarity and reducing complexity. Remove `PlatformColor` and simplify `Attribute` logic The `PlatformColor` property has been removed from the `Attribute` struct, along with its associated logic, simplifying the codebase and eliminating platform-specific dependencies. Constructors, equality checks, and hash code generation in `Attribute` have been updated accordingly. The `CurrentAttribute` property in `ConsoleDriver` and `OutputBuffer` has been simplified, removing dependencies on `Application.Driver`. The `MakeColor` method logic has been removed or simplified in related classes. Tests in `AttributeTests` have been refactored to reflect these changes, focusing on `Foreground`, `Background`, and `Style`. Unix-specific logic tied to `PlatformColor` has been eliminated. Additional updates include renaming parameters in the `With` class for clarity, simplifying `DriverAssert` output, and performing minor code cleanups to improve readability and maintainability. * Refactor Terminal.Gui driver architecture for v2 Updated documentation to reflect the new modular driver architecture in Terminal.Gui v2. - Revised `namespace-drivers.md` to include new components (`IConsoleInput`, `IConsoleOutput`, `IInputProcessor`, `IOutputBuffer`, `IWindowSizeMonitor`) and terminal size monitoring. - Replaced "Key Components" with "Architecture Overview" and added details on the **Component Factory** pattern. - Documented the four driver implementations (`DotNetDriver`, `WindowsDriver`, `UnixDriver`, `FakeDriver`) and their platform-specific optimizations. - Added a "Threading Model" section to explain the multi-threaded design for responsive input handling. - Updated examples to demonstrate driver capabilities and explicit driver selection. In `drivers.md`: - Expanded the "Overview" to emphasize the modular, component-based architecture. - Reorganized "Drivers" into "Available Drivers" and added details on `FakeDriver` for unit testing. - Added sections on "Initialization Flow," "Shutdown Flow," and platform-specific driver details. - Provided examples for accessing driver components and creating custom drivers. In `index.md`: - Updated "Cross Platform" feature to reflect new driver names and clarified compatibility with SSH and monochrome terminals. * Moved files around --------- 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: Thomas Nind <31306100+tznind@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
405 lines
11 KiB
C#
405 lines
11 KiB
C#
using UnitTests;
|
|
using Xunit;
|
|
|
|
using Xunit.Abstractions;
|
|
|
|
namespace Terminal.Gui.DriverTests;
|
|
|
|
/// <summary>
|
|
/// Tests for the FakeDriver to ensure it works properly with the modern component factory architecture.
|
|
/// </summary>
|
|
public class FakeDriverTests (ITestOutputHelper output)
|
|
{
|
|
private readonly ITestOutputHelper _output = output;
|
|
|
|
#region Basic FakeDriver Tests
|
|
|
|
[Fact]
|
|
[AutoInitShutdown]
|
|
public void FakeDriver_Init_Works ()
|
|
{
|
|
// Verify Application was initialized
|
|
Assert.True (Application.Initialized);
|
|
// Assert.NotNull (Application.Top);
|
|
|
|
// Verify it's using a driver facade (modern architecture)
|
|
Assert.IsAssignableFrom<IConsoleDriverFacade> (Application.Driver);
|
|
|
|
_output.WriteLine ($"Driver type: {Application.Driver.GetType().Name}");
|
|
_output.WriteLine ($"Screen size: {Application.Screen}");
|
|
}
|
|
|
|
[Fact]
|
|
[AutoInitShutdown]
|
|
public void FakeDriver_Screen_Has_Default_Size ()
|
|
{
|
|
// Default size should be 80x25
|
|
Assert.Equal (new (0, 0, 80, 25), Application.Screen);
|
|
Assert.Equal (80, Application.Driver!.Cols);
|
|
Assert.Equal (25, Application.Driver.Rows);
|
|
}
|
|
|
|
[Fact]
|
|
[AutoInitShutdown]
|
|
public void FakeDriver_Can_Resize ()
|
|
{
|
|
// Start with default size
|
|
Assert.Equal (80, Application.Driver!.Cols);
|
|
Assert.Equal (25, Application.Driver.Rows);
|
|
|
|
// Resize to 100x30
|
|
AutoInitShutdownAttribute.FakeResize (new (100, 30));
|
|
|
|
// Verify new size
|
|
Assert.Equal (100, Application.Driver.Cols);
|
|
Assert.Equal (30, Application.Driver.Rows);
|
|
Assert.Equal (new (0, 0, 100, 30), Application.Screen);
|
|
}
|
|
|
|
[Fact]
|
|
[AutoInitShutdown]
|
|
public void FakeDriver_Top_Is_Created ()
|
|
{
|
|
Application.Top = new Toplevel ();
|
|
|
|
Application.Begin (Application.Top);
|
|
|
|
Assert.NotNull (Application.Top);
|
|
Assert.True (Application.Top.IsInitialized);
|
|
Assert.Equal (new (0, 0, 80, 25), Application.Top.Frame);
|
|
}
|
|
|
|
[Fact]
|
|
[AutoInitShutdown]
|
|
public void FakeDriver_Can_Add_View_To_Top ()
|
|
{
|
|
Application.Top = new Toplevel ();
|
|
|
|
var label = new Label { Text = "Hello World" };
|
|
Application.Top!.Add (label);
|
|
|
|
Assert.Contains (label, Application.Top!.SubViews);
|
|
Assert.Same (Application.Top, label.SuperView);
|
|
}
|
|
|
|
[Fact]
|
|
[AutoInitShutdown]
|
|
public void FakeDriver_RunIteration_Works ()
|
|
{
|
|
Application.Top = new Toplevel ();
|
|
|
|
var label = new Label { Text = "Hello" };
|
|
Application.Top!.Add (label);
|
|
|
|
|
|
Application.Begin (Application.Top);
|
|
|
|
// Run a single iteration - this should layout and draw
|
|
AutoInitShutdownAttribute.RunIteration ();
|
|
|
|
// Verify the view was laid out
|
|
Assert.True (label.Frame.Width > 0);
|
|
Assert.True (label.IsInitialized);
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region AutoInitShutdown Attribute Tests
|
|
|
|
[Theory]
|
|
[InlineData (true)]
|
|
[InlineData (false)]
|
|
public void AutoInitShutdown_Attribute_Respects_AutoInit_Parameter (bool autoInit)
|
|
{
|
|
// When autoInit is false, Application should not be initialized
|
|
// When autoInit is true, Application should be initialized
|
|
|
|
// This test will be called twice - once with autoInit=true, once with false
|
|
// We can't use the attribute directly in the test body, but we can verify
|
|
// the behavior by checking Application.Initialized
|
|
|
|
// For this test to work properly, we need to call Application.Init manually when autoInit=false
|
|
bool wasInitialized = Application.Initialized;
|
|
|
|
try
|
|
{
|
|
if (!wasInitialized)
|
|
{
|
|
Application.ResetState ();
|
|
var fa = new FakeApplicationFactory ();
|
|
using var cleanup = fa.SetupFakeApplication ();
|
|
Assert.True (Application.Initialized);
|
|
}
|
|
else
|
|
{
|
|
Assert.True (Application.Initialized);
|
|
}
|
|
}
|
|
finally
|
|
{
|
|
if (!wasInitialized)
|
|
{
|
|
Application.Shutdown ();
|
|
}
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public void Without_AutoInitShutdown_Application_Is_Not_Initialized ()
|
|
{
|
|
// This test deliberately does NOT use [AutoInitShutdown]
|
|
// Application should not be initialized
|
|
Assert.False (Application.Initialized);
|
|
Assert.Null (Application.Driver);
|
|
Assert.Null (Application.Top);
|
|
}
|
|
|
|
[Fact]
|
|
[AutoInitShutdown]
|
|
public void AutoInitShutdown_Cleans_Up_After_Test ()
|
|
{
|
|
// This test verifies that Application is properly initialized
|
|
// The After method of AutoInitShutdown will verify cleanup
|
|
Assert.True (Application.Initialized);
|
|
Assert.NotNull (Application.Driver);
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region SetupFakeDriver Attribute Tests
|
|
|
|
[Fact]
|
|
[SetupFakeDriver]
|
|
public void SetupFakeDriver_Initializes_Driver_With_25x25 ()
|
|
{
|
|
Assert.NotNull (Application.Driver);
|
|
Assert.Equal (new (0, 0, 25, 25), Application.Screen);
|
|
Assert.Equal (25, Application.Driver.Cols);
|
|
Assert.Equal (25, Application.Driver.Rows);
|
|
}
|
|
|
|
[Fact]
|
|
[SetupFakeDriver]
|
|
public void SetupFakeDriver_Driver_Is_FakeConsoleDriver ()
|
|
{
|
|
Assert.NotNull (Application.Driver);
|
|
|
|
// Should be IFakeConsoleDriver
|
|
Assert.IsAssignableFrom<IFakeConsoleDriver> (Application.Driver);
|
|
|
|
_output.WriteLine ($"Driver type: {Application.Driver.GetType().Name}");
|
|
}
|
|
|
|
[Fact]
|
|
[SetupFakeDriver]
|
|
public void SetupFakeDriver_Can_Set_Buffer_Size ()
|
|
{
|
|
var fakeDriver = Application.Driver as IFakeConsoleDriver;
|
|
Assert.NotNull (fakeDriver);
|
|
|
|
fakeDriver!.SetBufferSize (100, 50);
|
|
|
|
Assert.Equal (100, Application.Driver!.Cols);
|
|
Assert.Equal (50, Application.Driver.Rows);
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Integration Tests
|
|
|
|
[Fact]
|
|
[AutoInitShutdown]
|
|
public void FakeDriver_Can_Draw_Simple_View ()
|
|
{
|
|
Application.Top = new Toplevel ();
|
|
|
|
var window = new Window
|
|
{
|
|
Title = "Test Window",
|
|
X = 0,
|
|
Y = 0,
|
|
Width = 40,
|
|
Height = 10
|
|
};
|
|
|
|
var label = new Label
|
|
{
|
|
Text = "Hello World",
|
|
X = 1,
|
|
Y = 1
|
|
};
|
|
|
|
window.Add (label);
|
|
Application.Top!.Add (window);
|
|
|
|
Application.Begin (Application.Top);
|
|
|
|
// Run iteration to layout and draw
|
|
AutoInitShutdownAttribute.RunIteration ();
|
|
|
|
// Verify views were initialized and laid out
|
|
Assert.True (window.IsInitialized);
|
|
Assert.True (label.IsInitialized);
|
|
Assert.True (window.Frame.Width > 0);
|
|
Assert.True (label.Frame.Width > 0);
|
|
}
|
|
|
|
[Fact]
|
|
[AutoInitShutdown]
|
|
public void FakeDriver_Multiple_RunIterations_Work ()
|
|
{
|
|
Application.Top = new Toplevel ();
|
|
|
|
var label = new Label { Text = "Iteration Test" };
|
|
Application.Top!.Add (label);
|
|
|
|
// Run multiple iterations
|
|
for (int i = 0; i < 5; i++)
|
|
{
|
|
AutoInitShutdownAttribute.RunIteration ();
|
|
}
|
|
|
|
Application.Begin (Application.Top);
|
|
|
|
// Should still be working
|
|
Assert.True (Application.Initialized);
|
|
Assert.True (label.IsInitialized);
|
|
}
|
|
|
|
[Fact]
|
|
[AutoInitShutdown]
|
|
public void FakeDriver_Resize_Triggers_Layout ()
|
|
{
|
|
Application.Top = new Toplevel ();
|
|
|
|
var view = new View
|
|
{
|
|
Width = Dim.Fill (),
|
|
Height = Dim.Fill ()
|
|
};
|
|
Application.Top!.Add (view);
|
|
|
|
Application.Begin (Application.Top);
|
|
|
|
AutoInitShutdownAttribute.FakeResize (new Size (80,25));
|
|
AutoInitShutdownAttribute.RunIteration ();
|
|
|
|
// Check initial size
|
|
var initialFrame = view.Frame;
|
|
Assert.Equal (80, initialFrame.Width);
|
|
Assert.Equal (25, initialFrame.Height);
|
|
|
|
// Resize
|
|
AutoInitShutdownAttribute.FakeResize (new (100, 40));
|
|
|
|
// Check new size
|
|
Assert.Equal (100, view.Frame.Width);
|
|
Assert.Equal (40, view.Frame.Height);
|
|
}
|
|
|
|
[Fact]
|
|
[AutoInitShutdown]
|
|
public void FakeDriver_Window_Can_Be_Shown_And_Closed ()
|
|
{
|
|
Application.Top = new Toplevel ();
|
|
|
|
var window = new Window { Title = "Test" };
|
|
Application.Top!.Add (window);
|
|
|
|
Application.Begin (Application.Top);
|
|
|
|
AutoInitShutdownAttribute.RunIteration ();
|
|
|
|
Assert.True (window.IsInitialized);
|
|
Assert.Contains (window, Application.Top!.SubViews);
|
|
|
|
// Remove window
|
|
Application.Top.Remove (window);
|
|
AutoInitShutdownAttribute.RunIteration ();
|
|
|
|
Assert.DoesNotContain (window, Application.Top!.SubViews);
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Clipboard Tests
|
|
|
|
[Fact]
|
|
[AutoInitShutdown (useFakeClipboard: true)]
|
|
public void FakeDriver_Clipboard_Works_When_Enabled ()
|
|
{
|
|
Assert.NotNull (Application.Driver!.Clipboard);
|
|
Assert.True (Application.Driver.Clipboard.IsSupported);
|
|
|
|
// Set clipboard content
|
|
Application.Driver.Clipboard.SetClipboardData ("Test content");
|
|
|
|
// Get clipboard content
|
|
string content = Application.Driver.Clipboard.GetClipboardData ();
|
|
Assert.Equal ("Test content", content);
|
|
}
|
|
|
|
[Fact]
|
|
[AutoInitShutdown (useFakeClipboard: true, fakeClipboardAlwaysThrowsNotSupportedException: true)]
|
|
public void FakeDriver_Clipboard_Can_Throw_NotSupportedException ()
|
|
{
|
|
Assert.NotNull (Application.Driver!.Clipboard);
|
|
|
|
// Should throw NotSupportedException
|
|
Assert.Throws<NotSupportedException> (() =>
|
|
Application.Driver.Clipboard.GetClipboardData ());
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Error Handling Tests
|
|
|
|
[Fact]
|
|
[AutoInitShutdown]
|
|
public void FakeDriver_Handles_Invalid_Coordinates_Gracefully ()
|
|
{
|
|
Application.Top = new Toplevel ();
|
|
|
|
// Try to add a view with invalid coordinates - should not crash
|
|
var view = new View
|
|
{
|
|
X = -1000,
|
|
Y = -1000,
|
|
Width = 10,
|
|
Height = 10
|
|
};
|
|
|
|
Application.Top!.Add (view);
|
|
|
|
// Should not throw
|
|
AutoInitShutdownAttribute.RunIteration ();
|
|
|
|
Assert.True (Application.Initialized);
|
|
}
|
|
|
|
[Fact]
|
|
[AutoInitShutdown]
|
|
public void FakeDriver_Survives_Rapid_Resizes ()
|
|
{
|
|
var sizes = new[]
|
|
{
|
|
new Size (80, 25),
|
|
new Size (100, 30),
|
|
new Size (60, 20),
|
|
new Size (120, 40),
|
|
new Size (80, 25)
|
|
};
|
|
|
|
foreach (var size in sizes)
|
|
{
|
|
AutoInitShutdownAttribute.FakeResize (size);
|
|
AutoInitShutdownAttribute.RunIteration ();
|
|
|
|
Assert.Equal (size.Width, Application.Driver!.Cols);
|
|
Assert.Equal (size.Height, Application.Driver.Rows);
|
|
}
|
|
}
|
|
|
|
#endregion
|
|
}
|