Test entity deletion during migration

Author: Toastbrot236

RefreshTests.GameServer/GameServer/TestMigrationJobDeletingLevels.cs

@@ -0,0 +1,37 @@
+using Refresh.Database.Models.Levels;
+using Refresh.Workers;
+
+namespace RefreshTests.GameServer.GameServer;
+
+public class TestMigrationJobDeletingLevels : MigrationJob<GameLevel>
+{
+    protected override int BatchCount => 6;
+
+    // Deletes every second level
+    protected override int Migrate(WorkContext context, GameLevel[] batch)
+    {
+        int entitiesLeft = batch.Length;
+        int index = 0;
+        foreach (GameLevel level in batch)
+        {
+            if (index % 2 == 1)
+            {
+                context.Database.DeleteLevel(level);
+                entitiesLeft--;
+            }
+            else
+            {
+                level.Title += " test";
+            }
+
+            index++;
+        }
+
+        return entitiesLeft;
+    }
+
+    protected override IQueryable<GameLevel> SortAndFilter(IQueryable<GameLevel> query)
+    {
+        return query.OrderBy(l => l.LevelId);
+    }
+}

RefreshTests.GameServer/Tests/Workers/MigrationTests.cs

@@ -1,7 +1,9 @@
 using Refresh.Database.Models.Authentication;
 using Refresh.Database.Models.Levels;
+using Refresh.Database.Models.Pins;
 using Refresh.Database.Models.Users;
-using Refresh.Database.Query;
+using Refresh.Database.Models.Workers;
+using Refresh.Interfaces.Workers.Migrations;
 using Refresh.Workers.State;
 
 namespace RefreshTests.GameServer.Tests.Workers;
@@ -29,4 +31,132 @@ public void MigrationJobWorks()
         allLevels = context.Database.GetNewestLevels(100, 0, null, new(TokenGame.Website)).Items;
         Assert.That(allLevels.All(l => l.Title == "Level test"), Is.True);
     }
