acdream/tests/AcDream.Headless.Tests/HeadlessConfigurationLoaderTests.cs
Erik 7b60e71b85 fix(headless,runtime): OP7 review fixes + docs: OP3 re-review REOPEN (narrow)
TWO work products share this commit (a staged-index collision between the
coordinator's docs commit and the OP7 fixer's staged files — content
verified complete and coherent; only this message was wrong before the
amend):

1. OP7 review fixes (all nine findings from
   docs/research/2026-08-11-op7-review.md):
   - M1: HeadlessSessionDescriptor is a record; WithAccount uses 'with' non-destructive record copy,
     so a future property cannot be silently dropped; direct-CLI
     regression test proves CharacterOptions survives --user/--password.
   - M2 root fix: LiveSessionEventRouter skips BOTH Replace and the
     options notification on a trailer-truncated PlayerDescription — a
     truncated re-seed can no longer install zeroed words under an armed
     latch for OP7's automation to flush into 0x01A1.
   - SF1: schema keys validate as ordinal strings against the allowed
     names (numeric / comma-combined aliases rejected). SF2: both-true
     fellowship exclusion rejected at load, naming both keys. SF3: the
     onLoginCompleteSent observer moved after transit.EndTeleport().
     SF4: production-hook coverage for all three LoginComplete sites.
     SF5: test-script OP7 wire expectation corrected (batched ids ride
     only the 0x01A1).

2. docs/research/2026-08-11-op3-rereview.md — OP3 re-review verdict
   REOPEN (narrow): M1 byte-decode independently re-verified (6a 07 at
   all six sites); residuals R1 (gate script promises a timestamp prefix
   acdream doesn't render), R2 (null-controller player-mode still
   refuses), R3 (dormancy pin lacks stimulus) — coordinator fixes follow.

Full Release suite at this tree: 12,956 passed / 4 skipped / 0 failed.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-08-11 03:22:54 +02:00

253 lines
9.3 KiB
C#

