Files
Terminal.Gui/UnitTests/Configuration/JsonConverterTests.cs
Tig dcb3b359ad Fixes #2926 - Refactor KeyEvent and KeyEventEventArgs to simplify (#2927)
* Adds basic MainLoop unit tests

* Remove WinChange action from Curses

* Remove WinChange action from Curses

* Remove ProcessInput action from Windows MainLoop

* Simplified MainLoop/ConsoleDriver by making MainLoop internal and moving impt fns to Application

* Modernized Terminal resize events

* Modernized Terminal resize events

* Removed un used property

* for _isWindowsTerminal devenv->wininit; not sure what changed

* Modernized mouse/keyboard events (Action->EventHandler)

* Updated OnMouseEvent API docs

* Using WT_SESSION to detect WT

* removes hacky GetParentProcess

* Updates to fix #2634 (clear last line)

* removes hacky GetParentProcess2

* Addressed mac resize issue

* Addressed mac resize issue

* Removes ConsoleDriver.PrepareToRun, has Init return MainLoop

* Removes unneeded Attribute methods

* Removed GetProcesssName

* Removed GetProcesssName

* Refactored KeyEvent and KeyEventEventArgs into a single class

* Revert "Refactored KeyEvent and KeyEventEventArgs into a single class"

This reverts commit 88a00658db.

* Fixed key repeat issue; reverted stupidity on 1049/1047 confusion

* Updated CSI API Docs

* merge

* Rearranged Event.cs to Keyboard.cs and Mouse.cs

* Renamed KeyEventEventArgs KeyEventArgs

* temp renamed KeyEvent OldKeyEvent

* Merged KeyEvent into KeyEventArgs

* Renamed Application.ProcessKey members

* Renamed Application.ProcessKey members

* Renamed Application.ProcessKey members

* Added Responder.KeyPressed

* Removed unused references

* Fixed arg naming

* InvokeKeybindings->InvokeKeyBindings

* InvokeKeybindings->InvokeKeyBindings

* Fixed unit tests fail

* More progress on refactoring key input; still broken and probably wrong

* Moved OnKeyPressed out of Responder and made ProcessKeyPrssed non-virtual

* Updated API docs

* Moved key handling from Responder to View

* Updated API docs

* Updated HotKey API docs

* Updated shortcut API docs

* Fixed responder unit tests

* Removed Shortcut from View as it is not used

* Removed unneeded OnHotKey override from Button

* Fixed BackTab logic

* Button now uses Key Bindings exclusively

* Button now uses Key Bindings exclusively

* Updated keyboard.md docs

* Fixed unit tests to account for Toplevel handling default button

* Added View.InvokeCommand API

* Modernized RadioGroup

* Removed ColdKey

* Modernized (partially) StatusBar

* Worked around FileDialog issue with Ctrl-F

* Fixed driver unit test; view must be focused to reciev key pressed

* Application code cleanup

* Start on updaing menu

* Menu now mostly works

* Menu Select refinement

* Fixed known menu bugs!

* Enabled HotKey to cause focus- experimental

* Fixes #3022 & adds unit test to prove it

* Actually Fixes #3022 & adds unit test to prove it

* Working through hotkey issues

* Misc fixes

* removed hot/cold key stuff from Keys scenario

* Fixed scenarios

* Simplified shortcut string handling

* Modernized Checkbox

* Modernized TileView

* Updated API docs

* Updated API docs

* attempting to publish v2 docs

* Revert "attempting to publish v2 docs"

This reverts commit 59dcec111b.

* Playing with api docs

* Removed Key.BackTab

* Removed Caps/Scroll/Numlock

* Partial removal of keymodifiers - unit tests pass

* Partial removal of keymodifiers - broke netdriver somewhere

* WindowsDriver & added KeyEventArgsTests

* Fixing menu shortcut/hotkeys - broke Menu.cs into separate files

* Fixed MenuBar!

* Finished modernizing Menu/MenuBar

* Removed Key.a-z. Broke lots of stuff

* checkout@v4

* progress on key mapping and formatting

* VK tests are still failing

* Fixed some unit tests

* Added Hotkey and Keybinding unit tests

* fixed unit test

* All unit tests pass again...

* Fixed broken unit tests

* KeyEventArgs.KeyValue -> AsRune

