Files
Terminal.Gui/Tests/UnitTests/Configuration/SchemeManagerTests.cs
Tig 3e2eebfd2c 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 14:08:48 -06:00

490 lines
19 KiB
C#

#nullable enable
using System.Collections.Concurrent;
using System.Collections.Immutable;
using System.Text.Json;
using static Terminal.Gui.ConfigurationManager;
namespace Terminal.Gui.ConfigurationTests;
public class SchemeManagerTests
{
[Fact]
public void GetSchemes_Not_Enabled_Gets_Schemes ()
{
Disable (true);
Dictionary<string, Scheme?>? schemes = SchemeManager.GetSchemesForCurrentTheme ();
Assert.NotNull (schemes);
Assert.NotNull (schemes ["Base"]);
Assert.True (schemes!.ContainsKey ("Base"));
Assert.True (schemes.ContainsKey ("base"));
Assert.Equal (SchemeManager.GetSchemes (), schemes);
}
[Fact]
public void GetSchemes_Enabled_Gets_Current ()
{
Enable (ConfigLocations.HardCoded);
Dictionary<string, Scheme?>? schemes = SchemeManager.GetSchemesForCurrentTheme ();
Assert.NotNull (schemes);
Assert.NotNull (schemes ["Base"]);
Assert.True (schemes!.ContainsKey ("Base"));
Assert.True (schemes.ContainsKey ("base"));
Assert.Equal (SchemeManager.GetSchemes (), schemes);
Disable (true);
}
[Fact]
public void GetSchemes_Get_Schemes_After_Load ()
{
Enable (ConfigLocations.HardCoded);
Load (ConfigLocations.All);
Apply ();
Assert.Equal (SchemeManager.GetSchemes (), SchemeManager.GetSchemesForCurrentTheme ());
}
[Fact]
public void GetHardCodedSchemes_Gets_HardCoded_Theme_Schemes ()
{
ImmutableSortedDictionary<string, Scheme?>? hardCoded = SchemeManager.GetHardCodedSchemes ();
Assert.Equal (Scheme.GetHardCodedSchemes (), actual: hardCoded!);
}
[Fact]
public void Not_Case_Sensitive_Disabled ()
{
Assert.False (IsEnabled);
Dictionary<string, Scheme?>? current = SchemeManager.GetSchemesForCurrentTheme ();
Assert.NotNull (current);
Assert.True (current!.ContainsKey ("Base"));
Assert.True (current.ContainsKey ("base"));
}
[Fact]
public void Not_Case_Sensitive_Enabled ()
{
Assert.False (IsEnabled);
Enable (ConfigLocations.HardCoded);
Assert.True (SchemeManager.GetSchemesForCurrentTheme ()!.ContainsKey ("Base"));
Assert.True (SchemeManager.GetSchemesForCurrentTheme ()!.ContainsKey ("base"));
ResetToHardCodedDefaults ();
Dictionary<string, Scheme?>? current = SchemeManager.GetSchemesForCurrentTheme ();
Assert.NotNull (current);
Assert.True (current!.ContainsKey ("Base"));
Assert.True (current.ContainsKey ("base"));
Disable (true);
}
[Fact]
public void Load_Adds ()
{
// arrange
Enable (ConfigLocations.HardCoded);
var theme = new ThemeScope ();
theme.LoadHardCodedDefaults ();
Assert.NotEmpty (theme);
Assert.Equal (5, SchemeManager.GetSchemes ().Count);
theme ["Schemes"].PropertyValue = SchemeManager.GetSchemes ();
Dictionary<string, Scheme> schemes = (Dictionary<string, Scheme>)theme ["Schemes"].PropertyValue!;
Assert.Equal (SchemeManager.GetSchemes ().Count, schemes.Count);
var newTheme = new ThemeScope ();
newTheme.LoadHardCodedDefaults ();
var scheme = new Scheme
{
// note: Scheme's can't be partial; default for each attribute
// is always White/Black
Normal = new (Color.Red, Color.Green),
Focus = new (Color.Cyan, Color.BrightCyan),
HotNormal = new (Color.Yellow, Color.BrightYellow),
HotFocus = new (Color.Green, Color.BrightGreen),
Disabled = new (Color.Gray, Color.DarkGray)
};
newTheme ["Schemes"].PropertyValue = SchemeManager.GetSchemesForCurrentTheme ();
Assert.Equal (5, SchemeManager.GetSchemes ().Count);
// add a new Scheme to the newTheme
((Dictionary<string, Scheme>)theme ["Schemes"].PropertyValue!) ["Test"] = scheme;
schemes = (Dictionary<string, Scheme>)theme ["Schemes"].PropertyValue!;
Assert.Equal (SchemeManager.GetSchemes ().Count, schemes.Count);
// Act
theme.UpdateFrom (newTheme);
// Assert
schemes = (Dictionary<string, Scheme>)theme ["Schemes"].PropertyValue!;
Assert.Equal (schemes ["Test"].Normal, scheme.Normal);
Assert.Equal (schemes ["Test"].Focus, scheme.Focus);
Disable (true);
}
[Fact]
public void Load_Changes ()
{
// arrange
Enable (ConfigLocations.HardCoded);
var theme = new ThemeScope ();
theme.LoadHardCodedDefaults ();
Assert.NotEmpty (theme);
var scheme = new Scheme
{
// note: Scheme's can't be partial; default for each attribute
// is always White/Black
Normal = new (Color.Red, Color.Green),
Focus = new (Color.Cyan, Color.BrightCyan),
HotNormal = new (Color.Yellow, Color.BrightYellow),
HotFocus = new (Color.Green, Color.BrightGreen),
Disabled = new (Color.Gray, Color.DarkGray)
};
theme ["Schemes"].PropertyValue = SchemeManager.GetSchemesForCurrentTheme ();
((Dictionary<string, Scheme>)theme ["Schemes"].PropertyValue!)! ["Test"] = scheme;
Dictionary<string, Scheme>? schemes = (Dictionary<string, Scheme>)theme ["Schemes"].PropertyValue!;
Assert.Equal (scheme.Normal, schemes ["Test"].Normal);
Assert.Equal (scheme.Focus, schemes ["Test"].Focus);
// Change just Normal
var newTheme = new ThemeScope ();
newTheme.LoadHardCodedDefaults ();
var newScheme = new Scheme
{
Normal = new (Color.Blue, Color.BrightBlue),
Focus = scheme.Focus,
HotNormal = scheme.HotNormal,
HotFocus = scheme.HotFocus,
Disabled = scheme.Disabled
};
newTheme ["Schemes"].PropertyValue = SchemeManager.GetSchemesForCurrentTheme ();
((Dictionary<string, Scheme>)newTheme ["Schemes"].PropertyValue!)! ["Test"] = newScheme;
// Act
theme.UpdateFrom (newTheme);
// Assert
schemes = (Dictionary<string, Scheme>)theme ["Schemes"].PropertyValue!;
// Normal should have changed
Assert.Equal (new (Color.Blue, Color.BrightBlue), schemes ["Test"].Normal);
Assert.Equal (Color.BrightBlue, schemes ["Test"].Normal.Background);
Assert.Equal (Color.Cyan, schemes ["Test"].Focus.Foreground);
Assert.Equal (Color.BrightCyan, schemes ["Test"].Focus.Background);
Disable (true);
}
[Fact]
public void Load_Null_Scheme_Throws ()
{
try
{
Enable (ConfigLocations.HardCoded);
ThrowOnJsonErrors = true;
// Create a test theme
RuntimeConfig = """
{
"Theme": "TestTheme",
"Themes": [
{
"TestTheme": {
}
}
]
}
""";
// Load the test theme
// TODO: This should throw an exception!
Assert.Throws<JsonException> (() => Load (ConfigLocations.Runtime));
Assert.Contains ("TestTheme", ThemeManager.Themes!);
Assert.Equal ("TestTheme", ThemeManager.Theme);
Assert.Throws<System.Collections.Generic.KeyNotFoundException> (SchemeManager.GetSchemes);
// Now reset everything and reload
ResetToCurrentValues ();
// Verify we're back to default
Assert.Equal ("Default", ThemeManager.Theme);
}
finally
{
Disable (true);
}
}
[Fact]
public void Load_Empty_Scheme_Throws ()
{
try
{
Enable (ConfigLocations.HardCoded);
ThrowOnJsonErrors = true;
// Create a test theme
RuntimeConfig = """
{
"Theme": "TestTheme",
"Themes": [
{
"TestTheme": {
"Schemes": []
}
}
]
}
""";
// Load the test theme
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 (true);
}
}
[Fact]
public void Load_Custom_Scheme_Loads ()
{
try
{
Enable (ConfigLocations.HardCoded);
ThrowOnJsonErrors = true;
// Create a test theme
RuntimeConfig = """
{
"Theme": "TestTheme",
"Themes": [
{
"TestTheme": {
"Schemes": [
{
"TopLevel": {
"Normal": {
"Foreground": "AntiqueWhite",
"Background": "DimGray"
},
"Focus": {
"Foreground": "White",
"Background": "DarkGray"
},
"HotNormal": {
"Foreground": "Wheat",
"Background": "DarkGray",
"Style": "Underline"
},
"HotFocus": {
"Foreground": "LightYellow",
"Background": "DimGray",
"Style": "Underline"
},
"Disabled": {
"Foreground": "Black",
"Background": "DimGray"
}
}
},
{
"Base": {
"Normal": {
"Foreground": "White",
"Background": "Blue"
},
"Focus": {
"Foreground": "DarkBlue",
"Background": "LightGray"
},
"HotNormal": {
"Foreground": "BrightCyan",
"Background": "Blue"
},
"HotFocus": {
"Foreground": "BrightBlue",
"Background": "LightGray"
},
"Disabled": {
"Foreground": "DarkGray",
"Background": "Blue"
}
}
},
{
"Dialog": {
"Normal": {
"Foreground": "Black",
"Background": "LightGray"
},
"Focus": {
"Foreground": "DarkGray",
"Background": "LightGray"
},
"HotNormal": {
"Foreground": "Blue",
"Background": "LightGray"
},
"HotFocus": {
"Foreground": "BrightBlue",
"Background": "LightGray"
},
"Disabled": {
"Foreground": "Gray",
"Background": "DarkGray"
}
}
},
{
"Menu": {
"Normal": {
"Foreground": "White",
"Background": "DarkBlue",
"Style": "Bold"
},
"Focus": {
"Foreground": "White",
"Background": "DarkBlue",
"Style": "Bold,Reverse"
},
"HotNormal": {
"Foreground": "BrightYellow",
"Background": "DarkBlue",
"Style": "Bold,Underline"
},
"HotFocus": {
"Foreground": "Blue",
"Background": "White",
"Style": "Bold,Underline"
},
"Disabled": {
"Foreground": "Gray",
"Background": "DarkGray",
"Style": "Faint"
}
}
},
{
"Error": {
"Normal": {
"Foreground": "Red",
"Background": "Pink"
},
"Focus": {
"Foreground": "White",
"Background": "BrightRed"
},
"HotNormal": {
"Foreground": "Black",
"Background": "Pink"
},
"HotFocus": {
"Foreground": "Pink",
"Background": "BrightRed"
},
"Disabled": {
"Foreground": "DarkGray",
"Background": "White"
}
}
}
]
}
}
]
}
""";
// Load the test theme
Load (ConfigLocations.Runtime);
Assert.Equal ("TestTheme", ThemeManager.Theme);
TextStyle style = SchemeManager.GetSchemesForCurrentTheme () ["Menu"]!.Normal.Style;
Assert.Equal (TextStyle.Bold, style);
// Now reset everything and reload
ResetToCurrentValues ();
// Verify we're back to default
Assert.Equal ("Default", ThemeManager.Theme);
}
finally
{
Disable (true);
}
}
[Fact (Skip = "WIP")]
public void Apply_UpdatesSchemes ()
{
Enable (ConfigLocations.HardCoded);
Assert.False (SchemeManager.GetSchemes ()!.ContainsKey ("test"));
Assert.Equal (5, SchemeManager.GetSchemes ().Count); // base, toplevel, menu, error, dialog
var theme = new ThemeScope ();
Assert.NotEmpty (theme);
ThemeManager.Themes!.TryAdd ("testTheme", theme);
var scheme = new Scheme { Normal = new (Color.Red, Color.Green) };
theme ["Schemes"].PropertyValue = new Dictionary<string, Scheme> (StringComparer.InvariantCultureIgnoreCase) { { "test", scheme } };
Assert.Equal (
new (Color.Red),
((Dictionary<string, Scheme>)theme["Schemes"].PropertyValue!) ["test"].Normal.Foreground
);
Assert.Equal (
new (Color.Green),
((Dictionary<string, Scheme>)theme["Schemes"].PropertyValue!) ["test"].Normal.Background
);
// Act
ThemeManager.Theme = "testTheme";
ThemeManager.Themes! [ThemeManager.Theme]!.Apply ();
Assert.Equal (5, SchemeManager.GetSchemes ().Count); // base, toplevel, menu, error, dialog
// Assert
Scheme updatedScheme = SchemeManager.GetSchemes () ["test"]!;
Assert.Equal (new (Color.Red), updatedScheme.Normal.Foreground);
Assert.Equal (new (Color.Green), updatedScheme.Normal.Background);
// remove test Scheme from Colors to avoid failures on others unit tests with Scheme
SchemeManager.GetSchemes ().Remove ("test");
Assert.Equal (5, SchemeManager.GetSchemes ().Count);
Disable (true);
}
}