Files
Terminal.Gui/Tests/UnitTests/Application/ApplicationTests.cs
Copilot c5906c2dc1 #4329—Major Terminal.Gui v2 Architecture Modernization: Application Decoupling, Terminology Improvements, and Nullable Migration (#4338)
* Initial plan

* Add comprehensive terminology proposal for Application.Top/Toplevel renaming

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add terminology proposal summary document

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add before/after comparison document for terminology proposal

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add index document for terminology proposal

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add Mermaid diagrams visualizing the terminology proposal

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Move terminology docs to docfx/docs per CONTRIBUTING.md guidelines

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update terminology proposal to reflect recent modernization (post-MainLoop removal)

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update terminology proposal - validate against recent driver refactoring changes

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update proposal after massive v2_develop modernization - TopLevels now public, RunState→SessionToken

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update proposal: RunStack → SessionStack to align with SessionToken terminology

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Phase 1: Core API rename - Application.Top→Current, TopLevels→SessionStack

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Phase 2: Fix test compilation errors for renamed properties

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Phase 3: Update documentation files with new terminology

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Refactor generic type names and remove unused field

Renamed generic type parameters in `Dim` and `Pos` classes for clarity:
- `T` was renamed to `TDim` in `Dim.Has` method.
- `T` was renamed to `TPos` in `Pos.Has` method.
Updated type casting and pattern matching logic to reflect these changes.

Removed the unused `_stopAfterFirstIteration` field from the `ApplicationImpl` class to clean up the codebase.

* Increase minimum code coverage target to 75%

Updated the `codecov.yml` configuration file to raise the
`project.default.target` value from 70% to 75%, enforcing
stricter code coverage requirements for the overall project.

* Add comprehensive unit tests for ApplicationImpl Begin/End logic

Added ApplicationImplBeginEndTests with 16 tests covering:
- Begin/End argument validation
- SessionStack push/pop operations
- Current property management
- Balanced Begin/End enforcement
- Multiple nested Begin/End scenarios
- ResetState cleanup behavior
- Toplevel activation/deactivation
- SessionToken management

Tests validate the fragile state management logic in ApplicationImpl.Lifecycle.cs
and ApplicationImpl.Run.cs to catch regressions in Current/SessionStack handling.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Refactor ApplicationImplBeginEndTests to work with ApplicationImpl instances directly

Tests now:
- Create ApplicationImpl instances directly instead of using global Application
- Use try-finally blocks to ensure Shutdown() is always called
- Work with app.Init() and app.Shutdown() properly
- 13 of 16 tests passing (3 tests need adjustment for ResetState behavior)

Tests validate fragile Begin/End state management logic without polluting global Application state.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Fix ApplicationImplBeginEndTests: Remove explicit ResetState calls, rely on Shutdown

Per maintainer feedback:
- Tests should not call ResetState explicitly if they call Shutdown (Shutdown calls ResetState)
- Removed all explicit app.ResetState() calls from tests
- Tests now only call Shutdown in finally blocks for cleanup
- Ensured toplevels are disposed BEFORE Shutdown to satisfy DEBUG_IDISPOSABLE assertions
- Fixed test cleanup order to prevent ResetState assertion failures
- All 16 tests now pass successfully

ResetState is idempotent - the issue was tests calling it unnecessarily and with incorrect disposal ordering.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Phase 1: Enable nullable by default, add directives to all files

- Added <Nullable>enable</Nullable> to Terminal.Gui.csproj
- Removed #nullable enable from 37 files (now redundant with project setting)
- Added #nullable disable to 170 files that don't have nullable enabled yet
- Build successful with 279 nullable warnings (expected)

Breakdown of files with #nullable disable:
- 27 in Views/ directory (will remain disabled per plan)
- 143 outside Views/ (need to be fixed in subsequent commits)

Next: Systematically fix nullable issues in non-View files.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Phase 2: Remove nullable disable from all non-View files - COMPLETE!

- Removed #nullable disable from 142 non-View files
- All non-View code is now nullable-enabled
- Build successful with 0 errors, only 1 unrelated warning
- Created NULLABLE_VIEWS_REMAINING.md documenting the 121 View files still with nullable disable

Nullable cleanup summary:
 App/: 25 files - nullable enabled
 Configuration/: 24 files - nullable enabled
 ViewBase/: 30 files - nullable enabled
 Drivers/: 25 files - nullable enabled
 Drawing/: 18 files - nullable enabled
 FileServices/: 7 files - nullable enabled
 Input/: 6 files - nullable enabled
 Text/: 5 files - nullable enabled
 Resources/: 3 files - nullable enabled
⏸️  Views/: 121 files - remain disabled (as requested)

Total: 143 files nullable-enabled, 121 View files remain disabled.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* WIP: fixing nullability issues.

* Fixed final nullability issues.

* Moved Arrangment tests

* Refactor and improve modularity across multiple classes

Refactored `FillRectangles` in `RegionScenario` and `Region` to accept an `IDriver` parameter, reducing reliance on global state. Updated `ApplicationImpl` to replace static method calls with instance methods for better encapsulation. Renamed `Toplevel` to `Current` in `IPopover` and related classes for clarity.

Simplified `LineCanvas` methods by removing unnecessary `IDriver` parameters. Added `Id` and `App` properties to `View` for better state management and unique identification. Streamlined the `Driver` property in `View` with a concise getter.

Improved formatting and consistency across files, including `Region` and `IntersectionRuneResolver`. Enhanced thread safety in `Region` and cleaned up redundant code. Updated tests to align with interface changes and ensure compatibility.

