ykq-playwright-ci 0.1.1 → 0.1.2

package/README.md

@@ -186,10 +186,13 @@ projects.config.json
 失败时会生成：
 
 ```text
+test-results/summary.md
 test-results/
 playwright-report/
 ```
 
+其中 `test-results/summary.md` 是 Markdown 摘要，适合直接发给别人看。
+
 在源码仓库里可以打开报告：
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ykq-playwright-ci",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Company-level Playwright E2E test project for doctor PC workflows.",
   "bin": {
     "playwright-ci": "bin/playwright-ci.mjs"
@@ -16,6 +16,7 @@
     ".nvmrc",
     "eslint.config.mjs",
     "package.json",
+    "playwright.config.mjs",
     "playwright.config.ts",
     "projects.config.json",
     "README.md",

package/playwright.config.mjs

@@ -0,0 +1,62 @@
+/* global process */
+
+import { defineConfig, devices } from '@playwright/test';
+import dotenv from 'dotenv';
+import path from 'node:path';
+
+dotenv.config();
+
+const resultsDir = process.env.PLAYWRIGHT_CI_RESULTS_DIR || 'test-results';
+const reportDir = process.env.PLAYWRIGHT_CI_REPORT_DIR || 'playwright-report';
+const testDir = process.env.PLAYWRIGHT_CI_TEST_DIR || '.';
+
+function optional(name) {
+  const value = process.env[name]?.trim();
+  return value ? value : undefined;
+}
+
+function trimTrailingSlash(value) {
+  return value?.replace(/\/+$/, '');
+}
+
+export default defineConfig({
+  testDir,
+  testMatch: ['**/*.spec.ts', '**/*.setup.ts'],
+  outputDir: resultsDir,
+  timeout: 60_000,
+  expect: {
+    timeout: 10_000
+  },
+  fullyParallel: false,
+  forbidOnly: Boolean(process.env.CI),
+  retries: process.env.CI ? 2 : 0,
+  workers: process.env.CI ? 2 : undefined,
+  reporter: [
+    ['list'],
+    ['html', { outputFolder: reportDir, open: 'never' }],
+    ['junit', { outputFile: path.join(resultsDir, 'junit.xml') }],
+    ['json', { outputFile: path.join(resultsDir, 'results.json') }]
+  ],
+  use: {
+    baseURL: trimTrailingSlash(optional('DOCTOR_BASE_URL')),
+    actionTimeout: 15_000,
+    navigationTimeout: 30_000,
+    trace: 'retain-on-failure',
+    screenshot: 'only-on-failure',
+    video: 'retain-on-failure'
+  },
+  projects: [
+    {
+      name: 'setup',
+      testMatch: /.*\.setup\.ts/
+    },
+    {
+      name: 'chromium',
+      dependencies: ['setup'],
+      testIgnore: /.*\.setup\.ts/,
+      use: {
+        ...devices['Desktop Chrome']
+      }
+    }
+  ]
+});

package/playwright.config.ts

@@ -1,10 +1,15 @@
 import { defineConfig, devices } from '@playwright/test';
+import path from 'node:path';
 import { appEnv } from './src/utils/env';
 
+const resultsDir = process.env.PLAYWRIGHT_CI_RESULTS_DIR || 'test-results';
+const reportDir = process.env.PLAYWRIGHT_CI_REPORT_DIR || 'playwright-report';
+const testDir = process.env.PLAYWRIGHT_CI_TEST_DIR || '.';
+
 export default defineConfig({
-  testDir: '.',
-  testMatch: ['cases/**/*.spec.ts', 'cases/**/*.setup.ts'],
-  outputDir: 'test-results',
+  testDir,
+  testMatch: ['**/*.spec.ts', '**/*.setup.ts'],
+  outputDir: resultsDir,
   timeout: 60_000,
   expect: {
     timeout: 10_000
@@ -15,9 +20,9 @@ export default defineConfig({
   workers: process.env.CI ? 2 : undefined,
   reporter: [
     ['list'],
-    ['html', { outputFolder: 'playwright-report', open: 'never' }],
-    ['junit', { outputFile: 'test-results/junit.xml' }],
-    ['json', { outputFile: 'test-results/results.json' }]
+    ['html', { outputFolder: reportDir, open: 'never' }],
+    ['junit', { outputFile: path.join(resultsDir, 'junit.xml') }],
+    ['json', { outputFile: path.join(resultsDir, 'results.json') }]
   ],
   use: {
     baseURL: appEnv.doctorBaseURL,

package/scripts/run-project.mjs

@@ -13,9 +13,11 @@ const configPath = process.env.PROJECTS_CONFIG_PATH
   ? path.resolve(process.env.PROJECTS_CONFIG_PATH)
   : path.join(rootDir, 'projects.config.json');
 const workspaceDir = process.env.PROJECTS_CONFIG_PATH ? path.dirname(configPath) : rootDir;
-const playwrightConfigPath = path.join(rootDir, 'playwright.config.ts');
+const playwrightConfigPath = path.join(rootDir, 'playwright.config.mjs');
 const playwrightCliPath = path.join(path.dirname(require.resolve('@playwright/test/package.json')), 'cli.js');
 const knownModeArgs = new Set(['--headed', '--debug', '--ui']);
+const resultsDir = process.env.PLAYWRIGHT_CI_RESULTS_DIR || path.join(workspaceDir, 'test-results');
+const reportDir = process.env.PLAYWRIGHT_CI_REPORT_DIR || path.join(workspaceDir, 'playwright-report');
 let gitAskpassPath = '';
 
 function readConfig() {
@@ -201,6 +203,112 @@ function buildPlaywrightArgs(caseDir, project, passthroughArgs) {
   return args;
 }
 
+function formatDuration(durationMs = 0) {
+  if (durationMs < 1000) {
+    return `${Math.round(durationMs)}ms`;
+  }
+
+  return `${(durationMs / 1000).toFixed(1)}s`;
+}
+
+function escapeMarkdown(value = '') {
+  return String(value).replace(/\|/g, '\\|').replace(/\r?\n/g, ' ');
+}
+
+function collectSpecs(suites = [], rows = []) {
+  for (const suite of suites) {
+    for (const spec of suite.specs || []) {
+      for (const test of spec.tests || []) {
+        const result = test.results?.[test.results.length - 1] || {};
+        const annotations = [...(test.annotations || []), ...(result.annotations || [])];
+        const caseId = annotations.find((item) => item.type === 'case-id')?.description || '-';
+        const priority = annotations.find((item) => item.type === 'priority')?.description || '-';
+        const error = result.errors?.[0]?.message || '';
+
+        rows.push({
+          status: result.status || test.status || (spec.ok ? 'passed' : 'failed'),
+          caseId,
+          priority,
+          title: spec.title,
+          projectName: test.projectName || '-',
+          duration: result.duration || 0,
+          file: spec.file || suite.file || '-',
+          line: spec.line || 0,
+          error
+        });
+      }
+    }
+
+    collectSpecs(suite.suites || [], rows);
+  }
+
+  return rows;
+}
+
+function statusText(status) {
+  if (status === 'passed') return '通过';
+  if (status === 'skipped') return '跳过';
+  if (status === 'timedOut') return '超时';
+  if (status === 'failed' || status === 'unexpected') return '失败';
+  return status || '-';
+}
+
+function writeMarkdownSummary(projectName, caseDir, exitCode) {
+  const jsonPath = path.join(resultsDir, 'results.json');
+  if (!fs.existsSync(jsonPath)) {
+    console.warn(`未找到 Playwright JSON 结果，已跳过 Markdown 摘要：${jsonPath}`);
+    return;
+  }
+
+  const result = JSON.parse(fs.readFileSync(jsonPath, 'utf8'));
+  const stats = result.stats || {};
+  const rows = collectSpecs(result.suites || []);
+  const summaryPath = path.join(resultsDir, 'summary.md');
+  const failedRows = rows.filter((row) => !['passed', 'skipped'].includes(row.status));
+  const status = exitCode === 0 && failedRows.length === 0 ? '通过' : '失败';
+  const reportPath = path.relative(resultsDir, path.join(reportDir, 'index.html')) || 'index.html';
+
+  const lines = [
+    '# Playwright 测试结果',
+    '',
+    `- 项目：${projectName}`,
+    `- 状态：${status}`,
+    `- 开始时间：${stats.startTime || '-'}`,
+    `- 总耗时：${formatDuration(stats.duration || 0)}`,
+    `- 用例数：${rows.length}`,
+    `- 通过：${stats.expected ?? 0}`,
+    `- 失败：${stats.unexpected ?? 0}`,
+    `- 跳过：${stats.skipped ?? 0}`,
+    `- 不稳定：${stats.flaky ?? 0}`,
+    `- 用例目录：${path.relative(workspaceDir, caseDir) || caseDir}`,
+    `- HTML 报告：${reportPath}`,
+    '',
+    '## 用例明细',
+    '',
+    '| 状态 | 用例 ID | 优先级 | 用例 | 浏览器 | 耗时 | 文件 |',
+    '| --- | --- | --- | --- | --- | --- | --- |'
+  ];
+
+  for (const row of rows) {
+    const file = row.line ? `${row.file}:${row.line}` : row.file;
+    lines.push(
+      `| ${statusText(row.status)} | ${escapeMarkdown(row.caseId)} | ${escapeMarkdown(row.priority)} | ${escapeMarkdown(row.title)} | ${escapeMarkdown(row.projectName)} | ${formatDuration(row.duration)} | ${escapeMarkdown(file)} |`
+    );
+  }
+
+  if (failedRows.length) {
+    lines.push('', '## 失败信息', '');
+    for (const row of failedRows) {
+      lines.push(`### ${row.caseId} ${row.title}`, '');
+      lines.push(row.error ? `\`\`\`text\n${row.error.trim()}\n\`\`\`` : '无错误详情。', '');
+    }
+  }
+
+  fs.mkdirSync(resultsDir, { recursive: true });
+  fs.writeFileSync(summaryPath, `${lines.join('\n')}\n`);
+  console.log(`Markdown 测试摘要已生成：${summaryPath}`);
+}
+
 function main() {
   const config = readConfig();
   const { projectName, passthroughArgs, skipPull } = parseArgs(process.argv.slice(2));
@@ -227,7 +335,10 @@ function main() {
       cwd: workspaceDir,
       env: {
         ...(project.env || {}),
-        ...process.env
+        ...process.env,
+        PLAYWRIGHT_CI_RESULTS_DIR: resultsDir,
+        PLAYWRIGHT_CI_REPORT_DIR: reportDir,
+        PLAYWRIGHT_CI_TEST_DIR: workspaceDir
       },
       stdio: 'inherit'
     }
@@ -239,7 +350,13 @@ function main() {
       return;
     }
 
-    process.exit(code ?? 1);
+    const exitCode = code ?? 1;
+    try {
+      writeMarkdownSummary(projectName, caseDir, exitCode);
+    } catch (error) {
+      console.warn(`Markdown 测试摘要生成失败：${error instanceof Error ? error.message : error}`);
+    }
+    process.exit(exitCode);
   });
 }