Files
Terminal.Gui/Tests/UnitTests/Configuration/ThemeManagerTests.cs
Tig 7422385457 Fixes #4057 - MASSIVE! Fully implements ColorScheme->Scheme + VisualRole + Colors.->SchemeManager. (#4062)
* touching publish.yml

* ColorScheme->Scheme

* ColorScheme->Scheme 2

* Prototype of GetAttributeForRole

* Badly broke CM

* Further Badly broke CM

* Refactored CM big-time. View still broken

* All unit test pass again. Tons added. CM is still WIP, but Schemes is not mostly refactored and working.

* Actually:
All unit test pass again.
Tons added.
CM is still WIP, but Schemes is not mostly refactored and working.

* Bug fixes.
DeepMemberWiseClone cleanup

* Further cleanup of Scope<T>, ConfigProperty, etc.

* Made ConfigManager thread safe.

* WIP: Broken

* WIP: new deep clone impl

* WIP: new deep clone impl is done. Now fixing CM

* WIP:
- config.md
- Working on AOT clean up
- Core CM is broken; but known.

* WIP

* Merged.
Removed CM from Application.Init

* WIP

* More WIP; Less broke

* All CM unit tests pass... Not sure if it actually works though

* All unit tests pass... Themes are broken though in UI Cat

* CM Ready for review?

* Fixed failures due to TextStyles PR

* Working on Scheme/Attribute

* Working on Scheme/Attribute 2

* Working on Scheme/Attribute 3

* Working on Scheme/Attribute 4

* Working on Scheme/Attribute 5

* Working on Scheme/Attribute 6

* Added test to show how awful memory usage is

* Improved schema. Updated config.json

* Nade Scope<T> concurrentdictionary and added test to prove

* Made Themes ConcrurrentDictionary. Added bunches of tests

* Code cleanup

* Code cleanup 2

* Code cleanup 3

* Tweaking Scheme

* ClearJsonErrors

* ClearJsonErrors2

* Updated Attribute API

* It all (mostly) works!

* Skip odd unit test

* Messed with Themes

* Theme tweaks

* Code reorg. New .md stuff

* Fixed Enabled. Added mock driver

* Fixed a bunch of View.Enabled related issues

* Scheme -> Get/SetScheme()

* Cleanup

* Cleanup2

* Broke something

* Fixed everything

* Made CM.Enable better

* Text Style Scenario

* Added comments

* Fixed UI Catalog Theme Changing

* Fixed more dynamic CM update stuff

* Warning cleanup

* New Default Theme

* fixed unit test

* Refactoring Scheme and Attribute to fix inheritance

* more unit tests

* ConfigProperty is not updating schemes correctly

* All unit tests pass.
Code cleanup

* All unit tests pass.
Code cleanup2

* Fixed unit tests

* Upgraded TextField and TextView

* Fixed TextView !Enabled bug

* More updates to TextView. More unit tests for SchemeManager

* Upgraded CharMap

* API docs

* Fixe HexView API

* upgrade HexView

* Fixed shortcut KeyView

* Fixed more bugs. Added new themes

* updated themes

* upgraded Border

* Fixed themes memory usage...mostly

* Fixed themes memory usage...mostly2

* Fixed themes memory usage...2

* Fixed themes memory usage...3

* Added new colors

* Fixed GetHardCodedConfig bug

* Added Themes Scenario - WIP

* Added Themes Scenario

* Tweaked Themes Scenario

* Code cleanup

* Fixed json schmea

* updated deepdives

* updated deepdives

* Tweaked Themes Scenario

* Made Schemes a concurrent dict

* Test cleanup

* Thread safe ConfigProperty tests

* trying to make things more thread safe

* more trying to make things more thread safe

* Fixing bugs in shadowview

* Fixing bugs in shadowview 2

* Refactored GetViewsUnderMouse to GetViewsUnderLocation etc...

* Fixed dupe unit tests?

* Added better description of layout and coordiantes to deep dive

* Added better description of layout and coordiantes to deep dive

* Modified tests that call v2.AddTimeout; they were returning true which means restart the timer!
This was causing mac/linux unit test failures.
I think

* Fixed auto scheme.
Broke TextView/TextField selection

* Realized Attribute.IsExplicitlySet is stupid; just use nullable

* Fixed Attribute. Simplified. MOre theme testing

* Updated themes again

* GetViewsUnderMouse to GetViewsUnderLocation broke TransparentMouse.

* Fixing mouseunder bugs

* rewriting...

* All working again.
Shadows are now slick as snot.
GetViewsUnderLocation is rewritten to actually work and be readable.
Tons more low-level unit tests.
Margin is now actually ViewportSettings.Transparent.

* Code cleanup

* Code cleanup

* Code cleanup of color apis

* Fixed Hover/Highlight

* Update Examples/UICatalog/Scenarios/AllViewsTester.cs

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

* Update Examples/UICatalog/Scenarios/CharacterMap/CharacterMap.cs

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

* Update Examples/UICatalog/Scenarios/Clipping.cs

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