* Refactor to make IDriver dependency explicit

Updated `AnsiEscapeSequenceRequest.Send` to accept an `IDriver?` parameter, replacing reliance on `Application.Driver`. Refactored `AnsiRequestScheduler` methods (`SendOrSchedule`, `RunSchedule`, and private `Send`) to propagate the `IDriver?` parameter, ensuring explicit driver dependency.

Modified `DriverImpl.QueueAnsiRequest` to pass `this` to `SendOrSchedule`. Updated `AnsiRequestSchedulerTests` to reflect new method signatures, passing `null` for the driver parameter where applicable.

Added `<param>` documentation for new parameters to improve clarity. These changes enhance flexibility, maintainability, and testability by reducing reliance on global state and allowing driver substitution in tests.

* WIP: Started migrating to View.App

Refactored `ApplicationImpl` to ensure proper handling of the `App`
property for `Toplevel` instances, improving modularity. Replaced
direct references to `Application` with `App` in `Border`, `ShadowView`,
and other classes to enhance flexibility and maintainability.

Introduced `GetApp` in `View` to allow overrides for retrieving the
`App` instance. Updated `Adornment` to use this method. Moved mouse
event subscriptions in `Border` to `BeginInit` for proper lifecycle
management.

Updated unit tests in `ArrangementTests` to use `App.Mouse` instead of
`Application.Mouse`, ensuring alignment with the refactored design.
Added `BeginInit` and `EndInit` calls for proper initialization during
tests. Removed redundant code and improved test assertions.

* WIP: Next set of View.App changes

Updated `SetClipToScreen`, `SetClip`, and `GetClip` methods to accept an `IDriver` parameter, replacing reliance on the global `Application.Driver`. This improves modularity, testability, and reduces implicit global state usage.

- Updated `Driver` property in `View` to use `App?.Driver` as fallback.
- Refactored `DimAuto` to use `App?.Screen.Size` with a default for unit tests.
- Updated all test cases to align with the new method signatures.
- Performed general cleanup for consistency and readability.

* Adds View clip tests.

* Merged

* Merged

* wip

* Fixed test bug.

* Refactored Thickness.Draw to require driver.

* Made TextFormatter.Draw require driver.

* Code cleanup.

* Un did stoopid idea.

* Decouped Application.Navigation

* MASSIVE - Almost completely decoupled Application from View etc...

* Obsolete

* Missed some

* More cleanup and decoupling.

Refactor `ToString` and remove legacy code

Refactored `ToString` implementations across `Application`, `DriverImpl`, and `IDriver` to improve consistency and maintainability. Removed the legacy `ToString(IDriver? driver)` method and its associated references. Simplified `ToString` in `DriverImpl` to generate a string representation of the `Contents` buffer.

Replaced redundant XML documentation with `<inheritdoc/>` tags to reduce duplication. Cleaned up unused `global using` directives and removed deprecated methods and properties, including `Screen`, `SetCursorVisibility`, and `IsRuneSupported`.

Updated test cases in `GuiTestContext` and `DriverAssert` to use the new `ToString` implementation. Improved error messages for better debugging output. Streamlined LINQ queries and removed redundant checks for better readability and performance.

Enhanced maintainability by decluttering the codebase, aligning namespaces, and consolidating related changes.

* Changes before error encountered

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update docfx/docs to document View.App architecture and instance-based patterns

Updated 16 documentation files to reflect the major architectural changes:

NEW FILES:
- application.md: Comprehensive deep dive on decoupled Application architecture

UPDATED FILES:
- View.md: Documents View.App property, GetApp(), and instance-based patterns
- navigation.md: Shows View.App usage instead of static Application
- drivers.md: Documents View.Driver and GetDriver() patterns
- keyboard.md: Event handling through View.App
- mouse.md: Mouse event handling via View.App
- arrangement.md: Updated code examples to use View.App
- drawing.md: Rendering examples with instance-based API
- cursor.md: Cursor management through View.App
- multitasking.md: SessionStack and session management via View.App
- Popovers.md: Popover patterns with View.App
- cancellable-work-pattern.md: Updated examples
- command.md: Command pattern with View.App context
- config.md: Configuration access through View.App
- migratingfromv1.md: Migration guide for static→instance patterns
- newinv2.md: Documents new instance-based architecture

All code examples now demonstrate the instance-based API (view.App.Current)
instead of obsolete static Application references. Documentation accurately
reflects the massive architectural decoupling achieved in this PR.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add `ToAnsi` support for ANSI escape sequence generation

Introduced `ToAnsi` in `IDriver` and `IOutput` interfaces to generate
ANSI escape sequences representing the terminal's current state. This
enables serialization of terminal content for debugging, testing, and
exporting.

Implemented `ToAnsi` in `DriverImpl` and `FakeOutput`, supporting both
16-color and RGB modes. Refactored `OutputBase` with helper methods
`BuildAnsiForRegion` and `AppendCellAnsi` for efficient ANSI generation.

Enhanced `GuiTestContext` with `AnsiScreenShot` for capturing terminal
state during tests. Added `ToAnsiTests` for comprehensive validation,
including edge cases, performance, and wide/Unicode character handling.

Updated documentation to reflect `ToAnsi` functionality and modernized
driver architecture. Improved testability, modularity, and performance
while removing legacy driver references.

* Improve null safety and cleanup in GuiTestContext

Enhanced null safety across `GuiTestContext` and `GuiTestContextTests`:
- Replaced `a` with `app` for better readability in tests.
- Added null checks (`!`, `?.`) to prevent potential null reference exceptions.
- Removed redundant `WaitIteration` and duplicate `ScreenShot` calls.

