Files
Terminal.Gui/Tests/UnitTestsParallelizable/View/Layout/FrameTests.cs
Tig a6258ed398 Updates IListDataSource.Render to rename the start parameter to viewportXOffset (#4392)
* Add comprehensive unit tests for WindowsKeyConverter

- Implement 118 parallelizable unit tests for WindowsKeyConverter

- Cover ToKey and ToKeyInfo methods with full bidirectional testing

- Test basic characters, modifiers, special keys, function keys

- Test VK_PACKET Unicode/IME input

- Test OEM keys, NumPad keys, and lock states

- Include round-trip conversion tests

- All tests passing successfully

Fixes #4389

* Rename `start` parameter to `viewportXOffset` for clarity

The `start` parameter in several methods and interfaces has been
renamed to `viewportXOffset` to better reflect its purpose as the
horizontal offset of the viewport during string rendering.

- Updated method signatures in `ListViewWithSelection` to use
  `viewportXOffset` instead of `start`, including default values.
- Modified the `RenderUstr` method in `ListViewWithSelection` to
  use `viewportXOffset` for calculating the starting index.
- Renamed the `start` parameter to `viewportXOffset` in the
  `IListDataSource` interface and updated its documentation.
- Replaced all occurrences of `start` with `viewportXOffset` in
  the `ListWrapper<T>` class, including method calls and logic.
- Updated the `RenderUstr` method in `ListWrapper<T>` to use
  `viewportXOffset` for substring calculations.
- Adjusted the test method in `ListViewTests.cs` to reflect the
  parameter name change.

These changes improve code readability and make the parameter's
role in rendering logic more explicit.

* Remove WindowsKeyConverterTests class that was added by mistake

* Modernized ListView and IListDataSource - Tons of new unit tests

Refactored `ListView` and `IListDataSource` to improve readability, maintainability, and functionality. Introduced `ListWrapper<T>` as a default implementation of `IListDataSource` for easier integration with standard collections.

Enhanced `ListView` with better handling of marking, selection, and scrolling. Replaced `viewportXOffset` with `viewportX` for horizontal scrolling. Added `EnsureSelectedItemVisible` to maintain visibility of the selected item.

Updated `IListDataSource` with detailed XML documentation and added `SuspendCollectionChangedEvent` for bulk updates. Improved null safety with nullable reference types.

Added comprehensive unit tests for `ListWrapper<T>` and `IListDataSource` to ensure robustness. Modernized the codebase with C# features like expression-bodied members and pattern matching. Fixed bugs related to `SelectedItem` validation and rendering artifacts.

* Improve index validation in ComboBox and ListView

Enhance robustness by adding stricter checks for valid indices
in ComboBox and ListView. Updated conditions in the
`_listview.SelectedItemChanged` event handler to ensure `e.Item`
is non-negative before accessing `_searchSet`. Modified the
`SetValue` method to use `e.Item` instead of `_listview.SelectedItem`.

In ListView, updated the `OnSelectedChanged` method to validate
that `SelectedItem` is non-negative (`>= 0`) before accessing
the `Source` list. These changes prevent potential out-of-range
errors and improve code safety.

* Refactor and enhance test coverage across modules

Refactored and added new tests to improve coverage, readability, and consistency across multiple test files. Key changes include:

- **ShortcutTests.cs**: Added tests for `BindKeyToApplication` and removed redundant tests.
- **SourcesManagerTests.cs**: Renamed `Update_*` tests to `Load_*` for clarity.
- **ArrangementTests.cs**: Reintroduced `MouseGrabHandler` tests, added `ViewArrangement` flag tests, and improved structure.
- **NeedsDrawTests.cs**: Replaced `Application.Screen.Size` with fixed dimensions for better isolation.
- **DimAutoTests.cs**: Updated layout tests to use fixed dimensions.
- **FrameTests.cs**: Standardized object initialization and validated frame behavior.
- **SubViewTests.cs**: Improved formatting and modernized event handling.
- **NumericUpDownTests.cs**: Decoupled layout tests from screen size.

General improvements:
- Enhanced formatting and removed redundant tests.
- Added comments for clarity.
- Introduced `ITestOutputHelper` for better debugging in `ArrangementTests`.

* Refactor to use nullable types for better null safety

Enabled nullable reference types across the codebase to improve null safety and prevent potential null reference issues. Refactored `SelectedItem` and related properties from `int` to `int?` to represent no selection with `null` instead of `-1`. Updated logic, event arguments, and method signatures to handle nullable values consistently.

Simplified object initialization using modern C# syntax and improved code readability with interpolated strings. Added null checks and early returns to prevent runtime errors. Enhanced error handling by throwing `ArgumentOutOfRangeException` for invalid values.

Updated tests to reflect the changes, replacing assertions for `-1` with `null` and ensuring proper handling of nullable values. Cleaned up redundant code and improved formatting for better maintainability.

* on` functionality has been deprecated, refactored, or removed from the `Shortcut` class.

* Refactor: Transition to instance-based architecture

Updated `Run-LocalCoverage.ps1` to increase `--blame-hang-timeout` from 10s to 60s. Improved null safety in `GuiTestContext` by adding null-conditional operators. Commented out problematic code in `SetupFakeApplicationAttribute.cs` to prevent test hangs.

Excluded `ViewBase` files from `UnitTests.Parallelizable.csproj` and removed redundant folder declarations. Simplified event handling in `IListDataSourceTests.cs` and updated `ListViewTests.cs` to use nullable reference types.

Enhanced documentation to emphasize the transition to an instance-based application architecture. Updated examples in `application.md`, `multitasking.md`, and `navigation.md` to reflect the use of `Application.Create()` and `View.App`. Clarified the obsolescence of the static `Application` class.

Revised table of contents in `toc.yml` to include new sections like "Application Deep Dive" and "Scheme Deep Dive." Added `dotnet-tools.json` for tool configuration.

These changes improve maintainability, testability, and alignment with modern C# practices.

* Refactor ListViewTests to use Terminal.Gui framework

The `ListViewTests` class has been refactored to replace the `AutoInitShutdown` attribute with explicit application lifecycle management using `IApplication` and `app.Init()` from the `Terminal.Gui` framework.

Key changes include:
- Rewriting tests to use `Terminal.Gui`'s application lifecycle.
- Adding a private `_output` field for logging test output via `ITestOutputHelper`.
- Updating `DriverAssert.AssertDriverContentsWithFrameAre` to include `app.Driver` for UI verification.
- Rewriting tests like `Clicking_On_Border_Is_Ignored`, `EnsureSelectedItemVisible_SelectedItem`, and others to align with the new framework.
- Adding explicit calls to `app.Shutdown()` for proper cleanup.
- Enabling nullable reference types with `#nullable enable`.
- Updating `using` directives and `namespace` to reflect the new structure.

These changes improve test maintainability, compatibility, and diagnostics.

* Update Terminal.Gui/Views/CollectionNavigation/CollectionNavigatorBase.cs

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

* Update Terminal.Gui/Views/CollectionNavigation/CollectionNavigatorBase.cs

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

* Update Examples/UICatalog/UICatalogTop.cs

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

* Update Terminal.Gui/Views/ListWrapper.cs

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

* Update Terminal.Gui/Views/ListWrapper.cs

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

* Updated the `SetMark` method to return `Source.IsMarked(SelectedItem.Value)` for consistency and removed an outdated comment questioning its correctness.

Enhanced the exception message in the `SelectedItem` property setter to provide clearer guidance when the value is out of range.

* Add comprehensive ListView behavior test coverage

Added multiple test methods to validate `ListView` behavior:
- `Vertical_ScrollBar_Hides_And_Shows_As_Needed`: Ensures the vertical scrollbar auto-hides/shows based on content height.
- `Mouse_Wheel_Scrolls`: Verifies vertical scrolling with the mouse wheel updates `TopItem`.
- `SelectedItem_With_Source_Null_Does_Nothing`: Confirms no exceptions occur when setting `SelectedItem` with a `null` source.
- `Horizontal_Scroll`: Tests horizontal scrolling, including programmatic and mouse wheel interactions, ensuring `LeftItem` updates correctly.
- `SetSourceAsync_SetsSource`: Validates the asynchronous `SetSourceAsync` method updates the source and item count.
- `AllowsMultipleSelection_Set_To_False_Unmarks_All_But_Selected`: Ensures disabling multiple selection unmarks all but the selected item.
- `Source_CollectionChanged_Remove`: Confirms `SelectedItem` and source count update correctly when items are removed from the source collection.

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-11-19 20:39:34 -05:00

324 lines
10 KiB
C#

namespace UnitTests_Parallelizable.LayoutTests;
public class FrameTests
{
[Fact]
public void Frame_Empty_Default ()
{
View view = new ();
Assert.Equal (Rectangle.Empty, view.Frame);
view.BeginInit ();
view.EndInit ();
Assert.Equal (Rectangle.Empty, view.Frame);
}
[Fact]
public void Frame_Empty_Initializer_Overrides_Base ()
{
// Prove TestView is correct
FrameTestView view = new ();
Assert.True (view.NeedsLayout);
view.Layout ();
Assert.Equal (new (10, 20, 30, 40), view.Frame);
Assert.Equal (10, view.X.GetAnchor (0));
Assert.Equal (20, view.Y.GetAnchor (0));
Assert.Equal (30, view.Width!.GetAnchor (0));
Assert.Equal (40, view.Height!.GetAnchor (0));
Assert.Equal (new (0, 0, 30, 40), view.Viewport);
// Set Frame via init
Rectangle frame = new (1, 2, 3, 4);
view = new ()
{
Frame = frame
};
Assert.Equal (frame, view.Frame);
Assert.False (view.NeedsLayout);
Assert.Equal (frame.Size, view.Viewport.Size);
Assert.Equal (view.X, frame.X);
Assert.Equal (view.Y, frame.Y);
Assert.Equal (view.Width, frame.Width);
Assert.Equal (view.Height, frame.Height);
// Set Frame via init to empty
frame = Rectangle.Empty;
view = new ()
{
Frame = frame
};
Assert.Equal (frame, view.Frame);
Assert.False (view.NeedsLayout);
Assert.Equal (frame.Size, view.Viewport.Size);
Assert.Equal (view.X, frame.X);
Assert.Equal (view.Y, frame.Y);
Assert.Equal (view.Width, frame.Width);
Assert.Equal (view.Height, frame.Height);
// Set back to original state
view.X = Pos.Func (_ => 10);
view.Y = Pos.Func (_ => 20);
view.Width = Dim.Func (_ => 30);
view.Height = Dim.Func (_ => 40);
Assert.True (view.NeedsLayout);
view.Layout ();
Assert.Equal (new (10, 20, 30, 40), view.Frame);
Assert.Equal (10, view.X.GetAnchor (0));
Assert.Equal (20, view.Y.GetAnchor (0));
Assert.Equal (30, view.Width!.GetAnchor (0));
Assert.Equal (40, view.Height!.GetAnchor (0));
Assert.Equal (new (0, 0, 30, 40), view.Viewport);
view.Frame = frame;
Assert.Equal (frame, view.Frame);
Assert.False (view.NeedsLayout);
Assert.Equal (frame.Size, view.Viewport.Size);
Assert.Equal (view.X, frame.X);
Assert.Equal (view.Y, frame.Y);
Assert.Equal (view.Width, frame.Width);
Assert.Equal (view.Height, frame.Height);
}
[Fact]
public void Frame_Empty_Initializer_Sets ()
{
Rectangle frame = new (1, 2, 3, 4);
View view = new ()
{
Frame = frame
};
Assert.Equal (frame, view.Frame);
Assert.False (view.NeedsLayout);
Assert.Equal (frame.Size, view.Viewport.Size);
Assert.Equal (view.X, frame.X);
Assert.Equal (view.Y, frame.Y);
Assert.Equal (view.Width, frame.Width);
Assert.Equal (view.Height, frame.Height);
view.Frame = Rectangle.Empty;
Assert.Equal (Rectangle.Empty, view.Frame);
Assert.False (view.NeedsLayout);
Assert.Equal (Rectangle.Empty.Size, view.Viewport.Size);
Assert.Equal (view.X, Rectangle.Empty.X);
Assert.Equal (view.Y, Rectangle.Empty.Y);
Assert.Equal (view.Width, Rectangle.Empty.Width);
Assert.Equal (view.Height, Rectangle.Empty.Height);
view.Width = Dim.Fill ();
view.Height = Dim.Fill ();
Assert.True (view.NeedsLayout);
view.Layout ();
Assert.False (view.NeedsLayout);
Assert.Equal (new Size (2048, 2048), view.Frame.Size);
view.Frame = Rectangle.Empty;
Assert.Equal (Rectangle.Empty, view.Frame);
Assert.False (view.NeedsLayout);
Assert.Equal (Rectangle.Empty.Size, view.Viewport.Size);
Assert.Equal (view.X, Rectangle.Empty.X);
Assert.Equal (view.Y, Rectangle.Empty.Y);
Assert.Equal (view.Width, Rectangle.Empty.Width);
Assert.Equal (view.Height, Rectangle.Empty.Height);
}
[Fact]
public void Frame_Initializer_Sets ()
{
Rectangle frame = new (1, 2, 3, 4);
View view = new ()
{
Frame = frame
};
Assert.Equal (frame, view.Frame);
Assert.False (view.NeedsLayout);
Assert.Equal (frame.Size, view.Viewport.Size);
Assert.Equal (view.X, frame.X);
Assert.Equal (view.Y, frame.Y);
Assert.Equal (view.Width, frame.Width);
Assert.Equal (view.Height, frame.Height);
}
// Moved this test from AbsoluteLayoutTests
// TODO: Refactor as Theory
[Fact]
public void Frame_Set ()
{
var frame = new Rectangle (1, 2, 3, 4);
var newFrame = new Rectangle (1, 2, 30, 40);
var v = new View ();
Assert.Equal (Rectangle.Empty, v.Frame);
v.Dispose ();
v = new () { Frame = frame };
Assert.Equal (frame, v.Frame);
v.Frame = newFrame;
Assert.Equal (newFrame, v.Frame);
Assert.Equal (
new (0, 0, newFrame.Width, newFrame.Height),
v.Viewport
); // With Absolute Viewport *is* deterministic before Layout
Assert.Equal (Pos.Absolute (1), v.X);
Assert.Equal (Pos.Absolute (2), v.Y);
Assert.Equal (Dim.Absolute (30), v.Width);
Assert.Equal (Dim.Absolute (40), v.Height);
v.Dispose ();
v = new () { X = frame.X, Y = frame.Y, Text = "v" };
v.Frame = newFrame;
Assert.Equal (newFrame, v.Frame);
Assert.Equal (
new (0, 0, newFrame.Width, newFrame.Height),
v.Viewport
); // With Absolute Viewport *is* deterministic before Layout
Assert.Equal (Pos.Absolute (1), v.X);
Assert.Equal (Pos.Absolute (2), v.Y);
Assert.Equal (Dim.Absolute (30), v.Width);
Assert.Equal (Dim.Absolute (40), v.Height);
v.Dispose ();
newFrame = new (10, 20, 30, 40);
v = new () { Frame = frame };
v.Frame = newFrame;
Assert.Equal (newFrame, v.Frame);
Assert.Equal (
new (0, 0, newFrame.Width, newFrame.Height),
v.Viewport
); // With Absolute Viewport *is* deterministic before Layout
Assert.Equal (Pos.Absolute (10), v.X);
Assert.Equal (Pos.Absolute (20), v.Y);
Assert.Equal (Dim.Absolute (30), v.Width);
Assert.Equal (Dim.Absolute (40), v.Height);
v.Dispose ();
v = new () { X = frame.X, Y = frame.Y, Text = "v" };
v.Frame = newFrame;
Assert.Equal (newFrame, v.Frame);
Assert.Equal (
new (0, 0, newFrame.Width, newFrame.Height),
v.Viewport
); // With Absolute Viewport *is* deterministic before Layout
Assert.Equal (Pos.Absolute (10), v.X);
Assert.Equal (Pos.Absolute (20), v.Y);
Assert.Equal (Dim.Absolute (30), v.Width);
Assert.Equal (Dim.Absolute (40), v.Height);
v.Dispose ();
}
[Fact]
public void Frame_Set_Sets ()
{
Rectangle frame = new (1, 2, 3, 4);
View view = new ();
Assert.True (view.NeedsLayout);
Assert.Equal (Rectangle.Empty, view.Frame);
view.Frame = frame;
Assert.Equal (frame, view.Frame);
Assert.False (view.NeedsLayout);
Assert.Equal (view.X, frame.X);
Assert.Equal (view.Y, frame.Y);
Assert.Equal (view.Width, frame.Width);
Assert.Equal (view.Height, frame.Height);
}
[Fact]
public void Frame_Set_Sets_Viewport_Without_Layout ()
{
Rectangle frame = new (1, 2, 3, 4);
View v = new () { Frame = frame };
Assert.Equal (frame, v.Frame);
Assert.Equal (
new (0, 0, frame.Width, frame.Height),
v.Viewport
); // With Absolute Viewport *is* deterministic before Layout
Assert.Equal (Pos.Absolute (1), v.X);
Assert.Equal (Pos.Absolute (2), v.Y);
Assert.Equal (Dim.Absolute (3), v.Width);
Assert.Equal (Dim.Absolute (4), v.Height);
}
[Fact]
public void FrameChanged_Event_Raised_When_Frame_Changes ()
{
// Arrange
var view = new TestFrameEventsView ();
var initialFrame = new Rectangle (0, 0, 10, 10);
var newFrame = new Rectangle (0, 0, 20, 20);
view.Frame = initialFrame;
Assert.Equal (1, view.FrameChangedEventCallCount);
// Act
view.Frame = newFrame;
// Assert
Assert.Equal (2, view.FrameChangedEventCallCount);
}
[Fact]
public void OnFrameChanged_Called_When_Frame_Changes ()
{
// Arrange
var view = new TestFrameEventsView ();
var initialFrame = new Rectangle (0, 0, 10, 10);
var newFrame = new Rectangle (0, 0, 20, 20);
view.Frame = initialFrame;
Assert.Equal (1, view.OnFrameChangedCallCount);
// Act
view.Frame = newFrame;
// Assert
Assert.Equal (2, view.OnFrameChangedCallCount);
}
private class FrameTestView : View
{
public FrameTestView ()
{
X = Pos.Func (_ => 10);
Y = Pos.Func (_ => 20);
Width = Dim.Func (_ => 30);
Height = Dim.Func (_ => 40);
}
}
private class TestFrameEventsView : View
{
public TestFrameEventsView () { FrameChanged += (sender, args) => FrameChangedEventCallCount++; }
public int FrameChangedEventCallCount { get; private set; }
public int OnFrameChangedCallCount { get; private set; }
protected override void OnFrameChanged (in Rectangle frame)
{
OnFrameChangedCallCount++;
base.OnFrameChanged (frame);
}
}
}