using System.Text.Json;
using AcDream.Headless.Configuration;
namespace AcDream.Headless.Tests;
/// <summary>
/// Campaign OP slice OP7 (2026-08-11), D8: schema tests for the optional
/// per-session <c>characterOptions</c> block —
/// docs/plans/2026-08-10-options-panel-campaign.md §4 OP7. Exercises
/// <see cref="HeadlessConfigurationLoader.Load"/> directly (rather than
/// through <c>HeadlessEntryPoint</c>'s CLI wrapper) so assertions can pin the
/// exact exception type/message for the semantic "unknown name" rejection,
/// matching the loader's own established split: type-shape violations
/// (missing required field, wrong JSON value kind) fail during
/// deserialization itself with a raw <see cref="JsonException"/>; semantic
/// violations of an already-well-typed value fail with
/// <see cref="HeadlessConfigurationException"/> (see
/// <see cref="HeadlessConfigurationLoader"/>'s own doc comment on
/// <c>ValidateCharacterOptions</c>).
/// </summary>
public sealed class HeadlessConfigurationLoaderTests
{
[Fact]
public void ValidCharacterOptionsBlockParsesExactDeclaredNames()
{
using TemporaryConfiguration file = TemporaryConfiguration.Create(
ConfigurationWith(Session(
"bot",
"BOT_PASSWORD",
"""
"characterOptions":{
"IgnoreAllegianceRequests":true,
"ListenToTradeChat":false,
"AutoTarget":true
}
""")));
HeadlessConfiguration configuration =
HeadlessConfigurationLoader.Load(file.Path);
Dictionary<string, bool>? declared =
Assert.Single(configuration.Sessions)!.CharacterOptions;
Assert.NotNull(declared);
Assert.Equal(3, declared!.Count);
Assert.True(declared["IgnoreAllegianceRequests"]);
Assert.False(declared["ListenToTradeChat"]);
Assert.True(declared["AutoTarget"]);
}
[Fact]
public void UnknownOptionNameFailsLoadNamingTheOffendingKey()
{
using TemporaryConfiguration file = TemporaryConfiguration.Create(
ConfigurationWith(Session(
"bot",
"BOT_PASSWORD",
"\"characterOptions\":{\"NotARealOption\":true}")));
HeadlessConfigurationException exception = Assert.Throws<
HeadlessConfigurationException>(
() => HeadlessConfigurationLoader.Load(file.Path));
Assert.Contains(
"NotARealOption",
exception.Message,
StringComparison.Ordinal);
}
[Fact]
public void PresentationOnlyTierThreeOptionNameFailsLoad()
{
// ShowHelm is a REAL CharacterOptionId member (0x2F) but is
// deliberately outside the tier-1+2 bot-declarable subset (research
// doc §5.2 tier 3) — excluded by construction, not merely absent
// from an allow-list that forgot it.
using TemporaryConfiguration file = TemporaryConfiguration.Create(
ConfigurationWith(Session(
"bot",
"BOT_PASSWORD",
"\"characterOptions\":{\"ShowHelm\":true}")));
HeadlessConfigurationException exception = Assert.Throws<
HeadlessConfigurationException>(
() => HeadlessConfigurationLoader.Load(file.Path));
Assert.Contains(
"ShowHelm",
exception.Message,
StringComparison.Ordinal);
}
[Fact]
public void NumericKeyFailsLoadInsteadOfAliasingIntoAnAllowedId()
{
// SF-1 (OP7 review fix, 2026-08-11): Enum.TryParse on a non-[Flags]
// enum accepts a decimal numeric string — "15" parsed to 0x0F
// (FellowshipShareXP), which IS allow-listed, so the old
// parsed-value check let a key that is not an enum-member spelling
// at all silently pass. Validation must reject the STRING.
using TemporaryConfiguration file = TemporaryConfiguration.Create(
ConfigurationWith(Session(
"bot",
"BOT_PASSWORD",
"\"characterOptions\":{\"15\":true}")));
HeadlessConfigurationException exception = Assert.Throws<
HeadlessConfigurationException>(
() => HeadlessConfigurationLoader.Load(file.Path));
Assert.Contains("15", exception.Message, StringComparison.Ordinal);
}
[Fact]
public void CommaCombinedKeyFailsLoadInsteadOfOrCombiningIntoAnAllowedId()
{
// SF-1 companion case: Enum.TryParse OR-combines a comma-separated
// member list — "ToggleRun,AutoTarget" (0x0A | 0x0D) parsed to
// 0x0F (FellowshipShareXP), again allow-listed, so a config that
// reads as two movement options would have silently set fellowship
// XP sharing instead.
using TemporaryConfiguration file = TemporaryConfiguration.Create(
ConfigurationWith(Session(
"bot",
"BOT_PASSWORD",
"\"characterOptions\":{\"ToggleRun,AutoTarget\":true}")));
HeadlessConfigurationException exception = Assert.Throws<
HeadlessConfigurationException>(
() => HeadlessConfigurationLoader.Load(file.Path));
Assert.Contains(
"ToggleRun,AutoTarget",
exception.Message,
StringComparison.Ordinal);
}
[Fact]
public void BothFellowshipExclusionOptionsTrueFailsLoadNamingBothKeys()
{
// SF-2 (OP7 review fix, 2026-08-11): retail's own OnChanged mutual
// exclusion means IgnoreFellowshipRequests and
// FellowshipAutoAcceptRequests can never both be true at once —
// turning one on always clears the other. A config declaring both
// true would have the seeder oscillate (re-send) on every connect
// forever with neither value ever actually honoured. Reject it at
// load instead.
using TemporaryConfiguration file = TemporaryConfiguration.Create(
ConfigurationWith(Session(
"bot",
"BOT_PASSWORD",
"\"characterOptions\":{\"IgnoreFellowshipRequests\":true,"
+ "\"FellowshipAutoAcceptRequests\":true}")));
HeadlessConfigurationException exception = Assert.Throws<
HeadlessConfigurationException>(
() => HeadlessConfigurationLoader.Load(file.Path));
Assert.Contains(
"IgnoreFellowshipRequests",
exception.Message,
StringComparison.Ordinal);
Assert.Contains(
"FellowshipAutoAcceptRequests",
exception.Message,
StringComparison.Ordinal);
}
[Fact]
public void NonBoolValueFailsLoad()
{
using TemporaryConfiguration file = TemporaryConfiguration.Create(
ConfigurationWith(Session(
"bot",
"BOT_PASSWORD",
"\"characterOptions\":{\"IgnoreAllegianceRequests\":\"yes\"}")));
Assert.ThrowsAny<Exception>(
() => HeadlessConfigurationLoader.Load(file.Path));
}
[Fact]
public void AbsentCharacterOptionsBlockIsANoOp()
{
using TemporaryConfiguration file = TemporaryConfiguration.Create(
ConfigurationWith(Session("bot", "BOT_PASSWORD")));
HeadlessConfiguration configuration =
HeadlessConfigurationLoader.Load(file.Path);
Assert.Null(Assert.Single(configuration.Sessions)!.CharacterOptions);
}
[Fact]
public void EmptyCharacterOptionsBlockIsANoOp()
{
using TemporaryConfiguration file = TemporaryConfiguration.Create(
ConfigurationWith(Session(
"bot",
"BOT_PASSWORD",
"\"characterOptions\":{}")));
HeadlessConfiguration configuration =
HeadlessConfigurationLoader.Load(file.Path);
Dictionary<string, bool>? declared =
Assert.Single(configuration.Sessions)!.CharacterOptions;
Assert.NotNull(declared);
Assert.Empty(declared!);
}
private static string ConfigurationWith(params string[] sessions) =>
$$"""{"version":1,"sessions":[{{string.Join(",", sessions)}}]}""";
private static string Session(
string id,
string credentialReference,
string? extraTopLevelField = null)
{
string suffix = extraTopLevelField is null
? string.Empty
: $",{extraTopLevelField}";
return $"{{\"id\":\"{id}\",\"endpoint\":{{\"host\":\"127.0.0.1\",\"port\":9000}},"
+ "\"account\":\"account\",\"character\":{\"index\":0},"
+ "\"policy\":{\"id\":\"idle\"},\"credential\":"
+ $"{{\"provider\":\"environment\",\"reference\":\"{credentialReference}\"}}"
+ suffix
+ "}";
}
private sealed class TemporaryConfiguration : IDisposable
{
private TemporaryConfiguration(string path)
{
Path = path;
}
internal string Path { get; }
internal static TemporaryConfiguration Create(string json)
{
string path = System.IO.Path.Combine(
System.IO.Path.GetTempPath(),
$"acdream-headless-op7-{Guid.NewGuid():N}.json");
File.WriteAllText(path, json);
return new TemporaryConfiguration(path);
}
public void Dispose()
{
File.Delete(Path);
}
}
}