bk-press 0.0.3 → 0.0.5

package/lib/command/fixture.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fixture = fixture;
+const path_1 = __importDefault(require("path"));
+const util_1 = require("../util");
+async function fixture() {
+    console.log("开始生成 fixture 文件...");
+    const logJsonFile = path_1.default.join(process.cwd(), "web-interaction-log.json");
+    const isExistJsonFile = await (0, util_1.isFileOrFolderExist)(logJsonFile);
+    if (!isExistJsonFile) {
+        throw new Error("web-interaction-log.json 文件不存在，请在 Chrome 应用商店安装 Web Interaction Logger 插件后，录制并导出 web-interaction-log.json 到项目根目录下。");
+    }
+    const logList = (await (0, util_1.readFile)(logJsonFile));
+    const validLogList = logList.filter((log) => log.type === "network" &&
+        log.subtype === "response-body" &&
+        log.url.startsWith("/"));
+    const commonPath = path_1.default.join(process.cwd(), "cypress_fixtures");
+    const isExistFolder = await (0, util_1.isFileOrFolderExist)(commonPath);
+    if (!isExistFolder) {
+        await (0, util_1.createFolder)(commonPath);
+        console.log(`创建 fixtures 文件夹: ${commonPath}`);
+    }
+    validLogList.forEach(async (log) => {
+        const jsonContent = log.responseBody;
+        const jsonString = JSON.stringify(jsonContent, null, 2);
+        const isExistQuery = log.url.includes("?");
+        let fileName = "";
+        if (isExistQuery) {
+            fileName = log.url.split("?")[0].replace(/\//g, "_");
+        }
+        else {
+            fileName = log.url.replace(/\//g, "_");
+        }
+        fileName = `${log.method}_${fileName.substring(1, fileName.length - 1)}.json`;
+        console.log(`生成 fixture 文件: ${fileName}`);
+        const fixtureFile = path_1.default.join(commonPath, fileName);
+        await (0, util_1.writeFile)(fixtureFile, jsonString);
+    });
+}

package/lib/command/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./login"), exports);
 __exportStar(require("./init"), exports);
 __exportStar(require("./run"), exports);
+__exportStar(require("./fixture"), exports);

package/lib/command/init.js

@@ -10,7 +10,7 @@ const path_1 = __importDefault(require("path"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const util_1 = require("../util");
 async function init() {
-    console.log("开始初始化Cypress自动化测试...");
+    console.log("开始初始化Cypress自动化测试环境...");
     console.log("安装相关依赖...");
     await installDependencies();
     console.log("添加类型到 tsconfig.json 文件...");
@@ -57,6 +57,11 @@ async function addScriptsToPackageJson() {
 }
 // 创建 cypress 文件夹并拉取模板文件
 async function addTemplateFiles() {
+    const isCypressExist = await (0, util_1.isFileOrFolderExist)(path_1.default.join(process.cwd(), "cypress"));
+    if (isCypressExist) {
+        console.log("cypress 文件夹已存在，跳过拉取模板文件");
+        return;
+    }
     const isTsProject = await checkIsTsProject();
     console.log("当前项目是否是 TypeScript 项目: ", isTsProject);
     await createCypressFolder();
@@ -113,6 +118,11 @@ async function copyTemplateFiles() {
 // 添加 cypress.config.ts 文件
 async function addCypressConfigFile() {
     const cypressConfigFile = path_1.default.join(process.cwd(), "cypress.config.ts");
+    const isExist = await (0, util_1.isFileOrFolderExist)(cypressConfigFile);
+    if (isExist) {
+        console.log("cypress.config.ts 文件已存在，跳过创建");
+        return;
+    }
     const fileContent = `import { defineConfig } from 'cypress';
 
 export default defineConfig({
@@ -141,6 +151,11 @@ async function addCypressEnvJsonFile() {
 async function addIgnoreToGitignoreFile() {
     const gitignoreFile = path_1.default.join(process.cwd(), ".gitignore");
     const oldFileContent = await (0, util_1.readFile)(gitignoreFile, false);
+    const isExist = oldFileContent.includes("cypress");
+    if (isExist) {
+        console.log(".gitignore 文件中已存在 cypress 相关文件，跳过添加忽略文件");
+        return;
+    }
     const fileContent = `${oldFileContent}\n
 cypress/parallel-weights.json
 cypress/screenshots
@@ -151,16 +166,19 @@ multi-reporter-config.json`;
 }
 // 添加 cypress 类型到 tsconfig.json 文件
 async function addCypressTypesToTsconfigJsonFile() {
-    const tsconfigJsonFile = path_1.default.join(process.cwd(), "tsconfig.json");
-    const tsconfigJson = (await (0, util_1.readFile)(tsconfigJsonFile));
+    const tsconfigJsonFilePath = path_1.default.join(process.cwd(), "tsconfig.json");
+    const tsconfigJson = (await (0, util_1.readFile)(tsconfigJsonFilePath));
     if (tsconfigJson.include) {
-        tsconfigJson.include.push("cypress/**/*");
+        if (!tsconfigJson.include.includes("cypress/**/*")) {
+            tsconfigJson.include.push("cypress/**/*");
+        }
     }
     else {
         tsconfigJson.include = ["cypress/**/*"];
     }
     if (tsconfigJson.compilerOptions) {
-        if (tsconfigJson.compilerOptions.types) {
+        if (tsconfigJson.compilerOptions.types &&
+            !tsconfigJson.compilerOptions.types.includes("cypress")) {
             tsconfigJson.compilerOptions.types.push("cypress");
         }
         else {
@@ -173,5 +191,5 @@ async function addCypressTypesToTsconfigJsonFile() {
         };
     }
     const fileContent = JSON.stringify(tsconfigJson, null, 2);
-    await (0, util_1.writeFile)(tsconfigJsonFile, fileContent);
+    await (0, util_1.writeFile)(tsconfigJsonFilePath, fileContent);
 }

package/lib/command/run.js

@@ -9,11 +9,14 @@ const login_1 = require("./login");
 const os_1 = __importDefault(require("os"));
 async function run() {
     console.log("开始运行自动化测试...");
+    // console.log("当前工作目录: ", process.cwd());
     const config = await (0, login_1.readCypressEnvConfig)();
     const cpuCount = os_1.default.cpus().length;
     console.log("当前CPU核心数: ", cpuCount, ", 设置测试并发数: ", cpuCount);
     return new Promise((resolve, reject) => {
-        const child = (0, child_process_1.exec)(`start-server-and-test dev ${config.localUrl} 'cypress-parallel -s e2e -t ${cpuCount} -d cypress/e2e'`, {
+        const child = (0, child_process_1.exec)(
+        // `npm run dev & npx wait-on ${config.localUrl} && npx cypress-parallel -s e2e -t ${cpuCount} -d cypress/e2e`,
+        `npx start-server-and-test dev ${config.localUrl} "cypress-parallel -s e2e -t ${cpuCount} -d cypress/e2e"`, {
             cwd: process.cwd(),
             // @ts-ignore
             stdio: "inherit",

package/lib/index.js

@@ -7,9 +7,19 @@ const program = new commander_1.Command();
 program
     .name("bk-press")
     .description("一个用于 Cypress 自动化测试的 CLI 工具，帮助快速初始化和运行端到端测试")
-    .version("0.0.3");
-program.command("init").action(command_1.init);
-program.command("login").action(command_1.login);
+    .version("0.0.5");
+program
+    .command("init")
+    .description("初始化 Cypress 自动化测试环境")
+    .action(command_1.init);
+program
+    .command("login")
+    .description("登录本地开发环境并保存 Cookie")
+    .action(command_1.login);
 // @ts-ignore
-program.command("run").action(command_1.run);
+program.command("run").description("并行运行自动化测试").action(command_1.run);
+program
+    .command("fixture")
+    .description("根据 Chrome 插件 Web Interaction Logger 导出的 web-interaction-log.json 生成 fixture 拦截数据")
+    .action(command_1.fixture);
 program.parse(process.argv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bk-press",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "一个用于 Cypress 自动化测试的 CLI 工具，帮助快速初始化测试环境和并行运行自动化测试",
   "main": "lib/index.js",
   "bin": {

package/src/command/fixture.ts

@@ -0,0 +1,58 @@
+import path from "path";
+import {
+  isFileOrFolderExist,
+  readFile,
+  writeFile,
+  createFolder,
+} from "../util";
+
+interface WebInteractionLog {
+  type: string;
+  subtype: string;
+  requestId: string;
+  url: string;
+  method: string;
+  status: number;
+  statusText: string;
+  responseHeaders: string;
+  responseBody: Record<string, any>;
+}
+
+export async function fixture() {
+  console.log("开始生成 fixture 文件...");
+  const logJsonFile = path.join(process.cwd(), "web-interaction-log.json");
+  const isExistJsonFile = await isFileOrFolderExist(logJsonFile);
+  if (!isExistJsonFile) {
+    throw new Error(
+      "web-interaction-log.json 文件不存在，请在 Chrome 应用商店安装 Web Interaction Logger 插件后，录制并导出 web-interaction-log.json 到项目根目录下。",
+    );
+  }
+  const logList = (await readFile(logJsonFile)) as WebInteractionLog[];
+  const validLogList = logList.filter(
+    (log) =>
+      log.type === "network" &&
+      log.subtype === "response-body" &&
+      log.url.startsWith("/"),
+  );
+  const commonPath = path.join(process.cwd(), "cypress_fixtures");
+  const isExistFolder = await isFileOrFolderExist(commonPath);
+  if (!isExistFolder) {
+    await createFolder(commonPath);
+    console.log(`创建 fixtures 文件夹: ${commonPath}`);
+  }
+  validLogList.forEach(async (log) => {
+    const jsonContent = log.responseBody;
+    const jsonString = JSON.stringify(jsonContent, null, 2);
+    const isExistQuery = log.url.includes("?");
+    let fileName = "";
+    if (isExistQuery) {
+      fileName = log.url.split("?")[0].replace(/\//g, "_");
+    } else {
+      fileName = log.url.replace(/\//g, "_");
+    }
+    fileName = `${log.method}_${fileName.substring(1, fileName.length - 1)}.json`;
+    console.log(`生成 fixture 文件: ${fileName}`);
+    const fixtureFile = path.join(commonPath, fileName);
+    await writeFile(fixtureFile, jsonString);
+  });
+}

package/src/command/index.ts

@@ -1,3 +1,4 @@
 export * from "./login";
 export * from "./init";
 export * from "./run";
+export * from "./fixture";

package/src/command/init.ts

@@ -11,7 +11,7 @@ import {
 } from "../util";
 
 export async function init() {
-  console.log("开始初始化Cypress自动化测试...");
+  console.log("开始初始化Cypress自动化测试环境...");
   console.log("安装相关依赖...");
   await installDependencies();
   console.log("添加类型到 tsconfig.json 文件...");
@@ -68,6 +68,13 @@ async function addScriptsToPackageJson() {
 
 // 创建 cypress 文件夹并拉取模板文件
 async function addTemplateFiles() {
+  const isCypressExist = await isFileOrFolderExist(
+    path.join(process.cwd(), "cypress")
+  );
+  if (isCypressExist) {
+    console.log("cypress 文件夹已存在，跳过拉取模板文件");
+    return;
+  }
   const isTsProject = await checkIsTsProject();
   console.log("当前项目是否是 TypeScript 项目: ", isTsProject);
   await createCypressFolder();
@@ -134,6 +141,11 @@ async function copyTemplateFiles() {
 // 添加 cypress.config.ts 文件
 async function addCypressConfigFile() {
   const cypressConfigFile = path.join(process.cwd(), "cypress.config.ts");
+  const isExist = await isFileOrFolderExist(cypressConfigFile);
+  if (isExist) {
+    console.log("cypress.config.ts 文件已存在，跳过创建");
+    return;
+  }
   const fileContent = `import { defineConfig } from 'cypress';
 
 export default defineConfig({
@@ -164,6 +176,12 @@ async function addCypressEnvJsonFile() {
 async function addIgnoreToGitignoreFile() {
   const gitignoreFile = path.join(process.cwd(), ".gitignore");
   const oldFileContent = await readFile(gitignoreFile, false);
+  const isExist = oldFileContent.includes("cypress");
+  if (isExist) {
+    console.log(".gitignore 文件中已存在 cypress 相关文件，跳过添加忽略文件");
+    return;
+  }
+
   const fileContent = `${oldFileContent}\n
 cypress/parallel-weights.json
 cypress/screenshots
@@ -175,19 +193,24 @@ multi-reporter-config.json`;
 
 // 添加 cypress 类型到 tsconfig.json 文件
 async function addCypressTypesToTsconfigJsonFile() {
-  const tsconfigJsonFile = path.join(process.cwd(), "tsconfig.json");
-  const tsconfigJson = (await readFile(tsconfigJsonFile)) as Record<
+  const tsconfigJsonFilePath = path.join(process.cwd(), "tsconfig.json");
+  const tsconfigJson = (await readFile(tsconfigJsonFilePath)) as Record<
     string,
     any
   >;
   if (tsconfigJson.include) {
-    tsconfigJson.include.push("cypress/**/*");
+    if (!tsconfigJson.include.includes("cypress/**/*")) {
+      tsconfigJson.include.push("cypress/**/*");
+    }
   } else {
     tsconfigJson.include = ["cypress/**/*"];
   }
 
   if (tsconfigJson.compilerOptions) {
-    if (tsconfigJson.compilerOptions.types) {
+    if (
+      tsconfigJson.compilerOptions.types &&
+      !tsconfigJson.compilerOptions.types.includes("cypress")
+    ) {
       tsconfigJson.compilerOptions.types.push("cypress");
     } else {
       tsconfigJson.compilerOptions.types = ["cypress"];
@@ -198,5 +221,5 @@ async function addCypressTypesToTsconfigJsonFile() {
     };
   }
   const fileContent = JSON.stringify(tsconfigJson, null, 2);
-  await writeFile(tsconfigJsonFile, fileContent);
+  await writeFile(tsconfigJsonFilePath, fileContent);
 }

package/src/command/run.ts

@@ -4,12 +4,14 @@ import os from "os";
 
 export async function run() {
   console.log("开始运行自动化测试...");
+  // console.log("当前工作目录: ", process.cwd());
   const config = await readCypressEnvConfig();
   const cpuCount = os.cpus().length;
   console.log("当前CPU核心数: ", cpuCount, ", 设置测试并发数: ", cpuCount);
   return new Promise((resolve, reject) => {
     const child = exec(
-      `start-server-and-test dev ${config.localUrl} 'cypress-parallel -s e2e -t ${cpuCount} -d cypress/e2e'`,
+      // `npm run dev & npx wait-on ${config.localUrl} && npx cypress-parallel -s e2e -t ${cpuCount} -d cypress/e2e`,
+      `npx start-server-and-test dev ${config.localUrl} "cypress-parallel -s e2e -t ${cpuCount} -d cypress/e2e"`,
       {
         cwd: process.cwd(),
         // @ts-ignore

package/src/index.ts

@@ -1,19 +1,31 @@
 #!/usr/bin/env node
 
 import { Command } from "commander";
-import { login, init, run } from "./command";
+import { login, init, run, fixture } from "./command";
 
 const program = new Command();
 
 program
   .name("bk-press")
   .description(
-    "一个用于 Cypress 自动化测试的 CLI 工具，帮助快速初始化和运行端到端测试"
+    "一个用于 Cypress 自动化测试的 CLI 工具，帮助快速初始化和运行端到端测试",
   )
-  .version("0.0.3");
+  .version("0.0.5");
 
-program.command("init").action(init);
-program.command("login").action(login);
+program
+  .command("init")
+  .description("初始化 Cypress 自动化测试环境")
+  .action(init);
+program
+  .command("login")
+  .description("登录本地开发环境并保存 Cookie")
+  .action(login);
 // @ts-ignore
-program.command("run").action(run);
+program.command("run").description("并行运行自动化测试").action(run);
+program
+  .command("fixture")
+  .description(
+    "根据 Chrome 插件 Web Interaction Logger 导出的 web-interaction-log.json 生成 fixture 拦截数据",
+  )
+  .action(fixture);
 program.parse(process.argv);