test(create-plugin): adding teardown process for e2e test (#2735)

Co-authored-by: Tuan Pham <tuan-pham@cybozu.vn>

packages/create-plugin/JestCustomEnvironment.js

@@ -0,0 +1,21 @@
+const { TestEnvironment } = require("jest-environment-node");
+
+class JestCustomEnvironment extends TestEnvironment {
+  handleTestEvent(event) {
+    if (event.name === "test_start") {
+      const testName = event.test.name;
+      console.log(`Running test: ${testName}`);
+    }
+
+    if (!this.global.testStatuses) {
+      this.global.testStatuses = {};
+    }
+
+    if (event.name === "test_fn_success") {
+      const testName = event.test.name;
+      this.global.testStatuses[testName] = "passed";
+    }
+  }
+}
+
+module.exports = JestCustomEnvironment;

packages/create-plugin/__e2e__/e2e.test.ts

@@ -78,7 +78,20 @@ describe("create-plugin", function () {
   });
 
   afterEach(() => {
-    rimrafSync(workingDir);
-    console.log(`Working directory ${workingDir} has been removed`);
+    const testName = expect.getState().currentTestName;
+    if (!testName || !workingDir) {
+      return;
+    }
+
+    // @ts-ignore
+    const match = Object.keys(globalThis.testStatuses).find((item: string) =>
+      testName.includes(item),
+    );
+
+    // @ts-ignore
+    if (match && globalThis.testStatuses[match] === "passed") {
+      rimrafSync(workingDir);
+      console.log(`Working directory ${workingDir} has been removed`);
+    }
   });
 });

packages/create-plugin/jest.e2e.config.js

@@ -2,7 +2,7 @@
 const config = {
   roots: ["<rootDir>"],
   testRegex: "/__e2e__/.*\\.test\\.ts$",
-  testEnvironment: "node",
+  testEnvironment: "./JestCustomEnvironment.js",
   testTimeout: 120000,
 };
 module.exports = config;

packages/create-plugin/package.json

@@ -36,7 +36,8 @@
     "@types/lodash": "^4.17.0",
     "@types/node-rsa": "^1.1.4",
     "@types/normalize-path": "^3.0.2",
-    "cross-env": "^7.0.3"
+    "cross-env": "^7.0.3",
+    "jest-environment-node": "^29.7.0"
   },
   "files": [
     "bin",

packages/create-plugin/types/global/index.d.ts

@@ -2,3 +2,10 @@
 declare interface Element {}
 declare interface Document {}
 declare interface NodeListOf<T = {}> {}
+
+/* eslint-disable no-var,vars-on-top */
+// We cannot use let,const to declare global object:(
+// https://stackoverflow.com/a/69230938
+declare global {
+  var testStatuses: { [testPath: string]: "failed" | "passed" | "running" };
+}