using System.Collections.Generic; using System.IO; using System.Linq; using System.Text.RegularExpressions; using Content.Server.Administration.Systems; using Content.Server.GameTicking; using Content.Server.Maps; using Content.Server.Shuttles.Components; using Content.Server.Shuttles.Systems; using Content.Server.Spawners.Components; using Content.Server.Station.Components; using Content.Shared.CCVar; using Content.Shared.Roles; using Robust.Shared.Configuration; using Robust.Shared.ContentPack; using Robust.Shared.GameObjects; using Robust.Shared.Map; using Robust.Shared.Map.Components; using Robust.Shared.Prototypes; using Content.Shared.Station.Components; using Robust.Shared.EntitySerialization; using Robust.Shared.EntitySerialization.Systems; using Robust.Shared.IoC; using Robust.Shared.Utility; using YamlDotNet.RepresentationModel; using Robust.Shared.Map.Events; namespace Content.IntegrationTests.Tests { [TestFixture] public sealed class PostMapInitTest { private const bool SkipTestMaps = true; private const string TestMapsPath = "/Maps/Test/"; private static readonly string[] NoSpawnMaps = { "CentComm", "Dart" }; private static readonly string[] Grids = { "/Maps/centcomm.yml", AdminTestArenaSystem.ArenaMapPath }; /// /// A dictionary linking maps to collections of entity prototype ids that should be exempt from "DoNotMap" restrictions. /// /// /// This declares that the listed entity prototypes are allowed to be present on the map /// despite being categorized as "DoNotMap", while any unlisted prototypes will still /// cause the test to fail. /// private static readonly Dictionary> DoNotMapWhitelistSpecific = new() { {"/Maps/bagel.yml", ["RubberStampMime"]}, {"/Maps/reach.yml", ["HandheldCrewMonitor"]}, {"/Maps/Shuttles/ShuttleEvent/honki.yml", ["GoldenBikeHorn", "RubberStampClown"]}, {"/Maps/Shuttles/ShuttleEvent/syndie_evacpod.yml", ["RubberStampSyndicate"]}, {"/Maps/Shuttles/ShuttleEvent/cruiser.yml", ["ShuttleGunPerforator"]}, {"/Maps/Shuttles/ShuttleEvent/instigator.yml", ["ShuttleGunFriendship"]}, }; /// /// Maps listed here are given blanket freedom to contain "DoNotMap" entities. Use sparingly. /// /// /// It is also possible to whitelist entire directories here. For example, adding /// "/Maps/Shuttles/**" will whitelist all shuttle maps. /// private static readonly string[] DoNotMapWhitelist = { "/Maps/centcomm.yml", "/Maps/Shuttles/AdminSpawn/**" // admin gaming }; /// /// Converts the above globs into regex so your eyes dont bleed trying to add filepaths. /// private static readonly Regex[] DoNotMapWhiteListRegexes = DoNotMapWhitelist .Select(glob => new Regex(GlobToRegex(glob), RegexOptions.IgnoreCase | RegexOptions.Compiled)) .ToArray(); private static readonly string[] GameMaps = { "Dev", "TestTeg", "Fland", "Packed", "Bagel", "CentComm", "Box", "Marathon", "MeteorArena", "Saltern", "Reach", "Oasis", "Amber", "Plasma", "Elkridge", "Relic", "dm01-entryway", "Exo", }; private static readonly ProtoId DoNotMapCategory = "DoNotMap"; /// /// Asserts that specific files have been saved as grids and not maps. /// [Test, TestCaseSource(nameof(Grids))] public async Task GridsLoadableTest(string mapFile) { await using var pair = await PoolManager.GetServerClient(); var server = pair.Server; var entManager = server.ResolveDependency(); var mapLoader = entManager.System(); var mapSystem = entManager.System(); var cfg = server.ResolveDependency(); Assert.That(cfg.GetCVar(CCVars.GridFill), Is.False); var path = new ResPath(mapFile); await server.WaitPost(() => { mapSystem.CreateMap(out var mapId); try { Assert.That(mapLoader.TryLoadGrid(mapId, path, out var grid)); } catch (Exception ex) { throw new Exception($"Failed to load map {mapFile}, was it saved as a map instead of a grid?", ex); } mapSystem.DeleteMap(mapId); }); await server.WaitRunTicks(1); await pair.CleanReturnAsync(); } /// /// Asserts that shuttles are loadable and have been saved as grids and not maps. /// [Test] public async Task ShuttlesLoadableTest() { await using var pair = await PoolManager.GetServerClient(); var server = pair.Server; var entManager = server.ResolveDependency(); var resMan = server.ResolveDependency(); var mapLoader = entManager.System(); var mapSystem = entManager.System(); var cfg = server.ResolveDependency(); Assert.That(cfg.GetCVar(CCVars.GridFill), Is.False); var shuttleFolder = new ResPath("/Maps/Shuttles"); var shuttles = resMan .ContentFindFiles(shuttleFolder) .Where(filePath => filePath.Extension == "yml" && !filePath.Filename.StartsWith(".", StringComparison.Ordinal)) .ToArray(); await server.WaitPost(() => { Assert.Multiple(() => { foreach (var path in shuttles) { mapSystem.CreateMap(out var mapId); try { Assert.That(mapLoader.TryLoadGrid(mapId, path, out _), $"Failed to load shuttle {path}, was it saved as a map instead of a grid?"); } catch (Exception ex) { throw new Exception($"Failed to load shuttle {path}, was it saved as a map instead of a grid?", ex); } mapSystem.DeleteMap(mapId); } }); }); await server.WaitRunTicks(1); await pair.CleanReturnAsync(); } [Test] public async Task NoSavedPostMapInitTest() { await using var pair = await PoolManager.GetServerClient(); var server = pair.Server; var resourceManager = server.ResolveDependency(); var protoManager = server.ResolveDependency(); var loader = server.System(); var mapFolder = new ResPath("/Maps"); var maps = resourceManager .ContentFindFiles(mapFolder) .Where(filePath => filePath.Extension == "yml" && !filePath.Filename.StartsWith(".", StringComparison.Ordinal)) .ToArray(); var v7Maps = new List(); foreach (var map in maps) { var rootedPath = map.ToRootedPath(); // ReSharper disable once RedundantLogicalConditionalExpressionOperand if (SkipTestMaps && rootedPath.ToString().StartsWith(TestMapsPath, StringComparison.Ordinal)) { continue; } if (!resourceManager.TryContentFileRead(rootedPath, out var fileStream)) { Assert.Fail($"Map not found: {rootedPath}"); } using var reader = new StreamReader(fileStream); var yamlStream = new YamlStream(); yamlStream.Load(reader); var root = yamlStream.Documents[0].RootNode; var meta = root["meta"]; var version = meta["format"].AsInt(); // TODO MAP TESTS // Move this to some separate test? CheckDoNotMap(map, root, protoManager); if (version >= 7) { v7Maps.Add(map); continue; } var postMapInit = meta["postmapinit"].AsBool(); Assert.That(postMapInit, Is.False, $"Map {map.Filename} was saved postmapinit"); } var deps = server.ResolveDependency().DependencyCollection; var ev = new BeforeEntityReadEvent(); server.EntMan.EventBus.RaiseEvent(EventSource.Local, ev); foreach (var map in v7Maps) { Assert.That(IsPreInit(map, loader, deps, ev.RenamedPrototypes, ev.DeletedPrototypes)); } // Check that the test actually does manage to catch post-init maps and isn't just blindly passing everything. // To that end, create a new post-init map and try verify it. var mapSys = server.System(); MapId id = default; await server.WaitPost(() => mapSys.CreateMap(out id, runMapInit: false)); await server.WaitPost(() => server.EntMan.Spawn(null, new MapCoordinates(0, 0, id))); // First check that a pre-init version passes var path = new ResPath($"{nameof(NoSavedPostMapInitTest)}.yml"); Assert.That(loader.TrySaveMap(id, path)); Assert.That(IsPreInit(path, loader, deps, ev.RenamedPrototypes, ev.DeletedPrototypes)); // and the post-init version fails. await server.WaitPost(() => mapSys.InitializeMap(id)); Assert.That(loader.TrySaveMap(id, path)); Assert.That(IsPreInit(path, loader, deps, ev.RenamedPrototypes, ev.DeletedPrototypes), Is.False); await pair.CleanReturnAsync(); } private bool IsWhitelistedForMap(EntProtoId protoId, ResPath map) { if (!DoNotMapWhitelistSpecific.TryGetValue(map.ToString(), out var allowedProtos)) return false; return allowedProtos.Contains(protoId); } /// /// Check that maps do not have any entities that belong to the DoNotMap entity category /// private void CheckDoNotMap(ResPath map, YamlNode node, IPrototypeManager protoManager) { foreach (var regex in DoNotMapWhiteListRegexes) { if (regex.IsMatch(map.ToString())) return; } var yamlEntities = node["entities"]; var dnmCategory = protoManager.Index(DoNotMapCategory); // Make a set containing all the specific whitelisted proto ids for this map HashSet unusedExemptions = DoNotMapWhitelistSpecific.TryGetValue(map.ToString(), out var exemptions) ? new(exemptions) : []; Assert.Multiple(() => { foreach (var yamlEntity in (YamlSequenceNode)yamlEntities) { var protoId = yamlEntity["proto"].AsString(); // This doesn't properly handle prototype migrations, but thats not a significant issue. if (!protoManager.TryIndex(protoId, out var proto)) continue; Assert.That(!proto.Categories.Contains(dnmCategory) || IsWhitelistedForMap(protoId, map), $"\nMap {map} contains entities in the DO NOT MAP category ({proto.Name})"); // The proto id is used on this map, so remove it from the set unusedExemptions.Remove(protoId); } }); // If there are any proto ids left, they must not have been used in the map! Assert.That(unusedExemptions, Is.Empty, $"Map {map} has DO NOT MAP entities whitelisted that are not present in the map: {string.Join(", ", unusedExemptions)}"); } private bool IsPreInit(ResPath map, MapLoaderSystem loader, IDependencyCollection deps, Dictionary renamedPrototypes, HashSet deletedPrototypes) { if (!loader.TryReadFile(map, out var data)) { Assert.Fail($"Failed to read {map}"); return false; } var reader = new EntityDeserializer(deps, data, DeserializationOptions.Default, renamedPrototypes, deletedPrototypes); if (!reader.TryProcessData()) { Assert.Fail($"Failed to process {map}"); return false; } foreach (var mapId in reader.MapYamlIds) { var mapData = reader.YamlEntities[mapId]; if (mapData.PostInit) return false; } return true; } [Test, TestCaseSource(nameof(GameMaps))] public async Task GameMapsLoadableTest(string mapProto) { await using var pair = await PoolManager.GetServerClient(new PoolSettings { Dirty = true // Stations spawn a bunch of nullspace entities and maps like centcomm. }); var server = pair.Server; var mapManager = server.ResolveDependency(); var entManager = server.ResolveDependency(); var mapLoader = entManager.System(); var mapSystem = entManager.System(); var protoManager = server.ResolveDependency(); var ticker = entManager.EntitySysManager.GetEntitySystem(); var shuttleSystem = entManager.EntitySysManager.GetEntitySystem(); var cfg = server.ResolveDependency(); Assert.That(cfg.GetCVar(CCVars.GridFill), Is.False); await server.WaitPost(() => { MapId mapId; try { var opts = DeserializationOptions.Default with { InitializeMaps = true }; ticker.LoadGameMap(protoManager.Index(mapProto), out mapId, opts); } catch (Exception ex) { throw new Exception($"Failed to load map {mapProto}", ex); } mapSystem.CreateMap(out var shuttleMap); var largest = 0f; EntityUid? targetGrid = null; var memberQuery = entManager.GetEntityQuery(); var grids = mapManager.GetAllGrids(mapId).ToList(); var gridUids = grids.Select(o => o.Owner).ToList(); targetGrid = gridUids.First(); foreach (var grid in grids) { var gridEnt = grid.Owner; if (!memberQuery.HasComponent(gridEnt)) continue; var area = grid.Comp.LocalAABB.Width * grid.Comp.LocalAABB.Height; if (area > largest) { largest = area; targetGrid = gridEnt; } } // Test shuttle can dock. // This is done inside gamemap test because loading the map takes ages and we already have it. var station = entManager.GetComponent(targetGrid!.Value).Station; if (entManager.TryGetComponent(station, out var stationEvac)) { var shuttlePath = stationEvac.EmergencyShuttlePath; Assert.That(mapLoader.TryLoadGrid(shuttleMap, shuttlePath, out var shuttle), $"Failed to load {shuttlePath}"); Assert.That( shuttleSystem.TryFTLDock(shuttle!.Value.Owner, entManager.GetComponent(shuttle!.Value.Owner), targetGrid.Value), $"Unable to dock {shuttlePath} to {mapProto}"); } mapSystem.DeleteMap(shuttleMap); if (entManager.HasComponent(station)) { // Test that the map has valid latejoin spawn points or container spawn points if (!NoSpawnMaps.Contains(mapProto)) { var lateSpawns = 0; lateSpawns += GetCountLateSpawn(gridUids, entManager); lateSpawns += GetCountLateSpawn(gridUids, entManager); Assert.That(lateSpawns, Is.GreaterThan(0), $"Found no latejoin spawn points on {mapProto}"); } // Test all availableJobs have spawnPoints // This is done inside gamemap test because loading the map takes ages and we already have it. var comp = entManager.GetComponent(station); var jobs = new HashSet>(comp.SetupAvailableJobs.Keys); var spawnPoints = entManager.EntityQuery() .Where(x => x.SpawnType == SpawnPointType.Job && x.Job != null) .Select(x => x.Job.Value); jobs.ExceptWith(spawnPoints); spawnPoints = entManager.EntityQuery() .Where(x => x.SpawnType is SpawnPointType.Job or SpawnPointType.Unset && x.Job != null) .Select(x => x.Job.Value); jobs.ExceptWith(spawnPoints); Assert.That(jobs, Is.Empty, $"There is no spawnpoints for {string.Join(", ", jobs)} on {mapProto}."); } try { mapSystem.DeleteMap(mapId); } catch (Exception ex) { throw new Exception($"Failed to delete map {mapProto}", ex); } }); await server.WaitRunTicks(1); await pair.CleanReturnAsync(); } private static int GetCountLateSpawn(List gridUids, IEntityManager entManager) where T : ISpawnPoint, IComponent { var resultCount = 0; var queryPoint = entManager.AllEntityQueryEnumerator(); #nullable enable while (queryPoint.MoveNext(out T? comp, out var xform)) { var spawner = (ISpawnPoint)comp; if (spawner.SpawnType is not SpawnPointType.LateJoin || xform.GridUid == null || !gridUids.Contains(xform.GridUid.Value)) { continue; } #nullable disable resultCount++; break; } return resultCount; } [Test] public async Task AllMapsTested() { await using var pair = await PoolManager.GetServerClient(); var server = pair.Server; var protoMan = server.ResolveDependency(); var gameMaps = protoMan.EnumeratePrototypes() .Where(x => !pair.IsTestPrototype(x)) .Select(x => x.ID) .ToHashSet(); Assert.That(gameMaps.Remove(PoolManager.TestMap)); Assert.That(gameMaps, Is.EquivalentTo(GameMaps.ToHashSet()), "Game map prototype missing from test cases."); await pair.CleanReturnAsync(); } [Test] public async Task NonGameMapsLoadableTest() { await using var pair = await PoolManager.GetServerClient(); var server = pair.Server; var mapLoader = server.ResolveDependency().GetEntitySystem(); var resourceManager = server.ResolveDependency(); var protoManager = server.ResolveDependency(); var cfg = server.ResolveDependency(); Assert.That(cfg.GetCVar(CCVars.GridFill), Is.False); var gameMaps = protoManager.EnumeratePrototypes().Select(o => o.MapPath).ToHashSet(); var mapFolder = new ResPath("/Maps"); var maps = resourceManager .ContentFindFiles(mapFolder) .Where(filePath => filePath.Extension == "yml" && !filePath.Filename.StartsWith(".", StringComparison.Ordinal)) .ToArray(); var mapPaths = new List(); foreach (var map in maps) { if (gameMaps.Contains(map)) continue; var rootedPath = map.ToRootedPath(); if (SkipTestMaps && rootedPath.ToString().StartsWith(TestMapsPath, StringComparison.Ordinal)) { continue; } mapPaths.Add(rootedPath); } await server.WaitPost(() => { Assert.Multiple(() => { // This bunch of files contains a random mixture of both map and grid files. // TODO MAPPING organize files var opts = MapLoadOptions.Default with { DeserializationOptions = DeserializationOptions.Default with { InitializeMaps = true, LogOrphanedGrids = false } }; HashSet> maps; foreach (var path in mapPaths) { try { Assert.That(mapLoader.TryLoadGeneric(path, out maps, out _, opts)); } catch (Exception ex) { throw new Exception($"Failed to load map {path}", ex); } try { foreach (var map in maps) { server.EntMan.DeleteEntity(map); } } catch (Exception ex) { throw new Exception($"Failed to delete map {path}", ex); } } }); }); await server.WaitRunTicks(1); await pair.CleanReturnAsync(); } /// /// Lets us the convert the filepaths to regex without eyeglaze trying to add new paths. /// private static string GlobToRegex(string glob) { var regex = Regex.Escape(glob) .Replace(@"\*\*", "**") // replace ** .Replace(@"\*", "*") // replace * .Replace("**", ".*") // ** → match across folders .Replace("*", @"[^/]*") // * → match within a single folder .Replace(@"\?", "."); // ? → any single character return $"^{regex}$"; } } }