テストカバレッジアナライザー は何をしますか?
このスキルは、テストカバレッジのギャップを特定し、コード品質を向上させるための具体的なテストケースを提案します。
このスキルを使用するタイミング
- ユーザーがテストカバレッジの分析を依頼した場合
- ユーザーがテストカバレッジの改善を希望する場合
- ユーザーが不足しているテストの提案を要求した場合
- コードカバレッジ率の向上に取り組んでいる場合
- ユーザーが「カバレッジギャップ」「未テストコード」「テスト提案」に言及した場合
手順
1. テストフレームワークの検出
プロジェクトで使用されているテストフレームワークを特定します。
JavaScript/TypeScript:
- Jest:
package.json内のjestまたはjest.config.js - Mocha:
package.json内のmochaまたは.mocharc - Vitest:
package.json内のvitestまたはvitest.config.js - Jasmine:
package.json内のjasmine
Python:
- pytest:
requirements.txt内のpytestまたはpytest.ini - unittest: 標準ライブラリ、テストファイルを確認
- coverage.py:
requirements.txt内のcoverage
Ruby:
- RSpec:
Gemfile内のrspec - 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('should reject invalid email format', () => {
// TODO: メール検証のエラーパスをテスト(15~18行目)
const result = validateEmail('invalid-email');
expect(result.valid).toBe(false);
});
it('should handle empty string input', () => {
// TODO: 空入力の処理をテスト(23~25行目)
});
});
});
8. カバレッジ指標の計算
サマリー統計を提供します。
- 全体のカバレッジ率
- ファイル/ディレクトリ別のカバレッジ
- テストがない関数/メソッド
- カバレッジが低いクリティカルファイル
- カバレッジのトレンド(過去データがある場合)
9. 推奨事項の優先順位付け
提案を以下の順序で並べます。
- 影響: クリティカルなビジネスロジックを最優先
- リスク: 高リスク領域(セキュリティ、データ整合性)
- 複雑性: 複雑なロジックはより多くのテストが必要
- 容易性: 即効性のあるもの(高カバレッジ向上のための簡単なテスト)
10. 出力形式
発見事項を明確で実行可能な形式で提示します。
カバレッジ分析サマリー
=========================
全体カバレッジ: 67%
- ステートメント: 65%
- ブランチ: 58%
- 関数: 72%
- 行: 67%
注意が必要なファイル(優先順位順):
1. src/payment/processor.js(23% カバレッジ)- 高優先度
- 不足: 支払い失敗のエラーハンドリング
- 不足: リトライロジックのテスト
- 不足: トランザクション検証
2. src/auth/validator.js(45% カバレッジ)- 中優先度
- 不足: 無効なトークンの処理
- 不足: 期限切れセッションのテスト
提案テストケース:
[各ファイルの詳細な提案]
ベストプラクティス
- 意味のあるカバレッジに焦点を当てる: 100% カバレッジが常に必要とは限らない
- 実装ではなく振る舞いをテストする: 機能を検証するテストを提案する
- クリティカルパスを優先する: 認証、支払い、データ検証を最初に
- テストの種類を考慮する: 適宜、単体テスト、結合テスト、E2E テストを
- 既存のテストを確認する: すでに存在するテストは提案しない
- 現実的なテストデータ: 例では妥当な入力を使う
- カバレッジしきい値: 最低限のカバレッジ目標(例: 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 用テストファイルテンプレート