測試覆蓋率分析器
此技能有助於識別測試覆蓋率的缺口,並提出具體的測試案例以改善程式碼品質。
何時使用此技能
- 使用者要求分析測試覆蓋率
- 使用者想要改善測試覆蓋率
- 使用者請求提供缺少測試的建議
- 正在努力提升程式碼覆蓋率百分比
- 使用者提及「覆蓋率缺口」、「未測試程式碼」或「測試建議」
指示
1. 偵測測試框架
識別專案中使用的測試框架:
JavaScript/TypeScript:
- Jest:
jest在 package.json 或jest.config.js - Mocha:
mocha在 package.json 或.mocharc - Vitest:
vitest在 package.json 或vitest.config.js - Jasmine:
jasmine在 package.json
Python:
- pytest:
pytest在 requirements.txt 或pytest.ini - unittest:標準函式庫,檢查測試檔案
- coverage.py:
coverage在 requirements.txt
Ruby:
- RSpec:
rspec在 Gemfile - Minitest:標準函式庫
Go:
- 內建:
go test(透過go test -cover產生覆蓋率)
Java:
- JUnit:在 pom.xml 或 build.gradle 中尋找 JUnit
- JaCoCo:覆蓋率工具設定
使用 Glob 和 Grep 尋找設定檔案。
2. 定位覆蓋率報告
尋找現有的覆蓋率報告:
常見位置:
coverage/目錄.nyc_output/(Node.js 的 NYC)htmlcov/(Python 的 coverage.py)target/site/jacoco/(Java 的 JaCoCo)- 覆蓋率檔案:
lcov.info、coverage.json、.coverage
如果沒有覆蓋率報告:
- 引導使用者執行覆蓋率命令:
npm test -- --coverage、pytest --cov等 - 等待報告產生後再進行分析
3. 解析覆蓋率資料
提取覆蓋率資訊:
從 lcov.info:
- 已覆蓋行數 vs 總行數
- 已覆蓋函式 vs 總函式數
- 已覆蓋分支 vs 總分支數
- 各檔案的未覆蓋行號
從 coverage.json(Jest):
- 語句覆蓋率百分比
- 分支覆蓋率百分比
- 函式覆蓋率百分比
- 行覆蓋率百分比
- 各檔案的未覆蓋行數
從 .coverage(Python):
- 使用
coverage report或coverage json - 缺少的行範圍
- 排除的行
從 HTML 報告:
- 讀取摘要統計資料
- 識別覆蓋率低的檔案
4. 識別覆蓋率缺口
優先找出需要測試的檔案/函式:
高優先順序:
- 覆蓋率為 0% 的業務邏輯
- 公開 API 和匯出的函式
- 錯誤處理路徑(catch 區塊、錯誤回呼)
- 邊緣情況和邊界條件
- 關鍵路徑(驗證、付款、資料驗證)
中優先順序:
- 部分覆蓋率的公用函式
- 被公開 API 呼叫的私有函式
- 設定和初始化程式碼
低優先順序:
- 簡單的 getter/setter
- 型別定義
- 自動產生的程式碼
- 第三方程式碼
5. 分析未測試的程式碼路徑
對於每個有覆蓋率缺口的檔案:
- 讀取原始檔案以了解程式碼結構
- 識別未測試的程式碼:
- 未覆蓋的行數和行範圍
- 未測試的條件分支(if/else)
- 未覆蓋的錯誤處理器
- 缺少的函式覆蓋率
- 分類缺少的測試:
- 快樂路徑測試
- 錯誤/例外測試
- 邊緣情況測試
- 整合測試
6. 產生測試建議
對於每個覆蓋率缺口,建議具體的測試案例:
格式:
檔案:src/utils/validator.js(42% 覆蓋率)
缺少的覆蓋率:
- 第 15-18 行:電子郵件驗證錯誤路徑
- 第 23-25 行:空輸入處理
- 第 30-35 行:特殊字元的邊緣情況
建議的測試:
1. 測試使用無效格式的電子郵件驗證(覆蓋第 15-18 行)
2. 測試使用空字串輸入的驗證器(覆蓋第 23-25 行)
3. 測試名稱中的特殊字元處理(覆蓋第 30-35 行)
測試案例細節應包含:
- 測試描述
- 輸入資料
- 預期的輸出/行為
- 覆蓋的行數/分支
7. 建立測試樁(選擇性)
如果使用者想要,產生測試檔案樁:
- 使用適當的測試框架語法
- 包含包含 TODO 註解的 describe/test 區塊
- 加入範例測試結構
- 參考
templates/test-template.js中的範本(或適當的副檔名)
範例(Jest):
describe('Validator', () => {
describe('validateEmail', () => {
it('應拒絕無效的電子郵件格式', () => {
// TODO:測試電子郵件驗證錯誤路徑(第 15-18 行)
const result = validateEmail('invalid-email');
expect(result.valid).toBe(false);
});
it('應處理空字串輸入', () => {
// TODO:測試空輸入處理(第 23-25 行)
});
});
});
8. 計算覆蓋率指標
提供摘要統計資料:
- 整體覆蓋率百分比
- 依檔案/目錄的覆蓋率
- 沒有測試的函式/方法
- 覆蓋率低的關鍵檔案
- 覆蓋率趨勢(如果有歷史資料)
9. 優先排序建議
按以下順序排列建議:
- 影響力:先處理關鍵業務邏輯
- 風險:高風險區域(安全性、資料完整性)
- 複雜度:複雜邏輯需要更多測試
- 簡易性:快速達成的成果(簡單測試以獲得高覆蓋率增益)
10. 輸出格式
以清晰、可操作的方式呈現結果:
覆蓋率分析摘要
=========================
整體覆蓋率:67%
- 語句:65%
- 分支:58%
- 函式:72%
- 行數:67%
需要注意的檔案(依優先順序排序):
1. src/payment/processor.js(23% 覆蓋率)- 高優先順序
- 缺少:付款失敗的錯誤處理
- 缺少:重試邏輯測試
- 缺少:交易驗證
2. src/auth/validator.js(45% 覆蓋率)- 中優先順序
- 缺少:無效 token 處理
- 缺少:過期 session 測試
建議的測試案例:
[每個檔案的詳細建議]
最佳實務
- 專注於有意義的覆蓋率:不總是需要 100% 覆蓋率
- 測試行為,而非實作:建議驗證功能的測試
- 優先處理關鍵路徑:先處理驗證、付款、資料驗證
- 考慮測試類型:適當時使用單元測試、整合測試和端到端測試
- 檢查現有測試:不要建議已存在的測試
- 使用真實的測試資料:在範例中使用合理的輸入
- 設定覆蓋率門檻:建議最低覆蓋率目標(例如 80%)
執行覆蓋率報告
根據偵測到的框架提供命令:
Jest: npm test -- --coverage 或 jest --coverage
Vitest: npm test -- --coverage 或 vitest run --coverage
Mocha + NYC: nyc mocha
pytest: pytest --cov=src --cov-report=html
Go: go test -cover ./... 或 go test -coverprofile=coverage.out
JUnit + JaCoCo: mvn test jacoco:report
支援檔案
scripts/parse-coverage.sh:用於提取覆蓋率資料的輔助腳本templates/test-template.js:JavaScript 的測試檔案範本templates/test-template.py:Python 的測試檔案範本templates/test-template.go:Go 的測試檔案範本