acdream/tests/AcDream.UI.Abstractions.Tests/Panels/Settings/SettingsStoreTests.cs
Erik dd2cb92b99 chore(audio): Campaign A slice A6 — delete what retail does not have
Retail EoR has no music system: the linked winmm MIDI player has zero
callers, 'music' appears zero times in the 65 MB decomp, SoundType has no
music member, InitPrefs registers no music key, and the install ships no
music files. So PlayMusic/StopMusic/MusicVolume and the AudioSettings
Music knob are deleted rather than left as an API modelling dead code —
the string-keyed signature was the tell, since every other entry point is
DID-keyed. Old settings.json files carrying a 'music' key still load; the
reader ignores unknown keys and the next save drops it.

The Ambient slider is now surfaced, because slice A5 gave it something to
drive, and its default returns to retail's 1.0 from an invented 0.8 —
InitPrefs defaults every sound preference to unity. The panel rule is
unchanged: no slider that does nothing.

r05-audio-sound.md gets a SUPERSEDED banner naming its five wrong
sections (falloff, pan, voice pool, selection, music, ambient) so a
future reader reaches the lane notes instead of the Ghidra-era reads that
this campaign spent its first two slices undoing.

TS-9 re-scoped from 'any MP3 cue' to the measured blast radius: exactly 1
MP3 among 786 shipped waves, a ~2 s mono clip. Its original framing
assumed a music system that does not exist. The ADPCM count remains
unmeasured and is named as the open question.

Deferred deliberately: #321's sound-cache decode-dedup race. It is a
pre-existing concurrency flake rather than audio-parity behaviour, and
shipping a speculative fix to a race I have not reproduced is exactly the
shortcut this project's no-workarounds rule exists to prevent.

Campaign A is code-complete; the plan carries the closeout.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-08 22:58:50 +02:00

477 lines
17 KiB
C#

