演習 - GitHub Copilot ツールを使用して単体テストを開発する

20 分

GitHub Copilot は、コードの単体テストを記述するのに役立ちます。 GitHub Copilot を使用して単体テストを生成するには、いくつかの方法があります。

テストケースの生成: GitHub Copilot を使用して、コードのテストケースを生成できます。 Copilot は、記述したコードに基づいてテストケースを提案できます。その後、これらのテストケースを使用して、コードの単体テストを作成できます。
テストメソッドを生成する: Copilot では、コードのテストメソッドを生成することもできます。これらのテストメソッドを使用して、コードの単体テストを作成できます。
テストアサーションを生成する: Copilot は、単体テストで使用できるアサーションを提案できます。これらのアサーションは、コードの動作を確認するのに役立ちます。
テストモックを生成する: Copilot では、単体テストで使用できるモックオブジェクトを生成できます。これらのモックオブジェクトは、テストするコードを依存関係から分離するのに役立ちます。
テストデータを生成する: Copilot では、単体テストで使用できるテストデータを生成できます。このテストデータは、さまざまな入力でコードをテストするのに役立ちます。
テストセットアップコードを生成する: Copilot は単体テストのセットアップコードを生成できます。このコードは、テストを実行する前にテスト環境を設定するのに役立ちます。
テスト破棄コードを生成する: Copilot は単体テストの破棄コードを生成できます。このコードは、テストの実行後にテスト環境をクリーンアップするのに役立ちます。

既存のソリューションには、UnitTests という名前の単体テストプロジェクトが含まれています。このプロジェクトには、ApplicationCore プロジェクトのサービスクラスを部分的にカバーする単体テストが既に含まれています。

この演習では、GitHub Copilot を使用して次のタスクを完了します。

UnitTests プロジェクトによって実装される単体テストへのアプローチを確認します。
UnitTests プロジェクトを拡張して、Library.Infrastructure プロジェクトのデータアクセスクラスのテストを開始します。

UnitTests プロジェクトによって実装される単体テストへのアプローチを確認する

既存のコードベースには、次のフォルダー構造を実装する UnitTests プロジェクトが含まれています。

UnitTests\
- ApplicationCore\
  - LoanService\
    - ExtendLoan.cs
    - ReturnLoan.cs
  - PatronService\
    - RenewMembership.cs
- LoanFactory.cs
- PatronFactory.cs

この構造は、Services プロジェクトの ApplicationCore 部分をミラー化し、サポートします。

ApplicationCore\
- Services\
  - LoanService.cs:ExtendLoan メソッドと ReturnLoan メソッドが含まれます。
  - PatronService.cs:RenewMembership メソッドが含まれます。

演習のこのセクションでは、GitHub Copilot を使用して、UnitTests プロジェクトによって実装される単体テストのアプローチを調べます。

以下の手順に従って、演習のこのセクションを完了します。

チャットビューを開きます。
チャットコンテキストに次のファイルを追加します: LoanFactory.cs、PatronFactory.cs、ExtendLoan.cs、ReturnLoan.cs、RenewMembership.cs、LoanService.cs、PatronService.cs。

ファイルは、tests/UnitTests、tests/UnitTests/ApplicationCore/LoanService、tests/UnitTests/ApplicationCore/PatronService、src/Library.ApplicationCore/Services の各フォルダーにあります。
次のプロンプトを入力します。
```
@workspace Explain the approach to unit testing that's been implemented in this workspace.
```
このプロンプトは、ワークスペースのコンテキストでの単体テストのアプローチについて説明するように GitHub Copilot に求めます。応答のコンテキストを提供するために、プロンプトにはいくつかのファイルが含まれています。
少し時間を取って、GitHub Copilot からの応答を確認してください。

次の説明に似た情報が提示されます。
- モックの依存関係:テストでは、NSubstitute を使用してインターフェイスのモック実装を作成します。
- テストの編成:テストは、テストされるメソッドに基づいて個別のファイルに編成されます。たとえば、ExtendLoan メソッドと ReturnLoan メソッドは、LoanService フォルダーの下で個別のファイルでテストされます。
- アサーション:アサーションは、各テストの予想される結果を検証するために使用されます。
- テストシナリオ:テストでは、入力に基づいて異なる状態を返すなど、メソッドごとにさまざまなシナリオがカバーされています。
- 分離性: 各テストは、副作用を防ぐために他のテストから分離されます。
- ファクトリメソッド:ファクトリメソッドは、テストデータを一貫して作成するために使用されます。