Improved error handling and robustness:
- Updated shutdown logic to use null-safe calls for `RequestStop` and `Shutdown`.
- Applied null-safe invocation for `_applicationImpl.Invoke`.

General cleanup:
- Removed redundant method calls and improved naming consistency.
- Ensured better maintainability and adherence to best practices.

* Refactor docs: remove deprecated files, update architecture

Removed outdated documentation files related to the terminology
proposal (`terminology-before-after.md`, `terminology-diagrams.md`,
`terminology-index.md`, `terminology-proposal-summary.md`,
`terminology-proposal.md`) from the `Docs` project. These files
were either deprecated or consolidated into other documentation.

Updated `application.md`:
- Added a "View Hierarchy and Run Stack" section with a Mermaid
  diagram to illustrate the relationship between the view hierarchy
  and the application session stack.
- Added a "Usage Example Flow" section with a sequence diagram
  to demonstrate the flow of running and stopping views.

These changes improve clarity, streamline documentation, and
align with the finalized terminology updates for the
`Application.Current` and `Application.SessionStack` APIs.

* Refactor Init/Run methods to simplify driver handling

The `Init` method in `Application` and `IApplication` now accepts only an optional `driverName` parameter, removing the `IDriver` parameter. This simplifies initialization by relying on driver names to determine the appropriate driver.

The `Run` methods have been updated to use `driverName` instead of `driver`, ensuring consistency with the updated `Init` method.

Replaced redundant inline documentation with `<inheritdoc>` tags to improve maintainability and consistency. Legacy `Application` methods (`Init`, `Shutdown`, `Run`) have been marked as `[Obsolete]` to signal their eventual deprecation.

Test cases have been refactored to align with the updated `Init` method signature, removing unused `driver` parameters. Documentation files have also been updated to reflect these API changes.

These changes improve clarity, reduce complexity, and ensure a more consistent API design.

* Refactor: Introduce Application.Create() factory method

Introduced a new static method `Application.Create()` to create
instances of `IApplication`, replacing direct instantiation of
`ApplicationImpl`. This enforces a cleaner, recommended pattern
for creating application instances.

Made the `ApplicationImpl` constructor `internal` to ensure
`Application.Create()` is used for instance creation.

Refactored test cases across multiple files to use
`Application.Create()` instead of directly instantiating
`ApplicationImpl`. Simplified object initialization in tests
using target-typed `new()` expressions.

Updated documentation and examples in `application.md` to
reflect the new instance-based architecture and highlight its
benefits, such as supporting multiple applications with
different drivers.

Improved code readability, formatting, and consistency in
tests and documentation. Aligned `ApplicationImplBeginEndTests`
to use `IApplication` directly, adhering to the new architecture.

* Added `Application.StopAll` and fixed coupling issues.

Refactored `ApplicationImpl` to use an instance-based approach, replacing the static singleton pattern and Lazy<T>. Introduced `SetInstance` for configuring the singleton instance and updated tests to use `ApplicationImpl.Instance` or explicitly set the `Driver` property.

Enabled nullable reference types across the codebase, updating fields and variables to nullable types where applicable. Added null checks to improve safety and prevent runtime errors.

Refactored timeout management by introducing tokens for `Application.AddTimeout` and adding a `StopAll` method to `TimedEvents` for cleanup. Updated tests to use `System.Threading.Timer` for independent watchdog timers.

Removed legacy code, improved logging for error cases, and updated view initialization to explicitly set `App` or `Driver` in tests. Enhanced test coverage and restructured `ScrollSliderTests` for better readability.

Performed general code cleanup, including formatting changes, removal of unused imports, and improved naming consistency.

* Refactor: Transition to IApplication interface

Refactored the codebase to replace the static `Application` class with the `IApplication` interface, improving modularity, testability, and maintainability. Updated methods like `Application.Run`, `RequestStop`, and `Init` to use the new interface.

Marked static members `SessionStack` and `Current` as `[Obsolete]` and delegated their functionality to `ApplicationImpl.Instance`. Updated XML documentation to reflect these changes.

Simplified code by removing redundant comments, unused code, and converting methods like `GetMarginThickness` to single-line expressions. Improved null safety with null-conditional operators in `ToplevelTransitionManager`.

Enhanced consistency with formatting updates, logging improvements, and better error handling. Updated `Shortcut` and other classes to align with the new interface-based design.

Made breaking changes, including the removal of the `helpText` parameter in the `Shortcut` constructor. Updated `Wizard`, `Dialog`, and `GraphView` to use `IApplication` methods. Adjusted `ViewportSettings` and `HighlightStates` for better behavior.

* Enhance null-safety and simplify codebase

Improved null-safety by adopting nullable reference types and adding null-forgiving operators (`!`) where appropriate. Replaced direct method calls with null-safe calls using the null-conditional operator (`?.`) to prevent potential `NullReferenceException`.

Removed default parameter values in test methods to enforce explicit parameter passing. Refactored test classes to remove unnecessary dependencies on `ITestOutputHelper`.

Fixed a bug in `WindowsOutput.cs` by setting `_force16Colors` to `false` to avoid reliance on a problematic driver property. Updated `SessionTokenTests` to use null-forgiving operators for clarity in intentional null usage.

Simplified graph and UI updates by ensuring safe access to properties and methods. Cleaned up namespaces and removed unused `using` directives for better readability.

Updated `Dispose` methods to use null-safe calls and replaced nullable driver initialization with non-nullable initialization in `ScrollSliderTests` to ensure proper instantiation.

