@szc-ft/mcp-szcd-client 0.34.2 → 0.38.0

package/standard-skill/local-browser-test/lib/trend-aggregator.js

@@ -0,0 +1,97 @@
+/**
+ * trend.json 按日聚合（v4 关键能力）
+ *
+ * 设计：
+ *   - schemaVersion: 1
+ *   - byDay[YYYY-MM-DD]: { runs, total, passed, failed, flaky, skipped,
+ *                          byStrategy: {api, ui, newman, browser},
+ *                          byTag: {}, byProject: {}, byBranch: {} }
+ */
+
+import fs from "node:fs";
+
+const DEFAULTS = {
+  schemaVersion: 1,
+  updatedAt: null,
+  byDay: {}
+};
+
+/**
+ * 把一次 run 追加到 trend.json
+ * @param {object} result
+ * @param {string} trendPath
+ */
+export function appendToTrend(result, trendPath) {
+  const trend = fs.existsSync(trendPath)
+    ? JSON.parse(fs.readFileSync(trendPath, "utf8"))
+    : structuredClone(DEFAULTS);
+
+  const day = (result.startedAt ?? new Date().toISOString()).slice(0, 10);
+  if (!trend.byDay[day]) {
+    trend.byDay[day] = {
+      runs: 0, total: 0, passed: 0, failed: 0, flaky: 0, skipped: 0,
+      byStrategy: { api: 0, ui: 0, newman: 0, browser: 0 },
+      byTag: {},
+      byProject: {},
+      byBranch: {}
+    };
+  }
+
+  const d = trend.byDay[day];
+  d.runs += 1;
+  d.total += result.stats?.total ?? 0;
+  d.passed += result.stats?.passed ?? 0;
+  d.failed += result.stats?.failed ?? 0;
+  d.flaky += result.stats?.flaky ?? 0;
+  d.skipped += result.stats?.skipped ?? 0;
+
+  // ★ v4 新增：按 strategy 分桶
+  const strategy = result.strategy ?? "newman";
+  d.byStrategy[strategy] = (d.byStrategy[strategy] ?? 0) + (result.stats?.total ?? 0);
+
+  // 按 tag 分桶
+  if (result.tag) {
+    if (!d.byTag[result.tag]) d.byTag[result.tag] = { runs: 0, passed: 0, failed: 0 };
+    const t = d.byTag[result.tag];
+    t.runs += 1;
+    t.passed += result.stats?.passed ?? 0;
+    t.failed += result.stats?.failed ?? 0;
+  }
+
+  // 按 project 分桶
+  if (result.project) {
+    if (!d.byProject[result.project]) d.byProject[result.project] = { runs: 0, passed: 0, failed: 0 };
+    const p = d.byProject[result.project];
+    p.runs += 1;
+    p.passed += result.stats?.passed ?? 0;
+    p.failed += result.stats?.failed ?? 0;
+  }
+
+  // 按 branch 分桶
+  if (result.branch) {
+    if (!d.byBranch[result.branch]) d.byBranch[result.branch] = { runs: 0, passed: 0, failed: 0 };
+    const b = d.byBranch[result.branch];
+    b.runs += 1;
+    b.passed += result.stats?.passed ?? 0;
+    b.failed += result.stats?.failed ?? 0;
+  }
+
+  trend.updatedAt = new Date().toISOString();
+  fs.writeFileSync(trendPath, JSON.stringify(trend, null, 2));
+}
+
+/**
+ * 裁剪 trend.json：保留最近 N 天
+ * @param {string} trendPath
+ * @param {number} days
+ */
+export function trimTrendToDays(trendPath, days) {
+  if (!fs.existsSync(trendPath)) return;
+  const trend = JSON.parse(fs.readFileSync(trendPath, "utf8"));
+  const cutoff = new Date(Date.now() - days * 24 * 3600 * 1000).toISOString().slice(0, 10);
+  for (const day of Object.keys(trend.byDay)) {
+    if (day < cutoff) delete trend.byDay[day];
+  }
+  trend.updatedAt = new Date().toISOString();
+  fs.writeFileSync(trendPath, JSON.stringify(trend, null, 2));
+}

