Files
Terminal.Gui/Tests/UnitTests/Configuration/ConfigurationMangerTests.cs
BDisp 75f5a847c0 Fixes #4274. Using Windows Host Console v2win is rendering window size badly using VSDebugConsole.exe (#4275)
* Fixes #4274. Using Windows Host Console v2win is rendering window size badly using VSDebugConsole.exe

* Fixes #4259. Our wcwidth library is out of date (#4281)

* Update package versions and remove hack code from RuneExtensions

Updated several package versions in `Directory.Packages.props`, including `JetBrains.Annotations`, `Microsoft.Extensions.Logging.Abstractions`, `System.IO.Abstractions`, and `Wcwidth`.

Refactored methods in `RuneExtensions.cs`:
- Simplified `GetColumns` by removing special Unicode handling.
- Renamed constants to follow naming conventions.
- Improved logic and readability in `DecodeSurrogatePair`, `Encode`, and `GetEncodingLength`.
- Streamlined `IsSurrogatePair` and `MakePrintable` for clarity and efficiency.

* Update package version ranges for flexibility

Updated the `JetBrains.Annotations` package to use a version range
starting from `2025.2.2` to allow future updates. Adjusted the
`Microsoft.Extensions.Logging.Abstractions` package to a version
range `[9.0.0,10)` for compatibility. Changed `System.IO.Abstractions`
to a range `[22.0.16,23)` and `Wcwidth` to `[3.0.0,)` to enable
future updates within specified ranges.

* 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>

* Fix nit test.

* Change ClearScreenNextIteration to internal and trying to fix unit test failure

* Reuse method and fix text field color to normal, probably due some changed configuration

* Fix scenario Shortcut not restoring Application.Quit

* Giving more time to load Scrolling scenario and display failing scenario

* Revert changes and add more assertions

* Forcing CI tests again and I suspect that is causing by UpdateFromJson unit test

* Changed test to force fake driver

* Ensure restore the original colors

* Fix ResetToHardCodedDefaults method

* Tested with this before and the tests pass

* Revert "Tested with this before and the tests pass"

This reverts commit 297b88536c.

* Revert "Fix ResetToHardCodedDefaults method"

This reverts commit 3a28c5e945.

* Trying to fix scenario tests

---------

Co-authored-by: Tig <tig@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: tig <585482+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-16 17:42:49 -06:00

1016 lines
30 KiB
C#

