add: coverate rate test

Author: Junyi-99

.github/workflows/test-coverage.yaml

@@ -0,0 +1,77 @@
+name: Test Coverage
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  test-coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests with coverage
+        run: npm run test:coverage
+
+      - name: Upload coverage reports
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: coverage/
+          retention-days: 30
+
+      - name: Coverage Report Summary
+        if: always()
+        run: |
+          echo "## 📊 Test Coverage Summary" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          if [ -f coverage/coverage-summary.json ]; then
+            echo "### Overall Coverage:" >> $GITHUB_STEP_SUMMARY
+            echo "\`\`\`json" >> $GITHUB_STEP_SUMMARY
+            cat coverage/coverage-summary.json | jq '.' >> $GITHUB_STEP_SUMMARY
+            echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+          fi
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "📁 [Download detailed coverage report](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})" >> $GITHUB_STEP_SUMMARY
+
+      - name: Comment PR with coverage
+        if: github.event_name == 'pull_request'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const fs = require('fs');
+            if (fs.existsSync('coverage/coverage-summary.json')) {
+              const coverage = JSON.parse(fs.readFileSync('coverage/coverage-summary.json', 'utf8'));
+              const total = coverage.total;
+              
+              const comment = `## 📊 Test Coverage Report
+              
+              | Metric | Coverage | 
+              |--------|----------|
+              | Lines | ${total.lines.pct}% (${total.lines.covered}/${total.lines.total}) |
+              | Functions | ${total.functions.pct}% (${total.functions.covered}/${total.functions.total}) |
+              | Branches | ${total.branches.pct}% (${total.branches.covered}/${total.branches.total}) |
+              | Statements | ${total.statements.pct}% (${total.statements.covered}/${total.statements.total}) |
+              
+              🔗 [View detailed report](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})`;
+              
+              github.rest.issues.createComment({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                body: comment
+              });
+            } 

README.test-coverage.md

@@ -0,0 +1,88 @@
+# 测试覆盖率 (Test Coverage)
+
+本项目已经配置了自动化的测试覆盖率报告功能。
+
+## 🚀 功能特性
+
+- **自动触发**: 当代码推送到 `main` 或 `develop` 分支，或创建 Pull Request 时自动运行
+- **详细报告**: 生成包含行覆盖率、函数覆盖率、分支覆盖率和语句覆盖率的详细报告
+- **PR 评论**: 在 Pull Request 中自动添加覆盖率摘要评论
+- **工件保存**: 覆盖率报告作为 GitHub Actions 工件保存30天，可下载查看详细信息
+
+## 📊 覆盖率阈值
+
+当前配置的最低覆盖率要求：
+- 行覆盖率: 70%
+- 函数覆盖率: 70%
+- 分支覆盖率: 70%
+- 语句覆盖率: 70%
+
+如果覆盖率低于这些阈值，测试将失败。
+
+## 🛠️ 本地运行
+
+### 运行测试并生成覆盖率报告
+```bash
+npm run test:coverage
+```
+
+### 查看覆盖率报告
+```bash
+# 在浏览器中打开 HTML 报告
+open coverage/lcov-report/index.html
+```
+
+## 📁 覆盖率文件说明
+
+运行覆盖率测试后，会在 `coverage/` 目录生成以下文件：
+- `lcov.info`: LCOV 格式的覆盖率数据
+- `coverage-summary.json`: JSON 格式的覆盖率摘要
+- `lcov-report/`: HTML 格式的详细覆盖率报告
+- `coverage-final.json`: 完整的覆盖率数据
+
+## ⚙️ 配置修改
+
+### 修改覆盖率阈值
+编辑 `jest.config.js` 文件中的 `coverageThreshold` 部分：
+
+```javascript
+coverageThreshold: {
+    global: {
+        branches: 80,    // 修改分支覆盖率阈值
+        functions: 80,   // 修改函数覆盖率阈值
+        lines: 80,       // 修改行覆盖率阈值
+        statements: 80   // 修改语句覆盖率阈值
+    }
+}
+```
+
+### 修改触发分支
+编辑 `.github/workflows/test-coverage.yaml` 文件中的 `on` 部分：
+
+```yaml
+on:
+  push:
+    branches: [ main, develop, feature/* ]  # 添加更多分支
+  pull_request:
+    branches: [ main, develop ]
+```
+
+## 🔍 查看报告
+
+1. **GitHub Actions 页面**: 在 Actions 标签页查看测试运行状态和覆盖率摘要
+2. **Pull Request 评论**: 每个 PR 都会自动添加覆盖率报告评论
+3. **下载详细报告**: 在 Actions 运行页面下载 `coverage-report` 工件
+
+## 🚨 故障排除
+
+### 测试失败
+如果覆盖率测试失败，请检查：
+1. 测试是否正常运行：`npm test`
+2. 覆盖率是否达到阈值
+3. 是否有未测试的代码文件
+
+### 无法生成报告
+确保：
+1. Jest 配置正确
+2. 测试文件路径匹配 `testMatch` 模式
+3. 源代码路径在 `collectCoverageFrom` 中正确配置 

jest.config.js

@@ -7,5 +7,27 @@ module.exports = {
     transform: {
         '^.+\\.ts$': 'ts-jest',
     },
-    collectCoverageFrom: ['<rootDir>/src/**/*.ts', '!**/node_modules/**'],
+    collectCoverageFrom: [
+        '<rootDir>/src/**/*.ts',
+        '!**/node_modules/**',
+        '!<rootDir>/src/**/*.d.ts',
+        '!<rootDir>/src/**/__tests__/**',
+        '!<rootDir>/src/**/test/**'
+    ],
+    coverageDirectory: 'coverage',
+    coverageReporters: [
+        'text',
+        'text-summary',
+        'lcov',
+        'html',
+        'json-summary'
+    ],
+    coverageThreshold: {
+        global: {
+            branches: 70,
+            functions: 70,
+            lines: 70,
+            statements: 70
+        }
+    }
 };