次のプロンプトを入力します。

@workspace What are the benefits of this approach to unit testing?

少し時間を取って、GitHub Copilot からの応答を確認してください。

次に挙げるような利点の一覧を示す説明が表示されます。
- 依存関係の分離:モックを使用すると、作業単位が依存関係から分離されます。
- 再現性と一貫性:ファクトリメソッドは、テストデータを作成するための一貫した方法を提供します。
- 読みやすさと保守容易性:記述的なテストメソッドとテストステップの明確な配置により、テストの読みやすさが向上します。
- 包括的なカバレッジ:さまざまなシナリオをテストすることで、コードが堅牢になり、さまざまなエッジケースを確実に処理できます。
- 懸念事項の分離:テストロジック自体からテストデータの作成を分離すると、テストがクリーンに保たれ、テスト対象の動作に集中できます。
- 即時のフィードバック:単体テストを実行すると、コードの正確性に関するフィードバックがすぐに得られます。
チャットコンテキストに次のファイルを追加します: ExtendLoan.cs、ReturnLoan.cs、RenewMembership.cs、LoanFactory.cs、PatronFactory.cs、LoanService.cs、PatronService.cs。
次のプロンプトを入力します。
```
@workspace How can I extend the `UnitTests` project to begin testing methods in the `Library.Infrastructure` project? Provide a process overview.
```
このプロンプトは、UnitTests プロジェクトを拡張して、Library.Infrastructure プロジェクトでメソッドのテストを開始するためのプロセスの概要を提供するよう GitHub Copilot に求めます。応答のコンテキストを提供するために、プロンプトにはいくつかのファイルが含まれています。

少し時間を取って、GitHub Copilot からの応答を確認してください。

次の説明に似た情報が提示されます。

1. Add Project Reference:

  - Open the `UnitTests.csproj` file located at `tests/UnitTests/UnitTests.csproj`.
  - Add a reference to the `Library.Infrastructure` project.

2. Identify methods to test:

  - Identify the methods in the `Library.Infrastructure` project that need to be tested. For example, if you want to test the `LoanService` class, identify the methods in the `LoanService` class that need to be tested.

3. Create Test Classes:

  - Create new test classes in the `tests/UnitTests` directory to test the methods in the `Library.Infrastructure` project. For example, if you want to test `LoanService`, create a file named `LoanServiceTests.cs`.

4. Write Unit Tests:

  - In the newly created test classes, write unit tests for the methods in the `Library.Infrastructure` project. Use the xUnit framework for writing tests and NSubstitute for mocking dependencies.

5. Run Tests:

  - Use Visual Studio Code's integrated terminal or the Test Explorer to run the tests.
  - Ensure that the tests are discovered and executed correctly.

UnitTests プロジェクトを拡張してデータアクセスクラスのテストを開始する

演習のこのセクションでは、GitHub Copilot を使用して、Library.Infrastructure プロジェクトの単体テストを作成します。

Library.Infrastructure プロジェクトには、ファイルシステムと対話してデータを読み込んで保存するデータアクセスクラスが含まれています。プロジェクトには、次のクラスが含まれています。

JsonData:JSON データを読み込んで保存するクラス。
JsonLoanRepository:ILoanRepository インターフェイスを実装し、JsonData クラスを使用して貸し出しデータを読み込んで保存するクラス。
JsonPatronRepository:IPatronRepository インターフェイスを実装し、JsonData クラスを使用して利用者データを読み込んで保存するクラス。

まず、JsonLoanRepository クラスの単体テストを記述します。

以下の手順に従って、演習のこのセクションを完了します。

チャットコンテキストに次のファイルを追加します: UnitTests.csproj。
チャットビューで次のプロンプトを入力します。
```
@workspace Explain how to add a reference to the Library.Infrastructure project inside `UnitTests.csproj`.
```
このプロンプトは、GitHub Copilot に、Library.Infrastructure ファイル内の UnitTests.csproj プロジェクトへの参照を追加する方法を説明するように求めます。