+
+    [Test]
+    public void WebsitePinMigrationDoesNotBreakPagination()
+    {
+        using TestContext context = this.GetServer();
+
+        for (int i = 0; i < 50; i++)
+        {
+            GameUser user = context.CreateUser();
+            context.Database.AddPinProgress(new()
+            {
+                PinId = (long)ServerPins.SignIntoWebsite,
+                Progress = i + 1,
+                Publisher = user,
+                FirstPublished = new(),
+                LastUpdated = new(),
+                IsBeta = false,
+                Platform = TokenPlatform.RPCS3,
+            }, false);
+
+            context.Database.AddPinProgress(new()
+            {
+                PinId = (long)ServerPins.SignIntoWebsite,
+                Progress = i + 1,
+                Publisher = user,
+                FirstPublished = new(),
+                LastUpdated = new(),
+                IsBeta = true,
+                Platform = TokenPlatform.RPCS3,
+            }, false);
+        }
+        context.Database.SaveChanges();
+        Assert.That(context.Database.GetTotalPinProgresses(), Is.EqualTo(100));
+
+        // Prepare migration
+        CorrectWebsitePinProgressPlatformMigration job = new();
+        context.Database.UpdateOrCreateJobState(typeof(CorrectWebsitePinProgressPlatformMigration).Name, new MigrationJobState()
+        {
+            Total = 100 // Since we already have to manually create the state
+        }, WorkerClass.Refresh);
+        context.Database.Refresh();
+
+        object? stateObject = context.Database.GetJobState(typeof(CorrectWebsitePinProgressPlatformMigration).Name, typeof(MigrationJobState), WorkerClass.Refresh);
+        Assert.That(stateObject, Is.Not.Null);
+        job.JobState = stateObject!;
+        
+        // Migrate
+        job.ExecuteJob(context.GetWorkContext());
+        context.Database.Refresh();
+
+        stateObject = context.Database.GetJobState(typeof(CorrectWebsitePinProgressPlatformMigration).Name, typeof(MigrationJobState), WorkerClass.Refresh);
+        Assert.That(stateObject, Is.Not.Null);
+
+        // While we're not actually testing pagination here (batch count can't be edited + don't want to create over 1000 users here, would take too long),
+        // it should be enough to simply ensure that both the total and processed counts are adjusted to be less than 100 (as 50 pins were deleted)
+        MigrationJobState jobState = (MigrationJobState)stateObject!;
+        Assert.That(jobState.Processed, Is.EqualTo(50));
+        Assert.That(jobState.Total, Is.EqualTo(50));
+        Assert.That(jobState.Complete, Is.True);
+
+        Assert.That(context.Database.GetTotalPinProgresses(), Is.EqualTo(50));
+    }
+
+    [Test]
+    public void DeletingEntitiesDuringMigrationJobDoesNotBreakPagination()
+    {
+        using TestContext context = this.GetServer();
+        GameUser user = context.CreateUser();
+
+        // 3 cycles (6 levels per cycle)
+        for (int i = 0; i < 18; i++)
+        {
+            context.CreateLevel(user);
+        }
+        context.Database.Refresh();
+        Assert.That(context.Database.GetTotalLevelCount(), Is.EqualTo(18));
+
+        // Prepare migration
+        TestMigrationJobDeletingLevels job = new();
+        context.Database.UpdateOrCreateJobState(typeof(TestMigrationJobDeletingLevels).Name, new MigrationJobState()
+        {
+            Total = 18
+        }, WorkerClass.Refresh);
+        context.Database.Refresh();
+
+        object? stateObject = context.Database.GetJobState(typeof(TestMigrationJobDeletingLevels).Name, typeof(MigrationJobState), WorkerClass.Refresh);
+        Assert.That(stateObject, Is.Not.Null);
+        job.JobState = stateObject!;
+        
+        // Migrate - First cycle
+        job.ExecuteJob(context.GetWorkContext());
+        context.Database.Refresh();
+
+        // Ensure only 3 levels were actually migrated, and 3 levels were deleted
+        Assert.That(context.Database.GetTotalLevelCount(), Is.EqualTo(15));
+        Assert.That(context.Database.GetNewestLevels(20, 0, null, new(TokenGame.Website)).Items.Count(l => l.Title.EndsWith(" test")), Is.EqualTo(3));
+
+        MigrationJobState jobState = (MigrationJobState)stateObject!;
+        Assert.That(jobState.Processed, Is.EqualTo(3));
+        Assert.That(jobState.Total, Is.EqualTo(15));
+        Assert.That(jobState.Complete, Is.False);
+
+        // Migrate - Second cycle
+        job.ExecuteJob(context.GetWorkContext());
+        context.Database.Refresh();
+
+        // Ensure 3 more levels were deleted, and 3 more levels were migrated
+        Assert.That(context.Database.GetTotalLevelCount(), Is.EqualTo(12));
+        Assert.That(context.Database.GetNewestLevels(20, 0, null, new(TokenGame.Website)).Items.Count(l => l.Title.EndsWith(" test")), Is.EqualTo(6));
+
+        jobState = (MigrationJobState)stateObject!;
+        Assert.That(jobState.Processed, Is.EqualTo(6));
+        Assert.That(jobState.Total, Is.EqualTo(12));
+        Assert.That(jobState.Complete, Is.False);
+
+        // Migrate - Last cycle
+        job.ExecuteJob(context.GetWorkContext());
+        context.Database.Refresh();
+
+        // Ensure 3 more levels were deleted, and 3 more levels were migrated
+        Assert.That(context.Database.GetTotalLevelCount(), Is.EqualTo(9));
+        Assert.That(context.Database.GetNewestLevels(20, 0, null, new(TokenGame.Website)).Items.Count(l => l.Title.EndsWith(" test")), Is.EqualTo(9));
+
+        jobState = (MigrationJobState)stateObject!;
+        Assert.That(jobState.Processed, Is.EqualTo(9));
+        Assert.That(jobState.Total, Is.EqualTo(9));
+        Assert.That(jobState.Complete, Is.True);
+    }
 }