package/standard-skill/local-browser-test/lib/workspace-init.js

@@ -0,0 +1,178 @@
+/**
+ * .lbt/ workspace 自动初始化（v3 多次调用安全）
+ *
+ * 关键设计：
+ *   - 缺啥补啥，绝不覆盖任何已有文件
+ *   - 双层 .gitignore（.lbt/.gitignore + 项目级 .gitignore 追加）
+ *   - .fingerprint 走 read → merge → write 增量更新
+ *   - --init-force 显式重置（需 yes 二次确认）
+ */
+
+import fs from "node:fs";
+import path from "node:path";
+import readline from "node:readline";
+
+// ESM-friendly 方式读 package.json（避免 createRequire 在 lib 内 resolve 失败）
+const PKG_URL = new URL("../package.json", import.meta.url);
+const PKG = JSON.parse(fs.readFileSync(PKG_URL, "utf8"));
+
+const INNER_GITIGNORE_CONTENT =
+  "auth/\n" +
+  "*.log\n" +
+  "config.yaml\n" +
+  "reports/\n";
+
+const PROJECT_GITIGNORE_RULES = [
+  ".lbt/auth/",
+  ".lbt/config.yaml",
+  ".lbt/reports/",
+  ".lbt/*.log"
+];
+
+/**
+ * 幂等追加到 .gitignore（不破坏用户已有内容）
+ * @param {string} projectGi 项目级 .gitignore 路径
+ * @param {string[]} rules 要追加的规则
+ * @returns {string[]} 实际新增的规则（已存在的跳过）
+ */
+export function appendIfMissing(projectGi, rules) {
+  if (!fs.existsSync(projectGi)) {
+    fs.writeFileSync(projectGi, rules.join("\n") + "\n");
+    return rules;
+  }
+  const content = fs.readFileSync(projectGi, "utf8");
+  const missing = rules.filter((r) => !content.includes(r));
+  if (missing.length > 0) {
+    const header = "\n# szcd local-browser-test workspace\n";
+    fs.appendFileSync(projectGi, header + missing.join("\n") + "\n");
+    return missing;
+  }
+  return [];
+}
+
+/**
+ * ensureWorkspace: 缺啥补啥，绝不覆盖任何已有文件
+ *   - 子目录：mkdir recursive（已存在则 no-op）
+ *   - .lbt/.gitignore：已存在则跳过
+ *   - config.yaml.example：已存在则跳过（用户可能改过）
+ *   - config.yaml：永远不主动建（避免覆盖用户配置）
+ *   - 项目 .gitignore：appendIfMissing
+ *   - .fingerprint：read → merge → write（保留 firstInitAt / initCount）
+ *
+ * @param {string} SKILL_DIR skill 目录绝对路径
+ * @param {string} [lbtDirOverride] 可选，cwd 外的 .lbt/ 路径
+ * @returns {string} .lbt 实际路径
+ */
+export function ensureWorkspace(SKILL_DIR, lbtDirOverride = null) {
+  const lbtDir = lbtDirOverride || path.join(process.cwd(), ".lbt");
+  const isNew = !fs.existsSync(lbtDir);
+  const actions = [];
+
+  // 1. 子目录（idempotent：mkdir recursive 已存在则 no-op）
+  for (const sub of ["plans/regression", "plans/smoke", "reports", "auth", "api"]) {
+    fs.mkdirSync(path.join(lbtDir, sub), { recursive: true });
+  }
+
+  // 2. .lbt/.gitignore（内部自带，双层防御）
+  const innerGi = path.join(lbtDir, ".gitignore");
+  if (!fs.existsSync(innerGi)) {
+    fs.writeFileSync(innerGi, INNER_GITIGNORE_CONTENT);
+    actions.push("+ 创建 .lbt/.gitignore");
+  } else {
+    actions.push("· .lbt/.gitignore 已存在，跳过");
+  }
+
+  // 3. config.yaml.example（已存在则跳过，用户可能改过）
+  const examplePath = path.join(lbtDir, "config.yaml.example");
+  if (!fs.existsSync(examplePath)) {
+    const sourceExample = path.join(SKILL_DIR, "config.example.yaml");
+    if (fs.existsSync(sourceExample)) {
+      fs.copyFileSync(sourceExample, examplePath);
+      actions.push("+ 创建 config.yaml.example");
+    }
+  } else {
+    actions.push("· config.yaml.example 已存在，跳过");
+  }
+
+  // 4. config.yaml — 永远不主动建（避免覆盖用户配置）
+
+  // 5. 项目级 .gitignore（幂等追加）
+  const appended = appendIfMissing(path.join(process.cwd(), ".gitignore"), PROJECT_GITIGNORE_RULES);
+  if (appended.length > 0) {
+    actions.push(`+ 项目 .gitignore 追加: ${appended.join(", ")}`);
+  } else {
+    actions.push("· 项目 .gitignore 已包含 .lbt/ 规则，跳过");
+  }
+
+  // 6. .fingerprint（read → merge → write 保留 firstInitAt）
+  const fpPath = path.join(lbtDir, ".fingerprint");
+  const existing = fs.existsSync(fpPath)
+    ? JSON.parse(fs.readFileSync(fpPath, "utf8"))
+    : {};
+  const now = new Date().toISOString();
+  const merged = {
+    ...existing,
+    skillDir: SKILL_DIR,
+    executorVersion: PKG.version,
+    lastInitAt: now,
+    firstInitAt: existing.firstInitAt ?? now,
+    initCount: (existing.initCount ?? 0) + 1,
+    runCount: existing.runCount ?? 0,  // 由 bumpRunCount 时 +1
+  };
+  fs.writeFileSync(fpPath, JSON.stringify(merged, null, 2));
+
+  // 7. 打印动作摘要
+  console.log(`${isNew ? "✓" : "↻"} workspace ${lbtDir}:`);
+  for (const a of actions) console.log(`  ${a}`);
+  if (isNew) {
+    console.log(`  提示：cp .lbt/config.yaml.example .lbt/config.yaml 并填值`);
+  }
+
+  return lbtDir;
+}
+
+/**
+ * initForce: 显式强制重置（需 --init-force 显式开启 + yes 二次确认）
+ * @param {string} SKILL_DIR
+ * @param {string} [lbtDirOverride]
+ * @returns {Promise<string>} .lbt 实际路径
+ */
+export async function initForce(SKILL_DIR, lbtDirOverride = null) {
+  const lbtDir = lbtDirOverride || path.join(process.cwd(), ".lbt");
+  if (fs.existsSync(lbtDir)) {
+    console.log(`⚠ 将清空 .lbt/ 全部内容（含 plans / reports / auth / config）`);
+    console.log(`  如有重要 plan 请先备份到 .lbt/plans/ 之外的位置`);
+    const answer = await prompt("\n继续清空？(yes/no): ");
+    if (answer !== "yes") {
+      console.log("已取消，workspace 保持原样");
+      return lbtDir;
+    }
+    fs.rmSync(lbtDir, { recursive: true, force: true });
+    console.log("✓ 已清空 .lbt/");
+  }
+  return ensureWorkspace(SKILL_DIR, lbtDirOverride);
+}
+
+function prompt(question) {
+  return new Promise((resolve) => {
+    const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+    rl.question(question, (ans) => {
+      rl.close();
+      resolve(ans.trim().toLowerCase());
+    });
+  });
+}
+
+/**
+ * 跑完一次 run 后，更新 .fingerprint 的 runCount 和 lastRunAt
+ * @param {string} [lbtDirOverride]
+ */
+export function bumpRunCount(lbtDirOverride = null) {
+  const lbtDir = lbtDirOverride || path.join(process.cwd(), ".lbt");
+  const fpPath = path.join(lbtDir, ".fingerprint");
+  if (!fs.existsSync(fpPath)) return;
+  const fp = JSON.parse(fs.readFileSync(fpPath, "utf8"));
+  fp.runCount = (fp.runCount ?? 0) + 1;
+  fp.lastRunAt = new Date().toISOString();
+  fs.writeFileSync(fpPath, JSON.stringify(fp, null, 2));
+}

