CatStation/Content.IntegrationTests/Tests/Access/ExpireIdCardTest.cs

#nullable enable
using Content.IntegrationTests.Fixtures;
using Content.IntegrationTests.Fixtures.Attributes;
using Content.Shared.Access;
using Content.Shared.Access.Components;
using Content.Shared.Access.Systems;
using Robust.Shared.GameObjects;
using Robust.Shared.Localization;
using Robust.Shared.Prototypes;
using Robust.Shared.Timing;
using System.Collections.Generic;

namespace Content.IntegrationTests.Tests.Access
{
    [TestOf(typeof(ExpireIdCardComponent))]
    public sealed class ExpireIdCardTest : GameTest
    {
        private const string TestExpireIdCard = "TestExpireIdCard";
        private static readonly ProtoId<AccessLevelPrototype> GenpopEnter = "GenpopEnter";
        private static readonly ProtoId<AccessLevelPrototype> GenpopLeave = "GenpopLeave";

        [TestPrototypes]
        private const string Prototypes = $@"
- type: entity
  id: {TestExpireIdCard}
  name: Expire ID Card
  components:
  - type: Access
    tags:
    - GenpopEnter
  - type: ExpireIdCard
    expireMessage: genpop-prisoner-id-expire
    expiredAccess:
    - GenpopLeave
";

        [SidedDependency(Side.Server)] private readonly IGameTiming _gameTiming = null!;
        [SidedDependency(Side.Server)] private readonly MetaDataSystem _metaDataSystem = null!;
        [SidedDependency(Side.Server)] private readonly SharedIdCardSystem _sharedIdCardSystem = null!;

        [Test]
        public async Task TestExpireIdCardResetsAccessTagsWhenExpiring()
        {
            EntityUid ent = default;
            ExpireIdCardComponent expireComp = default!;
            AccessComponent accessComp = default!;
            var expirationTimeInSeconds = 2.0f;
            var expireTime = TimeSpan.FromSeconds(expirationTimeInSeconds);

            await Pair.Server.WaitPost(() =>
            {
                ent = SSpawn(TestExpireIdCard);
                expireComp = SComp<ExpireIdCardComponent>(ent);
                accessComp = SComp<AccessComponent>(ent);
            });

            // Check that default component values are all correct
            Assume.That(expireComp.Expired, Is.False);
            Assume.That(expireComp.Permanent, Is.True);
            Assume.That(expireComp.ExpireTime, Is.Null);

            using (Assert.EnterMultipleScope())
            {
                Assert.That(accessComp.Tags, Is.EqualTo(new HashSet<ProtoId<AccessLevelPrototype>> { GenpopEnter }));
                Assert.That(expireComp.ExpiredAccess, Is.EqualTo(new HashSet<ProtoId<AccessLevelPrototype>> { GenpopLeave }));
                Assert.That(expireComp.ExpireMessage, Is.EqualTo(new LocId("genpop-prisoner-id-expire")));
            }

            // Set the expire time to the future
            var absoluteExpireTime = _gameTiming.CurTime + expireTime;
            _sharedIdCardSystem.SetExpireTime(ent, absoluteExpireTime);
            using (Assert.EnterMultipleScope())
            {
                Assert.That(expireComp.Expired, Is.False);
                Assert.That(expireComp.Permanent, Is.False);
                Assert.That(expireComp.ExpireTime, Is.EqualTo(absoluteExpireTime));
                Assert.That(accessComp.Tags, Is.EqualTo(new HashSet<ProtoId<AccessLevelPrototype>> { GenpopEnter }));
            }

            // Ensure that after just before expiry, the card has not yet expired and the access has not been replaced
            await Pair.RunSeconds(1.0f);
            using (Assert.EnterMultipleScope())
            {
                Assert.That(expireComp.Expired, Is.False);
                Assert.That(accessComp.Tags, Is.EqualTo(new HashSet<ProtoId<AccessLevelPrototype>> { GenpopEnter }));
            }

            // Ensure that after expiry, the card has expired and the access has been replaced
            await Pair.RunSeconds(1.0f);
            using (Assert.EnterMultipleScope())
            {
                Assert.That(expireComp.Expired, Is.True);
                Assert.That(expireComp.Permanent, Is.False);
                Assert.That(accessComp.Tags, Is.EqualTo(new HashSet<ProtoId<AccessLevelPrototype>> { GenpopLeave }));
            }
        }

        [Test]
        public async Task TestExpireIdCardExpiryUsesPauseDuration()
        {
            EntityUid ent = default;
            ExpireIdCardComponent expireComp = default!;
            AccessComponent accessComp = default!;

            await Pair.Server.WaitPost(() =>
            {
                ent = SSpawn(TestExpireIdCard);
                expireComp = SComp<ExpireIdCardComponent>(ent);
                accessComp = SComp<AccessComponent>(ent);

                _sharedIdCardSystem.SetExpireTime(ent, _gameTiming.CurTime + TimeSpan.FromSeconds(1));
                _metaDataSystem.SetEntityPaused(ent, true);
            });

            await Pair.RunSeconds(2.0f);

            await Pair.Server.WaitPost(() =>
            {
                Assert.That(expireComp.Expired, Is.False);
                Assert.That(accessComp.Tags, Is.EqualTo(new HashSet<ProtoId<AccessLevelPrototype>> { GenpopEnter }));

                _metaDataSystem.SetEntityPaused(ent, false);
            });

            await Pair.RunSeconds(1.1f);

            await Pair.Server.WaitPost(() =>
            {
                Assert.That(expireComp.Expired, Is.True);
                Assert.That(accessComp.Tags, Is.EqualTo(new HashSet<ProtoId<AccessLevelPrototype>> { GenpopLeave }));
            });
        }
    }
}