テストとデバッグ

Verdent for VS Code は、マルチパスの生成・テスト・修復サイクル、エラー分析、自動的なテストカバレッジの改善を通じて、包括的なテストの作成と問題のデバッグを支援します。プロジェクトのテストフレームワークやスタイルに合わせて、ユニットテスト、統合テスト、エンドツーエンドテストを生成します。

このページで学べること

• エッジケースと期待される動作を網羅するユニットテストの生成
• 主要なすべてのテストフレームワーク（Jest、Pytest、JUnit など）への対応
• 複数コンポーネントにまたがるワークフローを検証する統合テストの作成
• 未カバーのコードパスを特定してテストし、テストカバレッジを改善
• エラーメッセージ分析と実行トレースによる問題のデバッグ
• スタックトレース、エラーログ、予期しない動作からのバグ診断

前提条件

Verdent でテストやデバッグを行う前に、以下を確認してください。

• Verdent 拡張機能をインストールした Visual Studio Code
• VS Code で開いたコードベースまたはプロジェクトワークスペース
• 利用可能なクレジットがある有効な Verdent サブスクリプション
• プロジェクトに設定されたテストフレームワーク（テスト生成では任意）

ユニットテストの作成

Verdent は、プロジェクトのテストフレームワークやスタイルに合わせてユニットテストを生成します。既存のテストを分析してパターンを把握し、適切なセットアップ、アサーション、モックを備えたテストを生成します。

例：

Write unit tests for the calculateDiscount function

Verdent は次の処理を行います。

• calculateDiscount 関数の実装を調査
• 入力パラメータと戻り値を特定
• 既存のテストを分析して規約（テスト構造、アサーションスタイル、命名パターン）に合わせる
• 次を網羅するテストを生成：
  • 正常系: 期待される出力を持つ有効な入力
  • エッジケース: 境界値、ゼロ、負の数、最大値
  • 無効な入力: null、undefined、誤った型
  • 期待される動作: ビジネスロジックの検証

生成されるテストの構造：

Verdent は、プロジェクトのパターンに従ってテストを作成します。

• テストスイートの構成: describe ブロック、テストクラス、またはモジュール構造
• セットアップとティアダウン: 既存のテストに合わせた before/after フック
• アサーション: プロジェクトのアサーションライブラリ（expect、assert、should など）を使用
• モック: プロジェクトのモックパターン（jest.mock、sinon、unittest.mock）に合わせる
• 命名規約: 確立されたスタイルに従ったテスト名

マルチパスの生成・テスト・修復サイクル：

包括的なテストのために、Verdent はマルチパスサイクルを使用します。

1. 生成: 初期テストスイートを作成
2. 実行: テストを実行して動作を検証
3. 修復: 失敗するテストを修正、またはカバレッジを改善
4. 反復: テストが成功しカバレッジが十分になるまで繰り返す

これにより、テストは単に書かれるだけでなく、実際にコードベースで正しく動作することが保証されます。

対応するテストフレームワーク

Verdent は、さまざまなプログラミング言語や技術スタックにわたる主要なテストフレームワークすべてに、追加設定なしで対応します。

test('sum returns correct result', () => {
  expect(sum(2, 3)).toBe(5);
});

const assert = require('assert');

describe('sum', () => {
  it('returns correct result', () => {
    assert.strictEqual(sum(2, 3), 5);
  });
});

import { describe, it, expect } from 'vitest';

it('sum returns correct result', () => {
  expect(sum(2, 3)).toBe(5);
});

describe('sum', () => {
  it('returns correct result', () => {
    expect(sum(2, 3)).toEqual(5);
  });
});

Verdent は、プロジェクトの設定や既存のテストからテストフレームワークを認識し、セットアップに合ったテストを自動的に生成します。

統合テストの生成

Verdent は、複数のコンポーネント、サービス、モジュールがどのように連携して動作するかを検証する統合テストを生成します。API とのやり取り、データベース操作、認証フロー、複数ステップのユーザージャーニーなど、実際のワークフローをシミュレートするテストを作成します。

例：

Write integration tests for the user registration flow

Verdent は、フロー全体を検証するテストを生成します。

1. フォーム送信: ユーザーが有効なデータで登録フォームを送信
2. 検証: バックエンドがメール形式、パスワード強度、データの完全性を検証
3. データベース挿入: ユーザーレコードがデータベースに作成される
4. メール送信: 確認メールが送信される（モックまたは実際の送信）
5. ログイン成功: 新規ユーザーが認証情報ですぐにログインできる