GitHub Copilot の応答を使用して、UnitTests.csproj ファイルを更新します。

更新された UnitTests.csproj ファイルは、次の XML コードのようになります。

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net8.0</TargetFramework>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
    <IsPackable>false</IsPackable>
    <IsTestProject>true</IsTestProject>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="coverlet.collector" Version="6.0.0" />
    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
    <PackageReference Include="NSubstitute" Version="5.1.0" />
    <PackageReference Include="xunit" Version="2.5.3" />
    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.3" />
  </ItemGroup>
  <ItemGroup>
    <Using Include="Xunit" />
  </ItemGroup>
  <ItemGroup>
    <ProjectReference Include="..\..\src\Library.ApplicationCore\Library.ApplicationCore.csproj" />
    <ProjectReference Include="..\..\src\Library.Infrastructure\Library.Infrastructure.csproj" />
  </ItemGroup>
</Project>

JsonLoanRepository.cs ファイルを開きます。

JsonLoanRepository.cs は、src/Library.Infrastructure/Data/ フォルダーにあります。

少し時間を取って JsonLoanRepository.cs ファイルを確認してください。

using Library.ApplicationCore;
using Library.ApplicationCore.Entities;

namespace Library.Infrastructure.Data;

public class JsonLoanRepository : ILoanRepository
{
    private readonly JsonData _jsonData;

    public JsonLoanRepository(JsonData jsonData)
    {
        _jsonData = jsonData;
    }

    public async Task<Loan?> GetLoan(int id)
    {
        await _jsonData.EnsureDataLoaded();

        foreach (Loan loan in _jsonData.Loans!)
        {
            if (loan.Id == id)
            {
                Loan populated = _jsonData.GetPopulatedLoan(loan);
                return populated;
            }
        }
        return null;
    }

    public async Task UpdateLoan(Loan loan)
    {
        Loan? existingLoan = null;
        foreach (Loan l in _jsonData.Loans!)
        {
            if (l.Id == loan.Id)
            {
                existingLoan = l;
                break;
            }
        }

        if (existingLoan != null)
        {
            existingLoan.BookItemId = loan.BookItemId;
            existingLoan.PatronId = loan.PatronId;
            existingLoan.LoanDate = loan.LoanDate;
            existingLoan.DueDate = loan.DueDate;
            existingLoan.ReturnDate = loan.ReturnDate;

            await _jsonData.SaveLoans(_jsonData.Loans!);

            await _jsonData.LoadData();
        }
    }
}

JsonLoanRepository クラスに関する次の詳細に注意してください。
- JsonLoanRepository クラスには、GetLoan と UpdateLoan の 2 つのメソッドが含まれています。
- JsonLoanRepository クラスは、JsonData オブジェクトを使用して貸し出しデータを読み込んで保存します。
まず、GetLoan メソッドの単体テストを記述します。
UnitTests プロジェクトの下に次のフォルダー構造を作成します。
- Infrastructure\
  - JsonLoanRepository\
このフォルダー構造は、Library.ApplicationCore 単体テストに使用されるアプローチを反映しています。
GetLoan フォルダーに JsonLoanRepository という名前のクラスファイルを作成します。
少し時間を取って、GetLoan 単体テストのフィールドコンストラクターとクラスコンストラクターの要件を考慮します。

JsonLoanRepository.GetLoan メソッドは、呼び出されたときに貸し出し ID パラメーターを受け取ります。このメソッドでは、_jsonData.EnsureDataLoaded を使用して最新の JSON データを取得し、_jsonData.Loans を使用して一致する貸し出しを検索します。一致する貸し出し ID が見つかると、設定された貸し出しオブジェクト (populated) が返されます。メソッドが一致する貸し出し ID を見つけることができない場合は、null を返します。

