mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-27 00:07:58 +01:00
* Initial plan * Change MessageBox to return nullable int instead of -1 Co-authored-by: tig <585482+tig@users.noreply.github.com> * Initial plan * Add fencing to prevent mixing Application models Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fix fence logic to work with parallel tests Co-authored-by: tig <585482+tig@users.noreply.github.com> * WIP: Fixing Application issues. * Refactor error messages into constants Co-authored-by: tig <585482+tig@users.noreply.github.com> * Refactor ConfigurationProperty properties to use static backing fields and raise events Co-authored-by: tig <585482+tig@users.noreply.github.com> * Reset static Application properties in ResetStateStatic Co-authored-by: tig <585482+tig@users.noreply.github.com> * Refactor tests to decouple from global Application state Commented out `driver ??= Application.Driver` assignments in `DriverAssert` to prevent automatic global driver assignment. Removed `Application.ResetState(true)` calls and commented out state validation assertions in `GlobalTestSetup` to reduce dependency on global state. Reintroduced `ApplicationForceDriverTests` and `ApplicationModelFencingTests` to validate `ForceDriver` behavior and ensure proper handling of legacy and modern Application models. Skipped certain `ToAnsiTests` that rely on `Application`. Removed direct `Application.Driver` assignments in `ViewDrawingClippingTests` and `ViewDrawingFlowTests`. Performed general cleanup of redundant code and unused imports to simplify the codebase. * WIP: Fixed Parallel tests; non-Parallel still broken Refactor application model usage tracking Refactored `ApplicationModelUsage` into a public enum in the new `Terminal.Gui.App` namespace, making it accessible across the codebase. Replaced the private `_modelUsage` field in `ApplicationImpl` with a public static `ModelUsage` property to improve clarity and accessibility. Renamed error message constants for consistency and updated methods like `SetInstance` and `MarkInstanceBasedModelUsed` to use the new `ModelUsage` property. Removed the private `ApplicationModelUsage` enum from `ApplicationImpl`. Updated test cases to use `ApplicationImpl.Instance` instead of `Application.Create` to enforce the legacy static model. Skipped obsolete tests in `ApplicationForceDriverTests` and added null checks in `DriverAssert` and `SelectorBase` to handle edge cases. Commented out an unused line in `WindowsOutput` and made general improvements to code readability, maintainability, and consistency. * WIP: Almost there! Refactored tests and code to align with the modern instance-based application model. Key changes include: - Disabled Sixel rendering in `OutputBase.cs` due to dependency on legacy static `Application` object. - Hardcoded `force16Colors` to `false` in `WindowsOutput.cs` with a `BUGBUG` note. - Updated `ApplicationImplTests` to use `ApplicationImpl.SetInstance` and return `ApplicationImpl.Instance`. - Refactored `ApplicationModelFencingTests` to use `Application.Create()` and added `ResetModelUsageTracking()` for model switching. - Removed legacy `DriverTests` and reintroduced updated versions with cross-platform driver tests. - Reverted `ArrangementTests` and `ShortcutTests` to use legacy static `ApplicationImpl.Instance`. - Reintroduced driver tests in `DriverTests.cs` with modern `Application.Create()` and added `TestTop` for driver content verification. - General cleanup, including removal of outdated code and addition of `BUGBUG` notes for temporary workarounds. * Fixed all modelusage bugs? Replaced static `Application` references with instance-based `App` context across the codebase. Updated calls to `Application.RequestStop()` and `Application.Screen` to use `App?.RequestStop()` and `App?.Screen` for better encapsulation and flexibility. Refactored test infrastructure to align with the new context, including reintroducing `FakeApplicationFactory` and `FakeApplicationLifecycle` for testing purposes. Improved logging, error handling, and test clarity by adding `logWriter` support and simplifying test setup. Removed redundant or obsolete code, such as `NetSequences` and the old `FakeApplicationFactory` implementation. Updated documentation to reflect the new `IApplication.RequestStop()` usage. * merged * Refactor KeyboardImpl and modernize MessageBoxTests Refactored the `KeyboardImpl` class to remove hardcoded default key values, replacing them with uninitialized fields for dynamic configuration. Updated key binding logic to use `ReplaceCommands` instead of `Add` for better handling of dynamic changes. Removed unnecessary `KeyBindings.Clear()` calls to avoid side effects. Rewrote `MessageBoxTests.cs` to improve readability, maintainability, and adherence to modern C# standards. Enabled nullable reference checks, updated the namespace, and restructured test methods for clarity. Marked non-functional tests with `[Theory(Skip)]` and improved test organization with parameterized inputs. Enhanced test assertions, lifecycle handling, and error handling across the test suite. Updated `UICatalog_AboutBox` to use multiline string literals for expected outputs. These changes improve the overall maintainability and flexibility of the codebase. * Atempt to fix windows only CI/CD Unit tests failure Refactor Application lifecycle and test cleanup Refactored the `Application` class to phase out legacy static properties `SessionStack` and `TopRunnable` from `Application.Current.cs`. These were reintroduced in a new file `Application.TopRunnable.cs` for better modularity, while retaining their `[Obsolete]` status. Updated `ApplicationPopoverTests.cs` to replace `Application.ResetState(true)` with `Application.Shutdown()` for consistent application state cleanup. Added explicit cleanup for `Application.TopRunnable` in relevant test cases to ensure proper resource management. Adjusted namespaces and `using` directives to support the new structure. These changes improve code organization and align with updated application lifecycle management practices. * Fixes #<Issue> - Dispose TopRunnable in cleanup logic Updated the `finally` block in `ApplicationPopoverTests` to dispose of the `Application.TopRunnable` object if it is not null, ensuring proper resource cleanup. Previously, the property was being set to `null` without disposal. The `Application.Shutdown()` call remains unchanged. * Improve thread safety, reduce static dependencies, and align the codebase with the updated `IApplication` interface. Refactored the `MainThreadId` property to improve encapsulation: - Updated `Application.MainThreadId` to use `ApplicationImpl.Instance` directly. - Added `MainThreadId` to `ApplicationImpl` and `IApplication`. - Removed redundant `MainThreadId` from `ApplicationImpl.Run.cs`. Updated `EnqueueMouseEvent` to include an `IApplication?` parameter: - Modified `FakeInputProcessor`, `InputProcessorImpl`, and `WindowsInputProcessor` to support the new parameter. - Updated `IInputProcessor` interface to reflect the new method signature. - Adjusted `GuiTestContext` and `EnqueueMouseEventTests` to pass `IApplication` where required. Improved test coverage and code maintainability: - Added test cases for negative positions and empty mouse events. - Commented out legacy code in `GraphView` and `FakeDriverBase`. - Enhanced readability in `EnqueueMouseEventTests`. These changes improve thread safety, reduce static dependencies, and align the codebase with the updated `IApplication` interface. * Fixed more bugs. Enabled nullable reference types across multiple files to improve code safety. Refactored and modularized test classes, improving readability and maintainability. Removed outdated test cases and added new tests for edge cases, including culture-specific and non-Gregorian calendar handling. Addressed timeout issues in `ScenarioTests` with a watchdog timer and improved error handling. Updated `ApplicationImplTests` to use instance fields instead of static references for better test isolation. Refactored `ScenarioTests` to dynamically load and test all UI Catalog scenarios, with macOS-specific skips for known issues. Aligned `MessageBox.Query` calls with updated API signatures. Performed general code cleanup, including removing unused directives, improving formatting, and consolidating repetitive logic into helper methods. * Made the `InputBindings<TEvent, TBinding>` class thread-safe by replacing the internal `Dictionary<TEvent, TBinding>` with `ConcurrentDictionary<TEvent, TBinding>`. This fixes parallel test failures where "Collection was modified; enumeration operation may not execute" exceptions were thrown. ## Changes Made ### 1. InputBindings.cs - **File**: `Terminal.Gui/Input/InputBindings.cs` - **Change**: Replaced `Dictionary` with `ConcurrentDictionary` - **Key modifications**: - Changed `_bindings` from `Dictionary<TEvent, TBinding>` to `ConcurrentDictionary<TEvent, TBinding>` - Updated `Add()` methods to use `TryAdd()` instead of checking with `TryGet()` then `Add()` - Updated `Remove()` to use `TryRemove()` (no need to check existence first) - Updated `ReplaceCommands()` to use `ContainsKey()` instead of `TryGet()` - Added `.ToList()` to `GetAllFromCommands()` to create a snapshot for safe enumeration - Added comment explaining that `ConcurrentDictionary` provides snapshot enumeration in `GetBindings()` - Added `.ToArray()` to `Clear(Command[])` to create snapshot before iteration ### 2. Thread Safety Test Suite - **File**: `Tests/UnitTestsParallelizable/Input/InputBindingsThreadSafetyTests.cs` - **New file** with comprehensive thread safety tests: - `Add_ConcurrentAccess_NoExceptions` - Tests concurrent additions - `GetBindings_DuringConcurrentModification_NoExceptions` - Tests enumeration during modifications - `TryGet_ConcurrentAccess_ReturnsConsistentResults` - Tests concurrent reads - `Clear_ConcurrentAccess_NoExceptions` - Tests concurrent clearing - `Remove_ConcurrentAccess_NoExceptions` - Tests concurrent removals - `Replace_ConcurrentAccess_NoExceptions` - Tests concurrent replacements - `GetAllFromCommands_DuringModification_NoExceptions` - Tests LINQ queries during modifications - `MixedOperations_ConcurrentAccess_NoExceptions` - Tests mixed operations (add/read/remove) - `KeyBindings_ConcurrentAccess_NoExceptions` - Tests actual `KeyBindings` class - `MouseBindings_ConcurrentAccess_NoExceptions` - Tests actual `MouseBindings` class ## Benefits of ConcurrentDictionary Approach 1. **Lock-Free Reads**: Most read operations don't require locks, improving performance 2. **Snapshot Enumeration**: Built-in support for safe enumeration during concurrent modifications 3. **Simplified Code**: No need for explicit `lock` statements or lock objects 4. **Better Scalability**: Multiple threads can read/write simultaneously 5. **No "Collection was modified" Exceptions**: Enumeration creates a snapshot ## Performance Characteristics - **Read Operations**: Lock-free, very fast - **Write Operations**: Uses fine-grained locking internally, minimal contention - **Memory Overhead**: Slightly higher than `Dictionary` but negligible in practice - **Enumeration**: Creates a snapshot, safe for concurrent modifications ## Test Results - **Original failing test now passes**: `ApplicationImplTests.Init_CreatesKeybindings` - **10 new thread safety tests**: All passing - **All 11,741 parallelizable tests**: All passing (11,731 passed, 10 skipped) - **All 1,779 non-parallelizable tests**: All passing (1,762 passed, 17 skipped) - **No compilation errors**: Clean build with no xUnit1031 warnings (suppressed with pragmas) ## Verification The original failure was: ``` System.InvalidOperationException: Collection was modified; enumeration operation may not execute. ``` This occurred in parallelizable tests when multiple threads accessed `KeyBindings.GetBindings()` simultaneously. The `ConcurrentDictionary` implementation resolves this by providing thread-safe operations and snapshot enumeration. ## Notes - The xUnit1031 warnings about using `Task.WaitAll` instead of `async/await` have been suppressed with `#pragma warning disable xUnit1031` directives, as these are intentional blocking operations in stress tests that test concurrent scenarios - All existing functionality is preserved; this is a drop-in replacement - No changes to public API surface - Existing tests continue to pass * Make InputBindings and KeyboardImpl thread-safe for concurrent access Replace Dictionary with ConcurrentDictionary in InputBindings<TEvent, TBinding> and KeyboardImpl to enable safe parallel test execution and multi-threaded usage. Changes: - InputBindings: Replace Dictionary with ConcurrentDictionary for _bindings - InputBindings: Make Replace() atomic using AddOrUpdate instead of Remove+Add - InputBindings: Make ReplaceCommands() atomic using AddOrUpdate - InputBindings: Add IsValid() check to both Add() overloads - InputBindings: Add defensive .ToList()/.ToArray() for safe LINQ enumeration - KeyboardImpl: Replace Dictionary with ConcurrentDictionary for _commandImplementations - KeyboardImpl: Change AddKeyBindings() to use ReplaceCommands for idempotent initialization - Add 10 comprehensive thread safety tests for InputBindings - Add 9 comprehensive thread safety tests for KeyboardImpl The ConcurrentDictionary implementation provides: - Lock-free reads for better performance under concurrent access - Atomic operations for Replace/ReplaceCommands preventing race conditions - Snapshot enumeration preventing "Collection was modified" exceptions - No breaking API changes - maintains backward compatibility All 11,750 parallelizable tests pass (11,740 passed, 10 skipped). Fixes race conditions that caused ApplicationImplTests.Init_CreatesKeybindings to fail intermittently during parallel test execution. * Decouple ApplicationImpl from Application static props Removed initialization of `Force16Colors` and `ForceDriver` from `Application` static properties in the `ApplicationImpl` constructor. The class still subscribes to the `Force16ColorsChanged` and `ForceDriverChanged` events, but no longer sets initial values for these properties. This change simplifies the constructor and reduces coupling between `ApplicationImpl` and `Application`. * Refactored keyboard initialization in `ApplicationImpl` to use `Application` static properties for default key assignments, ensuring synchronization with pre-`Init()` changes. Improved `KeyboardImpl` initialization to avoid premature `ApplicationImpl.Instance` access, enhancing testability. Standardized constant naming conventions and improved code readability in thread safety tests for `KeyboardImpl` and `InputBindings`. Updated `TestInputBindings` implementation for clarity and conciseness. Applied consistent code style improvements across files, including spacing, formatting, and variable naming, to enhance maintainability and readability. * Fix race conditions in parallel tests - thread-safe ApplicationImpl and KeyboardImpl Fixes intermittent failures in parallel tests caused by three separate race conditions: 1. **KeyboardImpl constructor race condition** - Constructor was accessing Application.QuitKey/ArrangeKey/etc which triggered ApplicationImpl.Instance getter, setting ModelUsage=LegacyStatic before Application.Create() was called - Changed constructor to initialize keys with hard-coded defaults instead - Added synchronization from Application static properties during Init() 2. **InputBindings.Replace() race condition** - Between GetOrAdd(oldEventArgs) and AddOrUpdate(newEventArgs), another thread could modify bindings, causing stale data to overwrite valid bindings - Added early return for same-key case (oldEventArgs == newEventArgs) - Kept atomic operations with proper updateValueFactory handling - Added detailed thread-safety documentation 3. **ApplicationImpl model usage fence checks race condition** - Two threads calling Init() simultaneously could both pass fence checks before either set ModelUsage, allowing improper model mixing - Added _modelUsageLock for thread-safe synchronization - Made all ModelUsage operations atomic (Instance getter, SetInstance, MarkInstanceBasedModelUsed, ResetModelUsageTracking, Init fence checks) **Files Changed:** - Terminal.Gui/App/ApplicationImpl.cs - Added _modelUsageLock, made all ModelUsage access thread-safe - Terminal.Gui/App/ApplicationImpl.Lifecycle.cs - Thread-safe fence checks in Init(), sync keyboard keys from Application properties - Terminal.Gui/App/Keyboard/KeyboardImpl.cs - Fixed constructor to not trigger ApplicationImpl.Instance - Terminal.Gui/Input/InputBindings.cs - Fixed Replace() race condition with proper atomic operations **Testing:** - All 11 ApplicationImplTests pass - All 9 KeyboardImplThreadSafetyTests pass - All 10 InputBindingsThreadSafetyTests pass - No more intermittent "Cannot use modern instance-based model after using legacy static Application model" errors in parallel test execution The root cause was KeyboardImpl constructor accessing Application static properties during object creation, which would lazily initialize ApplicationImpl.Instance and set the wrong ModelUsage before Application.Create() could mark it as InstanceBased. * Warning cleanup * docs: Add comprehensive MessageBox and Clipboard API documentation - Updated MessageBox class docs with nullable return value explanation - Created docfx/docs/messagebox-clipboard-changes-v2.md migration guide - Updated migratingfromv1.md with quick links to major changes - Created PR-SUMMARY.md documenting all changes - Added examples for both instance-based and legacy patterns - Documented application model fencing and thread safety improvements The documentation covers: • MessageBox nullable int? returns (null = cancelled) • Clipboard refactoring from static to instance-based • Application model usage fencing to prevent pattern mixing • Thread safety improvements in KeyboardImpl and InputBindings • Complete migration guide with code examples • Benefits and rationale for all changes * Refactor static properties to use backing fields Refactored static properties in multiple classes (`Button`, `CheckBox`, `Dialog`, `FrameView`, `MessageBox`, `StatusBar`, and `Window`) to use private backing fields for better encapsulation and configurability. Default values are now stored in private static fields, allowing overrides via configuration files (e.g., `Resources/config.json`). Updated property definitions to use `get`/`set` accessors interacting with the backing fields. Retained the `[ConfigurationProperty]` attribute to ensure runtime configurability. Removed redundant code, improved XML documentation, adjusted namespace declarations for consistency, and performed general code cleanup to enhance readability and maintainability. * Fix Windows-only parallel test failure by preventing ConfigurationManager from triggering ApplicationImpl.Instance Problem: `MessageBoxTests.Location_And_Size_Correct` was failing only on Windows in parallel tests with: System.InvalidOperationException: Cannot use modern instance-based model (Application.Create) after using legacy static Application model (Application.Init/ApplicationImpl.Instance). Root Cause (maybe): View classes (MessageBox, Dialog, Window, Button, CheckBox, FrameView, StatusBar) had `[ConfigurationProperty]` decorated auto-properties with inline initializers. When ConfigurationManager's module initializer scanned assemblies using reflection, accessing these auto-properties could trigger lazy initialization of other static members, which in some cases indirectly referenced `ApplicationImpl.Instance`, marking the model as "legacy" before parallel tests called `Application.Create()`. Solution: Converted all `[ConfigurationProperty]` auto-properties in View classes to use private backing fields with explicit getters/setters, matching the pattern used by `Application.QuitKey`. This prevents any code execution during reflection-based property discovery. Files Changed: - Terminal.Gui/Views/MessageBox.cs - 4 properties converted - Terminal.Gui/Views/Dialog.cs - 6 properties converted - Terminal.Gui/Views/Window.cs - 2 properties converted - Terminal.Gui/Views/Button.cs - 2 properties converted - Terminal.Gui/Views/CheckBox.cs - 1 property converted - Terminal.Gui/Views/FrameView.cs - 1 property converted - Terminal.Gui/Views/StatusBar.cs - 1 property converted Test Reorganization: - Moved `ConfigurationManagerTests.GetConfigPropertiesByScope_Gets` from UnitTestsParallelizable to UnitTests (defines custom ConfigurationProperty which affects global state) - Moved `SourcesManagerTests.Sources_StaysConsistentWhenUpdateFails` from UnitTestsParallelizable to UnitTests (modifies static ConfigurationManager.ThrowOnJsonErrors property) Best Practice: All `[ConfigurationProperty]` decorated static properties should use private backing fields to avoid triggering lazy initialization during ConfigurationManager's module initialization. Fixes: Windows-only parallel test failure in MessageBoxTests * Add thread-safety to CollectionNavigator classes - Add lock-based synchronization to CollectionNavigatorBase for _searchString and _lastKeystroke fields - Add lock-based synchronization to CollectionNavigator for Collection property access - Protect ElementAt and GetCollectionLength methods with locks - Add 6 comprehensive thread-safety tests covering: - Concurrent SearchString access - Concurrent Collection property access - Concurrent navigation operations (50 parallel tasks) - Concurrent collection modification with readers/writers - Concurrent search string changes - Stress test with 100 tasks × 1000 operations each All tests pass (31/31) including new thread-safety tests. The implementation uses lock-based synchronization rather than concurrent collections because: - IList interface is not thread-safe by design - CollectionNavigator is internal and used by UI components (ListView/TreeView) - Matches existing Terminal.Gui patterns (Scope<T>, ConfigProperty) - Provides simpler and more predictable behavior Fixes thread-safety issues when CollectionNavigator is accessed from multiple threads. * cleanup * Run parallel unit tests 10 times with varying parallelization to expose concurrency issues Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fix parallel unit tests workflow - use proper xUnit parallelization parameters Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fix environment variable reference in workflow - use proper bash syntax Co-authored-by: tig <585482+tig@users.noreply.github.com> * Run parallel tests 10 times sequentially instead of matrix expansion Co-authored-by: tig <585482+tig@users.noreply.github.com> * Make ConfigurationManager thread-safe - use ConcurrentDictionary and add locks Co-authored-by: tig <585482+tig@users.noreply.github.com> * Add Debug.Fail to detect legacy Application usage in parallelizable tests Co-authored-by: tig <585482+tig@users.noreply.github.com> * Move ScrollSliderTests to UnitTests project - they access legacy Application model Co-authored-by: tig <585482+tig@users.noreply.github.com> * Revert ScrollSliderTests move and document root cause analysis Co-authored-by: tig <585482+tig@users.noreply.github.com> * Remove Debug.Fail and move ScrollSliderTests to UnitTests project Co-authored-by: tig <585482+tig@users.noreply.github.com> * Re-add Debug.Fail to detect legacy Application usage in parallelizable tests Co-authored-by: tig <585482+tig@users.noreply.github.com> * Refactor tests and improve parallelization support Commented out `Debug.Fail` statements in `Application.Lifecycle.cs` and `ApplicationImpl.cs` to prevent interruptions during parallel tests. Refactored `ToString` in `ApplicationImpl.cs` to use an expression-bodied member and removed unused imports. Rewrote tests in `ClipRegionTests.cs` and `ScrollSliderTests.cs` to remove global state dependencies and migrated them to the `UnitTests_Parallelizable` namespace. Enabled nullable annotations and updated assertions for clarity and modern patterns. Improved test coverage by adding scenarios for clamping, layout, and size calculations. Updated `README.md` to include `[SetupFakeApplication]` in the list of patterns that block parallelization and clarified migration guidelines. Replaced `[SetupFakeDriver]` with `[SetupFakeApplication]` in examples. Added `<Folder Include="Drivers\" />` to `UnitTests.csproj` for better organization. Adjusted test project references to reflect test migration. Enhanced test output validation in `ScrollSliderTests.cs`. Removed redundant test cases and improved documentation to align with modern C# practices and ensure maintainability. * marked as a "TODO" for potential future configurability. --------- 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>
377 lines
12 KiB
C#
377 lines
12 KiB
C#
using System.Text;
|
||
using UnitTests;
|
||
using Xunit.Abstractions;
|
||
|
||
namespace UnitTests_Parallelizable.DriverTests;
|
||
|
||
/// <summary>
|
||
/// Tests for the ToAnsi functionality that generates ANSI escape sequences from buffer contents.
|
||
/// </summary>
|
||
public class ToAnsiTests : FakeDriverBase
|
||
{
|
||
[Fact]
|
||
public void ToAnsi_Empty_Buffer ()
|
||
{
|
||
IDriver driver = CreateFakeDriver (10, 5);
|
||
string ansi = driver.ToAnsi ();
|
||
|
||
// Empty buffer should have newlines for each row
|
||
Assert.Contains ("\n", ansi);
|
||
// Should have 5 newlines (one per row)
|
||
Assert.Equal (5, ansi.Count (c => c == '\n'));
|
||
}
|
||
|
||
[Fact]
|
||
public void ToAnsi_Simple_Text ()
|
||
{
|
||
IDriver driver = CreateFakeDriver (10, 3);
|
||
driver.AddStr ("Hello");
|
||
driver.Move (0, 1);
|
||
driver.AddStr ("World");
|
||
|
||
string ansi = driver.ToAnsi ();
|
||
|
||
// Should contain the text
|
||
Assert.Contains ("Hello", ansi);
|
||
Assert.Contains ("World", ansi);
|
||
|
||
// Should have proper structure with newlines
|
||
string[] lines = ansi.Split (['\r', '\n'], StringSplitOptions.RemoveEmptyEntries);
|
||
Assert.Equal (3, lines.Length);
|
||
}
|
||
|
||
[Theory]
|
||
[InlineData (true, "\u001b[31m", "\u001b[34m")]
|
||
[InlineData (false, "\u001b[38;2;255;0;0m", "\u001b[38;2;0;0;255")]
|
||
public void ToAnsi_With_Colors (bool force16Colors, string expectedRed, string expectedBue)
|
||
{
|
||
IDriver driver = CreateFakeDriver (10, 2);
|
||
driver.Force16Colors = force16Colors;
|
||
|
||
// Set red foreground
|
||
driver.CurrentAttribute = new Attribute (Color.Red, Color.Black);
|
||
driver.AddStr ("Red");
|
||
driver.Move (0, 1);
|
||
|
||
// Set blue foreground
|
||
driver.CurrentAttribute = new Attribute (Color.Blue, Color.Black);
|
||
driver.AddStr ("Blue");
|
||
|
||
string ansi = driver.ToAnsi ();
|
||
|
||
Assert.True (driver.Force16Colors == force16Colors);
|
||
// Should contain ANSI color codes
|
||
Assert.Contains (expectedRed, ansi); // Red foreground
|
||
Assert.Contains (expectedBue, ansi); // Blue foreground
|
||
Assert.Contains ("Red", ansi);
|
||
Assert.Contains ("Blue", ansi);
|
||
}
|
||
|
||
[Theory (Skip = "Uses Application.")]
|
||
[InlineData (false, "\u001b[48;2;")]
|
||
[InlineData (true, "\u001b[41m")]
|
||
public void ToAnsi_With_Background_Colors (bool force16Colors, string expected)
|
||
{
|
||
IDriver driver = CreateFakeDriver (10, 2);
|
||
Application.Force16Colors = force16Colors;
|
||
|
||
// Set background color
|
||
driver.CurrentAttribute = new (Color.White, Color.Red);
|
||
driver.AddStr ("WhiteOnRed");
|
||
|
||
string ansi = driver.ToAnsi ();
|
||
|
||
/*
|
||
The ANSI escape sequence for red background (8-color) is ESC[41m <20> where ESC is \x1b (or \u001b).
|
||
Examples:
|
||
<20> C# string: "\u001b[41m" or "\x1b[41m"
|
||
<20> Reset (clear attributes): "\u001b[0m"
|
||
Notes:
|
||
<20> Bright/red background (16-color bright variant) uses ESC[101m ("\u001b[101m").
|
||
<20> For 24-bit RGB background use ESC[48;2;<r>;<g>;<b>m, e.g. "\u001b[48;2;255;0;0m" for pure red.
|
||
*/
|
||
|
||
Assert.True (driver.Force16Colors == force16Colors);
|
||
|
||
// Should contain ANSI background color code
|
||
Assert.Contains (expected, ansi); // Red background
|
||
Assert.Contains ("WhiteOnRed", ansi);
|
||
}
|
||
|
||
[Fact]
|
||
public void ToAnsi_With_Text_Styles ()
|
||
{
|
||
IDriver driver = CreateFakeDriver (10, 3);
|
||
|
||
// Bold text
|
||
driver.CurrentAttribute = new Attribute (Color.White, Color.Black, TextStyle.Bold);
|
||
driver.AddStr ("Bold");
|
||
driver.Move (0, 1);
|
||
|
||
// Italic text
|
||
driver.CurrentAttribute = new Attribute (Color.White, Color.Black, TextStyle.Italic);
|
||
driver.AddStr ("Italic");
|
||
driver.Move (0, 2);
|
||
|
||
// Underline text
|
||
driver.CurrentAttribute = new Attribute (Color.White, Color.Black, TextStyle.Underline);
|
||
driver.AddStr ("Underline");
|
||
|
||
string ansi = driver.ToAnsi ();
|
||
|
||
// Should contain ANSI style codes
|
||
Assert.Contains ("\u001b[1m", ansi); // Bold
|
||
Assert.Contains ("\u001b[3m", ansi); // Italic
|
||
Assert.Contains ("\u001b[4m", ansi); // Underline
|
||
}
|
||
|
||
[Fact]
|
||
public void ToAnsi_With_Wide_Characters ()
|
||
{
|
||
IDriver driver = CreateFakeDriver (10, 2);
|
||
|
||
// Add a wide character (Chinese character)
|
||
driver.AddStr ("??");
|
||
driver.Move (0, 1);
|
||
driver.AddStr ("??");
|
||
|
||
string ansi = driver.ToAnsi ();
|
||
|
||
Assert.Contains ("??", ansi);
|
||
Assert.Contains ("??", ansi);
|
||
}
|
||
|
||
[Fact]
|
||
public void ToAnsi_With_Unicode_Characters ()
|
||
{
|
||
IDriver driver = CreateFakeDriver (10, 2);
|
||
|
||
// Add various Unicode characters
|
||
driver.AddStr ("???"); // Greek letters
|
||
driver.Move (0, 1);
|
||
driver.AddStr ("???"); // Emoji
|
||
|
||
string ansi = driver.ToAnsi ();
|
||
|
||
Assert.Contains ("???", ansi);
|
||
Assert.Contains ("???", ansi);
|
||
}
|
||
|
||
[Theory]
|
||
[InlineData (true, "\u001b[31m", "\u001b[34m")]
|
||
[InlineData (false, "\u001b[38;2;", "\u001b[48;2;")]
|
||
public void ToAnsi_Attribute_Changes_Within_Line (bool force16Colors, string expectedRed, string expectedBlue)
|
||
{
|
||
IDriver driver = CreateFakeDriver (20, 1);
|
||
driver.Force16Colors = force16Colors;
|
||
|
||
driver.AddStr ("Normal");
|
||
driver.CurrentAttribute = new Attribute (Color.Red, Color.Black);
|
||
driver.AddStr ("Red");
|
||
driver.CurrentAttribute = new Attribute (Color.Blue, Color.Black);
|
||
driver.AddStr ("Blue");
|
||
|
||
string ansi = driver.ToAnsi ();
|
||
|
||
Assert.True (driver.Force16Colors == force16Colors);
|
||
// Should contain color changes within the line
|
||
Assert.Contains ("Normal", ansi);
|
||
Assert.Contains (expectedRed, ansi); // Red
|
||
Assert.Contains (expectedBlue, ansi); // Blue
|
||
}
|
||
|
||
[Fact]
|
||
public void ToAnsi_Large_Buffer ()
|
||
{
|
||
// Test with a larger buffer to stress performance
|
||
IDriver driver = CreateFakeDriver (200, 50);
|
||
|
||
// Fill with some content
|
||
for (int row = 0; row < 50; row++)
|
||
{
|
||
driver.Move (0, row);
|
||
driver.CurrentAttribute = new Attribute ((ColorName16)(row % 16), Color.Black);
|
||
driver.AddStr ($"Row {row:D2} content");
|
||
}
|
||
|
||
string ansi = driver.ToAnsi ();
|
||
|
||
// Should contain all rows
|
||
Assert.Contains ("Row 00", ansi);
|
||
Assert.Contains ("Row 49", ansi);
|
||
|
||
// Should have proper newlines (50 content lines + 50 newlines)
|
||
Assert.Equal (50, ansi.Count (c => c == '\n'));
|
||
}
|
||
|
||
[Fact (Skip = "Use Application.")]
|
||
public void ToAnsi_RGB_Colors ()
|
||
{
|
||
IDriver driver = CreateFakeDriver (10, 1);
|
||
|
||
// Use RGB colors (when not forcing 16 colors)
|
||
Application.Force16Colors = false;
|
||
try
|
||
{
|
||
driver.CurrentAttribute = new Attribute (new Color (255, 0, 0), new Color (0, 255, 0));
|
||
driver.AddStr ("RGB");
|
||
|
||
string ansi = driver.ToAnsi ();
|
||
|
||
// Should contain RGB color codes
|
||
Assert.Contains ("\u001b[38;2;255;0;0m", ansi); // Red foreground RGB
|
||
Assert.Contains ("\u001b[48;2;0;255;0m", ansi); // Green background RGB
|
||
}
|
||
finally
|
||
{
|
||
Application.Force16Colors = true; // Reset
|
||
}
|
||
}
|
||
|
||
[Fact (Skip = "Use Application.")]
|
||
public void ToAnsi_Force16Colors ()
|
||
{
|
||
IDriver driver = CreateFakeDriver (10, 1);
|
||
|
||
// Force 16 colors
|
||
Application.Force16Colors = true;
|
||
driver.CurrentAttribute = new Attribute (Color.Red, Color.Blue);
|
||
driver.AddStr ("16Color");
|
||
|
||
string ansi = driver.ToAnsi ();
|
||
|
||
// Should contain 16-color codes, not RGB
|
||
Assert.Contains ("\u001b[31m", ansi); // Red foreground (16-color)
|
||
Assert.Contains ("\u001b[44m", ansi); // Blue background (16-color)
|
||
Assert.DoesNotContain ("\u001b[38;2;", ansi); // No RGB codes
|
||
}
|
||
|
||
[Theory]
|
||
[InlineData (true, "\u001b[31m", "\u001b[32m", "\u001b[34m", "\u001b[33m", "\u001b[35m", "\u001b[36m")]
|
||
[InlineData (false, "\u001b[38;2;255;0;0m", "\u001b[38;2;0;128;0m", "\u001b[38;2;0;0;255", "\u001b[38;2;255;255;0m", "\u001b[38;2;255;0;255m", "\u001b[38;2;0;255;255m")]
|
||
public void ToAnsi_Multiple_Attributes_Per_Line (
|
||
bool force16Colors,
|
||
string expectedRed,
|
||
string expectedGreen,
|
||
string expectedBlue,
|
||
string expectedYellow,
|
||
string expectedMagenta,
|
||
string expectedCyan
|
||
)
|
||
{
|
||
IDriver driver = CreateFakeDriver (50, 1);
|
||
driver.Force16Colors = force16Colors;
|
||
|
||
// Create a line with many attribute changes
|
||
string [] colors = { "Red", "Green", "Blue", "Yellow", "Magenta", "Cyan" };
|
||
|
||
foreach (string colorName in colors)
|
||
{
|
||
Color fg = colorName switch
|
||
{
|
||
"Red" => Color.Red,
|
||
"Green" => Color.Green,
|
||
"Blue" => Color.Blue,
|
||
"Yellow" => Color.Yellow,
|
||
"Magenta" => Color.Magenta,
|
||
"Cyan" => Color.Cyan,
|
||
_ => Color.White
|
||
};
|
||
|
||
driver.CurrentAttribute = new (fg, Color.Black);
|
||
driver.AddStr (colorName);
|
||
}
|
||
|
||
string ansi = driver.ToAnsi ();
|
||
|
||
Assert.True (driver.Force16Colors == force16Colors);
|
||
// Should contain multiple color codes
|
||
Assert.Contains (expectedRed, ansi); // Red
|
||
Assert.Contains (expectedGreen, ansi); // Green
|
||
Assert.Contains (expectedBlue, ansi); // Blue
|
||
Assert.Contains (expectedYellow, ansi); // Yellow
|
||
Assert.Contains (expectedMagenta, ansi); // Magenta
|
||
Assert.Contains (expectedCyan, ansi); // Cyan
|
||
}
|
||
|
||
[Fact]
|
||
public void ToAnsi_Special_Characters ()
|
||
{
|
||
IDriver driver = CreateFakeDriver (20, 1);
|
||
|
||
// Test backslash character
|
||
driver.AddStr ("Backslash:");
|
||
driver.AddRune ('\\');
|
||
|
||
string ansi = driver.ToAnsi ();
|
||
|
||
Assert.Contains ("Backslash:", ansi);
|
||
Assert.Contains ("\\", ansi);
|
||
}
|
||
|
||
[Fact]
|
||
public void ToAnsi_Buffer_Boundary_Conditions ()
|
||
{
|
||
// Test with minimum buffer size
|
||
IDriver driver = CreateFakeDriver (1, 1);
|
||
driver.AddStr ("X");
|
||
|
||
string ansi = driver.ToAnsi ();
|
||
|
||
Assert.Contains ("X", ansi);
|
||
Assert.Contains ("\n", ansi);
|
||
|
||
// Test with very wide buffer
|
||
driver = CreateFakeDriver (1000, 1);
|
||
driver.AddStr ("Wide");
|
||
|
||
ansi = driver.ToAnsi ();
|
||
|
||
Assert.Contains ("Wide", ansi);
|
||
Assert.True (ansi.Length > 1000); // Should have many spaces
|
||
}
|
||
|
||
[Fact]
|
||
public void ToAnsi_Empty_Lines ()
|
||
{
|
||
IDriver driver = CreateFakeDriver (10, 3);
|
||
|
||
// Only write to first and third lines
|
||
driver.AddStr ("First");
|
||
driver.Move (0, 2);
|
||
driver.AddStr ("Third");
|
||
|
||
string ansi = driver.ToAnsi ();
|
||
|
||
string[] lines = ansi.Split ('\n');
|
||
Assert.Equal (4, lines.Length); // 3 content lines + 1 empty line at end
|
||
Assert.Contains ("First", lines[0]);
|
||
Assert.Contains ("Third", lines[2]);
|
||
}
|
||
|
||
[Fact]
|
||
public void ToAnsi_Performance_Stress_Test ()
|
||
{
|
||
// Create a large buffer and fill it completely
|
||
const int width = 200;
|
||
const int height = 100;
|
||
IDriver driver = CreateFakeDriver (width, height);
|
||
|
||
// Fill every cell with different content and colors
|
||
for (int row = 0; row < height; row++)
|
||
{
|
||
for (int col = 0; col < width; col++)
|
||
{
|
||
driver.Move (col, row);
|
||
driver.CurrentAttribute = new Attribute ((ColorName16)((row + col) % 16), Color.Black);
|
||
driver.AddRune ((char)('A' + ((row + col) % 26)));
|
||
}
|
||
}
|
||
|
||
// This should complete in reasonable time and not throw
|
||
string ansi = driver.ToAnsi ();
|
||
|
||
Assert.NotNull (ansi);
|
||
Assert.True (ansi.Length > width * height); // Should contain all characters plus ANSI codes
|
||
}
|
||
} |