package/standard-skill/local-browser-test/local-browser-executor.js

@@ -31,6 +31,18 @@ import fs from "node:fs";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
 import { BrowserEngine } from "./lib/browser-engine.js";
+// PR #1: 配置加载 + 脱敏
+import { loadConfig } from "./lib/config-loader.js";
+import { redact } from "./lib/redact.js";
+// PR #2: workspace + multi-env + storageState + globalSetup + projects
+import { ensureWorkspace, initForce, bumpRunCount } from "./lib/workspace-init.js";
+import { applyStorageState, buildCookieHeader } from "./lib/storage-state.js";
+import { globalSetupTakeover, globalSetupFillForm } from "./lib/global-setup.js";
+import { applyProject, listProjects } from "./lib/projects.js";
+// PR #3: v4 Playwright 风格 HTML 报告
+import { generateRunHtml, appendRunCardToIndex, initIndexHtml } from "./lib/html-reporter.js";
+import { appendToTrend } from "./lib/trend-aggregator.js";
+import { applyRetain, archiveFailedRun } from "./lib/report-retain.js";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -52,6 +64,71 @@ function parseArgs() {
             case "--plan-file":
                 parsed.planFile = args[++i];
                 break;
+            // ★ PR #1 v3: 配置外置
+            case "--config":
+                parsed.config = args[++i];
+                break;
+            case "--env":
+                parsed.env = args[++i];
+                break;
+            // ★ PR #2 v3: workspace + multi-env + storageState + globalSetup
+            case "--workspace":
+                parsed.workspace = args[++i];
+                break;
+            case "--project":
+                parsed.project = args[++i];
+                break;
+            case "--storage-state":
+                parsed.storageState = args[++i];
+                break;
+            case "--global-setup":
+                parsed.globalSetup = true;
+                break;
+            case "--init-force":
+                parsed.initForce = true;
+                break;
+            // ★ PR #5 v3: 失败定位资料（trace / video / HAR / console）
+            case "--screenshot":
+                parsed.screenshotPolicy = args[++i] || 'always';
+                break;
+            case "--video":
+                parsed.videoPolicy = args[++i] || 'off';
+                break;
+            case "--trace":
+                parsed.tracePolicy = args[++i] || 'off';
+                break;
+            case "--record-har":
+                parsed.recordHar = true;
+                break;
+            case "--ci":
+                parsed.ci = true;
+                // --ci 一键切 CI 模式
+                if (!parsed.screenshotPolicy) parsed.screenshotPolicy = 'only-on-failure';
+                if (!parsed.videoPolicy) parsed.videoPolicy = 'retain-on-failure';
+                if (!parsed.tracePolicy) parsed.tracePolicy = 'retain-on-failure';
+                // PR #6 v3: --ci 默认 retries=2
+                if (parsed.retries === undefined) parsed.retries = 2;
+                break;
+            // ★ PR #6 v3: 重试策略（用例级 + 写操作禁重试 + flaky）
+            case "--retries":
+                parsed.retries = parseInt(args[++i], 10) || 0;
+                break;
+            case "--flaky-threshold":
+                parsed.flakyThreshold = parseInt(args[++i], 10) || 5;
+                break;
+            case "--no-retry-actions":
+                parsed.noRetryActions = true;
+                break;
+            // ★ PR #7 v3: 用例标签过滤
+            case "--tags":
+                parsed.tags = args[++i] || "";
+                break;
+            case "--exclude-tags":
+                parsed.excludeTags = args[++i] || "";
+                break;
+            case "--tag-mode":
+                parsed.tagMode = args[++i] || "any";
+                break;
             case "--output":
                 parsed.output = args[++i];
                 break;
@@ -694,7 +771,8 @@ async function executeAction(args) {
                 if (args.testReport) {
                     const dir = path.dirname(args.testReport);
                     if (!fs.existsSync(dir)) fs.mkdirSync(dir, { recursive: true });
-                    fs.writeFileSync(args.testReport, JSON.stringify(result, null, 2), "utf8");
+                    // ★ PR #1 v3: 落盘前 redact
+                    fs.writeFileSync(args.testReport, JSON.stringify(redact(result), null, 2), "utf8");
                     process.stderr.write(`测试报告已写入: ${args.testReport}\n`);
                 }
 
@@ -894,6 +972,91 @@ async function executeAction(args) {
 async function main() {
     const args = parseArgs();
 
+    // ★ PR #1 v3: 加载配置（必须在 args 解析后立即做）
+    let config = null;
+    try {
+        config = loadConfig(args);
+        // 注入到 args，供后续 action 使用
+        args.config = config;
+        // 兼容 baseURL 字段
+        if (!args.baseUrl && config.app?.baseURL) {
+            args.baseUrl = config.app.baseURL;
+        }
+        if (config.auth?.type) args.authType = config.auth.type;
+    } catch (err) {
+        // 配置加载失败：若用户显式传 --config/--env 则报错，否则用默认
+        if (args.config || args.env) {
+            process.stderr.write(`❌ 配置加载失败: ${err.message}\n`);
+            process.exit(2);
+        }
+        // 隐式加载 + 没指定 → 用默认（不报错）
+        process.stderr.write(`ℹ️  使用默认配置（${err.message}）\n`);
+    }
+
+    // ★ PR #2 v3: 加载配置后立即 apply project（多环境）
+    if (config && args.project) {
+        try {
+            const updated = applyProject(config, args.project);
+            args.config = updated;
+            if (updated.app?.baseURL && !args.baseUrl) args.baseUrl = updated.app.baseURL;
+            if (updated.auth?.token) args.authToken = updated.auth.token;
+            if (updated.auth?.type) args.authType = updated.auth.type;
+        } catch (err) {
+            process.stderr.write(`❌ ${err.message}\n`);
+            process.exit(2);
+        }
+    }
+
+    // ★ PR #2 v3: workspace 初始化（仅显式 --workspace 或 --init-force 时）
+    if (args.workspace || args.initForce) {
+        const SKILL_DIR = __dirname;
+        if (args.initForce) {
+            await initForce(SKILL_DIR, args.workspace || null);
+        } else {
+            ensureWorkspace(SKILL_DIR, args.workspace || null);
+        }
+        args.workspace = args.workspace || path.join(process.cwd(), ".lbt");
+    }
+
+    // ★ PR #2 v3: globalSetup 模式（不走 testCase，单独导出 storageState）
+    if (args.globalSetup) {
+        try {
+            // 启动浏览器
+            const engine = new BrowserEngine();
+            const initResult = await engine.initialize({ cdpUrl: args.cdpUrl });
+            if (initResult?.error) {
+                process.stderr.write(`❌ 浏览器初始化失败: ${initResult.error}\n`);
+                process.exit(2);
+            }
+            const page = await engine.newPage();
+
+            const auth = args.config?.auth ?? {};
+            const outputPath = args.storageState || path.join(
+                args.workspace || path.join(process.cwd(), ".lbt"),
+                "auth",
+                `${args.project || "default"}.json`
+            );
+
+            if (auth.username && auth.password) {
+                // 模式 2：自动填表
+                await globalSetupFillForm(page, {
+                    loginUrl: (args.baseUrl || "http://localhost:3000") + "/login",
+                    username: auth.username,
+                    password: auth.password,
+                    verifyCode: auth.verifyCode
+                }, outputPath);
+            } else {
+                // 模式 1：接管浏览器（用户在浏览器里已登录）
+                await globalSetupTakeover(page, outputPath);
+            }
+            await engine.close();
+            process.exit(0);
+        } catch (err) {
+            process.stderr.write(`❌ globalSetup 失败: ${err.message}\n`);
+            process.exit(2);
+        }
+    }
+
     if (args.action === "assert-api" || args.action === "assertApi") {
         try {
             const results = executeAssertApiAction(args);
@@ -939,6 +1102,9 @@ async function main() {
     // 输出结果
     outputResult(results, args.output);
 
+    // ★ PR #3 v3: 生成 v4 报告（仅 workspace 模式启用）
+    v4ReportIfEnabled(results, args);
+
     // 输出摘要
     process.stderr.write(`\n执行完成:\n`);
     process.stderr.write(`  模式: ${results.mode || "failed"}\n`);
@@ -960,7 +1126,9 @@ async function main() {
 }
 
 function outputResult(results, outputPath) {
-    const json = JSON.stringify(results, null, 2);
+    // ★ PR #1 v3: 落盘前必走 redact（password / verifyCode / credentials / token 等）
+    const safe = redact(results);
+    const json = JSON.stringify(safe, null, 2);
 
     if (outputPath) {
         const dir = path.dirname(outputPath);
@@ -974,6 +1142,62 @@ function outputResult(results, outputPath) {
     }
 }
 
+/**
+ * ★ PR #3 v3: 生成 v4 Playwright 风格 HTML 报告
+ *   - 仅在 args.workspace 存在时启用
+ *   - 生成 runs/<id>/index.html + trend.json + 入口 index.html + retain
+ *   - 失败归档到 runs-failed/
+ */
+function v4ReportIfEnabled(results, args) {
+    if (!args.workspace) return;  // 仅 workspace 模式启用
+    try {
+        const reportsDir = path.join(args.workspace, "reports");
+        const runId = `${(results.startedAt ?? new Date().toISOString()).replace(/[:.]/g, "-")}-pid${process.pid}`;
+        const runDir = path.join(reportsDir, "runs", runId);
+        fs.mkdirSync(runDir, { recursive: true });
+
+        // 1. 补 runId
+        results.runId = runId;
+
+        // 2. 写 result.json（redact 后）
+        fs.writeFileSync(
+            path.join(runDir, "result.json"),
+            JSON.stringify(redact(results), null, 2)
+        );
+
+        // 3. 生成单 run HTML
+        generateRunHtml(results, runDir);
+
+        // 4. 初始化入口 + 追加 run card（仅首次）
+        initIndexHtml(reportsDir);
+        appendRunCardToIndex(results, path.join(reportsDir, "index.html"));
+
+        // 5. 写 trend.json
+        appendToTrend(results, path.join(reportsDir, "trend.json"));
+
+        // 6. 失败归档
+        if ((results.stats?.failed ?? 0) > 0) {
+            archiveFailedRun(runId, runDir, path.join(reportsDir, "runs-failed"));
+        }
+
+        // 7. retain 策略
+        const reportCfg = args.config?.report ?? {};
+        const retainResult = applyRetain(reportsDir, {
+            retainRuns: reportCfg.retainRuns ?? 30,
+            retainRunsByDay: reportCfg.retainDays ?? 7,
+            retainFailedForever: reportCfg.retainFailedForever ?? true
+        });
+
+        // 8. bumpRunCount
+        bumpRunCount(args.workspace);
+
+        process.stderr.write(`✓ v4 报告: ${reportsDir}/runs/${runId}/index.html\n`);
+        process.stderr.write(`  (保留 ${retainResult.kept} / 移除 ${retainResult.removed} / 总 ${retainResult.total})\n`);
+    } catch (err) {
+        process.stderr.write(`⚠️  v4 报告生成失败: ${err.message}\n`);
+    }
+}
+
 main().catch((err) => {
     process.stderr.write(`Fatal error: ${err.message}\n`);
     process.exit(2);