test: add e2e build test (#97)

northword · web-flow · commit 88ad87f0d2bb · 2025-02-03T20:04:04.000+08:00
* test: add e2e build test

* Update build.test.ts

* tweak

* refactor: mv folder
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,10 @@ build
 # vitepress
 **/.vitepress/dist
 **/.vitepress/cache
+
+# e2e
+packages/scaffold/test/e2e/fixtures/dist
+packages/scaffold/test/e2e/fixtures/.scaffold
+packages/scaffold/test/e2e/fixtures/typings
+packages/scaffold/test/e2e/fixtures/.gitignore
+!packages/scaffold/test/e2e/snap/dist
diff --git a/package.json b/package.json
@@ -25,6 +25,7 @@
     "eslint-plugin-format": "^1.0.1",
     "husky": "^9.1.7",
     "lint-staged": "^15.4.3",
+    "tsx": "^4.19.2",
     "typescript": "^5.7.3",
     "unbuild": "^3.3.1",
     "vitest": "^3.0.4"
diff --git a/packages/scaffold/test/e2e/fixtures/build.ts b/packages/scaffold/test/e2e/fixtures/build.ts
@@ -0,0 +1,51 @@
+import { Build, Config } from "../../../src/index.js";
+
+async function main() {
+  const config = await Config.loadConfig({
+    source: ["src", "static"],
+    dist: `dist`,
+    name: "Test Plugin",
+    id: "test-plugin",
+    namespace: "test-plugin",
+    updateURL: `https://github.com/{{owner}}/{{repo}}/releases/download/releaser/{{updateJson}}`,
+    xpiDownloadLink: "https://github.com/{{owner}}/{{repo}}/releases/download/v{{version}}/{{xpiName}}.xpi",
+
+    build: {
+      assets: [
+        "static/**/*.*",
+      ],
+      define: {
+        buildTime: "{{buildTime}}",
+      },
+      fluent: {
+        ignore: ["lint-on-item-added11", "section-item"],
+      },
+      prefs: {
+        prefix: "extensions.testplugin",
+      },
+      esbuildOptions: [],
+      makeUpdateJson: {
+        hash: false,
+        updates: [
+          {
+            version: "0.4.5",
+            update_link: "https://example.com/example.xpi",
+            applications: {
+              gecko: {
+                strict_min_version: "60.0",
+              },
+            },
+          },
+        ],
+      },
+    },
+
+    // If you need to see a more detailed build log, uncomment the following line:
+    // logLevel: "trace",
+  });
+
+  const build = new Build(config);
+  await build.run();
+}
+
+main();
diff --git a/packages/scaffold/test/e2e/fixtures/package.json b/packages/scaffold/test/e2e/fixtures/package.json
@@ -0,0 +1,10 @@
+{
+  "name": "test-plugin",
+  "type": "module",
+  "version": "1.0.0",
+  "private": "true",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/northword/zotero-plugin-scaffold.git"
+  }
+}
diff --git a/packages/scaffold/test/e2e/fixtures/static/locale/en-US/prefs.ftl b/packages/scaffold/test/e2e/fixtures/static/locale/en-US/prefs.ftl
@@ -0,0 +1,3 @@
+meaasge-1 = General Settings
+meaasge-2-message-1 = 
+    .label = example
diff --git a/packages/scaffold/test/e2e/fixtures/static/manifest.json b/packages/scaffold/test/e2e/fixtures/static/manifest.json
@@ -0,0 +1,9 @@
+{
+  "manifest_version": 2,
+  "applications": {
+    "zotero": {
+      "strict_min_version": "6.999",
+      "strict_max_version": "7.*"
+    }
+  }
+}
diff --git a/packages/scaffold/test/e2e/fixtures/static/preference.xhtml b/packages/scaffold/test/e2e/fixtures/static/preference.xhtml
@@ -0,0 +1,11 @@
+<linkset>
+  <html:link rel="localization" href="__addonRef__-preferences.ftl" />
+</linkset>
+<vbox id="__addonRef__"">
+  <groupbox>
+    <label>
+      <html:h2 data-l10n-id="meaasge-1" />
+    </label>
+    <checkbox data-l10n-id="meaasge-3" preference="boolean" native="true" />
+  </groupbox>
+</vbox>
diff --git a/packages/scaffold/test/e2e/fixtures/static/prefs.js b/packages/scaffold/test/e2e/fixtures/static/prefs.js
@@ -0,0 +1,9 @@
+/* eslint-disable no-undef */
+pref("string", "0.0.0");
+pref("boolean", true);
+pref("number", 123);
+pref(
+  "break-line",
+  "123",
+);
+pref("fake-number", "123");
diff --git a/packages/scaffold/test/e2e/snap/dist/addon/locale/en-US/test-plugin-prefs.ftl b/packages/scaffold/test/e2e/snap/dist/addon/locale/en-US/test-plugin-prefs.ftl
@@ -0,0 +1,3 @@
+test-plugin-meaasge-1 = General Settings
+test-plugin-meaasge-2-message-1 = 
+    .label = example
diff --git a/packages/scaffold/test/e2e/snap/dist/addon/manifest.json b/packages/scaffold/test/e2e/snap/dist/addon/manifest.json
@@ -0,0 +1,13 @@
+{
+  "manifest_version": 2,
+  "applications": {
+    "zotero": {
+      "strict_min_version": "6.999",
+      "strict_max_version": "7.*",
+      "id": "test-plugin",
+      "update_url": "https://github.com/northword/zotero-plugin-scaffold/releases/download/releaser/update.json"
+    }
+  },
+  "name": "Test Plugin",
+  "version": "1.0.0"
+}
diff --git a/packages/scaffold/test/e2e/snap/dist/addon/preference.xhtml b/packages/scaffold/test/e2e/snap/dist/addon/preference.xhtml
@@ -0,0 +1,11 @@
+<linkset>
+  <html:link rel="localization" href="__addonRef__-preferences.ftl" />
+</linkset>
+<vbox id="__addonRef__"">
+  <groupbox>
+    <label>
+      <html:h2 data-l10n-id="test-plugin-meaasge-1" />
+    </label>
+    <checkbox data-l10n-id="meaasge-3" preference="extensions.testplugin.boolean" native="true" />
+  </groupbox>
+</vbox>
diff --git a/packages/scaffold/test/e2e/snap/dist/addon/prefs.js b/packages/scaffold/test/e2e/snap/dist/addon/prefs.js
@@ -0,0 +1,5 @@
+pref("extensions.testplugin.string", "0.0.0");
+pref("extensions.testplugin.boolean", true);
+pref("extensions.testplugin.number", 123);
+pref("extensions.testplugin.break-line", "123");
+pref("extensions.testplugin.fake-number", "123");
diff --git a/packages/scaffold/test/e2e/snap/dist/update-beta.json b/packages/scaffold/test/e2e/snap/dist/update-beta.json
@@ -0,0 +1,27 @@
+{
+  "addons": {
+    "test-plugin": {
+      "updates": [
+        {
+          "version": "0.4.5",
+          "update_link": "https://example.com/example.xpi",
+          "applications": {
+            "gecko": {
+              "strict_min_version": "60.0"
+            }
+          }
+        },
+        {
+          "version": "1.0.0",
+          "update_link": "https://github.com/northword/zotero-plugin-scaffold/releases/download/v1.0.0/test-plugin.xpi",
+          "applications": {
+            "zotero": {
+              "strict_min_version": "6.999",
+              "strict_max_version": "7.*"
+            }
+          }
+        }
+      ]
+    }
+  }
+}
diff --git a/packages/scaffold/test/e2e/snap/dist/update.json b/packages/scaffold/test/e2e/snap/dist/update.json
@@ -0,0 +1,27 @@
+{
+  "addons": {
+    "test-plugin": {
+      "updates": [
+        {
+          "version": "0.4.5",
+          "update_link": "https://example.com/example.xpi",
+          "applications": {
+            "gecko": {
+              "strict_min_version": "60.0"
+            }
+          }
+        },
+        {
+          "version": "1.0.0",
+          "update_link": "https://github.com/northword/zotero-plugin-scaffold/releases/download/v1.0.0/test-plugin.xpi",
+          "applications": {
+            "zotero": {
+              "strict_min_version": "6.999",
+              "strict_max_version": "7.*"
+            }
+          }
+        }
+      ]
+    }
+  }
+}
diff --git a/packages/scaffold/test/e2e/snap/typings/prefs.d.ts b/packages/scaffold/test/e2e/snap/typings/prefs.d.ts
@@ -0,0 +1,17 @@
+// Generated by zotero-plugin-scaffold
+/* prettier-ignore */
+/* eslint-disable */
+// @ts-nocheck
+
+// prettier-ignore
+declare namespace _ZoteroTypes {
+  interface Prefs {
+    PluginPrefsMap: {
+      "string": string;
+      "boolean": boolean;
+      "number": number;
+      "break-line": string;
+      "fake-number": string;
+    };
+  }
+}
diff --git a/packages/scaffold/test/e2e/tests/build.test.ts b/packages/scaffold/test/e2e/tests/build.test.ts
@@ -0,0 +1,27 @@
+import { execSync } from "node:child_process";
+import { readFileSync } from "node:fs";
+import { join } from "node:path";
+import { globSync } from "tinyglobby";
+import { describe, expect, it } from "vitest";
+
+const SNAPSHOT_DIR = join(__dirname, "../snap"); // 预期的快照目录
+const FIXTURES_DIR = join(__dirname, "../fixtures"); // 测试用例目录
+
+describe("#build", () => {
+  const stdout = execSync("pnpm tsx build.ts", {
+    cwd: FIXTURES_DIR,
+    env: { ...process.env, NODE_ENV: "production" },
+  });
+  it("should output correct files", async () => {
+    const paths = [...globSync(["dist/**/*", "!**/*.xpi", "typings"], { cwd: FIXTURES_DIR })];
+
+    for (const path of paths) {
+      const content = readFileSync(`${FIXTURES_DIR}/${path}`, "utf-8");
+      await expect(content).toMatchFileSnapshot(`${SNAPSHOT_DIR}/${path}`);
+    }
+  });
+
+  it("should output correct warnings", () => {
+    expect(stdout.toString()).toEqual(expect.stringContaining("meaasge-3"));
+  });
+});
diff --git a/packages/scaffold/test/unit/prefs-manager.test.ts b/packages/scaffold/test/unit/prefs-manager.test.ts
@@ -1,5 +1,5 @@
 import { beforeEach, describe, expect, it } from "vitest";
-import { PrefsManager, renderPluginPrefsDts } from "./prefs-manager.js";
+import { PrefsManager, renderPluginPrefsDts } from "../../src/utils/prefs-manager.js";
 
 describe("prefs-manager", () => {
   let prefsManager: PrefsManager;
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+meaasge-1 = General Settings`
	`2`	`+meaasge-2-message-1 =`
	`3`	`+ .label = example`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+test-plugin-meaasge-1 = General Settings`
	`2`	`+test-plugin-meaasge-2-message-1 =`
	`3`	`+ .label = example`