Implement test cases for data migration

Author: MaddyGuthridge

tests/backend/migrations/README.md

@@ -0,0 +1,4 @@
+# Migrations
+
+These test cases are used to ensure that data migrations continue to work
+correctly.

tests/backend/migrations/migration.ts

@@ -0,0 +1,21 @@
+import api from '$endpoints';
+import { getDataDir, getPrivateDataDir } from '$lib/server/data/dataDir';
+import { unzip } from '$lib/server/zip';
+import { rimraf } from 'rimraf';
+
+/** Extract the given zip file into the data dir, then refresh the data to trigger a migration */
+export async function migrateDataFromZip(zipFile: string) {
+  await rimraf(getDataDir());
+  await unzip(zipFile, getDataDir());
+  await api().debug.dataRefresh();
+}
+
+/**
+ * Extract the given zip file into the private data dir, then refresh the data to trigger a
+ * migration.
+ */
+export async function migratePrivateDataFromZip(zipFile: string) {
+  await rimraf(getPrivateDataDir());
+  await unzip(zipFile, getPrivateDataDir());
+  await api().debug.dataRefresh();
+}

tests/backend/migrations/v0.6.6/README.md

@@ -0,0 +1,23 @@
+# Migrations / v0.6.6
+
+Migration test case for `v0.6.6`.
+
+## Data
+
+Overall structure:
+
+* `group`
+    * `listed`
+    * `unlisted`
+
+Of note:
+
+* `listed` is a listed child of `group`
+* `unlisted` is not listed as a child of `group`
+* `listed` has a URL of `https://example.com`
+* `listed` and `unlisted` link to each other
+
+## Private data
+
+* Username: `maddy`
+* Password: `Maddy123#`

tests/backend/migrations/v0.6.6/data.zip

@@ -0,0 +1,66 @@
+import type { ApiClient } from '$endpoints';
+import { beforeEach, describe, expect, it } from 'vitest';
+import { setup } from '../../helpers';
+import { migrateDataFromZip, migratePrivateDataFromZip } from '../migration';
+import path from 'path';
+import itemId from '$lib/itemId';
+
+let api: ApiClient;
+
+beforeEach(async () => {
+  api = (await setup()).api;
+});
+
+describe('Public data', () => {
+  beforeEach(async () => {
+    await migrateDataFromZip(path.join(__dirname, 'data.zip'));
+  });
+
+  it('Correctly creates all items', async () => {
+    await expect(api.item(itemId.ROOT).info.get()).resolves.toMatchObject({
+      children: ['group']
+    });
+
+    await expect(api.item(itemId.fromStr('/group')).info.get()).resolves.toMatchObject({
+      // Only listed child is listed
+      children: ['listed']
+    });
+
+    // Both children resolve
+    await expect(api.item(itemId.fromStr('/group/listed')).info.get()).toResolve();
+    await expect(api.item(itemId.fromStr('/group/unlisted')).info.get()).toResolve();
+  });
+
+  it('Migrates URL sections correctly', async () => {
+    await expect(api.item(itemId.fromStr('/group/listed')).info.get()).resolves.toMatchObject({
+      sections: expect.arrayContaining([
+        {
+          type: 'site',
+          url: 'https://example.com',
+          // Uses default icon and label
+          icon: null,
+          label: null,
+        },
+      ])
+    });
+  });
+
+  it('Migrates link sections correctly', async () => {
+    await expect(api.item(itemId.fromStr('/group/listed')).info.get()).resolves.toMatchObject({
+      sections: expect.arrayContaining([
+        {
+          type: 'links',
+          label: 'See also',
+          items: ['/group/unlisted'],
+          style: 'card',
+        },
+      ])
+    });
+  });
+});
+
+it('Migrates private data correctly', async () => {
+  await migratePrivateDataFromZip(path.join(__dirname, 'private_data.zip'));
+  // We can still log in
+  await expect(api.admin.auth.login('maddy', 'Maddy123#')).toResolve();
+});