* Fixed bugs. Still some broken

* Added KeyEventArgs.IsAlpha. Added KeyEventArgs.cast ops. Fixed bugs. Unit tests pass

* Fixed WindowsDriver

* Oops.

* Refactoring based on bdisp's help. Not complete!

* removed calling into subviews from OnKeyBindings

* removed calling into subviews from OnKeyBindings

* Improved View KeyEvent unit tests

* More hotkey unit tests

* BIg change - Got rid of KeyPress w/in Application/Drivers

* Unit tests now pass again

* Refreshed API docs

* Better HotKey logic. More progress. Getting close.

* Fixed handling of shifted chars like ö

* Minor code cleanup

* Minor code cleanup2

* Why is build Action failing?

* Why is build Action failing??

* upgraded to .net8 to try to fix weird CI/CD build errors

* upgraded to .net8 to try to fix weird CI/CD build errors2

* Disabling TextViewTests to diagnose build errors

* reenable TextViewTests to diagnose build errors

* Arrrrrrg

* Merged v2_develop

* Fixed uppercase accented keys in WindowsDriver

* Fixed key binding api docs

* Experimental impl of CommandScope.SubViews for MenuBar

* Removed dead code from application.cs

* Removed dead code from application.cs

* Removed dead code from ConsoleDriver.cs

* Cleaned up some key binding stuff

* Disabled Alt to activate menu for now

* Updated label commands

* Fixed menu bugs. Upgraded menu unit tests

* Fixed unit tests

* Working on NetDriver

* fixed netdriver

* Fixed issues called out by @bdisp CR

* fixed CursesDriver

* added todo to netdriver

* Cherry picked treeview test fix 1b415e5

* Fix NetDriver.

* CommandScope->KeyBindingScope

* Address some tznind feedback

* Refactored KeyBindings big time!

* Added key consts to KeyEventArgs and renamed Key to ConsoleDriverKey

* Fixed some API docs

* Moved ConsoleDriverKey to ConsoleDriver.cs

* Renamed Key->ConsoleDriverKey

* Renamed Key->ConsoleDriverKey

* Renamed Key->ConsoleDriverKey

* renamed file I forgot to rename before

* Updated name and API docs of KeyEventArgs.isAlpha

* Fixed issues with OnKeyUp not doing the right thing.

* Fixed MainLoop.Running never being used

* Fixed MainLoop.Running never being used - unit tests

* Claned up BUGBUG comments

* Disabled a unit test to see why ci/cd tests are failing

* Removed defunct commented code

* Removed more defunct commented code

* Re-eanbled unit test; jsut removing one test case...

* Disabled more...

* Renambed Global->Applicaton and updated scope API docs

* Disabled more unit tests...

* Removed dead code

* Disabled more unit tests...2

* Disabled more unit tests...3

* Renambed Global->Applicaton and updated scope API docs 2

* Added more KeyBinding scope tests

* Added more KeyBinding scope tests2

* ConsoleDriverKey too long. Key too ambiguous. Settled on KeyCode. (Partialy because eventually I want to intro a class named Key).

* KeyEventArgs improvements. cast to Rune must be explicit as it's lossy

* Fixed warnings

* Renamed KeyEventArgs to Key... progress on fixing broken stuff that resulted

* Fix ConsoleKeyMapping bugs.

* Fix NetDriver issue from converting a lower case to a upper case.

* Started migration to Key from KeyCode - e.g. made HotKeys all consistent.

* Fixed build warnings

* Added key defns to Key

* KeyBindings now uses Key vs. KeyCode

* Verified by tweaking UICatalog

* Fixed treeview test ... again

* Renamed ProcessKeyDown/Up to NewKeyDown/Up and OnKeyPressed to OnProcessKeyDown to make things more clear

* Added test AllViews_KeyDown_All_EventsFire unit tests and fixed a few Views that were wrong

* fixed stupid KeyUp event bug

* If key not handled, return false for datefield

* dotnet test --no-restore --verbosity diag

* dotnet test --blame

* run tests on windows

* Fix TestVKPacket unit test and move it to ConsoleKeyMappingTests.cs file.

* Remove unnecessary commented code.

* Tweaked unit tests and removed Key.BareKey

* Fixed little details and updated api docs

* updated api docs

