Copilot を使用してユニットテストを生成する方法

Microsoft と OpenAI は、GitHub と共同で、AI を活用したコード最適化および補完ツールである Copilot 拡張機能を開発しました。このツールは、利用可能な既存のコードに基づいてブロックやコード行を提案することで、開発者を支援します。ソフトウェア開発におけるユニット テストとは、コード ユニットまたはブロックをテストして、適切な機能があることを確認することです。コード テストに AI を統合すると、ソフトウェア開発の生産性が向上するだけでなく、全体的な品質も向上します。この記事では、Copilot を使用してユニット テストを生成する方法について説明します。

GitHub Copilotの概要

GitHub Copilot は、コードのコンテキストに基づいてコード スニペットを提案する AI 搭載のコーディング アシスタントです。OpenAI と Github は、コンテキスト ベースのコード提案を提供する GPT-3 モデルと Codex を使用した AI 搭載の言語処理ツールを開発しました。これは、公開されているコードでトレーニングされており、Visual Studio などの一般的なコード エディターと統合できます。

Copilot による自動ユニットテスト生成の利点

1. 時間効率: Copilot は、記述した説明やコメントに基づいて、ユニット テスト コードを即座に自動生成できます。これにより、手動でテスト コードを作成するよりも多くの時間を節約でき、ソフトウェア開発サイクルの改善と最適化が可能になります。
2. 人的エラーの削減:自動化によりプロセスが高速化されるだけでなく、一般的な人的エラーも大幅に削減されます。記述されたコードを確認することで、Copilot は目的を簡単に理解し、手動エラーなしでそれに応じたテストを生成できます。
3. 一貫性: Copilot は、ユニット テストを生成する際に、テスト構造とパターンの統一性を強化する傾向があります。このようなアプローチにより、コードベース全体に対して同様のテスト アプローチを維持でき、プログラム全体を理解しやすくなります。
4. Copilot は、テスト ケースの動的なコード提案を通じて TDD プラクティスをサポートします。同時に、コードを記述し、コードを実装する前にテストを作成するテスト ファースト アプローチを推奨します。

Copilot を使用してユニットテストを生成する方法

テストを生成するには、まず GitHub Copilot 拡張機能をインストールし、Copilot がテストを開始できるようにする前にプログラムを作成します。テスト ケースを生成するには、次の手順に従います。

1] Github Copilot拡張機能をインストールする

Visual Studio Marketplaceを開き、GitHub Copilot 拡張機能を検索して、「インストール」をクリックします。

2] 関数を作成する

Copilot を使用した単体テスト生成をデモンストレーションするために、Python のユーザー記述関数 is_prime()を使用して特定の数が素数であるかどうかを確認するプログラムを作成します。

まず、上記の関数と素数をチェックするために必要なコードを含む、Python スクリプト ファイルprime_number.pyを作成します。ファイルを作成したら、素数をチェックするロジックに基づいてコードを記述できます。

3] ユニットテストを実行する

Copilot が上記のプログラムの単体テストを生成する方法を説明するには、以下の手順に従います。

• is_prime()関数をテストするために、unit_test_prime_number()という名前のテスト関数を作成します。
• 作成後、関数の目的またはドキュメント文字列を記述し、アサーション条件を追加します。ドキュメント文字列が指定されると、Copilot はテストのアサーション条件を提案し始めます。

効果的なユニットコード生成のヒント

• 明確な説明: Copilot は主に、ユーザーがファイル内に入力したコメントやドキュメント文字列を確認してユニット コードを生成します。したがって、意味のあるユニット テスト コードを生成するには、適切に記述された説明コードが不可欠です。
• 変数の命名:コードの目的を表す変数名を使用すると、テスト ケースの生成に役立ちます。変数名を明確にすることで、自動生成されたテスト ケースが期待どおりのものになります。
• モッキングとスタブのテクニックの使用:モッキングとスタブは、コードの機能を検査するためのダミー環境を作成するために使用されるテスト テクニックです。モッキングは、データベースや Web サービスなどの実際のオブジェクトのクローンを作成し、スタブは、テスト対象のコードが依存する機能の簡略化されたバージョンを作成します。
• 提案されたコードを確認する: Copilot の提案がテスト要件とコーディング標準を満たしていることを確認するために確認する必要があります。

GitHub Copilot を使用したユニットテストの制限

GitHub Copilot Chat は、質問に対して最も適切な回答を提供することを目的としています。ただし、必ずしも求めている回答が提供されるとは限りません。Copilot Chat のユーザーは、システムによって生成された応答を確認し、正確かつ適切であることを確認する責任があります。

この投稿が役に立ち、GitHub を使用してユニット テストを生成する利点と制限を理解していただければ幸いです。

Copilot によって生成されたユニット テストは、コーナー ケースをカバーしますか?

Copilot は単体テストに役立つツールですが、すべてのシナリオをカバーできるわけではありません。提案内容を徹底的に確認し、異常な入力やエラーを考慮する必要があります。包括的なテストを確実に行うには、創造性を発揮してください。Copilot を使用しても、堅牢な単体テストを行うには専門知識が不可欠です。

テストケースの場合、Copilot は複雑なアルゴリズムを処理できますか?

Copilot は複雑なアルゴリズムのテストには苦労します。基本的なテストは作成できますが、専門知識に代わるものではありません。複雑なアルゴリズムの場合は、固有のロジックをターゲットにした特定のテストを作成してください。Copilot は役立ちますが、複雑なテストには常に専門知識が必要です。