CatStation/Content.IntegrationTests/Tests/Materials/ReclaimerLoopTest.cs

using Content.IntegrationTests.Fixtures.Attributes;
using Content.IntegrationTests.Tests.Interaction;
using Content.IntegrationTests.Utility;
using Content.Server.Materials;
using Content.Shared.Materials;
using Robust.Shared.GameObjects;
using Robust.Shared.Prototypes;

namespace Content.IntegrationTests.Tests.Materials;

/// <summary>
/// Tests to prevent Recycler loops, where the product of one recycling can be recycled again.
/// </summary>
[TestOf(typeof(MaterialReclaimerSystem))]
[TestOf(typeof(MaterialReclaimerComponent))]
public sealed class ReclaimerLoopTest : InteractionTest
{
    // ProtoIDs we need
    private static readonly EntProtoId ApcId = "APCBasic";
    private static readonly EntProtoId FloorTileId = "FloorTileItemSteel";

    private static readonly string[] Reclaimers = GameDataScrounger.EntitiesWithComponent("MaterialReclaimer");

    [SidedDependency(Side.Server)] private readonly SharedMaterialReclaimerSystem _materialReclaimerSystem = null!;

    [Test]
    [TestCaseSource(nameof(Reclaimers))]
    [TestOf(typeof(MaterialReclaimerSystem))]
    [TestOf(typeof(MaterialReclaimerComponent))]
    [Description("For every material that a reclaimer can spawn, make sure that it cannot get stuck in a loop of spawning then recycling.")]
    [TrackingIssue("https://github.com/space-wizards/space-station-14/issues/39691")]
    public async Task MaterialSpawnLoopTest(string reclaimerId)
    {
        // Spawn the reclaimer
        await SpawnTarget(reclaimerId, PlayerCoords);
        Assume.That(STarget, Is.Not.Null, "STarget was null, did the reclaimer spawn correctly?");

        var reclaimComp = Comp<MaterialReclaimerComponent>(Target);

        // Power the reclaimer
        await SpawnEntity(ApcId, SEntMan.GetCoordinates(TargetCoords));
        await RunTicks(1);
        // Set reclaimer to enabled
        await Server.WaitPost(() =>
        {
            _materialReclaimerSystem.SetReclaimerEnabled((EntityUid)STarget, true);
        });

        // Check that reclaimer enabled
        Assume.That(reclaimComp.Enabled, "The reclaimer did not get or stay enabled");

        // Put a floor tile down
        await InteractUsing(FloorTileId);

        // Reclaimer can't reclaim materials? Job's done.
        if (!reclaimComp.ReclaimMaterials)
            Assert.Ignore("Cannot reclaim materials");

        using (Assert.EnterMultipleScope())
        {
            // For each material, assert that it is not recyclable (and would thus cause a recycling loop)
            foreach (var material in ProtoMan.EnumeratePrototypes<MaterialPrototype>())
            {
                var matStack = material.StackEntity;
                Assert.That(
                    matStack,
                    Is.Not.Null,
                    $"The material, {material.ID}, did not have a stackentity associated with it. You may need to add a stackEntity to its Reagents/Materials yml file.");

                var matInHands = await PlaceInHands(matStack);
                var matInHandsUid = ToServer(matInHands);

                // Assert we're holding material
                Assert.That(
                    HandSys.GetActiveItem((SPlayer, Hands)),
                    Is.EqualTo(matInHandsUid),
                    $"The material, {matStack}, never got put in our hands.");

                await Interact();

                // Assert Hands not empty
                Assert.That(
                    HandSys.GetActiveItem((SPlayer, Hands)),
                    Is.Not.Null,
                    $"The material that should not have been reclaimed, {matStack}, is no longer in our hands. The reclaimer was {reclaimerId}");
            }
        }
    }
}