GetLoan 単体テストの場合:
- モック貸し出しリポジトリオブジェクト (_mockLoanRepository) を使用して、一致する ID が見つかったケースをテストできます。検索する ID を使用してモックを読み込みます。 ReturnLoanTest クラスは、ILoanRepository インターフェイスをモックし、モック貸し出しリポジトリオブジェクトをインスタンス化する方法を示します。
- 非モック貸し出しリポジトリオブジェクト (_jsonLoanRepository) を使用して、一致する ID が見つからないケースをテストできます。ファイルに含まれていないことがわかっている貸し出し ID を指定するだけです (100 を超えるものが機能するはずです)。
- 非モック JsonData オブジェクトを作成するには、JsonLoanRepository オブジェクトが必要です。 UnitTests プロジェクトは、JsonData プロジェクトによって作成された ConsoleApp オブジェクトにアクセスできないため、IConfiguration インターフェイスを使用して作成する必要があります。
チャットコンテキストに次のファイルを追加します: JsonLoanRepository.cs、ReturnLoan.cs、LoanService.cs、LoanFactory.cs、JsonData.cs。

次のプロンプトを入力します。

@workspace Create fields and a class constructor for the `GetLoan.cs` file. The class will be used to create unit tests for the GetLoan method in the `JsonLoanRepository.cs` file. Create the following private readonly fields: `_mockLoanRepository`, `_jsonLoanRepository`, `_configuration`, and `_jsonData`. Instantiate the fields in the `GetLoanTest` constructor. Use `ConfigurationBuilder` to create a `_configuration` object that can be used to instantiate the JsonData object.

このプロンプトは、GitHub Copilot にフィールドとクラスコンストラクターを提案するように求めます。

少し時間を取って、GitHub Copilot からの応答を確認してください。

次のコードスニペットのようなコード候補が表示されます。

using NSubstitute;
using Library.ApplicationCore;
using Library.ApplicationCore.Entities;
using Library.ApplicationCore.Interfaces;
using Library.Infrastructure.Data;
using Microsoft.Extensions.Configuration;

namespace UnitTests.Infrastructure.JsonLoanRepository;

public class GetLoanTest
{
    private readonly ILoanRepository _mockLoanRepository;
    private readonly JsonLoanRepository _jsonLoanRepository;
    private readonly IConfiguration _configuration;
    private readonly JsonData _jsonData;

    public GetLoanTest()
    {
        _mockLoanRepository = Substitute.For<ILoanRepository>();
        _configuration = new ConfigurationBuilder()
            .AddJsonFile("appsettings.json")
            .Build();
        _jsonData = new JsonData(_configuration);
        _jsonLoanRepository = new JsonLoanRepository(_jsonData);
    }

    // Add test methods here
}

GitHub Copilot によって提供されるコード提案を使用して、GetLoan.cs を更新します。
次の問題に注意してください。
- コード内で、名前空間と JsonLoanRepository の使用の間に競合があります。 ReturnLoan.cs および RenewMembership.cs ファイルで使用されるパターンに従って GetLoans.cs 内の名前空間を更新する必要があります。
- コードで ILoanRepository が認識されない場合は、using の Library.ApplicationCore ディレクティブをファイルの先頭に追加することが必要になる場合があります。
- _configuration オブジェクトが正しくインスタンス化されていない場合は、ConfigurationBuilder を含むコード行を更新することが必要になる場合があります。コードを簡略化して _configuration = new ConfigurationBuilder().Build(); を使用することができます。
- GitHub Copilot によって using Library.ApplicationCore.Interfaces が提案されている場合は、その部分をファイルの先頭から削除できます。

次のコードスニペットに一致するように GetLoan.cs ファイルを更新します。

using NSubstitute;
using Library.ApplicationCore;
using Library.ApplicationCore.Entities;
using Library.Infrastructure.Data;
using Microsoft.Extensions.Configuration;

namespace UnitTests.Infrastructure.JsonLoanRepositoryTests;

public class GetLoanTest
{
    private readonly ILoanRepository _mockLoanRepository;
    private readonly JsonLoanRepository _jsonLoanRepository;
    private readonly IConfiguration _configuration;
    private readonly JsonData _jsonData;

    public GetLoanTest()
    {
        _mockLoanRepository = Substitute.For<ILoanRepository>();
        _configuration = new ConfigurationBuilder().Build();
        _jsonData = new JsonData(_configuration);
        _jsonLoanRepository = new JsonLoanRepository(_jsonData);
    }

}