統合テストの構造：

Verdent は、次の要素を備えた統合テストを作成します。

• テストセットアップ: データベースのシード、サービスの初期化、テストデータの作成
• ワークフローのシミュレーション: 複数ステップの操作を順番に実行
• 状態の検証: データベース状態、API レスポンス、副作用の確認
• 外部サービスのモック: メールサービス、決済 API、サードパーティ連携
• テストのティアダウン: テストデータのクリーンアップ、データベースのロールバック、サービスのシャットダウン

テストシナリオの例：

Write integration tests for the checkout and payment process

Verdent がテストする内容：

• カートへの商品追加
• 割引コードの適用
• 税金と送料を含む合計金額の計算
• 決済処理（モック化された決済ゲートウェイを使用）
• データベースへの注文レコードの作成
• 確認メールの送信
• 在庫の更新

テストの分離：

Verdent は、統合テストが適切に分離されていることを保証します。

• 各テストはクリーンなデータベース状態から開始
• 外部サービス呼び出しはモック化され、副作用を防止
• テストは依存関係なしで任意の順序で実行可能
• テストが失敗してもクリーンアップが行われる

テストカバレッジの改善

Verdent は、コードベースを分析して未テストの関数、分岐、エッジケースを特定し、カバレッジを改善するテストを生成します。既存のテストスイートを調査し、コードパスが実行されていないギャップを見つけます。

例：

Analyze test coverage and write tests for uncovered code paths in the payment module

Verdent は次の処理を行います。

1. 既存テストの分析: 現在何がテストされているかを調査
2. カバレッジギャップの特定: テストが不足している特定の関数、条件分岐、エラー処理パス、エッジケースを発見
3. 不足テストの生成: 未カバーのコードを対象とするテストを作成
4. カバレッジ改善の検証: テストを実行してカバレッジが向上したことを確認

Verdent が特定する対象：

• 未テストの関数: テストカバレッジがまったくない関数
• 条件分岐: 一方の分岐がテストされていない if/else 文
• エラー処理パス: 失敗時のテストがない try/catch ブロックやエラーコールバック
• エッジケース: 境界値、null/undefined の処理、型変換
• 統合ポイント: API 呼び出し、データベース操作、外部サービスとのやり取り

カバレッジ改善の例：

Improve test coverage for the UserService class

Verdent が特定する内容：

• getUserById は有効な ID のテストはあるが無効な ID のテストがない
• updateUser は検証失敗のテストが不足
• deleteUser は認可チェックのテストが不足
• createUser のエラー処理パスが未テスト

そのうえで、これらのギャップを狙ったテストを生成し、カバレッジを 65% から 95% に向上させます。

カバレッジ指標：

Verdent は、より高いカバレッジ率の達成と、これまで未テストだったコードに潜む潜在的なバグの発見を支援します。

• 行カバレッジ: テストで実行されたコード行の割合
• 分岐カバレッジ: テストされた条件分岐の割合
• 関数カバレッジ: 少なくとも 1 つのテストがある関数の割合
• ステートメントカバレッジ: 実行されたステートメントの割合

Verdent によるデバッグ

Verdent は、エラーメッセージの分析、実行フローのトレース、根本原因の特定、修正案の提示によってデバッグを支援します。エラーログを貼り付けたり、予期しない動作を説明したり、特定の問題の調査を Verdent に依頼したりできます。

This function returns undefined instead of the user object. Debug it.

The login form redirects to the home page even when credentials are invalid

The product search is slow when the database has 10,000+ products

Why does this API endpoint return a 500 error when the email parameter is missing?

エラーメッセージとログからの診断

エラーメッセージ、スタックトレース、ログファイルをチャットに直接貼り付けてください。Verdent はエラーを分析し、ソースファイルと行番号を特定し、原因を説明して修正案を提示します。

TypeError: Cannot read property 'name' of undefined
    at UserProfile.render (UserProfile.jsx:45)
    at processComponent (react-dom.js:2103)

I'm getting this error: [paste stack trace]

Analyze these logs and tell me why the API requests are failing:
[paste 50 lines of log output]

The shopping cart total is sometimes incorrect. Here are the error logs: [paste logs]

ベストプラクティス

関連項目