* Fixed race condition?

* reverted

* Simplified Attribute API by removing events from SetAttributeForRole

* Removed recursion from GetViewsAtLocation

* Removed unneeded code

* Code clean up.
Fixed Scheme bug.

* reverted temporary disable

* Adjusted scheme algo

* Upgraded TextValidateField

* Fixed TextValidate bugs

* Tweaks

* Frameview rounded border by default

* API doc cleanup

* Readme fix

* Addressed tznind feeback

* Fixed more unit test issues by protecting Application statics from being set if Application.Initialized is not true

* Fixed more unit test issues by protecting Application statics from being set if Application.Initialized is not true 2

* cleanup

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-05-29 13:55:54 -06:00

284 lines
10 KiB
C#

#nullable enable
using System.Collections.Concurrent;
using System.Diagnostics.Metrics;
using System.Text;
using Xunit.Abstractions;
using static Terminal.Gui.ConfigurationManager;
namespace Terminal.Gui.ConfigurationTests;
public class ThemeManagerTests (ITestOutputHelper output)
{
[Fact]
public void ResetToCurrentValues_Adds_Default_Theme ()
{
try
{
Enable (ConfigLocations.HardCoded);
Assert.NotEmpty (ThemeManager.Themes!);
ThemeManager.UpdateToCurrentValues ();
Assert.NotEmpty (ThemeManager.Themes!);
// Default theme exists
Assert.NotNull (ThemeManager.Themes? [ThemeManager.DEFAULT_THEME_NAME]);
}
finally
{
Disable (resetToHardCodedDefaults: true);
}
}
// ResetToCurrentValues
// OnThemeChanged
#region Tests Settings["Theme"] and ThemeManager.Theme
[Fact]
public void Theme_Settings_Theme_Equals_ThemeManager_Theme ()
{
Assert.False (IsEnabled);
Assert.Equal (Settings! ["Theme"].PropertyValue, ThemeManager.Theme);
Assert.Equal (ThemeManager.DEFAULT_THEME_NAME, ThemeManager.Theme);
}
[Fact]
public void Theme_Enabled_Settings_Theme_Equals_ThemeManager_Theme ()
{
Assert.False (IsEnabled);
Enable (ConfigLocations.HardCoded);
Assert.Equal (Settings! ["Theme"].PropertyValue, ThemeManager.Theme);
Assert.Equal (ThemeManager.DEFAULT_THEME_NAME, ThemeManager.Theme);
Disable (resetToHardCodedDefaults: true);
}
[Fact]
public void Theme_Set_Sets ()
{
Assert.False (IsEnabled);
Enable (ConfigLocations.HardCoded);
Assert.Equal (ThemeManager.DEFAULT_THEME_NAME, ThemeManager.Theme);
ThemeManager.Theme = "Test";
Assert.Equal ("Test", ThemeManager.Theme);
Assert.Equal (Settings! ["Theme"].PropertyValue, ThemeManager.Theme);
Assert.Equal ("Test", Settings! ["Theme"].PropertyValue);
Disable (resetToHardCodedDefaults: true);
}
[Fact]
public void Theme_ResetToHardCodedDefaults_Sets_To_Default ()
{
Assert.False (IsEnabled);
Assert.Equal (ThemeManager.DEFAULT_THEME_NAME, ThemeManager.Theme);
Enable (ConfigLocations.HardCoded);
Assert.Equal ("Default", ThemeManager.Theme);
ThemeManager.Theme = "Test";
Assert.Equal ("Test", ThemeManager.Theme);
Assert.Equal (Settings! ["Theme"].PropertyValue, ThemeManager.Theme);
Assert.Equal ("Test", Settings! ["Theme"].PropertyValue);
ResetToHardCodedDefaults ();
Assert.Equal ("Default", ThemeManager.Theme);
Disable ();
}
#endregion Tests Settings["Theme"] and ThemeManager.Theme
#region Tests Settings["Themes"] and ThemeManager.Themes
[Fact]
public void Themes_Set_Throws_If_Not_Enabled ()
{
Assert.False (IsEnabled);
Assert.Single (ThemeManager.Themes!);
Assert.Throws<InvalidOperationException> (() => ThemeManager.Themes = new ());
Assert.Single (ThemeManager.Themes!);
}
[Fact]
public void Themes_Set_Sets_If_Enabled ()
{
Assert.False (IsEnabled);
Enable (ConfigLocations.HardCoded);
Assert.Single (ThemeManager.Themes!);
// Use ConcurrentDictionary instead of a regular dictionary
ThemeManager.Themes = new ConcurrentDictionary<string, ThemeScope> (
new Dictionary<string, ThemeScope>
{
{ "Default", new ThemeScope() },
{ "test", new ThemeScope() }
},
StringComparer.InvariantCultureIgnoreCase
);
Assert.Contains ("test", ThemeManager.Themes!);
Disable (resetToHardCodedDefaults: true);
}
[Fact]
public void Themes_Set_Throws_If_No_Default_Theme_In_Dictionary ()
{
Assert.False (IsEnabled);
Enable (ConfigLocations.HardCoded);
Assert.Single (ThemeManager.Themes!);
Assert.Throws<InvalidOperationException> (
() => ThemeManager.Themes = new ConcurrentDictionary<string, ThemeScope> (
new Dictionary<string, ThemeScope>
{
{ "test", new ThemeScope() }
},
StringComparer.InvariantCultureIgnoreCase
));
Assert.Single (ThemeManager.Themes!);
Disable (resetToHardCodedDefaults: true);
}
[Fact]
public void Themes_Get () { }
#endregion Tests Settings["Themes"] and ThemeManager.Themes
[Fact]
public void Themes_TryAdd_Adds ()
{
Enable (ConfigLocations.HardCoded);
// Verify that the Themes dictionary contains only the Default theme
Assert.Single (ThemeManager.Themes!);
Assert.Contains (ThemeManager.DEFAULT_THEME_NAME, ThemeManager.Themes!);
var theme = new ThemeScope ();
theme.LoadHardCodedDefaults ();
Assert.NotEmpty (theme);
Assert.True (ThemeManager.Themes!.TryAdd ("testTheme", theme));
Assert.Equal (2, ThemeManager.Themes.Count);
Disable (resetToHardCodedDefaults: true);
}
[Fact]
public void Apply_Applies ()
{
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; // default is Single
ThemeManager.Theme = "testTheme";
ThemeManager.Themes! [ThemeManager.Theme]!.Apply ();
Assert.Equal (LineStyle.Double, FrameView.DefaultBorderStyle);
Disable (resetToHardCodedDefaults: true);
}
[Fact]
public void Theme_Reload_Consistency ()
{
try
{
Enable (ConfigLocations.HardCoded);
// BUGBUG: Setting Schemes to empty array is not valid!
// Create a test theme
RuntimeConfig = """
{
"Theme": "TestTheme",
"Themes": [
{
"TestTheme": {
"Schemes": []
}
}
]
}
""";
// Load the test theme
ThrowOnJsonErrors = true;
Load (ConfigLocations.Runtime);
Assert.Equal ("TestTheme", ThemeManager.Theme);
// Now reset everything and reload
ResetToCurrentValues ();
// Verify we're back to default
Assert.Equal ("Default", ThemeManager.Theme);
}
finally
{
Disable (resetToHardCodedDefaults: true);
}
}
[Fact]
public void In_Memory_Themes_Size_Is_Reasonable ()
{
output.WriteLine ($"Start: Color size: {(MemorySizeEstimator.EstimateSize (Color.Red))} b");
output.WriteLine ($"Start: Attribute size: {(MemorySizeEstimator.EstimateSize (Attribute.Default))} b");
output.WriteLine ($"Start: Base Scheme size: {(MemorySizeEstimator.EstimateSize (Scheme.GetHardCodedSchemes ()))} b");
output.WriteLine ($"Start: PropertyInfo size: {(MemorySizeEstimator.EstimateSize (ConfigurationManager.Settings! ["Application.QuitKey"]))} b");
ThemeScope themeScope = new ThemeScope ();
output.WriteLine ($"Start: ThemeScope ({themeScope.Count}) size: {(MemorySizeEstimator.EstimateSize (themeScope))} b");
themeScope.AddValue ("Schemes", Scheme.GetHardCodedSchemes ());
output.WriteLine ($"Start: ThemeScope ({themeScope.Count}) size: {(MemorySizeEstimator.EstimateSize (themeScope))} b");
output.WriteLine ($"Start: HardCoded Schemes ({SchemeManager.Schemes!.Count}) size: {(MemorySizeEstimator.EstimateSize (SchemeManager.Schemes!))} b");
output.WriteLine ($"Start: Themes dictionary ({ThemeManager.Themes!.Count}) size: {(MemorySizeEstimator.EstimateSize (ThemeManager.Themes!)) / 1024} Kb");
Enable (ConfigLocations.HardCoded);
output.WriteLine ($"Enabled: Themes dictionary ({ThemeManager.Themes.Count}) size: {(MemorySizeEstimator.EstimateSize (ThemeManager.Themes!)) / 1024} Kb");
Load (ConfigLocations.LibraryResources);
output.WriteLine ($"After Load: Themes dictionary ({ThemeManager.Themes!.Count}) size: {(MemorySizeEstimator.EstimateSize (ThemeManager.Themes!)) / 1024} Kb");
output.WriteLine ($"Total Settings Size: {(MemorySizeEstimator.EstimateSize (Settings!)) / 1024} Kb");
string json = SourcesManager?.ToJson (Settings)!;
// In memory size should be less than the size of the json
output.WriteLine ($"JSON size: {json.Length / 1024} Kb");
Assert.True (70000 > MemorySizeEstimator.EstimateSize (ThemeManager.Themes!), $"In memory size ({(MemorySizeEstimator.EstimateSize (Settings!)) / 1024} Kb) is > json size ({json.Length / 1024} Kb)");
Disable (resetToHardCodedDefaults: true);
}
}