Files
Terminal.Gui/Tests/UnitTestsParallelizable/Configuration/SourcesManagerTests.cs
Copilot 6d53276be2 Fixes #4289 - Simplify Drawing/Color: unify named color handling under StandardColor and remove layered resolvers (#4432)
* Initial plan

* Delete AnsiColorNameResolver and MultiStandardColorNameResolver, add legacy 16-color names to StandardColor

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

* Refactor and enhance tests for Color, Region, and Lines

Refactored `Color` struct by removing unused methods and simplifying logic. Updated namespaces for better organization. Enhanced test coverage for `Color`, `Region`, and `LineCanvas` with new test cases, parameterized tests, and edge case handling.

Added `StraightLineExtensionsTests`, `StraightLineTests`, and `RegionClassTests` to validate behavior under various scenarios. Improved `MergeRectangles` stability and addressed crash patterns. Removed legacy features and unused code. Enhanced documentation and optimized performance in key methods.

* Improve Color struct and StandardColors functionality

Enhanced the Color struct to fully support the alpha channel for rendering intent while maintaining semantic color identity. Updated TryNameColor to ignore alpha when matching colors, ensuring transparency does not affect color resolution. Expanded XML documentation to clarify alpha channel usage and future alpha blending support.

Improved drawing documentation to explain the lifecycle, deferred rendering, and color support, including 24-bit true color and legacy 16-color compatibility. Added a new section on transparency and its role in rendering.

Revised StandardColors implementation to use modern C# features and ensure consistent ARGB mapping. Added comprehensive tests for StandardColors and Color, covering alpha handling, color parsing, thread safety, and aliased color resolution. Removed outdated tests relying on legacy behavior.

Enhanced code readability, maintainability, and test coverage to ensure correctness and backward compatibility.

* Code cleanup

* Code cleanup

* Fix warnings. Code cleanup

* Add comprehensive unit tests for ColorStrings class

Introduced a new test class `ColorStringsTests` under the
`DrawingTests.ColorTests` namespace to validate the functionality
of the `ColorStrings` class.

Key changes include:
- Added tests for `GetColorName` to verify behavior for standard
  and non-standard colors, ignoring alpha channels, and handling
  known colors.
- Added tests for `GetStandardColorNames` to ensure the method
  returns a non-empty, alphabetically sorted collection containing
  all `StandardColor` enum values.
- Implemented tests for `TryParseStandardColorName` to validate
  case-insensitive parsing, hex color support, handling invalid
  input, and `ReadOnlySpan<char>` compatibility.
- Added tests for `TryParseNamedColor` to verify parsing of named
  and hex colors, handling of aliases, and `ReadOnlySpan<char>`
  support.
- Added round-trip tests to ensure consistency between
  `GetColorName`, `TryParseNamedColor`, `GetStandardColorNames`,
  and `TryParseStandardColorName`.

These tests ensure robust validation of color parsing and naming
functionality.

---------

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>
2025-12-03 11:09:02 -07:00

521 lines
16 KiB
C#