チャットコンテキストに次のファイルを追加します: JsonLoanRepository.cs、ReturnLoan.cs、LoanService.cs、LoanFactory.cs、JsonData.cs、Loans.json。
GetLoan.cs ファイルの内容を選択し、チャットビューに次のプロンプトを入力します。
```
@workspace Update the selection to include a unit test for the `JsonLoanRepository.GetLoan` method. The unit test should test the case where a loan ID is found in the data. Use `_mockLoanRepository` to arrange the expected return loan. Use `_jsonLoanRepository` to return an actual loan. Asserts should verify that the return loan ID matches the expected loan ID. Use a loan ID that exists in the `Loans.json` file.
```
このプロンプトは、GitHub Copilot に対して、JsonLoanRepository.GetLoan メソッドの単体テストを提案するように求めます。単体テストでは、データに貸し出し ID が見つかったケースをテストする必要があります。テストでは、_mockLoanRepository を使用して、予想される返却貸し出しを手配し、_jsonLoanRepository を使用して実際の貸し出しを返却し、アサーションを実行して、返却貸し出し ID が予想される貸し出し ID と一致することを確認する必要があります。貸し出し ID は、Loans.json ファイルに存在する必要があります。

少し時間を取って、GitHub Copilot からの応答を確認してください。

次のコードスニペットのようなコード候補が表示されます。

using NSubstitute;
using Library.ApplicationCore;
using Library.ApplicationCore.Entities;
using Library.Infrastructure.Data;
using Microsoft.Extensions.Configuration;
using Xunit;

namespace UnitTests.Infrastructure.JsonLoanRepositoryTests;

public class GetLoanTest
{
    private readonly ILoanRepository _mockLoanRepository;
    private readonly JsonLoanRepository _jsonLoanRepository;
    private readonly IConfiguration _configuration;
    private readonly JsonData _jsonData;

    public GetLoanTest()
    {
        _mockLoanRepository = Substitute.For<ILoanRepository>();
        _configuration = new ConfigurationBuilder().Build();
        _jsonData = new JsonData(_configuration);
        _jsonLoanRepository = new JsonLoanRepository(_jsonData);
    }

    [Fact(DisplayName = "JsonLoanRepository.GetLoan: Returns loan when loan ID is found")]
    public async Task GetLoan_ReturnsLoanWhenLoanIdIsFound()
    {
        // Arrange
        var loanId = 1; // Use a loan ID that exists in the Loans.json file
        var expectedLoan = new Loan { Id = loanId, BookItemId = 101, PatronId = 202, LoanDate = DateTime.Now, DueDate = DateTime.Now.AddDays(14) };
        _mockLoanRepository.GetLoan(loanId).Returns(expectedLoan);
        await _jsonData.EnsureDataLoaded(); // Ensure data is loaded

        // Act
        var actualLoan = await _jsonLoanRepository.GetLoan(loanId);

        // Assert
        Assert.NotNull(actualLoan);
        Assert.Equal(expectedLoan.Id, actualLoan?.Id);
    }
}

GitHub Copilot によって提供されるコード提案を使用して、GetLoan.cs を更新します。

JsonLoanRepository.GetLoan メソッドは、JSON データが確実に読み込まれるように _jsonData.EnsureDataLoaded を呼び出します。テストメソッドに _jsonData.EnsureDataLoaded を呼び出すコード行が含まれている場合は削除できます。

Loan クラスがコードで認識されない場合は、GetLoan.cs ファイルの先頭に using Library.ApplicationCore.Entities ステートメントがあることを確認します。 Loan クラスは、Library.ApplicationCore.Entities 名前空間にあります。
AccelerateDevGitHubCopilot ソリューションをビルドしてエラーがないことを確認します。
GitHub Copilot のオートコンプリート機能を使用して、貸し出し ID が見つからない場合のテストを作成します。

GetLoan_ReturnsLoanWhenLoanIdIsFound メソッドの後に空白行を作成します。

オートコンプリートの提案を受け入れて、新しいテストメソッドを作成します。

少し時間を取って、GitHub Copilot からの応答を確認してください。

