#nullable enable
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Content.Shared.Coordinates;
using Content.Shared.Sound.Components;
using NUnit.Framework;
using Robust.Shared.GameObjects;
using Robust.Shared.IoC;
using Robust.Shared.Map;
using Robust.Shared.Map.Components;
using Robust.Shared.Physics;
using Robust.Shared.Prototypes;
using Robust.Shared.Serialization;
using Robust.Shared.Serialization.Manager;
using Robust.Shared.Serialization.Markdown;
using Robust.Shared.Serialization.Markdown.Mapping;
using Robust.Shared.Serialization.Markdown.Validation;
using Robust.Shared.Serialization.Markdown.Value;
using Robust.Shared.Serialization.TypeSerializers.Interfaces;
using Robust.Shared.Timing;
namespace Content.IntegrationTests.Tests;
///
/// This test ensure that when an entity prototype is spawned into an un-initialized map, its component data is not
/// modified during init. I.e., when the entity is saved to the map, its data is simply the default prototype data (ignoring transform component).
///
///
/// If you are here because this test is failing on your PR, then one easy way of figuring out how to fix the prototype is to just
/// spawn it into a new empty map and seeing what the map yml looks like.
///
[TestFixture]
public sealed class PrototypeSaveTest
{
private readonly HashSet _ignoredPrototypes = new()
{
"Singularity", // physics collision uses "AllMask" (-1). The flag serializer currently fails to save this because this features un-named bits.
"constructionghost",
// Don't add to this list unless you have a good reason
// Or it is just temporary because tests stopped working and now master has too many broken entities.
};
[Test]
public async Task UninitializedSaveTest()
{
// Apparently SpawnTest fails to clean up properly. Due to the similarities, I'll assume this also fails.
await using var pairTracker = await PoolManager.GetServerClient(new PoolSettings { NoClient = true, Dirty = true, Destructive = true });
var server = pairTracker.Pair.Server;
var mapManager = server.ResolveDependency();
var entityMan = server.ResolveDependency();
var prototypeMan = server.ResolveDependency();
var tileDefinitionManager = server.ResolveDependency();
var seriMan = server.ResolveDependency();
var compFact = server.ResolveDependency();
var prototypes = new List();
MapGridComponent grid = default!;
EntityUid uid;
MapId mapId = default;
//Build up test environment
await server.WaitPost(() =>
{
// Create a one tile grid to stave off the grid 0 monsters
mapId = mapManager.CreateMap();
mapManager.AddUninitializedMap(mapId);
grid = mapManager.CreateGrid(mapId);
var tileDefinition = tileDefinitionManager["FloorSteel"]; // Wires n such disable ambiance while under the floor
var tile = new Tile(tileDefinition.TileId);
var coordinates = grid.ToCoordinates();
grid.SetTile(coordinates, tile);
});
await server.WaitRunTicks(5);
//Generate list of non-abstract prototypes to test
foreach (var prototype in prototypeMan.EnumeratePrototypes())
{
if (prototype.Abstract)
continue;
// Currently mobs and such can't be serialized, but they aren't flagged as serializable anyways.
if (!prototype.MapSavable)
continue;
if (_ignoredPrototypes.Contains(prototype.ID))
continue;
if (prototype.SetSuffix == "DEBUG")
continue;
prototypes.Add(prototype);
}
var context = new TestEntityUidContext();
await server.WaitAssertion(() =>
{
Assert.That(!mapManager.IsMapInitialized(mapId));
var testLocation = grid.ToCoordinates();
Assert.Multiple(() =>
{
//Iterate list of prototypes to spawn
foreach (var prototype in prototypes)
{
uid = entityMan.SpawnEntity(prototype.ID, testLocation);
context.Prototype = prototype;
// get default prototype data
Dictionary protoData = new();
try
{
context.WritingReadingPrototypes = true;
foreach (var (compType, comp) in prototype.Components)
{
context.WritingComponent = compType;
protoData.Add(compType, seriMan.WriteValueAs(comp.Component.GetType(), comp.Component, alwaysWrite: true, context: context));
}
context.WritingComponent = string.Empty;
context.WritingReadingPrototypes = false;
}
catch (Exception e)
{
Assert.Fail($"Failed to convert prototype {prototype.ID} into yaml. Exception: {e.Message}");
continue;
}
var comps = new HashSet(entityMan.GetComponents(uid));
var compNames = new HashSet(comps.Count);
foreach (var component in comps)
{
var compType = component.GetType();
var compName = compFact.GetComponentName(compType);
compNames.Add(compName);
if (compType == typeof(MetaDataComponent) || compType == typeof(TransformComponent) || compType == typeof(FixturesComponent))
continue;
MappingDataNode compMapping;
try
{
context.WritingComponent = compName;
compMapping = seriMan.WriteValueAs(compType, component, alwaysWrite: true, context: context);
}
catch (Exception e)
{
Assert.Fail($"Failed to serialize {compName} component of entity prototype {prototype.ID}. Exception: {e.Message}");
continue;
}
if (protoData.TryGetValue(compName, out var protoMapping))
{
var diff = compMapping.Except(protoMapping);
if (diff != null && diff.Children.Count != 0)
{
var modComps = string.Join(",", diff.Keys.Select(x => x.ToString()));
Assert.Fail($"Prototype {prototype.ID} modifies component on spawn: {compName}. Modified fields: {modComps}");
}
}
else
{
Assert.Fail($"Prototype {prototype.ID} gains a component on spawn: {compName}");
}
}
// An entity may also remove components on init -> check no components are missing.
foreach (var (compType, comp) in prototype.Components)
{
Assert.That(compNames.Contains(compType), $"Prototype {prototype.ID} removes component {compType} on spawn.");
}
if (!entityMan.Deleted(uid))
entityMan.DeleteEntity(uid);
}
});
});
await pairTracker.CleanReturnAsync();
}
private sealed class TestEntityUidContext : ISerializationContext,
ITypeSerializer
{
public SerializationManager.SerializerProvider SerializerProvider { get; }
public bool WritingReadingPrototypes { get; set; }
public string WritingComponent = string.Empty;
public EntityPrototype Prototype = default!;
public TestEntityUidContext()
{
SerializerProvider = new();
SerializerProvider.RegisterSerializer(this);
}
ValidationNode ITypeValidator.Validate(ISerializationManager serializationManager,
ValueDataNode node, IDependencyCollection dependencies, ISerializationContext? context)
{
return new ValidatedValueNode(node);
}
public DataNode Write(ISerializationManager serializationManager, EntityUid value,
IDependencyCollection dependencies, bool alwaysWrite = false,
ISerializationContext? context = null)
{
if (WritingComponent != "Transform" && !Prototype.NoSpawn)
{
// Maybe this will be necessary in the future, but at the moment it just indicates that there is some
// issue, like a non-nullable entityUid data-field. If a component MUST have an entity uid to work with,
// then the prototype very likely has to be a no-spawn entity that is never meant to be directly spawned.
Assert.Fail($"Uninitialized entities should not be saving entity Uids. Component: {WritingComponent}. Prototype: {Prototype.ID}");
}
return new ValueDataNode(value.ToString());
}
EntityUid ITypeReader.Read(ISerializationManager serializationManager,
ValueDataNode node,
IDependencyCollection dependencies,
SerializationHookContext hookCtx,
ISerializationContext? context, ISerializationManager.InstantiationDelegate? instanceProvider)
{
return EntityUid.Invalid;
}
}
}