feat: share test cases between jest and e2e

Author: shijistar

.gitignore

@@ -5,10 +5,9 @@ umd
 tslib
 node_modules
 npm-debug.log
-test-browser/fixtures/es-modern-bundle.js
-test-browser/fixtures/es-legacy-bundle.js
+e2e/fixtures/scripts
+e2e/test-results
 coverage/
-test-results
 run
 .DS_Store
 .cache

CHANGELOG.md

@@ -10,7 +10,7 @@
 
 ### Features
 
-- 🔥 add `Enum.install` method which introduces a new plugin system. The plugin system allows you to add new methods or properties to all enums. While similar to `Enum.extends`, the plugin system enables features to be packaged as `shareable` plugins, making it more flexible and widely applicable.
+- 🔥 Introduces the new plugin system. Plugins are registered using `Enum.install`. The plugin system allows you to add new methods or properties to all enums. While similar to `Enum.extends`, the plugin system enables features to be packaged as `shareable` plugins, making it more flexible and widely applicable.
 - 🔥 introduce an official plugin `enum-plus-plugin` that provides a collection of highly shareable plugins.
   - These plugins are designed to work in all scenarios and environments (including browser and Node.js), without introducing dependencies on third-party frameworks, component libraries, or platforms.
   - If you have a good idea that might be specific to a certain framework or platform rather than universally applicable, we recommend creating a new plugin project (e.g., `enum-plus-plugin-xxx`). We are happy to see that, and hope that you submit a PR to `enum-plus-plugin` to link your project back.

Testing.md

@@ -0,0 +1,6 @@
+1. jest和playwright复用一套代码
+2. 所以在单元测试编写时还是有点区别
+   1. test分为evaluate和assert两个部分
+   2. 两个方法的入参和返回值都需要可序列化
+   3. 尽量不使用闭包，如果必须要使用的话，请添加到evaluate的返回值中
+   4. 用到的外部数据（例如enum-plus、config、data）等，需要考虑到浏览器端，需要编译到e2e目录中

browser-global.d.ts

@@ -0,0 +1,14 @@
+import type * as EnumPlus from '@enum-plus';
+import type * as WeekConfig from './test/data/week-config';
+import type * as WeekData from './test/data/week-data';
+import type * as SerializeJavascript from './test/utils/serialize-javascript';
+
+declare global {
+  interface Window {
+    EnumPlus: typeof EnumPlus;
+    WeekConfig: typeof WeekConfig;
+    WeekData: typeof WeekData;
+    SerializeJavascript: typeof SerializeJavascript;
+  }
+}
+export {};

e2e-global.d.ts

@@ -0,0 +1,22 @@
+import { test as base } from '@playwright/test';
+import EnumPage from './EnumPage';
+
+export { expect } from '@playwright/test';
+
+export const legacyTest = base.extend<{
+  enumPage: EnumPage;
+}>({
+  enumPage: async ({ page }, use) => {
+    const enumPage = new EnumPage(page);
+    await enumPage.gotoLegacy();
+
+    await use(enumPage);
+  },
+});
+
+legacyTest.beforeEach(async ({ enumPage }) => {
+  await enumPage.setupLang();
+});
+legacyTest.afterEach(async ({ enumPage }) => {
+  await enumPage.resetLang();
+});

e2e/fixtures/EnumLegacyTest.ts

@@ -0,0 +1,31 @@
+import type { Page } from '@playwright/test';
+
+export default class EnumPage {
+  constructor(public readonly page: Page) {}
+
+  async gotoModern() {
+    await this.page.goto('/modern.html');
+  }
+  async gotoLegacy() {
+    await this.page.goto('/legacy.html');
+  }
+  async setupLang() {
+    await this.page.evaluate(() => {
+      const {
+        EnumPlus: { Enum, defaultLocalize },
+        WeekConfig: { setLang, getLocales },
+      } = window;
+
+      setLang('en-US', Enum, getLocales, defaultLocalize);
+    });
+  }
+  async resetLang() {
+    await this.page.evaluate(() => {
+      const {
+        EnumPlus: { Enum },
+        WeekConfig: { clearLang },
+      } = window;
+      clearLang(Enum);
+    });
+  }
+}

e2e/fixtures/EnumPage.ts

@@ -0,0 +1,22 @@
+import { test as base } from '@playwright/test';
+import EnumPage from './EnumPage';
+
+export { expect } from '@playwright/test';
+
+export const test = base.extend<{
+  enumPage: EnumPage;
+}>({
+  enumPage: async ({ page }, use) => {
+    const enumPage = new EnumPage(page);
+    await enumPage.gotoModern();
+
+    await use(enumPage);
+  },
+});
+
+test.beforeEach(async ({ enumPage }) => {
+  await enumPage.setupLang();
+});
+test.afterEach(async ({ enumPage }) => {
+  await enumPage.resetLang();
+});

e2e/fixtures/EnumTest.ts

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+
+  <head>
+    <meta charset="UTF-8">
+    <title>Enum Plus Legacy Test</title>
+    <script src="scripts/serialize-javascript-bundle.js"></script>
+    <script src="scripts/es-legacy-bundle.js"></script>
+    <script src="scripts/week-config-bundle.js"></script>
+    <script src="scripts/week-data-bundle.js"></script>
+  </head>
+
+  <body>
+    <div id="test-results"></div>
+  </body>
+
+</html>

e2e/fixtures/legacy.html

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+
+  <head>
+    <meta charset="UTF-8">
+    <title>Enum Plus Modern Test</title>
+    <script src="scripts/serialize-javascript-bundle.js"></script>
+    <script src="scripts/es-modern-bundle.js"></script>
+    <script src="scripts/week-config-bundle.js"></script>
+    <script src="scripts/week-data-bundle.js"></script>
+  </head>
+
+  <body>
+    <div id="test-results"></div>
+  </body>
+
+</html>