* AddKeyBindingsForHotKey: KeyCode->Key

* Cleaned up more old KeyCode usages. Added TODOs

---------

Co-authored-by: BDisp <bd.bdisp@gmail.com>
2023-12-16 12:04:23 -07:00

332 lines
10 KiB
C#

using System.Text.Encodings.Web;
using System.Text.Json;
using System.Text.Unicode;
using Xunit;
namespace Terminal.Gui.ConfigurationTests;
public class ColorJsonConverterTests {
[Theory]
[InlineData ("Black", Color.Black)]
[InlineData ("Blue", Color.Blue)]
[InlineData ("BrightBlue", Color.BrightBlue)]
[InlineData ("BrightCyan", Color.BrightCyan)]
[InlineData ("BrightGreen", Color.BrightGreen)]
[InlineData ("BrightMagenta", Color.BrightMagenta)]
[InlineData ("BrightRed", Color.BrightRed)]
[InlineData ("BrightYellow", Color.BrightYellow)]
[InlineData ("Yellow", Color.Yellow)]
[InlineData ("Cyan", Color.Cyan)]
[InlineData ("DarkGray", Color.DarkGray)]
[InlineData ("Gray", Color.Gray)]
[InlineData ("Green", Color.Green)]
[InlineData ("Magenta", Color.Magenta)]
[InlineData ("Red", Color.Red)]
[InlineData ("White", Color.White)]
public void TestColorDeserializationFromHumanReadableColorNames (string colorName, ColorName expectedColor)
{
// Arrange
string json = $"\"{colorName}\"";
// Act
var actualColor = JsonSerializer.Deserialize<Color> (json, ConfigurationManagerTests._jsonOptions);
// Assert
Assert.Equal (new Color (expectedColor), actualColor);
}
[Theory]
[InlineData (ColorName.Black, "Black")]
[InlineData (ColorName.Blue, "Blue")]
[InlineData (ColorName.Green, "Green")]
[InlineData (ColorName.Cyan, "Cyan")]
[InlineData (ColorName.Gray, "Gray")]
[InlineData (ColorName.Red, "Red")]
[InlineData (ColorName.Magenta, "Magenta")]
[InlineData (ColorName.Yellow, "Yellow")]
[InlineData (ColorName.DarkGray, "DarkGray")]
[InlineData (ColorName.BrightBlue, "BrightBlue")]
[InlineData (ColorName.BrightGreen, "BrightGreen")]
[InlineData (ColorName.BrightCyan, "BrightCyan")]
[InlineData (ColorName.BrightRed, "BrightRed")]
[InlineData (ColorName.BrightMagenta, "BrightMagenta")]
[InlineData (ColorName.BrightYellow, "BrightYellow")]
[InlineData (ColorName.White, "White")]
public void SerializesEnumValuesAsStrings (ColorName colorName, string expectedJson)
{
var converter = new ColorJsonConverter ();
var options = new JsonSerializerOptions { Converters = { converter } };
string serialized = JsonSerializer.Serialize<Color> (new Color (colorName), options);
Assert.Equal ($"\"{expectedJson}\"", serialized);
}
[Fact]
public void TestSerializeColor_Black ()
{
// Arrange
string expectedJson = "\"Black\"";
// Act
string json = JsonSerializer.Serialize<Color> (new Color (Color.Black), new JsonSerializerOptions {
Converters = { new ColorJsonConverter () }
});
// Assert
Assert.Equal (expectedJson, json);
}
[Fact]
public void TestSerializeColor_BrightRed ()
{
// Arrange
string expectedJson = "\"BrightRed\"";
// Act
string json = JsonSerializer.Serialize<Color> (new Color (Color.BrightRed), new JsonSerializerOptions {
Converters = { new ColorJsonConverter () }
});
// Assert
Assert.Equal (expectedJson, json);
}
[Fact]
public void TestDeserializeColor_Black ()
{
// Arrange
string json = "\"Black\"";
var expectedColor = new Color (ColorName.Black);
// Act
var color = JsonSerializer.Deserialize<Color> (json, new JsonSerializerOptions {
Converters = { new ColorJsonConverter () }
});
// Assert
Assert.Equal (expectedColor, color);
}
[Fact]
public void TestDeserializeColor_BrightRed ()
{
// Arrange
string json = "\"BrightRed\"";
var expectedColor = new Color (ColorName.BrightRed);
// Act
var color = JsonSerializer.Deserialize<Color> (json, new JsonSerializerOptions {
Converters = { new ColorJsonConverter () }
});
// Assert
Assert.Equal (expectedColor, color);
}
[Theory]
[InlineData (0, 0, 0, "\"#000000\"")]
[InlineData (0, 0, 1, "\"#000001\"")]
public void SerializesToHexCode (int r, int g, int b, string expected)
{
// Arrange
// Act
string actual = JsonSerializer.Serialize (new Color (r, g, b), new JsonSerializerOptions {
Converters = { new ColorJsonConverter () }
});
//Assert
Assert.Equal (expected, actual);
}
[Theory]
[InlineData ("\"#000000\"", 0, 0, 0)]
public void DeserializesFromHexCode (string hexCode, int r, int g, int b)
{
// Arrange
var expected = new Color (r, g, b);
// Act
var actual = JsonSerializer.Deserialize<Color> (hexCode, new JsonSerializerOptions {
Converters = { new ColorJsonConverter () }
});
//Assert
Assert.Equal (expected, actual);
}
[Theory]
[InlineData ("\"rgb(0,0,0)\"", 0, 0, 0)]
public void DeserializesFromRgb (string rgb, int r, int g, int b)
{
// Arrange
var expected = new Color (r, g, b);
// Act
var actual = JsonSerializer.Deserialize<Color> (rgb, new JsonSerializerOptions {
Converters = { new ColorJsonConverter () }
});
//Assert
Assert.Equal (expected, actual);
}
}
public class AttributeJsonConverterTests {
[Fact]
public void TestDeserialize ()
{
// Test deserializing from human-readable color names
string json = "{\"Foreground\":\"Blue\",\"Background\":\"Green\"}";
var attribute = JsonSerializer.Deserialize<Attribute> (json, ConfigurationManagerTests._jsonOptions);
Assert.Equal (Color.Blue, attribute.Foreground.ColorName);
Assert.Equal (Color.Green, attribute.Background.ColorName);
// Test deserializing from RGB values
json = "{\"Foreground\":\"rgb(255,0,0)\",\"Background\":\"rgb(0,255,0)\"}";
attribute = JsonSerializer.Deserialize<Attribute> (json, ConfigurationManagerTests._jsonOptions);
Assert.Equal (Color.Red, attribute.Foreground.ColorName);
Assert.Equal (Color.BrightGreen, attribute.Background.ColorName);
}
[Fact] [AutoInitShutdown]
public void TestSerialize ()
{
// Test serializing to human-readable color names
var attribute = new Attribute (Color.Blue, Color.Green);
string json = JsonSerializer.Serialize<Attribute> (attribute, ConfigurationManagerTests._jsonOptions);
Assert.Equal ("{\"Foreground\":\"Blue\",\"Background\":\"Green\"}", json);
}
}
public class ColorSchemeJsonConverterTests {
//string json = @"
// {
// ""ColorSchemes"": {
// ""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""
// }
// }
// }
// }";
[Fact] [AutoInitShutdown]
public void TestColorSchemesSerialization ()
{
// Arrange
var expectedColorScheme = new ColorScheme {
Normal = new Attribute (Color.White, Color.Blue),
Focus = new Attribute (Color.Black, Color.Gray),
HotNormal = new Attribute (Color.BrightCyan, Color.Blue),
HotFocus = new Attribute (Color.BrightBlue, Color.Gray),
Disabled = new Attribute (Color.DarkGray, Color.Blue)
};
string serializedColorScheme = JsonSerializer.Serialize<ColorScheme> (expectedColorScheme, ConfigurationManagerTests._jsonOptions);
// Act
var actualColorScheme = JsonSerializer.Deserialize<ColorScheme> (serializedColorScheme, ConfigurationManagerTests._jsonOptions);
// Assert
Assert.Equal (expectedColorScheme, actualColorScheme);
}
}
public class KeyCodeJsonConverterTests {
[Theory]
[InlineData (KeyCode.A, "A")]
[InlineData (KeyCode.A | KeyCode.ShiftMask, "A, ShiftMask")]
[InlineData (KeyCode.A | KeyCode.CtrlMask, "A, CtrlMask")]
[InlineData (KeyCode.A | KeyCode.AltMask | KeyCode.CtrlMask, "A, CtrlMask, AltMask")]
[InlineData ((KeyCode)'a' | KeyCode.AltMask | KeyCode.CtrlMask, "Space, A, CtrlMask, AltMask")]
[InlineData ((KeyCode)'a' | KeyCode.ShiftMask, "Space, A, ShiftMask")]
[InlineData (KeyCode.Delete | KeyCode.AltMask | KeyCode.CtrlMask, "Delete, CtrlMask, AltMask")]
[InlineData (KeyCode.D4, "D4")]
[InlineData (KeyCode.Esc, "Esc")]
public void TestKeyRoundTripConversion (KeyCode key, string expectedStringTo)
{
// Arrange
var options = new JsonSerializerOptions ();
options.Converters.Add (new KeyCodeJsonConverter ());
// Act
string json = JsonSerializer.Serialize (key, options);
var deserializedKey = JsonSerializer.Deserialize<KeyCode> (json, options);
// Assert
Assert.Equal (expectedStringTo, deserializedKey.ToString ());
}
}
public class KeyJsonConverterTests {
[Theory]
[InlineData (KeyCode.A, "{\"Key\":\"a\"}")]
[InlineData ((KeyCode)'â', "{\"Key\":\"â\"}")]
[InlineData (KeyCode.A | KeyCode.ShiftMask, "{\"Key\":\"A\"}")]
[InlineData (KeyCode.A | KeyCode.CtrlMask, "{\"Key\":\"Ctrl+A\"}")]
[InlineData (KeyCode.A | KeyCode.AltMask | KeyCode.CtrlMask, "{\"Key\":\"Ctrl+Alt+A\"}")]
[InlineData ((KeyCode)'a' | KeyCode.AltMask | KeyCode.CtrlMask, "{\"Key\":\"Ctrl+Alt+A\"}")]
[InlineData ((KeyCode)'a' | KeyCode.ShiftMask, "{\"Key\":\"A\"}")]
[InlineData (KeyCode.Delete | KeyCode.AltMask | KeyCode.CtrlMask, "{\"Key\":\"Ctrl+Alt+Delete\"}")]
[InlineData (KeyCode.D4, "{\"Key\":\"4\"}")]
[InlineData (KeyCode.Esc, "{\"Key\":\"Esc\"}")]
public void TestKey_Serialize (KeyCode key, string expected)
{
// Arrange
var options = new JsonSerializerOptions ();
options.Converters.Add (new KeyJsonConverter ());
options.Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping;
// Act
string json = JsonSerializer.Serialize ((Key)key, options);
// Assert
Assert.Equal (expected, json);
}
[Theory]
[InlineData (KeyCode.A, "a")]
[InlineData (KeyCode.A | KeyCode.ShiftMask, "A")]
[InlineData (KeyCode.A | KeyCode.CtrlMask, "Ctrl+A")]
[InlineData (KeyCode.A | KeyCode.AltMask | KeyCode.CtrlMask, "Ctrl+Alt+A")]
[InlineData ((KeyCode)'a' | KeyCode.AltMask | KeyCode.CtrlMask, "Ctrl+Alt+A")]
[InlineData ((KeyCode)'a' | KeyCode.ShiftMask, "A")]
[InlineData (KeyCode.Delete | KeyCode.AltMask | KeyCode.CtrlMask, "Ctrl+Alt+Delete")]
[InlineData (KeyCode.D4, "4")]
[InlineData (KeyCode.Esc, "Esc")]
public void TestKeyRoundTripConversion (KeyCode key, string expectedStringTo)
{
// Arrange
var options = new JsonSerializerOptions ();
options.Converters.Add (new KeyJsonConverter ());
var encoderSettings = new TextEncoderSettings ();
encoderSettings.AllowCharacters ('+', '-');
encoderSettings.AllowRange (UnicodeRanges.BasicLatin);
options.Encoder = JavaScriptEncoder.Create (encoderSettings);
// Act
string json = JsonSerializer.Serialize ((Key)key, options);
var deserializedKey = JsonSerializer.Deserialize<Key> (json, options);
// Assert
Assert.Equal (expectedStringTo, deserializedKey.ToString ());
}
}