Files
Terminal.Gui/Tests/UnitTestsParallelizable/Drawing/AttributeTests.cs
Copilot 2be8397203 Remove legacy drivers, simplify architecture, and reorganize codebase structure (#4270)
* 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>
2025-10-15 13:24:47 -06:00

448 lines
13 KiB
C#

// Alias Console to MockConsole so we don't accidentally use Console
namespace Terminal.Gui.DrawingTests;
public class AttributeTests
{
[Fact]
public void Constructor_ParsesNamedColorsAndStyle ()
{
var attr = new Attribute ("Red", "Black", "Bold,Underline");
Assert.Equal (Color.Parse ("Red"), attr.Foreground);
Assert.Equal (Color.Parse ("Black"), attr.Background);
Assert.True (attr.Style.HasFlag (TextStyle.Bold));
Assert.True (attr.Style.HasFlag (TextStyle.Underline));
}
[Fact]
public void Constructor_ParsesHexColors ()
{
var attr = new Attribute ("#FF0000", "#000000", "Italic");
Assert.Equal (Color.Parse ("#FF0000"), attr.Foreground);
Assert.Equal (Color.Parse ("#000000"), attr.Background);
Assert.Equal (TextStyle.Italic, attr.Style);
}
[Fact]
public void Constructor_ParsesRgbColors ()
{
var attr = new Attribute ("rgb(0,255,0)", "rgb(0,0,255)", "Faint");
Assert.Equal (Color.Parse ("rgb(0,255,0)"), attr.Foreground);
Assert.Equal (Color.Parse ("rgb(0,0,255)"), attr.Background);
Assert.Equal (TextStyle.Faint, attr.Style);
}
[Fact]
public void Constructor_DefaultsToNoneStyle_WhenStyleIsNullOrEmpty ()
{
var attr1 = new Attribute ("White", "Black");
var attr2 = new Attribute ("White", "Black", null);
var attr3 = new Attribute ("White", "Black", "");
Assert.Equal (TextStyle.None, attr1.Style);
Assert.Equal (TextStyle.None, attr2.Style);
Assert.Equal (TextStyle.None, attr3.Style);
}
[Fact]
public void Constructor_DefaultsToNoneStyle_WhenStyleIsInvalid ()
{
var attr = new Attribute ("White", "Black", "NotAStyle");
Assert.Equal (TextStyle.None, attr.Style);
}
[Fact]
public void ColorAndColorNamesConstructor ()
{
// Arrange & Act
var foregroundColor = new Color (0, 0, 255);
var backgroundColorName = ColorName16.Black;
var attribute = new Attribute (foregroundColor, backgroundColorName);
// Assert
Assert.Equal (foregroundColor, attribute.Foreground);
Assert.Equal (new (backgroundColorName), attribute.Background);
}
[Fact]
public void ColorConstructor ()
{
// Arrange & Act
var foregroundColor = new Color (0, 0, 255);
var backgroundColor = new Color (255, 255, 255);
var attribute = new Attribute (foregroundColor, backgroundColor);
// Assert
Assert.Equal (foregroundColor, attribute.Foreground);
Assert.Equal (backgroundColor, attribute.Background);
}
[Fact]
public void ColorNamesAndColorConstructor ()
{
// Arrange & Act
var foregroundColorName = ColorName16.BrightYellow;
var backgroundColor = new Color (128, 128, 128);
var attribute = new Attribute (foregroundColorName, backgroundColor);
// Assert
Assert.Equal (new (foregroundColorName), attribute.Foreground);
Assert.Equal (backgroundColor, attribute.Background);
}
[Fact]
public void ColorNamesConstructor ()
{
// Arrange & Act
var attribute = new Attribute (ColorName16.Blue);
// Assert
Assert.Equal (new (Color.Blue), attribute.Foreground);
Assert.Equal (new (Color.Blue), attribute.Background);
}
[Fact]
public void Constructors_Construct ()
{
var driver = new FakeDriver ();
driver.Init ();
// Test parameterless constructor
var attr = new Attribute ();
Assert.Equal (new (Color.White), attr.Foreground);
Assert.Equal (new (Color.Black), attr.Background);
// Test foreground, background
var fg = new Color ();
fg = new (Color.Red);
var bg = new Color ();
bg = new (Color.Blue);
attr = new (fg, bg);
//Assert.True (attr.Initialized);
//Assert.True (attr.HasValidColors);
Assert.Equal (fg, attr.Foreground);
Assert.Equal (bg, attr.Background);
attr = new (fg);
//Assert.True (attr.Initialized);
//Assert.True (attr.HasValidColors);
Assert.Equal (fg, attr.Foreground);
Assert.Equal (fg, attr.Background);
attr = new (bg);
//Assert.True (attr.Initialized);
//Assert.True (attr.HasValidColors);
Assert.Equal (bg, attr.Foreground);
Assert.Equal (bg, attr.Background);
driver.End ();
}
[Fact]
public void DefaultConstructor ()
{
// Arrange & Act
var attribute = new Attribute ();
// Assert
Assert.Equal (new (Color.White), attribute.Foreground);
Assert.Equal (new (Color.Black), attribute.Background);
}
[Fact]
public void Equality_IncludesStyle ()
{
var attr1 = new Attribute (Color.Red, Color.Black, TextStyle.Bold);
var attr2 = new Attribute (Color.Red, Color.Black, TextStyle.Bold);
var attr3 = new Attribute (Color.Red, Color.Black, TextStyle.Underline);
Assert.Equal (attr1, attr2);
Assert.NotEqual (attr1, attr3);
}
[Fact]
public void EqualityOperator_ShouldReturnFalseForDifferentAttributes ()
{
// Arrange
var attribute1 = new Attribute (Color.Red, Color.Black);
var attribute2 = new Attribute (Color.Blue, Color.Black);
// Act & Assert
Assert.False (attribute1 == attribute2);
}
[Fact]
public void EqualityOperator_ShouldReturnTrueForEqualAttributes ()
{
// Arrange
var attribute1 = new Attribute (Color.Red, Color.Black);
var attribute2 = new Attribute (Color.Red, Color.Black);
// Act & Assert
Assert.True (attribute1 == attribute2);
}
[Fact]
public void Equals_Initialized ()
{
var attr1 = new Attribute (Color.Red, Color.Green);
var attr2 = new Attribute (Color.Red, Color.Green);
Assert.True (attr1.Equals (attr2));
Assert.True (attr2.Equals (attr1));
}
[Fact]
public void Equals_NotInitialized ()
{
var attr1 = new Attribute (Color.Red, Color.Green);
var attr2 = new Attribute (Color.Red, Color.Green);
Assert.True (attr1.Equals (attr2));
Assert.True (attr2.Equals (attr1));
}
[Fact]
public void GetHashCode_ConsistentWithEquals ()
{
var attr1 = new Attribute (Color.Red, Color.Black, TextStyle.Bold);
var attr2 = new Attribute (Color.Red, Color.Black, TextStyle.Bold);
Assert.Equal (attr1, attr2);
Assert.Equal (attr1.GetHashCode (), attr2.GetHashCode ());
}
[Fact]
public void Implicit_Assign ()
{
var driver = new FakeDriver ();
driver.Init ();
var attr = new Attribute ();
var value = 42;
var fg = new Color ();
fg = new (Color.Red);
var bg = new Color ();
bg = new (Color.Blue);
driver.End ();
}
[Fact]
public void InequalityOperator_ShouldReturnFalseForEqualAttributes ()
{
// Arrange
var attribute1 = new Attribute (Color.Red, Color.Black);
var attribute2 = new Attribute (Color.Red, Color.Black);
// Act & Assert
Assert.False (attribute1 != attribute2);
}
[Fact]
public void InequalityOperator_ShouldReturnTrueForDifferentAttributes ()
{
// Arrange
var attribute1 = new Attribute (Color.Red, Color.Black);
var attribute2 = new Attribute (Color.Blue, Color.Black);
// Act & Assert
Assert.True (attribute1 != attribute2);
}
[Fact]
public void Is_Value_Type ()
{
// prove that Color is a value type
Assert.True (typeof (Attribute).IsValueType);
}
[Fact]
public void List_RoundTrip_EqualityHolds ()
{
List<Attribute> list1 = [new (Color.Red, Color.Black, TextStyle.Bold)];
List<Attribute> list2 = new (list1);
Assert.Equal (list1, list2);
}
[Fact]
public void Make_Creates ()
{
var driver = new FakeDriver ();
driver.Init ();
var fg = new Color ();
fg = new (Color.Red);
var bg = new Color ();
bg = new (Color.Blue);
var attr = new Attribute (fg, bg);
//Assert.True (attr.Initialized);
Assert.Equal (fg, attr.Foreground);
Assert.Equal (bg, attr.Background);
driver.End ();
}
[Fact]
public void Make_Creates_NoDriver ()
{
var fg = new Color ();
fg = new (Color.Red);
var bg = new Color ();
bg = new (Color.Blue);
var attr = new Attribute (fg, bg);
//Assert.False (attr.Initialized);
Assert.Equal (fg, attr.Foreground);
Assert.Equal (bg, attr.Background);
}
[Fact]
public void Make_SetsNotInitialized_NoDriver ()
{
var fg = new Color ();
fg = new (Color.Red);
var bg = new Color ();
bg = new (Color.Blue);
var a = new Attribute (fg, bg);
//Assert.False (a.Initialized);
}
[Fact]
public void MakeColorAndColor_ForegroundAndBackgroundShouldMatchInput ()
{
// Arrange
var foregroundColor = new Color (0, 0, 255);
var backgroundColor = new Color (255, 255, 255);
// Act
var attribute = new Attribute (foregroundColor, backgroundColor);
// Assert
Assert.Equal (foregroundColor, attribute.Foreground);
Assert.Equal (backgroundColor, attribute.Background);
}
[Fact]
public void MakeColorAndColorNames_ForegroundAndBackgroundShouldMatchInput ()
{
// Arrange
var foregroundColor = new Color (255, 0);
var backgroundColorName = ColorName16.White;
// Act
var attribute = new Attribute (foregroundColor, backgroundColorName);
// Assert
Assert.Equal (foregroundColor, attribute.Foreground);
Assert.Equal (new (backgroundColorName), attribute.Background);
}
[Fact]
public void MakeColorNamesAndColor_ForegroundAndBackgroundShouldMatchInput ()
{
// Arrange
var foregroundColorName = ColorName16.Green;
var backgroundColor = new Color (128, 128, 128);
// Act
var attribute = new Attribute (foregroundColorName, backgroundColor);
// Assert
Assert.Equal (new (foregroundColorName), attribute.Foreground);
Assert.Equal (backgroundColor, attribute.Background);
}
[Fact]
public void MakeColorNamesAndColorNames_ForegroundAndBackgroundShouldMatchInput ()
{
// Arrange
var foregroundColorName = ColorName16.BrightYellow;
var backgroundColorName = ColorName16.Black;
// Act
var attribute = new Attribute (foregroundColorName, backgroundColorName);
// Assert
Assert.Equal (new (foregroundColorName), attribute.Foreground);
Assert.Equal (new (backgroundColorName), attribute.Background);
}
[Fact]
public void NotEquals_Initialized ()
{
var attr1 = new Attribute (Color.Red, Color.Green);
var attr2 = new Attribute (Color.Green, Color.Red);
Assert.False (attr1.Equals (attr2));
Assert.False (attr2.Equals (attr1));
}
[Fact]
public void NotEquals_NotInitialized ()
{
var attr1 = new Attribute (Color.Red, Color.Green);
var attr2 = new Attribute (Color.Green, Color.Red);
Assert.False (attr1.Equals (attr2));
Assert.False (attr2.Equals (attr1));
}
[Fact]
public void ToString_Formats_Correctly ()
{
// Arrange
var foregroundColor = new Color (0, 0, 255);
var backgroundColor = new Color (255, 255, 255);
var expectedString = $"[{foregroundColor},{backgroundColor},None]";
// Act
var attribute = new Attribute (foregroundColor, backgroundColor);
var attributeString = attribute.ToString ();
// Assert
Assert.Equal (expectedString, attributeString);
}
[Theory]
[InlineData (TextStyle.Bold, "Bold")]
[InlineData (TextStyle.Bold | TextStyle.Underline, "Bold, Underline")]
[InlineData (TextStyle.None, "None")]
public void ToString_IncludesStyle (TextStyle style, string expectedStyleString)
{
var attr = new Attribute (Color.Red, Color.Black, style);
var result = attr.ToString ();
Assert.Contains (expectedStyleString, result);
}
[Fact]
public void ToString_ShouldFailComparison_IfDifferentInstancesSameContent ()
{
var original = new Attribute (Color.White, Color.White);
var clone = new Attribute (Color.White, Color.White);
// These print the same
Assert.Equal (original.ToString (), clone.ToString ());
// But this will fail if anything differs under the hood
Assert.Equal (original, clone); // Should pass — record struct
}
}