* Refactor test code to use nullable `App` property

Replaced direct `Application` references with `App` property across test classes to improve encapsulation and robustness. Updated `GuiTestContext` to use a nullable `App` property, replacing `_applicationImpl` for consistency.

Refactored key event handling to use `App.Driver` and revised `InitializeApplication` and `CleanupApplication` methods to ensure safe usage of the nullable `App` property. Updated `Then` callbacks to explicitly pass `App` for clarity.

Replaced `Application.QuitKey` with `context.App?.Keyboard.RaiseKeyDownEvent` to ensure context-specific event handling. Refactored `EnableForDesign` logic in `MenuBarv2Tests` and `PopoverMenuTests` to operate on the correct application instance.

Improved null safety in test assertions and revised `RequestStop` and `Shutdown` calls to use `App?.RequestStop` and `App?.Shutdown`. Updated navigation logic to use `Terminal.Gui.App.Application` for namespace consistency.

Enhanced exception handling in the `Invoke` method and performed general cleanup to align with modern C# practices, improving maintainability and readability.

* Commented out exception handling in Application.Shutdown

The `try-catch` block around `Application.Shutdown` was commented out, disabling the logging of exceptions thrown after a test exited. This change removes the `catch` block that used `Debug.WriteLine` for logging.

The `finally` block remains intact, ensuring cleanup operations such as clearing `View.Instances` and resetting the application state are still executed.

* Fixes #4394 - Changing Theme at Runtime does not Update Some Properties

* Tweaks to config format.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Tig <tig@users.noreply.github.com>
Co-authored-by: tig <585482+tig@users.noreply.github.com>
2025-11-19 16:23:35 -05:00

937 lines
28 KiB
C#