using System.Collections.Frozen;
using System.Diagnostics;
using System.Reflection;
using System.Text;
using System.Text.Json;
using ColorHelper;
using Xunit.Abstractions;
using static Terminal.Gui.Configuration.ConfigurationManager;
using File = System.IO.File;
#pragma warning disable IDE1006
namespace Terminal.Gui.ConfigurationTests;
public class ConfigurationManagerTests (ITestOutputHelper output)
{
[Fact]
public void ModuleInitializer_Was_Called ()
{
Assert.False (IsEnabled);
Assert.True (IsInitialized ());
}
[Fact]
public void Initialize_Throws_If_Called_Explicitly ()
{
Assert.False (IsEnabled);
Assert.Throws<InvalidOperationException> (Initialize);
}
[Fact]
public void HardCodedDefaultCache_Properties_Are_Copies ()
{
Assert.False (IsEnabled);
Enable (ConfigLocations.HardCoded);
Assert.Equal (Key.Esc, Application.QuitKey);
ConfigProperty fromSettings = Settings! ["Application.QuitKey"];
FrozenDictionary<string, ConfigProperty> initialCache = GetHardCodedConfigPropertyCache ();
Assert.NotNull (initialCache);
ConfigProperty fromCache = initialCache ["Application.QuitKey"];
// Assert
Assert.NotEqual (fromCache, fromSettings);
Disable (true);
}
[Fact]
public void HardCodedDefaultCache_Properties_Are_Immutable ()
{
Assert.False (IsEnabled);
try
{
Enable (ConfigLocations.HardCoded);
Assert.Equal (Key.Esc, Application.QuitKey);
FrozenDictionary<string, ConfigProperty> initialCache = GetHardCodedConfigPropertyCache ();
Assert.NotNull (initialCache);
Assert.Equal (Key.Esc, (Key)initialCache ["Application.QuitKey"].PropertyValue);
// Act
Settings! ["Application.QuitKey"].PropertyValue = Key.Q;
Assert.Equal (Key.Q, (Key)Settings ["Application.QuitKey"].PropertyValue);
Settings ["Application.QuitKey"].Apply ();
Assert.Equal (Key.Q, Application.QuitKey);
Application.QuitKey = Key.K;
// Assert
FrozenDictionary<string, ConfigProperty> cache = GetHardCodedConfigPropertyCache ();
Assert.Equal (initialCache, cache);
Assert.True (initialCache ["Application.QuitKey"].Immutable);
Assert.Equal (Key.Esc, (Key)initialCache ["Application.QuitKey"].PropertyValue);
}
finally
{
Disable (true);
Application.ResetState (true);
}
}
[Fact]
public void Disable_Settings_Is_NotNull ()
{
Assert.False (IsEnabled);
Disable ();
Assert.NotNull (Settings);
}
[Fact]
public void Disable_With_ResetToHardCodedDefaults_True_Works_When_Disabled ()
{
Assert.False (ConfigurationManager.IsEnabled);
ConfigurationManager.Disable (true);
}
[Fact]
public void Enable_Settings_Is_Valid ()
{
Assert.False (IsEnabled);
Enable (ConfigLocations.HardCoded);
Assert.NotNull (Settings);
Disable ();
}
[Fact]
public void Apply_Applies_Theme ()
{
Assert.False (IsEnabled);
Enable (ConfigLocations.HardCoded);
var theme = new ThemeScope ();
theme.LoadHardCodedDefaults ();
Assert.NotEmpty (theme);
Assert.True (ThemeManager.Themes!.TryAdd ("testTheme", theme));
Assert.Equal (2, ThemeManager.Themes.Count);
Assert.Equal (LineStyle.Rounded, FrameView.DefaultBorderStyle);
theme ["FrameView.DefaultBorderStyle"].PropertyValue = LineStyle.Double;
ThemeManager.Theme = "testTheme";
ConfigurationManager.Apply ();
Assert.Equal (LineStyle.Double, FrameView.DefaultBorderStyle);
Disable (resetToHardCodedDefaults: true);
}
[Fact]
public void Apply_Raises_Applied ()
{
Assert.False (IsEnabled);
Enable (ConfigLocations.HardCoded);
Applied += ConfigurationManagerApplied;
var fired = false;
void ConfigurationManagerApplied (object sender, ConfigurationManagerEventArgs obj)
{
fired = true;
// assert
Assert.Equal (KeyCode.Q, Application.QuitKey.KeyCode);
Assert.Equal (KeyCode.F, Application.NextTabGroupKey.KeyCode);
Assert.Equal (KeyCode.B, Application.PrevTabGroupKey.KeyCode);
}
// act
Settings! ["Application.QuitKey"].PropertyValue = Key.Q;
Settings ["Application.NextTabGroupKey"].PropertyValue = Key.F;
Settings ["Application.PrevTabGroupKey"].PropertyValue = Key.B;
Apply ();
// assert
Assert.True (fired);
Applied -= ConfigurationManagerApplied;
Disable (resetToHardCodedDefaults: true);
Application.ResetState (true);
}
[Fact]
public void Load_Raises_Updated ()
{
Assert.False (IsEnabled);
var fired = false;
Enable (ConfigLocations.HardCoded);
ThrowOnJsonErrors = true;
Assert.Equal (Key.Esc, ((Key)Settings! ["Application.QuitKey"].PropertyValue)!.KeyCode);
Updated += ConfigurationManagerUpdated;
// Act
// Only select locations under test control
Load (ConfigLocations.LibraryResources | ConfigLocations.AppResources | ConfigLocations.Runtime);
// assert
Assert.True (fired);
// clean up
Updated -= ConfigurationManagerUpdated;
Disable (true);
Application.ResetState (true);
return;
void ConfigurationManagerUpdated (object sender, ConfigurationManagerEventArgs obj) { fired = true; }
}
[Fact]
public void Load_And_Apply_Performance_Check ()
{
Assert.False (IsEnabled);
Enable (ConfigLocations.HardCoded);
try
{
// Start stopwatch
var stopwatch = new Stopwatch ();
stopwatch.Start ();
// Act
Load (ConfigLocations.All);
Apply ();
// Stop stopwatch
stopwatch.Stop ();
// Assert
output.WriteLine ($"Load took {stopwatch.ElapsedMilliseconds} ms");
// Ensure load time is reasonable (adjust threshold as needed)
Assert.True (
stopwatch.ElapsedMilliseconds < 1000,
$"Loading configuration took {stopwatch.ElapsedMilliseconds}ms, which exceeds reasonable threshold");
}
finally
{
Disable (true);
Application.ResetState (true);
}
}
[Fact]
public void Load_Loads_Custom_Json ()
{
Assert.False (IsEnabled);
try
{
Enable (ConfigLocations.HardCoded);
ThrowOnJsonErrors = true;
Assert.Equal (Key.Esc, (Key)Settings! ["Application.QuitKey"].PropertyValue);
// act
RuntimeConfig = """
{
"Application.QuitKey": "Ctrl-Q"
}
""";
Load (ConfigLocations.Runtime);
// assert
Assert.Equal (Key.Q.WithCtrl, (Key)Settings ["Application.QuitKey"].PropertyValue);
}
finally
{
// clean up
Disable (true);
Application.ResetState (true);
}
}
[Fact (Skip = "Events disabled")]
public void ResetToCurrentValues_Raises_Updated ()
{
Assert.False (IsEnabled);
var fired = false;
try
{
Enable (ConfigLocations.HardCoded);
Settings! ["Application.QuitKey"].PropertyValue = Key.Q;
Updated += ConfigurationManagerUpdated;
// Act
ResetToCurrentValues ();
// assert
Assert.True (fired);
}
finally
{
Updated -= ConfigurationManagerUpdated;
Disable (true);
Application.ResetState (true);
}
return;
void ConfigurationManagerUpdated (object sender, ConfigurationManagerEventArgs obj) { fired = true; }
}
[Fact]
public void ResetToHardCodedDefaults_and_Load_LibraryResourcesOnly_are_same ()
{
Assert.False (IsEnabled);
try
{
// arrange
Enable (ConfigLocations.HardCoded);
Settings! ["Application.QuitKey"].PropertyValue = Key.Q;
Settings ["Application.NextTabGroupKey"].PropertyValue = Key.F;
Settings ["Application.PrevTabGroupKey"].PropertyValue = Key.B;
Settings.Apply ();
// assert apply worked
Assert.Equal (KeyCode.Q, Application.QuitKey.KeyCode);
Assert.Equal (KeyCode.F, Application.NextTabGroupKey.KeyCode);
Assert.Equal (KeyCode.B, Application.PrevTabGroupKey.KeyCode);
//act
ResetToHardCodedDefaults ();
// assert
Assert.NotEmpty (ThemeManager.Themes!);
Assert.Equal ("Default", ThemeManager.Theme);
Assert.Equal (Key.Esc, Application.QuitKey);
Assert.Equal (Key.F6, Application.NextTabGroupKey);
Assert.Equal (Key.F6.WithShift, Application.PrevTabGroupKey);
// arrange
Settings ["Application.QuitKey"].PropertyValue = Key.Q;
Settings ["Application.NextTabGroupKey"].PropertyValue = Key.F;
Settings ["Application.PrevTabGroupKey"].PropertyValue = Key.B;
Settings.Apply ();
// act
Load (ConfigLocations.LibraryResources);
Apply ();
// assert
Assert.NotEmpty (ThemeManager.Themes);
Assert.Equal ("Default", ThemeManager.Theme);
Assert.Equal (KeyCode.Esc, Application.QuitKey.KeyCode);
Assert.Equal (Key.F6, Application.NextTabGroupKey);
Assert.Equal (Key.F6.WithShift, Application.PrevTabGroupKey);
}
finally
{
Disable (true);
Application.ResetState (true);
}
}
[Fact]
public void ResetToCurrentValues_Enabled_Resets ()
{
Assert.False (IsEnabled);
// Act
Enable (ConfigLocations.HardCoded);
Application.QuitKey = Key.A;
ResetToCurrentValues ();
Assert.Equal (Key.A, (Key)Settings! ["Application.QuitKey"].PropertyValue);
Assert.NotNull (Settings);
Assert.NotNull (AppSettings);
Assert.NotNull (ThemeManager.Themes);
// Default Theme should be "Default"
Assert.Single (ThemeManager.Themes);
Assert.Equal (ThemeManager.DEFAULT_THEME_NAME, ThemeManager.Theme);
ResetToHardCodedDefaults ();
Assert.Equal (Key.Esc, (Key)Settings! ["Application.QuitKey"].PropertyValue);
Disable ();
Application.ResetState (true);
}
[Fact]
public void ConfigurationManager_DefaultPrecedence_IsRespected ()
{
Assert.False (IsEnabled);
try
{
// arrange
Enable (ConfigLocations.HardCoded);
ThrowOnJsonErrors = true;
// Setup multiple configurations with the same setting
// with different precedence levels
RuntimeConfig = """
{
"Application.QuitKey": "Alt+Q"
}
""";
var defaultConfig = """
{
"Application.QuitKey": "Ctrl+X"
}
""";
// Update default config first (lower precedence)
ConfigurationManager.SourcesManager?.Load (Settings, defaultConfig, "default-test", ConfigLocations.LibraryResources);
// Then load runtime config, which should override default
Load (ConfigLocations.Runtime);
// Assert - the runtime config should win due to precedence
Assert.Equal (Key.Q.WithAlt, (Key)Settings! ["Application.QuitKey"].PropertyValue);
}
finally
{
Disable (true);
}
}
/// <summary>Save the `config.json` file; this can be used to update the file in `Terminal.Gui.Resources.config.json'.</summary>
/// <remarks>
/// IMPORTANT: For the file generated to be valid, this must be the ONLY test run. Config Properties are all
/// static and thus can be overwritten by other tests.
/// </remarks>
[Fact]
public void Save_HardCodedDefaults_To_config_json ()
{
Assert.False (IsEnabled);
try
{
Enable (ConfigLocations.HardCoded);
// Get the hard coded settings
ResetToHardCodedDefaults ();
// Serialize to a JSON string
string json = ConfigurationManager.SourcesManager?.ToJson (Settings);
// Write the JSON string to the file
File.WriteAllText ("hard_coded_defaults_config.json", json);
// Verify the file was created
Assert.True (File.Exists ("hard_coded_defaults_config.json"), "Failed to create config.json file");
}
finally
{
Disable (true);
}
}
/// <summary>Save the `config.json` file; this can be used to update the file in `Terminal.Gui.Resources.config.json'.</summary>
/// <remarks>
/// IMPORTANT: For the file generated to be valid, this must be the ONLY test run. Config Properties are all
/// static and thus can be overwritten by other tests.
/// </remarks>
[Fact]
public void Save_Library_Defaults_To_config_json ()
{
Assert.False (IsEnabled);
try
{
Enable (ConfigLocations.LibraryResources);
// Serialize to a JSON string
string json = ConfigurationManager.SourcesManager?.ToJson (Settings);
// Write the JSON string to the file
File.WriteAllText ("library_defaults_config.json", json);
// Verify the file was created
Assert.True (File.Exists ("library_defaults_config.json"), "Failed to create config.json file");
}
finally
{
Disable (true);
}
}
[Fact]
public void TestConfigProperties ()
{
Assert.False (IsEnabled);
try
{
Enable (ConfigLocations.HardCoded);
Assert.NotEmpty (Settings!);
// test that all ConfigProperties have our attribute
Assert.All (
Settings,
item => Assert.Contains (item.Value.PropertyInfo!.CustomAttributes, a => a.AttributeType
== typeof (ConfigurationPropertyAttribute)
));
#pragma warning disable xUnit2030
Assert.DoesNotContain (Settings, cp => cp.Value.PropertyInfo!.GetCustomAttribute (
typeof (ConfigurationPropertyAttribute)
)
== null
);
#pragma warning restore xUnit2030
// Application is a static class
PropertyInfo pi = typeof (Application).GetProperty ("QuitKey");
Assert.Equal (pi, Settings ["Application.QuitKey"].PropertyInfo);
// FrameView is not a static class and DefaultBorderStyle is Scope.Scheme
pi = typeof (FrameView).GetProperty ("DefaultBorderStyle");
Assert.False (Settings.ContainsKey ("FrameView.DefaultBorderStyle"));
Assert.True (ThemeManager.GetCurrentTheme ().ContainsKey ("FrameView.DefaultBorderStyle"));
Assert.Equal (pi, ThemeManager.GetCurrentTheme () ["FrameView.DefaultBorderStyle"].PropertyInfo);
}
finally
{
Disable (true);
}
}
[Fact]
public void Load_And_Apply_HardCoded ()
{
Assert.False (IsEnabled);
try
{
// Spot check by setting some of the config properties
Application.QuitKey = Key.X.WithCtrl;
FileDialog.MaxSearchResults = 1;
Enable (ConfigLocations.HardCoded);
Load (ConfigLocations.HardCoded);
// Spot check
Assert.Equal (Key.Esc, Settings ["Application.QuitKey"].PropertyValue as Key);
Assert.Equal (10000, (int)Settings ["FileDialog.MaxSearchResults"].PropertyValue!);
Assert.Single (ThemeManager.Themes!);
Assert.Equal ("Default", ThemeManager.Theme);
Assert.NotEmpty (ThemeManager.Themes [ThemeManager.Theme]);
// Verify schemes are properly initialized
Assert.NotNull (SchemeManager.GetSchemes ());
Assert.NotEmpty (SchemeManager.GetSchemes ());
// Verify "Base" has correct values
//Assert.Equal (Color.White, SchemeManager.GetSchemes () ["Base"]!.Normal.Foreground);
//Assert.Equal (Color.Blue, SchemeManager.GetSchemes () ["Base"].Normal.Background);
Apply ();
Assert.Equal (Key.Esc, Application.QuitKey);
Assert.Equal (10000, FileDialog.MaxSearchResults);
}
finally
{
Disable (true);
}
}
[Fact]
public void Load_And_Apply_LibraryResources ()
{
Assert.False (IsEnabled);
try
{
// Spot check by setting some of the config properties
Application.QuitKey = Key.X.WithCtrl;
FileDialog.MaxSearchResults = 1;
Enable (ConfigLocations.HardCoded);
Load (ConfigLocations.LibraryResources);
// Spot check
Assert.Equal (Key.Esc, Settings! ["Application.QuitKey"].PropertyValue as Key);
Assert.Equal (10000, (int)Settings ["FileDialog.MaxSearchResults"].PropertyValue!);
Assert.NotEmpty (ThemeManager.Themes!);
Assert.Equal ("Default", ThemeManager.Theme);
Assert.NotEmpty (ThemeManager.Themes [ThemeManager.Theme]);
// Verify schemes are properly initialized
Assert.NotNull (SchemeManager.GetSchemes ());
Assert.NotEmpty (SchemeManager.GetSchemes ());
// This is too fragile as the default scheme may change
// Verify "Base" has correct values
//Assert.Equal (Color.White, SchemeManager.Schemes ["Base"]!.Normal.Foreground);
//Assert.Equal (Color.Blue, SchemeManager.Schemes ["Base"].Normal.Background);
Apply ();
Assert.Equal (Key.Esc, Application.QuitKey);
Assert.Equal (10000, FileDialog.MaxSearchResults);
}
finally
{
Disable (true);
}
}
[Fact]
public void Load_And_Apply_RuntimeConfig ()
{
Assert.False (IsEnabled);
try
{
// Spot check by setting some of the config properties
Application.QuitKey = Key.X.WithCtrl;
FileDialog.MaxSearchResults = 1;
Glyphs.Apple = new ('z');
ThrowOnJsonErrors = true;
Enable (ConfigLocations.HardCoded);
RuntimeConfig = """
{
"Application.QuitKey": "Alt-Q",
"FileDialog.MaxSearchResults":9,
"Themes" : [
{
"Default" : {
"Glyphs.Apple": "a"
}
}
]
}
""";
Load (ConfigLocations.Runtime);
Assert.Equal (Key.Q.WithAlt, Settings! ["Application.QuitKey"].PropertyValue as Key);
Assert.Equal (9, (int)Settings ["FileDialog.MaxSearchResults"].PropertyValue!);
Assert.Equal (new Rune ('a'), ThemeManager.GetCurrentTheme () ["Glyphs.Apple"].PropertyValue);
Apply ();
Assert.Equal (Key.Q.WithAlt, Application.QuitKey);
Assert.Equal (9, FileDialog.MaxSearchResults);
Assert.Equal (new ('a'), Glyphs.Apple);
}
finally
{
Disable (true);
}
}
[Fact]
public void InvalidJsonLogs ()
{
Assert.False (IsEnabled);
Enable (ConfigLocations.HardCoded);
ThrowOnJsonErrors = false;
// "brown" is not a color
var json = @"
{
""Themes"" : [
{
""Default"" : {
""Schemes"": [
{
""UserDefined"": {
""hotNormal"": {
""foreground"": ""brown"",
""background"": ""1234""
}
}
}
]
}
}
}
}";
ConfigurationManager.SourcesManager?.Load (Settings, json, "test", ConfigLocations.Runtime);
// AbNormal is not a Scheme attribute
json = @"
{
""Themes"" : [
{
""Default"" : {
""Schemes"": [
{
""UserDefined"": {
""AbNormal"": {
""foreground"": ""green"",
""background"": ""black""
}
}
}
]
}
}
}
}";
ConfigurationManager.SourcesManager?.Load (Settings, json, "test", ConfigLocations.Runtime);
// Modify hotNormal background only
json = @"
{
""Themes"" : [
{
""Default"" : {
""Schemes"": [
{
""UserDefined"": {
""hotNormal"": {
""background"": ""cyan""
}
}
}
]
}
}
}
}";
ConfigurationManager.SourcesManager?.Load (Settings, json, "test", ConfigLocations.Runtime);
ConfigurationManager.SourcesManager?.Load (Settings, "{}}", "test", ConfigLocations.Runtime);
Assert.NotEqual (0, _jsonErrors.Length);
ThrowOnJsonErrors = false;
Disable (true);
}
[Fact]
public void InvalidJsonThrows ()
{
Assert.False (IsEnabled);
Enable (ConfigLocations.HardCoded);
ThrowOnJsonErrors = true;
// "yellow" is not a color
var json = @"
{
""Themes"" : [
{
""Default"" : {
""Schemes"": [
{
""UserDefined"": {
""hotNormal"": {
""foreground"": ""brownish"",
""background"": ""1234""
}
}
}
]
}
}
]
}";
var jsonException = Assert.Throws<JsonException> (() => ConfigurationManager.SourcesManager?.Load (Settings, json, "test", ConfigLocations.Runtime));
Assert.StartsWith ("foreground: \"\"brownish\"\"", jsonException.Message);
// AbNormal is not a Scheme attribute
json = @"
{
""Themes"" : [
{
""Default"" : {
""Schemes"": [
{
""UserDefined"": {
""AbNormal"": {
""foreground"": ""green"",
""background"": ""black""
}
}
}
]
}
}
]
}";
jsonException = Assert.Throws<JsonException> (() => ConfigurationManager.SourcesManager?.Load (Settings, json, "test", ConfigLocations.Runtime));
Assert.StartsWith ("AbNormal:", jsonException.Message);
// Modify hotNormal background only
json = @"
{
""Themes"" : [
{
""Default"" : {
""Schemes"": [
{
""UserDefined"": {
""hotNormal"": {
""background"": ""cyan""
}
}
}
]
}
}
]
}";
jsonException = Assert.Throws<JsonException> (() => ConfigurationManager.SourcesManager?.Load (Settings, json, "test", ConfigLocations.Runtime));
Assert.StartsWith ("background:", jsonException.Message);
// Unknown property
json = @"
{
""Unknown"" : ""Not known""
}";
jsonException = Assert.Throws<JsonException> (() => ConfigurationManager.SourcesManager?.Load (Settings, json, "test", ConfigLocations.Runtime));
Assert.StartsWith ("Unknown:", jsonException.Message);
Assert.Equal (0, _jsonErrors.Length);
ThrowOnJsonErrors = false;
Disable (true);
}
[Fact]
public void UpdateFromJson ()
{
Assert.False (IsEnabled);
try
{
Enable (ConfigLocations.HardCoded);
// Arrange
var json = @"
{
""$schema"": ""https://gui-cs.github.io/Terminal.Gui/schemas/tui-config-schema.json"",
""Application.QuitKey"": ""Alt-Z"",
""Theme"": ""Default"",
""Themes"": [
{
""Default"": {
""MessageBox.DefaultButtonAlignment"": ""End"",
""Schemes"": [
{
""TopLevel"": {
""Normal"": {
""Foreground"": ""BrightGreen"",
""Background"": ""Black""
},
""Focus"": {
""Foreground"": ""White"",
""Background"": ""Cyan""
},
""HotNormal"": {
""Foreground"": ""Yellow"",
""Background"": ""Black""
},
""HotFocus"": {
""Foreground"": ""Blue"",
""Background"": ""Cyan""
},
""Disabled"": {
""Foreground"": ""DarkGray"",
""Background"": ""Black""
}
}
},
{
""Base"": {
""Normal"": {
""Foreground"": ""White"",
""Background"": ""Blue""
},
""Focus"": {
""Foreground"": ""Black"",
""Background"": ""Gray""
},
""HotNormal"": {
""Foreground"": ""BrightCyan"",
""Background"": ""Blue""
},
""HotFocus"": {
""Foreground"": ""BrightBlue"",
""Background"": ""Gray""
},
""Disabled"": {
""Foreground"": ""DarkGray"",
""Background"": ""Blue""
}
}
},
{
""Dialog"": {
""Normal"": {
""Foreground"": ""Black"",
""Background"": ""Gray""
},
""Focus"": {
""Foreground"": ""White"",
""Background"": ""DarkGray""
},
""HotNormal"": {
""Foreground"": ""Blue"",
""Background"": ""Gray""
},
""HotFocus"": {
""Foreground"": ""BrightYellow"",
""Background"": ""DarkGray""
},
""Disabled"": {
""Foreground"": ""Gray"",
""Background"": ""DarkGray""
}
}
},
{
""Menu"": {
""Normal"": {
""Foreground"": ""White"",
""Background"": ""DarkGray""
},
""Focus"": {
""Foreground"": ""White"",
""Background"": ""Black""
},
""HotNormal"": {
""Foreground"": ""BrightYellow"",
""Background"": ""DarkGray""
},
""HotFocus"": {
""Foreground"": ""BrightYellow"",
""Background"": ""Black""
},
""Disabled"": {
""Foreground"": ""Gray"",
""Background"": ""DarkGray""
}
}
},
{
""Error"": {
""Normal"": {
""Foreground"": ""Red"",
""Background"": ""White""
},
""Focus"": {
""Foreground"": ""Black"",
""Background"": ""BrightRed""
},
""HotNormal"": {
""Foreground"": ""Black"",
""Background"": ""White""
},
""HotFocus"": {
""Foreground"": ""White"",
""Background"": ""BrightRed""
},
""Disabled"": {
""Foreground"": ""DarkGray"",
""Background"": ""White""
}
}
}
]
}
}
]
}
";
ResetToCurrentValues ();
ThrowOnJsonErrors = true;
ConfigurationManager.SourcesManager?.Load (Settings, json, "UpdateFromJson", ConfigLocations.Runtime);
Assert.Equal ("Default", ThemeManager.Theme);
Assert.Equal (KeyCode.Esc, Application.QuitKey.KeyCode);
Assert.Equal (KeyCode.Z | KeyCode.AltMask, ((Key)Settings! ["Application.QuitKey"].PropertyValue)!.KeyCode);
Assert.Equal (Alignment.Center, MessageBox.DefaultButtonAlignment);
// Now re-apply
Apply ();
Assert.Equal ("Default", ThemeManager.Theme);
Assert.Equal (KeyCode.Z | KeyCode.AltMask, Application.QuitKey.KeyCode);
Assert.Equal (Alignment.End, MessageBox.DefaultButtonAlignment);
Assert.Equal (Color.White, SchemeManager.GetSchemes ()! ["Base"].Normal.Foreground);
Assert.Equal (Color.Blue, SchemeManager.GetSchemes ()! ["Base"].Normal.Background);
}
finally
{
Disable (resetToHardCodedDefaults: true);
}
}
}