using System.IO;
using AcDream.UI.Abstractions.Panels.Settings;
namespace AcDream.UI.Abstractions.Tests.Panels.Settings;
/// <summary>
/// L.0: <see cref="SettingsStore"/> reads / writes <c>settings.json</c>.
/// Tests use a temp-file path so they don't touch the user's
/// %LOCALAPPDATA% file.
/// </summary>
public sealed class SettingsStoreTests : System.IDisposable
{
private readonly string _tempPath;
public SettingsStoreTests()
{
// Unique per-test file under the system temp dir so parallel test
// runners don't clobber each other.
_tempPath = Path.Combine(
Path.GetTempPath(),
$"acdream-settings-test-{System.Guid.NewGuid():N}.json");
}
public void Dispose()
{
if (File.Exists(_tempPath)) File.Delete(_tempPath);
}
[Fact]
public void LoadDisplay_returns_defaults_when_file_is_missing()
{
var store = new SettingsStore(_tempPath);
var loaded = store.LoadDisplay();
Assert.Equal(DisplaySettings.Default, loaded);
}
[Fact]
public void SaveDisplay_then_LoadDisplay_round_trips_all_fields()
{
var store = new SettingsStore(_tempPath);
var original = new DisplaySettings(
Resolution: "2560x1440",
Fullscreen: true,
VSync: false,
FieldOfView: 100f,
Gamma: 1.4f,
ShowFps: true,
Quality: AcDream.UI.Abstractions.Settings.QualityPreset.Ultra,
ParticleRange: ParticleRange.Extended);
store.SaveDisplay(original);
var loaded = store.LoadDisplay();
Assert.Equal(original, loaded);
}
[Fact]
public void LoadDisplay_falls_back_to_defaults_when_file_is_corrupt()
{
File.WriteAllText(_tempPath, "{ this is not valid json");
var store = new SettingsStore(_tempPath);
var loaded = store.LoadDisplay();
Assert.Equal(DisplaySettings.Default, loaded);
}
[Fact]
public void LoadDisplay_falls_back_per_field_when_keys_missing()
{
// Partial file — only resolution set; everything else should
// pick up DisplaySettings.Default values.
File.WriteAllText(_tempPath, """
{
"version": 1,
"display": { "resolution": "1366x768" }
}
""");
var store = new SettingsStore(_tempPath);
var loaded = store.LoadDisplay();
Assert.Equal("1366x768", loaded.Resolution);
Assert.Equal(DisplaySettings.Default.Fullscreen, loaded.Fullscreen);
Assert.Equal(DisplaySettings.Default.VSync, loaded.VSync);
Assert.Equal(DisplaySettings.Default.FieldOfView, loaded.FieldOfView);
Assert.Equal(ParticleRange.Extended, loaded.ParticleRange);
}
[Fact]
public void LoadDisplay_invalid_particle_range_falls_back_to_default()
{
File.WriteAllText(_tempPath, """
{
"version": 2,
"display": { "particleRange": "Unlimited" }
}
""");
var loaded = new SettingsStore(_tempPath).LoadDisplay();
Assert.Equal(ParticleRange.Extended, loaded.ParticleRange);
}
[Fact]
public void LoadDisplay_numeric_undefined_particle_range_falls_back_to_default()
{
File.WriteAllText(_tempPath, """
{
"version": 2,
"display": { "particleRange": "999" }
}
""");
var loaded = new SettingsStore(_tempPath).LoadDisplay();
Assert.Equal(ParticleRange.Extended, loaded.ParticleRange);
}
[Fact]
public void SaveDisplay_preserves_unknown_top_level_keys()
{
// Forward-compat: a newer client may have written sections we
// don't know about (audio, gameplay). Saving display must not
// delete those, otherwise running an older client would silently
// drop the user's other-tab preferences.
File.WriteAllText(_tempPath, """
{
"version": 1,
"display": { "resolution": "1280x720" },
"audio": { "master": 0.5, "music": 0.7 }
}
""");
var store = new SettingsStore(_tempPath);
store.SaveDisplay(DisplaySettings.Default with { Resolution = "1920x1080" });
var raw = File.ReadAllText(_tempPath);
Assert.Contains("\"audio\"", raw);
Assert.Contains("\"master\"", raw);
Assert.Contains("0.5", raw);
// And the new display value did get written.
Assert.Contains("1920x1080", raw);
}
// -- Audio section round-trip ----------------------------------------
[Fact]
public void LoadAudio_returns_defaults_when_file_is_missing()
{
var store = new SettingsStore(_tempPath);
Assert.Equal(AudioSettings.Default, store.LoadAudio());
}
[Fact]
public void SaveAudio_then_LoadAudio_round_trips_all_fields()
{
var store = new SettingsStore(_tempPath);
var original = new AudioSettings(Master: 0.3f, Sfx: 0.9f, Ambient: 0.6f);
store.SaveAudio(original);
var loaded = store.LoadAudio();
Assert.Equal(original, loaded);
}
[Fact]
public void LoadAudio_falls_back_per_field_when_keys_missing()
{
File.WriteAllText(_tempPath, """
{
"version": 1,
"audio": { "master": 0.25 }
}
""");
var store = new SettingsStore(_tempPath);
var loaded = store.LoadAudio();
Assert.Equal(0.25f, loaded.Master);
Assert.Equal(AudioSettings.Default.Sfx, loaded.Sfx);
Assert.Equal(AudioSettings.Default.Ambient, loaded.Ambient);
}
[Fact]
public void SaveAudio_preserves_display_section()
{
// Save display first, then audio — display values must survive.
var store = new SettingsStore(_tempPath);
store.SaveDisplay(DisplaySettings.Default with { Resolution = "2560x1440" });
store.SaveAudio(AudioSettings.Default with { Master = 0.4f });
Assert.Equal("2560x1440", store.LoadDisplay().Resolution);
Assert.Equal(0.4f, store.LoadAudio().Master);
}
[Fact]
public void SaveDisplay_after_SaveAudio_preserves_audio_section()
{
// Reverse order — audio must survive a subsequent display save.
var store = new SettingsStore(_tempPath);
store.SaveAudio(AudioSettings.Default with { Ambient = 0.1f });
store.SaveDisplay(DisplaySettings.Default with { ShowFps = true });
Assert.Equal(0.1f, store.LoadAudio().Ambient);
Assert.True(store.LoadDisplay().ShowFps);
}
// -- Gameplay section round-trip --------------------------------------
[Fact]
public void LoadGameplay_returns_defaults_when_file_is_missing()
{
var store = new SettingsStore(_tempPath);
Assert.Equal(GameplaySettings.Default, store.LoadGameplay());
}
[Fact]
public void SaveGameplay_then_LoadGameplay_round_trips_all_fields()
{
var store = new SettingsStore(_tempPath);
var original = GameplaySettings.Default with
{
AutoTarget = false,
AdvancedCombatUI = true,
ShowHelm = false,
LockUI = true,
UseMouseTurning = true,
AcceptLootPermits = false,
};
store.SaveGameplay(original);
var loaded = store.LoadGameplay();
Assert.Equal(original, loaded);
}
[Fact]
public void LoadGameplay_falls_back_per_field_when_keys_missing()
{
File.WriteAllText(_tempPath, """
{
"version": 1,
"gameplay": { "lockUI": true }
}
""");
var store = new SettingsStore(_tempPath);
var loaded = store.LoadGameplay();
Assert.True(loaded.LockUI);
Assert.Equal(GameplaySettings.Default.AutoTarget, loaded.AutoTarget);
Assert.Equal(GameplaySettings.Default.ShowHelm, loaded.ShowHelm);
}
[Fact]
public void All_three_sections_coexist_in_one_settings_json()
{
var store = new SettingsStore(_tempPath);
store.SaveDisplay(DisplaySettings.Default with { Resolution = "2560x1440" });
store.SaveAudio(AudioSettings.Default with { Master = 0.5f });
store.SaveGameplay(GameplaySettings.Default with { LockUI = true });
// All three load correctly from the same file.
Assert.Equal("2560x1440", store.LoadDisplay().Resolution);
Assert.Equal(0.5f, store.LoadAudio().Master);
Assert.True(store.LoadGameplay().LockUI);
}
// -- Chat section round-trip ------------------------------------------
[Fact]
public void LoadChat_returns_defaults_when_file_is_missing()
{
var store = new SettingsStore(_tempPath);
Assert.Equal(ChatSettings.Default, store.LoadChat());
}
[Fact]
public void SaveChat_then_LoadChat_round_trips_all_fields()
{
var store = new SettingsStore(_tempPath);
var original = new ChatSettings(
HearGeneralChat: false,
HearTradeChat: false,
HearLFGChat: false,
HearRoleplayChat: true,
HearSocietyChat: true,
AppearOffline: true,
ShowTimestamps: false,
FilterProfanity: false,
FontSize: 16f);
store.SaveChat(original);
Assert.Equal(original, store.LoadChat());
}
[Fact]
public void All_four_sections_coexist_in_one_settings_json()
{
var store = new SettingsStore(_tempPath);
store.SaveDisplay(DisplaySettings.Default with { Resolution = "2560x1440" });
store.SaveAudio(AudioSettings.Default with { Master = 0.5f });
store.SaveGameplay(GameplaySettings.Default with { LockUI = true });
store.SaveChat(ChatSettings.Default with { HearTradeChat = false, FontSize = 14f });
Assert.Equal("2560x1440", store.LoadDisplay().Resolution);
Assert.Equal(0.5f, store.LoadAudio().Master);
Assert.True(store.LoadGameplay().LockUI);
Assert.False(store.LoadChat().HearTradeChat);
Assert.Equal(14f, store.LoadChat().FontSize);
}
// -- Character section round-trip (per-toon) --------------------------
[Fact]
public void LoadCharacter_returns_defaults_when_file_is_missing()
{
var store = new SettingsStore(_tempPath);
Assert.Equal(CharacterSettings.Default, store.LoadCharacter("default"));
}
[Fact]
public void LoadCharacter_returns_defaults_when_toonKey_not_in_file()
{
// File exists with a different toon's data; asking for "+Acdream"
// returns defaults rather than the other toon's data.
var store = new SettingsStore(_tempPath);
store.SaveCharacter("Bob", CharacterSettings.Default with { AutoAttack = true });
var loaded = store.LoadCharacter("+Acdream");
Assert.Equal(CharacterSettings.Default, loaded);
}
[Fact]
public void SaveCharacter_then_LoadCharacter_round_trips_all_fields()
{
var store = new SettingsStore(_tempPath);
var original = new CharacterSettings(
DefaultChatChannel: "Allegiance",
AutoAttack: true,
ConfirmSalvage: false,
ShowPickupMessages: false);
store.SaveCharacter("+Acdream", original);
Assert.Equal(original, store.LoadCharacter("+Acdream"));
}
[Fact]
public void SaveCharacter_preserves_other_toons_within_character_section()
{
// Two different toons, each with distinct settings — saving one
// must not clobber the other.
var store = new SettingsStore(_tempPath);
var alice = CharacterSettings.Default with { DefaultChatChannel = "Allegiance" };
var bob = CharacterSettings.Default with { DefaultChatChannel = "Fellowship", AutoAttack = true };
store.SaveCharacter("Alice", alice);
store.SaveCharacter("Bob", bob);
Assert.Equal(alice, store.LoadCharacter("Alice"));
Assert.Equal(bob, store.LoadCharacter("Bob"));
}
[Fact]
public void SaveCharacter_preserves_other_top_level_sections()
{
// Display/audio survive when SaveCharacter writes its nested map.
var store = new SettingsStore(_tempPath);
store.SaveDisplay(DisplaySettings.Default with { Resolution = "2560x1440" });
store.SaveAudio(AudioSettings.Default with { Master = 0.4f });
store.SaveCharacter("+Acdream", CharacterSettings.Default with { AutoAttack = true });
Assert.Equal("2560x1440", store.LoadDisplay().Resolution);
Assert.Equal(0.4f, store.LoadAudio().Master);
Assert.True(store.LoadCharacter("+Acdream").AutoAttack);
}
[Fact]
public void All_five_sections_coexist_in_one_settings_json()
{
var store = new SettingsStore(_tempPath);
store.SaveDisplay(DisplaySettings.Default with { Resolution = "2560x1440" });
store.SaveAudio(AudioSettings.Default with { Master = 0.5f });
store.SaveGameplay(GameplaySettings.Default with { LockUI = true });
store.SaveChat(ChatSettings.Default with { HearTradeChat = false });
store.SaveCharacter("+Acdream",
CharacterSettings.Default with { DefaultChatChannel = "Fellowship" });
Assert.Equal("2560x1440", store.LoadDisplay().Resolution);
Assert.Equal(0.5f, store.LoadAudio().Master);
Assert.True(store.LoadGameplay().LockUI);
Assert.False(store.LoadChat().HearTradeChat);
Assert.Equal("Fellowship", store.LoadCharacter("+Acdream").DefaultChatChannel);
}
[Fact]
public void WindowPositions_RoundTripPerCharacterAndPreserveSettings()
{
var store = new SettingsStore(_tempPath);
store.SaveGameplay(GameplaySettings.Default with { LockUI = true });
store.SaveWindowPosition("Alice", "radar", new UiWindowPosition(321.5f, 18f));
store.SaveWindowPosition("Bob", "radar", new UiWindowPosition(44f, 55f));
Assert.Equal(new UiWindowPosition(321.5f, 18f),
store.LoadWindowPosition("Alice", "radar"));
Assert.Equal(new UiWindowPosition(44f, 55f),
store.LoadWindowPosition("Bob", "radar"));
Assert.Null(store.LoadWindowPosition("Alice", "inventory"));
Assert.True(store.LoadGameplay().LockUI);
}
[Fact]
public void WindowLayouts_RoundTripPerCharacterResolutionAndPreserveSettings()
{
var store = new SettingsStore(_tempPath);
store.SaveGameplay(GameplaySettings.Default with { LockUI = true });
var alice1080 = new UiWindowLayout(10f, 20f, 500f, 300f, true, false, true);
var alice1440 = new UiWindowLayout(30f, 40f, 650f, 420f, false, true, false);
var bob1080 = new UiWindowLayout(50f, 60f, 310f, 132f, true, false, false);
store.SaveWindowLayout("Alice", "1920x1080", "chat", alice1080);
store.SaveWindowLayout("Alice", "2560x1440", "chat", alice1440);
store.SaveWindowLayout("Bob", "1920x1080", "toolbar", bob1080);
Assert.Equal(alice1080, store.LoadWindowLayout("Alice", "1920x1080", "chat", default));
Assert.Equal(alice1440, store.LoadWindowLayout("Alice", "2560x1440", "chat", default));
Assert.Equal(bob1080, store.LoadWindowLayout("Bob", "1920x1080", "toolbar", default));
Assert.Null(store.LoadWindowLayout("Alice", "1920x1080", "inventory", default));
Assert.True(store.LoadGameplay().LockUI);
}
[Fact]
public void WindowLayouts_MigrateLegacyRadarPositionOverCurrentDefaults()
{
var store = new SettingsStore(_tempPath);
store.SaveWindowPosition("Alice", "radar", new UiWindowPosition(321.5f, 18f));
var current = new UiWindowLayout(10f, 10f, 160f, 180f, true, false, false);
UiWindowLayout migrated = Assert.IsType<UiWindowLayout>(
store.LoadWindowLayout("Alice", "1920x1080", "radar", current));
Assert.Equal(321.5f, migrated.X);
Assert.Equal(18f, migrated.Y);
Assert.Equal(current.Width, migrated.Width);
Assert.Equal(current.Height, migrated.Height);
Assert.Equal(current.Visible, migrated.Visible);
}
[Fact]
public void WindowLayouts_FallBackToNearestSavedResolution()
{
var store = new SettingsStore(_tempPath);
var hd = new UiWindowLayout(100f, 110f, 400f, 250f, true, false, false);
var uhd = new UiWindowLayout(300f, 310f, 600f, 450f, true, false, false);
store.SaveWindowLayout("Alice", "1280x720", "chat", hd);
store.SaveWindowLayout("Alice", "3840x2160", "chat", uhd);
Assert.Equal(hd, store.LoadWindowLayout("Alice", "1600x900", "chat", default));
Assert.Equal(uhd, store.LoadWindowLayout("Alice", "3200x1800", "chat", default));
}
[Fact]
public void NamedWindowLayouts_RoundTripIndependentlyOfCharacterAndResolution()
{
var store = new SettingsStore(_tempPath);
var hunting = new UiWindowLayout(10f, 20f, 500f, 250f, true, false, true);
var crafting = new UiWindowLayout(30f, 40f, 300f, 400f, false, true, false);
store.SaveNamedWindowLayout("hunting", "chat", hunting);
store.SaveNamedWindowLayout("crafting", "chat", crafting);
Assert.Equal(hunting, store.LoadNamedWindowLayout("hunting", "chat", default));
Assert.Equal(crafting, store.LoadNamedWindowLayout("crafting", "chat", default));
Assert.Null(store.LoadNamedWindowLayout("missing", "chat", default));
}
}