using System.Reflection;
using System.Text.Json;
namespace ConfigurationTests;
public class SourcesManagerTests
{
#region Update (Stream)
[Fact]
public void Load_WithNullSettingsScope_ReturnsFalse ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var stream = new MemoryStream ();
var source = "Load_WithNullSettingsScope_ReturnsFalse";
var location = ConfigLocations.AppCurrent;
// Act
bool result = sourcesManager.Load (null, stream, source, location);
// Assert
Assert.False (result);
}
[Fact]
public void Load_WithValidStream_UpdatesSettingsScope ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
settingsScope.LoadHardCodedDefaults ();
settingsScope ["Application.QuitKey"].PropertyValue = Key.Q.WithCtrl;
var json = """
{
"Application.QuitKey": "Ctrl+Z"
}
""";
var location = ConfigLocations.HardCoded;
var source = "Load_WithValidStream_UpdatesSettingsScope";
var stream = new MemoryStream ();
var writer = new StreamWriter (stream);
writer.Write (json);
writer.Flush ();
stream.Position = 0;
// Act
bool result = sourcesManager.Load (settingsScope, stream, source, location);
// Assert
// Assert
Assert.True (result);
Assert.Equal (Key.Z.WithCtrl, settingsScope ["Application.QuitKey"].PropertyValue as Key);
Assert.Contains (source, sourcesManager.Sources.Values);
}
[Fact]
public void Load_WithInvalidJson_AddsJsonError ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
var invalidJson = "{ invalid json }";
var stream = new MemoryStream ();
var writer = new StreamWriter (stream);
writer.Write (invalidJson);
writer.Flush ();
stream.Position = 0;
var source = "Load_WithInvalidJson_AddsJsonError";
var location = ConfigLocations.AppCurrent;
// Act
bool result = sourcesManager.Load (settingsScope, stream, source, location);
// Assert
Assert.False (result);
// Assuming AddJsonError logs errors, verify the error was logged (mock or inspect logs if possible).
}
#endregion
#region Update (FilePath)
[Fact]
public void Load_WithNonExistentFile_AddsToSourcesAndReturnsTrue ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
var filePath = "nonexistent.json";
var location = ConfigLocations.AppCurrent;
// Act
bool result = sourcesManager.Load (settingsScope, filePath, location);
// Assert
Assert.True (result);
Assert.Contains (filePath, sourcesManager.Sources.Values);
}
[Fact]
public void Load_WithValidFile_UpdatesSettingsScope ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
settingsScope.LoadHardCodedDefaults ();
settingsScope ["Application.QuitKey"].PropertyValue = Key.Q.WithCtrl;
var json = """
{
"Application.QuitKey": "Ctrl+Z"
}
""";
var source = Path.GetTempFileName ();
var location = ConfigLocations.HardCoded;
File.WriteAllText (source, json);
try
{
// Act
bool result = sourcesManager.Load (settingsScope, source, location);
// Assert
Assert.True (result);
Assert.Equal (Key.Z.WithCtrl, settingsScope ["Application.QuitKey"].PropertyValue as Key);
Assert.Contains (source, sourcesManager.Sources.Values);
}
finally
{
// Cleanup
File.Delete (source);
}
}
[Fact]
public void Load_WithIOException_RetriesAndFailsGracefully ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
settingsScope.LoadHardCodedDefaults ();
var filePath = "locked.json";
var json = "{\"Application.UseSystemConsole\": true}";
File.WriteAllText (filePath, json);
var location = ConfigLocations.AppCurrent;
try
{
using FileStream fileStream = File.Open (filePath, FileMode.Open, FileAccess.Read, FileShare.None);
// Act
bool result = sourcesManager.Load (settingsScope, filePath, location);
// Assert
Assert.False (result);
}
finally
{
// Cleanup
File.Delete (filePath);
}
}
#endregion
#region Update (Json String)
[Fact]
public void Load_WithNullOrEmptyJson_ReturnsFalse ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
var source = "Load_WithNullOrEmptyJson_ReturnsFalse";
var location = ConfigLocations.AppCurrent;
// Act
bool resultWithNull = sourcesManager.Load (settingsScope, json: null, source, location);
bool resultWithEmpty = sourcesManager.Load (settingsScope, string.Empty, source, location);
// Assert
Assert.False (resultWithNull);
Assert.False (resultWithEmpty);
}
[Fact]
public void Load_WithValidJson_UpdatesSettingsScope ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
settingsScope.LoadHardCodedDefaults ();
settingsScope ["Application.QuitKey"].PropertyValue = Key.Q.WithCtrl;
var json = """
{
"Application.QuitKey": "Ctrl+Z"
}
""";
var source = "Load_WithValidJson_UpdatesSettingsScope";
var location = ConfigLocations.HardCoded;
// Act
bool result = sourcesManager.Load (settingsScope, json, source, location);
// Assert
Assert.True (result);
Assert.Equal (Key.Z.WithCtrl, settingsScope ["Application.QuitKey"].PropertyValue as Key);
Assert.Contains (source, sourcesManager.Sources.Values);
}
//[Fact]
//public void Update_WithValidJson_UpdatesThemeScope ()
//{
// // Arrange
// var sourcesManager = new SourcesManager ();
// var themeScope = new ThemeScope ();
// themeScope.LoadHardCodedDefaults ();
// themeScope ["Button.DefaultShadowStyle"].PropertyValue = ShadowStyle.Opaque;
// var json = """
// {
// "Button.DefaultShadowStyle": "None"
// }
// """;
// var source = "Update_WithValidJson_UpdatesThemeScope";
// var location = ConfigLocations.HardCoded;
// // Act
// bool result = sourcesManager.Load (themeScope, json, source, location);
// // Assert
// Assert.True (result);
// Assert.Equal (Key.Z.WithCtrl, themeScope ["Application.QuitKey"].PropertyValue as Key);
// Assert.Contains (source, sourcesManager.Sources.Values);
//}
#endregion
#region Load
[Fact]
public void Load_WithNullResourceName_ReturnsFalse ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
settingsScope.LoadHardCodedDefaults ();
settingsScope ["Application.QuitKey"].PropertyValue = Key.Q.WithCtrl;
var assembly = Assembly.GetExecutingAssembly ();
var location = ConfigLocations.AppResources;
// Act
bool result = sourcesManager.Load (settingsScope, assembly, string.Empty, location);
// Assert
Assert.False (result);
}
[Fact]
public void Load_WithValidResource_UpdatesSettingsScope ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
var assembly = Assembly.GetAssembly (typeof (ConfigurationManager));
var resourceName = "Terminal.Gui.Resources.config.json";
var location = ConfigLocations.LibraryResources;
// Act
bool result = sourcesManager.Load (settingsScope, assembly!, resourceName, location);
// Assert
Assert.True (result);
// Verify settingsScope is updated as expected
}
[Fact]
public void Load_Runtime_Overrides ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
var assembly = Assembly.GetAssembly (typeof (ConfigurationManager));
var resourceName = "Terminal.Gui.Resources.config.json";
var location = ConfigLocations.LibraryResources;
sourcesManager.Load (settingsScope, assembly!, resourceName, location);
Assert.Equal (Key.Esc, settingsScope ["Application.QuitKey"].PropertyValue);
var runtimeJson = """
{
"Application.QuitKey": "Ctrl+Z"
}
""";
var runtimeSource = "runtime.json";
var runtimeLocation = ConfigLocations.Runtime;
var runtimeStream = new MemoryStream ();
var writer = new StreamWriter (runtimeStream);
writer.Write (runtimeJson);
writer.Flush ();
runtimeStream.Position = 0;
// Act
bool result = sourcesManager.Load (settingsScope, runtimeStream, runtimeSource, runtimeLocation);
// Assert
Assert.True (result);
// Verify settingsScope is updated as expected
Assert.Equal (Key.Z.WithCtrl, settingsScope ["Application.QuitKey"].PropertyValue);
}
#endregion
#region ToJson and ToStream
[Fact]
public void ToJson_WithValidScope_ReturnsJsonString ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
settingsScope.LoadHardCodedDefaults ();
settingsScope ["Application.QuitKey"].PropertyValue = Key.Q.WithCtrl;
// Act
string json = sourcesManager.ToJson (settingsScope);
// Assert
Assert.Contains ("""Application.QuitKey": "Ctrl+Q""", json);
}
[Fact]
public void ToStream_WithValidScope_ReturnsStream ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
settingsScope.LoadHardCodedDefaults ();
settingsScope ["Application.QuitKey"].PropertyValue = Key.Q.WithCtrl;
// Act
var stream = sourcesManager.ToStream (settingsScope);
// Assert
Assert.NotNull (stream);
stream.Position = 0;
var reader = new StreamReader (stream);
string json = reader.ReadToEnd ();
Assert.Contains ("""Application.QuitKey": "Ctrl+Q""", json);
}
#endregion
#region Sources Dictionary Tests
[Fact]
public void Sources_Dictionary_IsInitializedEmpty ()
{
// Arrange & Act
var sourcesManager = new SourcesManager ();
// Assert
Assert.NotNull (sourcesManager.Sources);
Assert.Empty (sourcesManager.Sources);
}
[Fact]
public void Load_WhenCalledMultipleTimes_MaintainsLastSourceForLocation ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
// Act - Update with first source for location
var firstSource = "first.json";
sourcesManager.Load (settingsScope, """{"Application.QuitKey": "Ctrl+A"}""", firstSource, ConfigLocations.Runtime);
// Update with second source for same location
var secondSource = "second.json";
sourcesManager.Load (settingsScope, """{"Application.QuitKey": "Ctrl+B"}""", secondSource, ConfigLocations.Runtime);
// Assert - Only the last source should be stored for the location
Assert.Single (sourcesManager.Sources);
Assert.Equal (secondSource, sourcesManager.Sources [ConfigLocations.Runtime]);
}
[Fact]
public void Load_WithDifferentLocations_AddsAllSourcesToCollection ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
ConfigLocations [] locations =
[
ConfigLocations.LibraryResources,
ConfigLocations.Runtime,
ConfigLocations.AppCurrent,
ConfigLocations.GlobalHome
];
// Act - Update with different sources for different locations
foreach (var location in locations)
{
var source = $"config-{location}.json";
sourcesManager.Load (settingsScope, """{"Application.QuitKey": "Ctrl+Z"}""", source, location);
}
// Assert
Assert.Equal (locations.Length, sourcesManager.Sources.Count);
foreach (var location in locations)
{
Assert.Contains (location, sourcesManager.Sources.Keys);
Assert.Equal ($"config-{location}.json", sourcesManager.Sources [location]);
}
}
[Fact]
public void Load_AddsResourceSourceToCollection ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
var assembly = Assembly.GetAssembly (typeof (ConfigurationManager));
var resourceName = "Terminal.Gui.Resources.config.json";
var location = ConfigLocations.LibraryResources;
// Act
bool result = sourcesManager.Load (settingsScope, assembly!, resourceName, location);
// Assert
Assert.True (result);
Assert.Contains (location, sourcesManager.Sources.Keys);
Assert.Equal ($"resource://[{assembly!.GetName ().Name}]/{resourceName}", sourcesManager.Sources [location]);
}
[Fact]
public void Load_WithNonExistentFileAndDifferentLocations_TracksAllSources ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
// Define multiple files and locations
var fileLocations = new Dictionary<string, ConfigLocations> (StringComparer.InvariantCultureIgnoreCase)
{
{ "file1.json", ConfigLocations.AppCurrent },
{ "file2.json", ConfigLocations.GlobalHome },
{ "file3.json", ConfigLocations.AppHome }
};
// Act
foreach (var pair in fileLocations)
{
sourcesManager.Load (settingsScope, pair.Key, pair.Value);
}
// Assert
Assert.Equal (fileLocations.Count, sourcesManager.Sources.Count);
foreach (var pair in fileLocations)
{
Assert.Contains (pair.Value, sourcesManager.Sources.Keys);
Assert.Equal (pair.Key, sourcesManager.Sources [pair.Value]);
}
}
[Fact]
public void Sources_IsPreservedAcrossOperations ()
{
// Arrange
var sourcesManager = new SourcesManager ();
var settingsScope = new SettingsScope ();
// First operation - file update
var filePath = "testfile.json";
var location1 = ConfigLocations.AppCurrent;
sourcesManager.Load (settingsScope, filePath, location1);
// Second operation - json string update
var jsonSource = "jsonstring";
var location2 = ConfigLocations.Runtime;
sourcesManager.Load (settingsScope, """{"Application.QuitKey": "Ctrl+Z"}""", jsonSource, location2);
// Perform a stream operation
var streamSource = "streamdata";
var location3 = ConfigLocations.GlobalCurrent;
var stream = new MemoryStream ();
var writer = new StreamWriter (stream);
writer.Write ("""{"Application.QuitKey": "Ctrl+Z"}""");
writer.Flush ();
stream.Position = 0;
sourcesManager.Load (settingsScope, stream, streamSource, location3);
// Assert - all sources should be preserved
Assert.Equal (3, sourcesManager.Sources.Count);
Assert.Equal (filePath, sourcesManager.Sources [location1]);
Assert.Equal (jsonSource, sourcesManager.Sources [location2]);
Assert.Equal (streamSource, sourcesManager.Sources [location3]);
}
#endregion
}