using System.Diagnostics;
using Xunit.Abstractions;
using static Terminal.Gui.Configuration.ConfigurationManager;
// Alias Console to MockConsole so we don't accidentally use Console
namespace UnitTests.ApplicationTests;
public class ApplicationTests
{
public ApplicationTests (ITestOutputHelper output)
{
_output = output;
#if DEBUG_IDISPOSABLE
View.EnableDebugIDisposableAsserts = true;
View.Instances.Clear ();
SessionToken.Instances.Clear ();
#endif
}
private readonly ITestOutputHelper _output;
[Fact]
public void AddTimeout_Fires ()
{
IApplication app = Application.Create ();
app.Init ("fake");
uint timeoutTime = 100;
var timeoutFired = false;
// Setup a timeout that will fire
app.AddTimeout (
TimeSpan.FromMilliseconds (timeoutTime),
() =>
{
timeoutFired = true;
// Return false so the timer does not repeat
return false;
}
);
// The timeout has not fired yet
Assert.False (timeoutFired);
// Block the thread to prove the timeout does not fire on a background thread
Thread.Sleep ((int)timeoutTime * 2);
Assert.False (timeoutFired);
app.StopAfterFirstIteration = true;
app.Run<Toplevel> ().Dispose ();
// The timeout should have fired
Assert.True (timeoutFired);
app.Shutdown ();
}
[Fact]
[SetupFakeApplication]
public void Begin_Null_Toplevel_Throws ()
{
// Test null Toplevel
Assert.Throws<ArgumentNullException> (() => Application.Begin (null));
}
[Fact]
[SetupFakeApplication]
public void Begin_Sets_Application_Top_To_Console_Size ()
{
Assert.Null (Application.Current);
Application.Driver!.SetScreenSize (80, 25);
Toplevel top = new ();
Application.Begin (top);
Assert.Equal (new (0, 0, 80, 25), Application.Current!.Frame);
Application.Driver!.SetScreenSize (5, 5);
Assert.Equal (new (0, 0, 5, 5), Application.Current!.Frame);
top.Dispose ();
}
[Fact]
[SetupFakeApplication]
public void End_And_Shutdown_Should_Not_Dispose_ApplicationTop ()
{
Assert.Null (Application.Current);
SessionToken rs = Application.Begin (new ());
Application.Current!.Title = "End_And_Shutdown_Should_Not_Dispose_ApplicationTop";
Assert.Equal (rs.Toplevel, Application.Current);
Application.End (rs);
#if DEBUG_IDISPOSABLE
Assert.True (rs.WasDisposed);
Assert.False (Application.Current!.WasDisposed); // Is true because the rs.Toplevel is the same as Application.Current
#endif
Assert.Null (rs.Toplevel);
Toplevel top = Application.Current;
#if DEBUG_IDISPOSABLE
Exception exception = Record.Exception (Application.Shutdown);
Assert.NotNull (exception);
Assert.False (top.WasDisposed);
top.Dispose ();
Assert.True (top.WasDisposed);
#endif
}
[Fact]
[SetupFakeApplication]
public void Init_Begin_End_Cleans_Up ()
{
// Start stopwatch
var stopwatch = new Stopwatch ();
stopwatch.Start ();
SessionToken sessionToken = null;
EventHandler<SessionTokenEventArgs> newSessionTokenFn = (s, e) =>
{
Assert.NotNull (e.State);
sessionToken = e.State;
};
Application.SessionBegun += newSessionTokenFn;
var topLevel = new Toplevel ();
SessionToken rs = Application.Begin (topLevel);
Assert.NotNull (rs);
Assert.NotNull (sessionToken);
Assert.Equal (rs, sessionToken);
Assert.Equal (topLevel, Application.Current);
Application.SessionBegun -= newSessionTokenFn;
Application.End (sessionToken);
Assert.NotNull (Application.Current);
Assert.NotNull (Application.Driver);
topLevel.Dispose ();
// Stop stopwatch
stopwatch.Stop ();
_output.WriteLine ($"Load took {stopwatch.ElapsedMilliseconds} ms");
}
[Fact]
public void Init_KeyBindings_Are_Not_Reset ()
{
Debug.Assert (!IsEnabled);
try
{
// arrange
ThrowOnJsonErrors = true;
Application.QuitKey = Key.Q;
Assert.Equal (Key.Q, Application.QuitKey);
Application.Init ("fake");
Assert.Equal (Key.Q, Application.QuitKey);
}
finally
{
Application.ResetState ();
}
}
[Fact]
public void Init_NoParam_ForceDriver_Works ()
{
Application.ForceDriver = "Fake";
Application.Init ();
Assert.Equal ("fake", Application.Driver!.GetName ());
Application.ResetState ();
}
[Fact]
public void Init_Null_Driver_Should_Pick_A_Driver ()
{
Application.Init ();
Assert.NotNull (Application.Driver);
Application.Shutdown ();
}
[Fact]
public void Init_ResetState_Resets_Properties ()
{
ThrowOnJsonErrors = true;
// For all the fields/properties of Application, check that they are reset to their default values
// Set some values
Application.Init (driverName: "fake");
// Application.IsInitialized = true;
// Reset
Application.ResetState ();
CheckReset ();
// Set the values that can be set
Application.Initialized = true;
Application.MainThreadId = 1;
//Application._topLevels = new List<Toplevel> ();
Application.CachedViewsUnderMouse.Clear ();
//Application.SupportedCultures = new List<CultureInfo> ();
Application.Force16Colors = true;
//Application.ForceDriver = "driver";
Application.StopAfterFirstIteration = true;
Application.PrevTabGroupKey = Key.A;
Application.NextTabGroupKey = Key.B;
Application.QuitKey = Key.C;
Application.KeyBindings.Add (Key.D, Command.Cancel);
Application.CachedViewsUnderMouse.Clear ();
//Application.WantContinuousButtonPressedView = new View ();
// Mouse
Application.LastMousePosition = new Point (1, 1);
Application.ResetState ();
CheckReset ();
ThrowOnJsonErrors = false;
return;
void CheckReset ()
{
// Check that all fields and properties are set to their default values
// Public Properties
Assert.Null (Application.Current);
Assert.Null (Application.Mouse.MouseGrabView);
// Don't check Application.ForceDriver
// Assert.Empty (Application.ForceDriver);
// Don't check Application.Force16Colors
//Assert.False (Application.Force16Colors);
Assert.Null (Application.Driver);
Assert.False (Application.StopAfterFirstIteration);
// Commented out because if CM changed the defaults, those changes should
// persist across Inits.
//Assert.Equal (Key.Tab.WithShift, Application.PrevTabKey);
//Assert.Equal (Key.Tab, Application.NextTabKey);
//Assert.Equal (Key.F6.WithShift, Application.PrevTabGroupKey);
//Assert.Equal (Key.F6, Application.NextTabGroupKey);
//Assert.Equal (Key.Esc, Application.QuitKey);
// Internal properties
Assert.False (Application.Initialized);
Assert.Equal (Application.GetSupportedCultures (), Application.SupportedCultures);
Assert.Equal (Application.GetAvailableCulturesFromEmbeddedResources (), Application.SupportedCultures);
Assert.Null (Application.MainThreadId);
Assert.Empty (Application.SessionStack);
Assert.Empty (Application.CachedViewsUnderMouse);
// Mouse
// Do not reset _lastMousePosition
//Assert.Null (Application._lastMousePosition);
// Navigation
// Assert.Null (Application.Navigation);
// Popover
//Assert.Null (Application.Popover);
// Events - Can't check
//Assert.Null (GetEventSubscribers (typeof (Application), "InitializedChanged"));
//Assert.Null (GetEventSubscribers (typeof (Application), "SessionBegun"));
//Assert.Null (GetEventSubscribers (typeof (Application), "Iteration"));
//Assert.Null (GetEventSubscribers (typeof (Application), "ScreenChanged"));
//Assert.Null (GetEventSubscribers (typeof (Application.Mouse), "MouseEvent"));
//Assert.Null (GetEventSubscribers (typeof (Application.Keyboard), "KeyDown"));
//Assert.Null (GetEventSubscribers (typeof (Application.Keyboard), "KeyUp"));
}
}
[Fact]
public void Init_Shutdown_Cleans_Up ()
{
// Verify initial state is per spec
//Pre_Init_State ();
Application.Init ("fake");
// Verify post-Init state is correct
//Post_Init_State ();
Application.Shutdown ();
// Verify state is back to initial
//Pre_Init_State ();
#if DEBUG_IDISPOSABLE
// Validate there are no outstanding Responder-based instances
// after a scenario was selected to run. This proves the main UI Catalog
// 'app' closed cleanly.
Assert.Empty (View.Instances);
#endif
}
[Fact]
public void Init_Shutdown_Fire_InitializedChanged ()
{
var initialized = false;
var shutdown = false;
Application.InitializedChanged += OnApplicationOnInitializedChanged;
Application.Init (driverName: "fake");
Assert.True (initialized);
Assert.False (shutdown);
Application.Shutdown ();
Assert.True (initialized);
Assert.True (shutdown);
Application.InitializedChanged -= OnApplicationOnInitializedChanged;
return;
void OnApplicationOnInitializedChanged (object s, EventArgs<bool> a)
{
if (a.Value)
{
initialized = true;
}
else
{
shutdown = true;
}
}
}
[Fact]
[SetupFakeApplication]
public void Init_Unbalanced_Throws ()
{
Assert.Throws<InvalidOperationException> (() =>
Application.Init ("fake")
);
}
[Fact]
[SetupFakeApplication]
public void Init_Unbalanced_Throws2 ()
{
// Now try the other way
Assert.Throws<InvalidOperationException> (() => Application.Init ("fake"));
}
[Fact]
public void Init_WithoutTopLevelFactory_Begin_End_Cleans_Up ()
{
Application.StopAfterFirstIteration = true;
// NOTE: Run<T>, when called after Init has been called behaves differently than
// when called if Init has not been called.
Toplevel topLevel = new ();
Application.Init ("fake");
SessionToken sessionToken = null;
EventHandler<SessionTokenEventArgs> newSessionTokenFn = (s, e) =>
{
Assert.NotNull (e.State);
sessionToken = e.State;
};
Application.SessionBegun += newSessionTokenFn;
SessionToken rs = Application.Begin (topLevel);
Assert.NotNull (rs);
Assert.NotNull (sessionToken);
Assert.Equal (rs, sessionToken);
Assert.Equal (topLevel, Application.Current);
Application.SessionBegun -= newSessionTokenFn;
Application.End (sessionToken);
Assert.NotNull (Application.Current);
Assert.NotNull (Application.Driver);
topLevel.Dispose ();
Application.Shutdown ();
Assert.Null (Application.Current);
Assert.Null (Application.Driver);
}
[Fact]
[SetupFakeApplication]
public void Internal_Properties_Correct ()
{
Assert.True (Application.Initialized);
Assert.Null (Application.Current);
SessionToken rs = Application.Begin (new ());
Assert.Equal (Application.Current, rs.Toplevel);
Assert.Null (Application.Mouse.MouseGrabView); // public
Application.Current!.Dispose ();
}
// Invoke Tests
// TODO: Test with threading scenarios
[Fact]
[SetupFakeApplication]
public void Invoke_Adds_Idle ()
{
Toplevel top = new ();
SessionToken rs = Application.Begin (top);
var actionCalled = 0;
Application.Invoke ((_) => { actionCalled++; });
Application.TimedEvents!.RunTimers ();
Assert.Equal (1, actionCalled);
top.Dispose ();
}
[Fact]
public void Run_Iteration_Fires ()
{
var iteration = 0;
Application.Init ("fake");
Application.Iteration += Application_Iteration;
Application.Run<Toplevel> ().Dispose ();
Application.Iteration -= Application_Iteration;
Assert.Equal (1, iteration);
Application.Shutdown ();
return;
void Application_Iteration (object sender, IterationEventArgs e)
{
if (iteration > 0)
{
Assert.Fail ();
}
iteration++;
Application.RequestStop ();
}
}
[Fact]
[SetupFakeApplication]
public void Screen_Size_Changes ()
{
IDriver driver = Application.Driver;
Application.Driver!.SetScreenSize (80, 25);
Assert.Equal (new (0, 0, 80, 25), driver!.Screen);
Assert.Equal (new (0, 0, 80, 25), Application.Screen);
// TODO: Should not be possible to manually change these at whim!
driver.Cols = 100;
driver.Rows = 30;
// IDriver.Screen isn't assignable
//driver.Screen = new (0, 0, driver.Cols, Rows);
Application.Driver!.SetScreenSize (100, 30);
Assert.Equal (new (0, 0, 100, 30), driver.Screen);
// Assert does not make sense
// Assert.NotEqual (new (0, 0, 100, 30), Application.Screen);
// Assert.Equal (new (0, 0, 80, 25), Application.Screen);
Application.Screen = new (0, 0, driver.Cols, driver.Rows);
Assert.Equal (new (0, 0, 100, 30), driver.Screen);
}
[Fact]
public void Shutdown_Alone_Does_Nothing () { Application.Shutdown (); }
//[Fact]
//public void InitState_Throws_If_Driver_Is_Null ()
//{
// Assert.Throws<ArgumentNullException> (static () => Application.SubscribeDriverEvents ());
//}
#region RunTests
[Fact]
[SetupFakeApplication]
public void Run_T_After_InitWithDriver_with_TopLevel_Does_Not_Throws ()
{
Application.StopAfterFirstIteration = true;
// Run<Toplevel> when already initialized or not with a Driver will not throw (because Window is derived from Toplevel)
// Using another type not derived from Toplevel will throws at compile time
Application.Run<Window> ();
Assert.True (Application.Current is Window);
Application.Current!.Dispose ();
}
[Fact]
public void Run_T_After_InitWithDriver_with_TopLevel_and_Driver_Does_Not_Throws ()
{
Application.StopAfterFirstIteration = true;
// Run<Toplevel> when already initialized or not with a Driver will not throw (because Window is derived from Toplevel)
// Using another type not derived from Toplevel will throws at compile time
Application.Run<Window> (null, "fake");
Assert.True (Application.Current is Window);
Application.Current!.Dispose ();
// Run<Toplevel> when already initialized or not with a Driver will not throw (because Dialog is derived from Toplevel)
Application.Run<Dialog> (null, "fake");
Assert.True (Application.Current is Dialog);
Application.Current!.Dispose ();
Application.Shutdown ();
}
[Fact]
[SetupFakeApplication]
public void Run_T_After_Init_Does_Not_Disposes_Application_Top ()
{
// Init doesn't create a Toplevel and assigned it to Application.Current
// but Begin does
var initTop = new Toplevel ();
Application.Iteration += OnApplicationOnIteration;
Application.Run<Toplevel> ();
Application.Iteration -= OnApplicationOnIteration;
#if DEBUG_IDISPOSABLE
Assert.False (initTop.WasDisposed);
initTop.Dispose ();
Assert.True (initTop.WasDisposed);
#endif
Application.Current!.Dispose ();
return;
void OnApplicationOnIteration (object s, IterationEventArgs a)
{
Assert.NotEqual (initTop, Application.Current);
#if DEBUG_IDISPOSABLE
Assert.False (initTop.WasDisposed);
#endif
Application.RequestStop ();
}
}
[Fact]
[SetupFakeApplication]
public void Run_T_After_InitWithDriver_with_TestTopLevel_DoesNotThrow ()
{
Application.StopAfterFirstIteration = true;
// Init has been called and we're passing no driver to Run<TestTopLevel>. This is ok.
Application.Run<Toplevel> ();
Application.Current!.Dispose ();
}
[Fact]
[SetupFakeApplication]
public void Run_T_After_InitNullDriver_with_TestTopLevel_DoesNotThrow ()
{
Application.StopAfterFirstIteration = true;
// Init has been called, selecting FakeDriver; we're passing no driver to Run<TestTopLevel>. Should be fine.
Application.Run<Toplevel> ();
Application.Current!.Dispose ();
}
[Fact]
[SetupFakeApplication]
public void Run_T_Init_Driver_Cleared_with_TestTopLevel_Throws ()
{
Application.Driver = null;
// Init has been called, but Driver has been set to null. Bad.
Assert.Throws<InvalidOperationException> (() => Application.Run<Toplevel> ());
}
[Fact]
[SetupFakeApplication]
public void Run_T_NoInit_DoesNotThrow ()
{
Application.StopAfterFirstIteration = true;
Application.Run<Toplevel> ().Dispose ();
}
[Fact]
[SetupFakeApplication]
public void Run_T_NoInit_WithDriver_DoesNotThrow ()
{
Application.StopAfterFirstIteration = true;
// Init has NOT been called and we're passing a valid driver to Run<TestTopLevel>. This is ok.
Application.Run<Toplevel> (null, "fake");
Application.Current!.Dispose ();
}
[Fact]
[SetupFakeApplication]
public void Run_RequestStop_Stops ()
{
var top = new Toplevel ();
SessionToken rs = Application.Begin (top);
Assert.NotNull (rs);
Application.Iteration += OnApplicationOnIteration;
Application.Run (top);
Application.Iteration -= OnApplicationOnIteration;
top.Dispose ();
return;
void OnApplicationOnIteration (object s, IterationEventArgs a) { Application.RequestStop (); }
}
[Fact]
[SetupFakeApplication]
public void Run_Sets_Running_True ()
{
var top = new Toplevel ();
SessionToken rs = Application.Begin (top);
Assert.NotNull (rs);
Application.Iteration += OnApplicationOnIteration;
Application.Run (top);
Application.Iteration -= OnApplicationOnIteration;
top.Dispose ();
return;
void OnApplicationOnIteration (object s, IterationEventArgs a)
{
Assert.True (top.Running);
top.Running = false;
}
}
[Fact]
[SetupFakeApplication]
public void Run_RunningFalse_Stops ()
{
var top = new Toplevel ();
SessionToken rs = Application.Begin (top);
Assert.NotNull (rs);
Application.Iteration += OnApplicationOnIteration;
Application.Run (top);
Application.Iteration -= OnApplicationOnIteration;
top.Dispose ();
return;
void OnApplicationOnIteration (object s, IterationEventArgs a) { top.Running = false; }
}
[Fact]
[SetupFakeApplication]
public void Run_Loaded_Ready_Unloaded_Events ()
{
Application.StopAfterFirstIteration = true;
Toplevel top = new ();
var count = 0;
top.Loaded += (s, e) => count++;
top.Ready += (s, e) => count++;
top.Unloaded += (s, e) => count++;
Application.Run (top);
top.Dispose ();
}
// TODO: All Toplevel layout tests should be moved to ToplevelTests.cs
[Fact]
[SetupFakeApplication]
public void Run_A_Modal_Toplevel_Refresh_Background_On_Moving ()
{
// Don't use Dialog here as it has more layout logic. Use Window instead.
var w = new Window
{
Width = 5, Height = 5,
Arrangement = ViewArrangement.Movable
};
Application.Driver!.SetScreenSize (10, 10);
SessionToken rs = Application.Begin (w);
// Don't use visuals to test as style of border can change over time.
Assert.Equal (new (0, 0), w.Frame.Location);
Application.RaiseMouseEvent (new () { Flags = MouseFlags.Button1Pressed });
Assert.Equal (w.Border, Application.Mouse.MouseGrabView);
Assert.Equal (new (0, 0), w.Frame.Location);
// Move down and to the right.
Application.RaiseMouseEvent (new () { ScreenPosition = new (1, 1), Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition });
Assert.Equal (new (1, 1), w.Frame.Location);
Application.End (rs);
w.Dispose ();
}
[Fact]
[SetupFakeApplication]
public void End_Does_Not_Dispose ()
{
var top = new Toplevel ();
Window w = new ();
Application.StopAfterFirstIteration = true;
Application.Run (w);
#if DEBUG_IDISPOSABLE
Assert.False (w.WasDisposed);
#endif
Assert.NotNull (w);
Assert.Equal (string.Empty, w.Title); // Valid - w has not been disposed. The user may want to run it again
Assert.NotNull (Application.Current);
Assert.Equal (w, Application.Current);
Assert.NotEqual (top, Application.Current);
Application.Run (w); // Valid - w has not been disposed.
#if DEBUG_IDISPOSABLE
Assert.False (w.WasDisposed);
Exception exception = Record.Exception (Application.Shutdown); // Invalid - w has not been disposed.
Assert.NotNull (exception);
w.Dispose ();
Assert.True (w.WasDisposed);
//exception = Record.Exception (
// () => Application.Run (
// w)); // Invalid - w has not been disposed. Run it in debug mode will throw, otherwise the user may want to run it again
//Assert.NotNull (exception);
// TODO: Re-enable this when we are done debug logging of ctx.Source.Title in RaiseSelecting
//exception = Record.Exception (() => Assert.Equal (string.Empty, w.Title)); // Invalid - w has been disposed and cannot be accessed
//Assert.NotNull (exception);
//exception = Record.Exception (() => w.Title = "NewTitle"); // Invalid - w has been disposed and cannot be accessed
//Assert.NotNull (exception);
#endif
}
[Fact]
public void Run_Creates_Top_Without_Init ()
{
Assert.Null (Application.Current);
Application.StopAfterFirstIteration = true;
Application.Iteration += OnApplicationOnIteration;
Toplevel top = Application.Run (null, "fake");
Application.Iteration -= OnApplicationOnIteration;
#if DEBUG_IDISPOSABLE
Assert.Equal (top, Application.Current);
Assert.False (top.WasDisposed);
Exception exception = Record.Exception (Application.Shutdown);
Assert.NotNull (exception);
Assert.False (top.WasDisposed);
#endif
// It's up to caller to dispose it
top.Dispose ();
#if DEBUG_IDISPOSABLE
Assert.True (top.WasDisposed);
#endif
Assert.NotNull (Application.Current);
Application.Shutdown ();
Assert.Null (Application.Current);
return;
void OnApplicationOnIteration (object s, IterationEventArgs e) { Assert.NotNull (Application.Current); }
}
[Fact]
public void Run_T_Creates_Top_Without_Init ()
{
Assert.Null (Application.Current);
Application.StopAfterFirstIteration = true;
Application.Run<Toplevel> (null, "fake");
#if DEBUG_IDISPOSABLE
Assert.False (Application.Current!.WasDisposed);
Exception exception = Record.Exception (Application.Shutdown);
Assert.NotNull (exception);
Assert.False (Application.Current!.WasDisposed);
// It's up to caller to dispose it
Application.Current!.Dispose ();
Assert.True (Application.Current!.WasDisposed);
#endif
Assert.NotNull (Application.Current);
Application.Shutdown ();
Assert.Null (Application.Current);
}
[Fact]
public void Run_t_Does_Not_Creates_Top_Without_Init ()
{
// When a Toplevel is created it must already have all the Application configuration loaded
// This is only possible by two ways:
// 1 - Using Application.Init first
// 2 - Using Application.Run() or Application.Run<T>()
// The Application.Run(new(Toplevel)) must always call Application.Init() first because
// the new(Toplevel) may be a derived class that is possible using Application static
// properties that is only available after the Application.Init was called
Assert.Null (Application.Current);
Assert.Throws<NotInitializedException> (() => Application.Run (new Toplevel ()));
Application.Init ("fake");
Application.Iteration += OnApplication_OnIteration;
Application.Run (new Toplevel ());
Application.Iteration -= OnApplication_OnIteration;
#if DEBUG_IDISPOSABLE
Assert.False (Application.Current!.WasDisposed);
Exception exception = Record.Exception (Application.Shutdown);
Assert.NotNull (exception);
Assert.False (Application.Current!.WasDisposed);
// It's up to caller to dispose it
Application.Current!.Dispose ();
Assert.True (Application.Current!.WasDisposed);
#endif
Assert.NotNull (Application.Current);
Application.Shutdown ();
Assert.Null (Application.Current);
return;
void OnApplication_OnIteration (object s, IterationEventArgs e)
{
Assert.NotNull (Application.Current);
Application.RequestStop ();
}
}
private class TestToplevel : Toplevel
{ }
[Fact]
public void Run_T_With_V2_Driver_Does_Not_Call_ResetState_After_Init ()
{
Assert.False (Application.Initialized);
Application.Init ("fake");
Assert.True (Application.Initialized);
Task.Run (() => { Task.Delay (300).Wait (); })
.ContinueWith (
(t, _) =>
{
// no longer loading
Application.Invoke ((app) => { app.RequestStop (); });
},
TaskScheduler.FromCurrentSynchronizationContext ());
Application.Run<TestToplevel> ();
Assert.NotNull (Application.Driver);
Assert.NotNull (Application.Current);
Assert.False (Application.Current!.Running);
Application.Current!.Dispose ();
Application.Shutdown ();
}
// TODO: Add tests for Run that test errorHandler
#endregion
#region ShutdownTests
[Fact]
public async Task Shutdown_Allows_Async ()
{
var isCompletedSuccessfully = false;
async Task TaskWithAsyncContinuation ()
{
await Task.Yield ();
await Task.Yield ();
isCompletedSuccessfully = true;
}
Application.Shutdown ();
Assert.False (isCompletedSuccessfully);
await TaskWithAsyncContinuation ();
Thread.Sleep (100);
Assert.True (isCompletedSuccessfully);
}
[Fact]
public void Shutdown_Resets_SyncContext ()
{
Application.Shutdown ();
Assert.Null (SynchronizationContext.Current);
}
#endregion
}