GitHub Copilot のオートコンプリート機能は、必要がない場合でも予想される貸し出しをモックする可能性があります。予想される貸し出しをモックするコードは削除できますが、Loans.json ファイルに存在しない貸し出し ID が必要です。

次のコードスニペットのいずれかに似たコード候補が表示されます。

[Fact(DisplayName = "JsonLoanRepository.GetLoan: Returns null when loan ID is not found")]
public async Task GetLoan_ReturnsNullWhenLoanIdIsNotFound()
{
    // Arrange
    var loanId = 999; // Use a loan ID that does not exist in the Loans.json file
    var expectedLoan = new Loan { Id = loanId, BookItemId = 101, PatronId = 202, LoanDate = DateTime.Now, DueDate = DateTime.Now.AddDays(14) };
    _mockLoanRepository.GetLoan(loanId).Returns(expectedLoan);

    // Act
    var actualLoan = await _jsonLoanRepository.GetLoan(loanId);

    // Assert
    Assert.Null(actualLoan);
}

データセットにない loanId 値を割り当てるオートコンプリート候補を採用します。

どの候補もデータセットにない loanId 番号を割り当てない場合は、 Ctrl + Enter キーボードショートカットを使用して追加の候補を一覧表示できます。
単体テストでは JSON データファイルへのアクセスが必要であることに注意してください。

JsonLoanRepository.GetLoan メソッドでは、JsonData オブジェクトを使用して貸し出しデータを読み込んで保存します。

JSON データファイルは、Library.Console\Json フォルダーにあります。これらのファイルをテストプロジェクトに含めるには、UnitTests.csproj ファイルを更新する必要があります。

次の XML スニペットを UnitTests.csproj ファイルに追加します。

<ItemGroup>
    <None Include="..\..\src\Library.Console\Json\**\*">
        <Link>Json\%(RecursiveDir)%(FileName)%(Extension)</Link>
        <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </None>
</ItemGroup>

これにより、テストの実行時に JSON データファイルが出力ディレクトリにコピーされます。

作業を確認

JsonLoanRepository クラスの単体テストを実行するには、いくつかの方法があります。 Visual Studio Code のテストエクスプローラー、統合ターミナル、または dotnet test コマンドを使用できます。

以下の手順に従って、演習のこのセクションを完了します。

GetLoans.cs ファイルがエディターで開かれていることを確認します。
ソリューションをビルドし、エラーがないことを確認します。

AccelerateDevGitHubCopilot を右クリックし、[ビルド] を選択します。
テストメソッドの左側にある "緑色の再生ボタン" に注目してください。
Visual Studio Code のテストエクスプローラービューを開きます。

テストエクスプローラービューを開くには、左側のアクティビティバーにあるビーカー型のアイコンを選択します。テストエクスプローラーには、ユーザーインターフェイスで [テスト] というラベルが付けられています。

テストエクスプローラーは、ワークスペース内のすべてのテストケースを表示するツリービューです。テストケースを実行/デバッグし、テストエクスプローラーを使用してテスト結果を表示できます。
UnitTests と基になるノードを展開して、GetLoanTestを見つけます。
JsonLoanRepository.GetLoan: ローン ID が見つかった場合にローンを返すテストケースを実行します。
テストエクスプローラービューとエディターのテスト結果に注目してください。

テストに合格したことを示す緑色のチェックマークが表示されます。
エディターを使用して JsonLoanRepository.GetLoan を実行します。ローン ID が見つからない場合は null を返します 。
テストエクスプローラービューとエディターのテスト結果に注目してください。

エディターからテストを実行するには、テストメソッドの左側にある緑色の再生ボタンを選択します。
JsonLoanRepository.GetLoan: Returns null when loan ID is not found テストに合格していることを確認します。

両方のテストの左側に緑色のチェックマークが表示されているはずです。

演習 - GitHub Copilot ツールを使用して単体テストを開発する

UnitTests プロジェクトによって実装される単体テストへのアプローチを確認する

UnitTests プロジェクトを拡張してデータ アクセス クラスのテストを開始する

作業を確認

フィードバック

UnitTests プロジェクトを拡張してデータアクセスクラスのテストを開始する