add example test

Author: ianmacartney

example/convex/example.test.ts

@@ -0,0 +1,34 @@
+import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
+import { initConvexTest } from "./setup.test";
+import { internal } from "./_generated/api";
+import { migrations } from "./example";
+
+describe("example", () => {
+  beforeEach(async () => {
+    vi.useFakeTimers();
+  });
+
+  afterEach(async () => {
+    vi.useRealTimers();
+  });
+
+  test("setDefaultValue", async () => {
+    const t = initConvexTest();
+    await t.mutation(internal.example.seed, { count: 10 });
+    await t.run(async (ctx) => {
+      const docs = await ctx.db.query("myTable").collect();
+      expect(docs).toHaveLength(10);
+      expect(docs.some((doc) => doc.optionalField === undefined)).toBe(true);
+      await migrations.runOne(ctx, internal.example.setDefaultValue, {
+        batchSize: 2,
+        dryRun: false,
+      });
+    });
+    await t.finishAllScheduledFunctions(vi.runAllTimers);
+    await t.run(async (ctx) => {
+      const after = await ctx.db.query("myTable").collect();
+      expect(after).toHaveLength(10);
+      expect(after.every((doc) => doc.optionalField !== undefined)).toBe(true);
+    });
+  });
+});

example/convex/setup.test.ts

@@ -0,0 +1,16 @@
+/// <reference types="vite/client" />
+import { test } from "vitest";
+import { convexTest } from "convex-test";
+import schema from "./schema.js";
+import component from "@convex-dev/migrations/test";
+
+const modules = import.meta.glob("./**/*.*s");
+// When users want to write tests that use your component, they need to
+// explicitly register it with its schema and modules.
+export function initConvexTest() {
+  const t = convexTest(schema, modules);
+  component.register(t);
+  return t;
+}
+
+test("setup", () => {});