test: fix shared state, CI-vacuous tests and harness duplication (#2722)
Follow-up to #2721. It fixes how the remaining tests behave and changes no production code. ## CI - Both `dotnet test` steps pass `--filter "Category!=Manual"`. Before this, Manual-tagged tests ran on CI anyway. - The one surviving movement-throttle latency test is the only coverage of burst forgiveness over a full, wrapped history. It loses its Manual tag, so it runs on CI. ## Tests that passed on CI without testing anything - **Corpse and throwing tests.** They relied on tiledata for the weapon `Layer`, so on CI the equip silently failed and they asserted against empty lists. They now set `Layer` explicitly and assert the equip took effect. `TestThrown` also pins its own strength and range values, so a shard retuning SoulGlaive no longer breaks them. - **Healthbar poison rows.** Server.Tests registers no poisons, so every row tested `null`. They now use real poison levels. - **Account packet tests.** The mock accounts reported `Length` 0, so the character-list tests only ever encoded empty slots. They now encode the real characters. - **Pathing and AI tests that only mean something on real Trammel/Felucca terrain** are now guarded with `TileDataRequirement.SkipIfMissing()`: Britain desk and clutter scenes, house footprints (no MultiData on CI) and fingerprints. Tests that are valid on flat blank terrain stay unguarded. (A synthetic tiledata fixture to run these on CI is a planned follow-up.) - **Assertions that couldn't fail now check their claim.** Affected tests include the `DefaultWalker` cache use, cache on/off parity requiring a path, the recorder capability flags, the idle-pet gate, the monthly DST recurrence, the AdvancedSearch `Record.Exception` wrappers, `CanFitItem` with no branch-guarded assert, the Firewall callback, and `Import_NoMap`. The Geometry Parse asserts also now use the same input as their TryParse. ## Shared state Every test that changes process-wide state now restores it, even when an assert fails: - **The clock.** A new `TimerWheelScope` saves and restores `Core._tickCount`, `Core._now` and the timer wheel. `SimulatedClockScope` covers decay tests. - **StepCache settings and caches**, via `StepCacheStateScope`. - **Network state.** The ManualAllowlist, LoginAllowlist, firewall and BanChannel reporters are restored. Global packet handlers are now registered per test and removed afterwards, so they no longer stay registered for later tests. - **Data and config tables.** `ArchiveJournal` statics, `TileData.ItemTable`, `ObjectPropertyList.Enabled`, `Core.Expansion` and the localization table are restored. One `MobileStatusVersion` restore was resetting a different expansion than the one the test changed. - **Entities.** Tests with fixed serials now delete what they create. Fixed mobile serials moved to `World.NewMobile`, because deleting a hard-coded serial could unregister a live entity. - **Collection race.** `SpiralScanTests` no longer clears the spawn cache from a separate collection that could run in parallel with the cache-manager tests. - **Shared statics.** Classes reading shared static allowlists joined the sequential collection. ## Duplication New shared helpers replace copy-pasted harness code: - **Server.Tests:** `PacketAssert.Sends`, used by about 130 packet tests; `TestClientHarness`, `PersistencePipelineScope`, `NetTestHelpers`, `EntityCleanup` and one `TestMulti`. - **UOContent.Tests:** `TimerWheelScope`, which also holds one wraparound-safe `RunFor`/`RunUntil`; `AiTestStubs`, which merges six walker copies and five identical creature stubs; `MobileTestHarness`, `CommandTestHarness` and `TempDirectory`. Dead oracle packet classes are removed. ## Cost | Test | Before | After | |---|---|---| | `VirtualSerialTests` | 1.57s | 2ms (starts near the wrap via reflection instead of drawing ~17.9M serials) | | Event scheduler recurrence loop | 473ms | 1ms | | CrowdSec drain | 517ms | 16ms (event-driven instead of a fixed 500ms wait) | | AuthId tests | 248ms | 99ms (SHA2 except the two GameLogin tests) | | Container cap tests | 5,000 items | 3,449 / 3,277 (one past each protocol cap) | | Bulk removal | 100k children | 20k children | | OPL hash distribution | 60k builds | 10k builds | ## Shard-tuning decoupling - AI assertions read `ReacquireDelay` and `FollowMoveSpeed` instead of hard-coding production tuning. - The guard friendly-fire test uses an `AI_Mage` stub instead of WhiteWyrm. - Argon2 assertions pin the `argon2id` variant and `v=19` but read the cost parameters from the configured hasher. ## Tests | Run | Server.Tests | UOContent.Tests | |---|---|---| | With client files | 812 pass | 1,123 pass | | Without client files (CI simulation) | 800 pass, 12 skip | 1,021 pass, 102 skip | - The UOContent fixture reads `MODERNUO_TEST_DATA_DIR`; Server.Tests reads `MODERNUO_CLIENT_PATH`. - The 15 new UOContent skips are the map-dependent guards above. - Total run time with client files is about 5s, down from about 8s.
This commit is contained in:
parent
79f736aa83
commit
00134cac33
135 changed files with 3164 additions and 4020 deletions
42
Projects/UOContent.Tests/Helpers/AiTestStubs.cs
Normal file
42
Projects/UOContent.Tests/Helpers/AiTestStubs.cs
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
using Server.Mobiles;
|
||||
|
||||
namespace Server.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// A plain <see cref="Mobile"/>: walker, target or bystander. Deriving straight from Mobile rather
|
||||
/// than BaseCreature is the point: MovementImpl sees no creature capabilities (no swim, no fly, no
|
||||
/// door-opening), which is exactly the walker the step cache bakes for.
|
||||
/// </summary>
|
||||
public sealed class WalkerStub : Mobile
|
||||
{
|
||||
public WalkerStub() => Body = 0xC9;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// A BaseCreature built through the Serial constructor, which skips the NPCSpeeds lookup and
|
||||
/// leaves AIObject unset: call <see cref="Mobile.DefaultMobileInit"/> and attach an AI by hand.
|
||||
/// </summary>
|
||||
public sealed class BareCreatureStub : BaseCreature
|
||||
{
|
||||
public BareCreatureStub(Serial serial) : base(serial) => Body = 0xC9;
|
||||
}
|
||||
|
||||
public static class TestTiles
|
||||
{
|
||||
/// <summary>
|
||||
/// The first item ID whose tile data is an impassable surface, so a test can wall a cell off
|
||||
/// without pinning a specific graphic. 0 when tile data is not loaded.
|
||||
/// </summary>
|
||||
public static ushort FirstImpassableItemId()
|
||||
{
|
||||
for (ushort id = 1; id < TileData.MaxItemValue; id++)
|
||||
{
|
||||
if (TileData.ItemTable[id].ImpassableSurface)
|
||||
{
|
||||
return id;
|
||||
}
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
40
Projects/UOContent.Tests/Helpers/CommandTestHarness.cs
Normal file
40
Projects/UOContent.Tests/Helpers/CommandTestHarness.cs
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
using System;
|
||||
using System.Collections.Generic;
|
||||
using Server.Commands;
|
||||
using Server.Items;
|
||||
|
||||
namespace Server.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// Shared setup for the generic-command compiler tests: teleporters to run conditions, sorts and
|
||||
/// distincts against, deleted on dispose, and property bindings resolved for reading.
|
||||
/// </summary>
|
||||
internal sealed class CommandTestHarness : IDisposable
|
||||
{
|
||||
private readonly List<Item> _items = [];
|
||||
|
||||
public T Track<T>(T item) where T : Item
|
||||
{
|
||||
_items.Add(item);
|
||||
return item;
|
||||
}
|
||||
|
||||
public SkillTeleporter Teleporter(TextDefinition message) => Track(new SkillTeleporter { Message = message });
|
||||
|
||||
public static Property Bind(Type type, string binding)
|
||||
{
|
||||
var prop = new Property(binding);
|
||||
prop.BindTo(type, PropertyAccess.Read);
|
||||
return prop;
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
for (var i = 0; i < _items.Count; i++)
|
||||
{
|
||||
_items[i].Delete();
|
||||
}
|
||||
|
||||
_items.Clear();
|
||||
}
|
||||
}
|
||||
114
Projects/UOContent.Tests/Helpers/MobileTestHarness.cs
Normal file
114
Projects/UOContent.Tests/Helpers/MobileTestHarness.cs
Normal file
|
|
@ -0,0 +1,114 @@
|
|||
using System;
|
||||
using System.Collections.Generic;
|
||||
using Server.Mobiles;
|
||||
|
||||
namespace Server.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// Owns the mobiles and items a test creates and deletes them on dispose, so a failed assertion
|
||||
/// cannot leave entities registered in the shared world. Hold one per test class instance and
|
||||
/// dispose it from the class's <see cref="IDisposable.Dispose"/>.
|
||||
/// </summary>
|
||||
internal sealed class MobileTestHarness : IDisposable
|
||||
{
|
||||
private readonly List<Mobile> _mobiles = [];
|
||||
private readonly List<Item> _items = [];
|
||||
|
||||
public T Track<T>(T mobile) where T : Mobile
|
||||
{
|
||||
_mobiles.Add(mobile);
|
||||
return mobile;
|
||||
}
|
||||
|
||||
public T TrackItem<T>(T item) where T : Item
|
||||
{
|
||||
_items.Add(item);
|
||||
return item;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// A player registered in the world table, so serialized references to it resolve on load.
|
||||
/// </summary>
|
||||
public PlayerMobile NewPlayer()
|
||||
{
|
||||
var pm = new PlayerMobile(World.NewMobile);
|
||||
pm.DefaultMobileInit();
|
||||
World.AddEntity(pm);
|
||||
return Track(pm);
|
||||
}
|
||||
|
||||
public TestCreature NewCreature() => Track(new TestCreature());
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
for (var i = 0; i < _mobiles.Count; i++)
|
||||
{
|
||||
_mobiles[i].Delete();
|
||||
}
|
||||
|
||||
for (var i = 0; i < _items.Count; i++)
|
||||
{
|
||||
_items[i].Delete();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// A plain melee creature. Its speeds are pinned so tests do not depend on the npc-speeds table.
|
||||
/// </summary>
|
||||
internal class TestCreature : BaseCreature
|
||||
{
|
||||
public TestCreature() : base(AIType.AI_Melee) => Body = 0xC9;
|
||||
|
||||
public TestCreature(Serial serial) : base(serial) => Body = 0xC9;
|
||||
|
||||
public DateTime SummonEndValue => SummonEnd;
|
||||
|
||||
public override void GetSpeeds(out double activeSpeed, out double passiveSpeed)
|
||||
{
|
||||
activeSpeed = 0.3;
|
||||
passiveSpeed = 0.6;
|
||||
}
|
||||
|
||||
public override void GetMoveSpeeds(out double activeMoveSpeed, out double passiveMoveSpeed)
|
||||
{
|
||||
activeMoveSpeed = 0.6;
|
||||
passiveMoveSpeed = 1.2;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// A vendor with no outfit and pinned speeds. Subclasses stock it by overriding
|
||||
/// <see cref="AddSBInfos"/>, which runs from the base constructor.
|
||||
/// </summary>
|
||||
internal class TestVendor : BaseVendor
|
||||
{
|
||||
// Initialized before the base constructor calls InitSBInfo.
|
||||
private readonly List<SBInfo> _sbInfos = [];
|
||||
|
||||
public TestVendor() : base("the stub")
|
||||
{
|
||||
}
|
||||
|
||||
public TestVendor(Serial serial) : base(serial)
|
||||
{
|
||||
}
|
||||
|
||||
protected override List<SBInfo> SBInfos => _sbInfos;
|
||||
|
||||
public override void InitSBInfo() => AddSBInfos(_sbInfos);
|
||||
|
||||
protected virtual void AddSBInfos(List<SBInfo> sbInfos)
|
||||
{
|
||||
}
|
||||
|
||||
public override void InitOutfit()
|
||||
{
|
||||
}
|
||||
|
||||
public override void GetSpeeds(out double activeSpeed, out double passiveSpeed)
|
||||
{
|
||||
activeSpeed = 0.3;
|
||||
passiveSpeed = 0.6;
|
||||
}
|
||||
}
|
||||
45
Projects/UOContent.Tests/Helpers/StepCacheStateScope.cs
Normal file
45
Projects/UOContent.Tests/Helpers/StepCacheStateScope.cs
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
using System;
|
||||
using Server.Engines.Pathing.Cache;
|
||||
using Server.Systems.FeatureFlags;
|
||||
|
||||
namespace Server.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// Snapshots the pathfinding cache's tuning knobs and feature flag, and restores them on dispose
|
||||
/// along with empty caches. StepCache and MultiMaskCache are process-wide singletons and
|
||||
/// <see cref="StepCache.Clear"/> leaves the knobs alone, so a test that tunes one would otherwise
|
||||
/// leak it into every test that runs after it.
|
||||
/// </summary>
|
||||
internal sealed class StepCacheStateScope : IDisposable
|
||||
{
|
||||
private readonly int _missPromotionThreshold;
|
||||
private readonly uint _missPromotionWindowMs;
|
||||
private readonly int _maxResidentChunks;
|
||||
private readonly bool _preloadOnLazyOpen;
|
||||
private readonly bool _cacheEnabled;
|
||||
|
||||
public StepCacheStateScope()
|
||||
{
|
||||
var cache = StepCache.Instance;
|
||||
_missPromotionThreshold = cache.MissPromotionThreshold;
|
||||
_missPromotionWindowMs = cache.MissPromotionWindowMs;
|
||||
_maxResidentChunks = cache.MaxResidentChunks;
|
||||
_preloadOnLazyOpen = cache.PreloadOnLazyOpen;
|
||||
_cacheEnabled = ContentFeatureFlags.BitmapPathfindingCache;
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
var cache = StepCache.Instance;
|
||||
|
||||
// Clear first: it closes any lazy reader a test opened under the knobs it set.
|
||||
cache.Clear();
|
||||
MultiMaskCache.Instance.Clear();
|
||||
|
||||
cache.MissPromotionThreshold = _missPromotionThreshold;
|
||||
cache.MissPromotionWindowMs = _missPromotionWindowMs;
|
||||
cache.MaxResidentChunks = _maxResidentChunks;
|
||||
cache.PreloadOnLazyOpen = _preloadOnLazyOpen;
|
||||
ContentFeatureFlags.BitmapPathfindingCache = _cacheEnabled;
|
||||
}
|
||||
}
|
||||
44
Projects/UOContent.Tests/Helpers/TempDirectory.cs
Normal file
44
Projects/UOContent.Tests/Helpers/TempDirectory.cs
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
using System;
|
||||
using System.IO;
|
||||
|
||||
namespace Server.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// A uniquely named directory under the system temp path, deleted with its contents on dispose so a
|
||||
/// failing assertion cannot leave files behind.
|
||||
/// </summary>
|
||||
internal sealed class TempDirectory : IDisposable
|
||||
{
|
||||
public TempDirectory(string prefix = "modernuo-test")
|
||||
{
|
||||
Path = System.IO.Path.Combine(System.IO.Path.GetTempPath(), $"{prefix}-{Guid.NewGuid():N}");
|
||||
Directory.CreateDirectory(Path);
|
||||
}
|
||||
|
||||
public string Path { get; }
|
||||
|
||||
public string Combine(string relativePath) => System.IO.Path.Combine(Path, relativePath);
|
||||
|
||||
/// <summary>Writes <paramref name="content"/> to <paramref name="relativePath"/> and returns its full path.</summary>
|
||||
public string WriteFile(string relativePath, string content)
|
||||
{
|
||||
var path = Combine(relativePath);
|
||||
File.WriteAllText(path, content);
|
||||
return path;
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
try
|
||||
{
|
||||
if (Directory.Exists(Path))
|
||||
{
|
||||
Directory.Delete(Path, true);
|
||||
}
|
||||
}
|
||||
catch (IOException)
|
||||
{
|
||||
// A handle still open on Windows; the OS temp cleaner reclaims it.
|
||||
}
|
||||
}
|
||||
}
|
||||
140
Projects/UOContent.Tests/Helpers/TimerWheelScope.cs
Normal file
140
Projects/UOContent.Tests/Helpers/TimerWheelScope.cs
Normal file
|
|
@ -0,0 +1,140 @@
|
|||
using System;
|
||||
using System.Reflection;
|
||||
|
||||
namespace Server.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// Gives a test its own simulated clock and an empty timer wheel, and puts the process-wide ones
|
||||
/// back on dispose. Core's tick, Core.Now and the wheel are statics shared by every test in the
|
||||
/// host, so a test that resets them without restoring hands its clock to whatever runs next.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Timers started inside the scope are stopped on dispose; timers that were scheduled before it
|
||||
/// resume on the restored wheel.
|
||||
/// </remarks>
|
||||
internal sealed class TimerWheelScope : IDisposable
|
||||
{
|
||||
private const BindingFlags PrivateStatic = BindingFlags.NonPublic | BindingFlags.Static;
|
||||
|
||||
private static readonly FieldInfo _ringsField = GetTimerField("_rings");
|
||||
private static readonly FieldInfo _ringIndexesField = GetTimerField("_ringIndexes");
|
||||
private static readonly FieldInfo _lastTickTurnedField = GetTimerField("_lastTickTurned");
|
||||
|
||||
private readonly long _savedTick;
|
||||
private readonly DateTime _savedNow;
|
||||
private readonly Timer[][] _savedRings;
|
||||
private readonly int[] _savedRingIndexes;
|
||||
private readonly long _savedLastTickTurned;
|
||||
private bool _disposed;
|
||||
|
||||
public TimerWheelScope(long startTick = 0)
|
||||
{
|
||||
_savedTick = Core._tickCount;
|
||||
_savedNow = Core._now;
|
||||
_savedRings = (Timer[][])Rings.Clone();
|
||||
_savedRingIndexes = (int[])RingIndexes.Clone();
|
||||
_savedLastTickTurned = (long)_lastTickTurnedField.GetValue(null)!;
|
||||
|
||||
Core._tickCount = startTick;
|
||||
Timer.Init(startTick);
|
||||
}
|
||||
|
||||
private static Timer[][] Rings => (Timer[][])_ringsField.GetValue(null)!;
|
||||
|
||||
private static int[] RingIndexes => (int[])_ringIndexesField.GetValue(null)!;
|
||||
|
||||
/// <summary>The wheel's tick rate: one turn per call keeps it in lockstep with Core.TickCount.</summary>
|
||||
public static int Step => Timer.TickRate;
|
||||
|
||||
/// <summary>Advances the clock by <paramref name="ms"/>, turning the wheel every step.</summary>
|
||||
public static void RunFor(long ms)
|
||||
{
|
||||
var deadline = Core._tickCount + ms;
|
||||
|
||||
while (Core._tickCount - deadline < 0)
|
||||
{
|
||||
Core._tickCount += Step;
|
||||
Timer.Slice(Core._tickCount);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Advances the clock step by step until <paramref name="condition"/> holds or
|
||||
/// <paramref name="maxMs"/> has passed. Returns the condition's final value.
|
||||
/// </summary>
|
||||
public static bool RunUntil(Func<bool> condition, long maxMs)
|
||||
{
|
||||
var deadline = Core._tickCount + maxMs;
|
||||
|
||||
while (Core._tickCount - deadline < 0)
|
||||
{
|
||||
if (condition())
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
Core._tickCount += Step;
|
||||
Timer.Slice(Core._tickCount);
|
||||
}
|
||||
|
||||
return condition();
|
||||
}
|
||||
|
||||
/// <summary>Jumps the tick and Core.Now forward together, then fires everything that came due.</summary>
|
||||
public static void Advance(TimeSpan time)
|
||||
{
|
||||
Core._now += time;
|
||||
Core._tickCount += (long)time.TotalMilliseconds;
|
||||
Timer.Slice(Core._tickCount);
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
if (_disposed)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
_disposed = true;
|
||||
StopAll(Rings);
|
||||
|
||||
var rings = Rings;
|
||||
for (var i = 0; i < rings.Length; i++)
|
||||
{
|
||||
rings[i] = _savedRings[i];
|
||||
}
|
||||
|
||||
Array.Copy(_savedRingIndexes, RingIndexes, _savedRingIndexes.Length);
|
||||
_lastTickTurnedField.SetValue(null, _savedLastTickTurned);
|
||||
|
||||
Core._tickCount = _savedTick;
|
||||
Core._now = _savedNow;
|
||||
}
|
||||
|
||||
// Stop() unlinks the slot's head and promotes the next timer, so draining heads empties a slot.
|
||||
private static void StopAll(Timer[][] rings)
|
||||
{
|
||||
for (var i = 0; i < rings.Length; i++)
|
||||
{
|
||||
var ring = rings[i];
|
||||
for (var slot = 0; slot < ring.Length; slot++)
|
||||
{
|
||||
Timer head;
|
||||
while ((head = ring[slot]) != null)
|
||||
{
|
||||
head.Stop();
|
||||
|
||||
if (ring[slot] == head)
|
||||
{
|
||||
// A head that was already stopped never unlinks itself.
|
||||
ring[slot] = null;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private static FieldInfo GetTimerField(string name) =>
|
||||
typeof(Timer).GetField(name, PrivateStatic)
|
||||
?? throw new InvalidOperationException($"Timer.{name} not found via reflection; the timer wheel was refactored.");
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue