Bot Builder v4 でのテスト : ミドルウェアのテスト

13122 ワード
BotFramework Botbuilder unittest unittest テキストリンク

前回はユニットテストの基本を紹介しました。今回は IBot のメイン処理と BotBuilder のミドルウェアをユニットテストしてみます。

ミドルウェアのテスト

ミドルウェアのテストでは大きく分けて以下の 2 種類があります。

処理内でアダプター経由の返信があり、それを検証したい場合
返信はアダプター経由で行われるため、TestAdapter の Use メソッドにテストしたいミドルウェアを渡して、AssetReply で検証を行います。

処理の結果、次のミドルウェアが実行されるか確認したい場合
MiddlewareSet を作成して、テストしたいミドルウェアを追加。次のミドルウェアとして任意のコールバックを追加して検証を行います。

今回検証するサンプルボットでは両方のパターンが存在するので、それぞれやり方を紹介します。

ソリューションの準備

ボットのコードはBot Builder v4 でボット開発 : アダプター、TurnContext、Activity で開発したものを使います。

1. GitHub よりレポジトリをクローン。

git clone https://github.com/kenakamu/botbuilderv4completeguide
cd botbuilderv4completeguide

2. article3 ブランチをチェックアウトして、test-article2 ブランチを作成

git checkout article3
git checkout -b test-article2

3. myfirstbot フォルダを作成して .git フォルダ、LICENSE、.gitignore 以外を全て移動。

4. Visual Studio を起動して新規プロジェクトを作成。空のソリューションを .git フォルダと同じ階層に作成。「ソリューションのディレクトリを作成」のチェックを外す。

5. ソリューションを右クリックして、既存のプロジェクトを追加。

6. myfirstbot プロジェクトを追加。

7. ソリューションを右クリックして、新規プロジェクトを追加。.NET Core より MSTest テストプロジェクトを追加。

8. 追加したプロジェクトのプロパティより、ターゲットフレームワークを .NET Core 2.2 を選択。

9. ソリューションを右クリックして「ソリューションの NuGet パッケージの管理」を選択。

10. 以下パッケージをテストプロジェクトにも追加。また myfirstbot プロジェクトをテストプロジェクトに参照追加。

Microsoft.AspNetCore
Microsoft.Bot.Builder.Integration.AspNet.Core

11. Test 関連パッケージの更新があれば最新版に更新。

12. ソリューションをビルドしてエラーがないことを確認。

テストの実装と実行

今回のボットはミドルウェアが 2 つあり、メインロジックもあるため、テストを複数作成します。テストクラスの分割は対応するクラスに合わせることが多いのですが、今回はシンプルに 1 つのテストクラスに実装してみます。

1. テストプロジェクトにある既存のテストクラスを MyBotUnitTest.cs に変更。コードを以下のものに差し替え。ここではメインロジックのオウム返しをテスト。

MyBotUnitTest.cs
using Microsoft.Bot.Builder.Adapters;
using Microsoft.Bot.Schema;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using System.Collections.Generic;
using System.Threading.Tasks;

namespace myfirstbot.unittest
{
    [TestClass]
    public class MyBotUnitTest
    {
        [TestMethod]
        public async Task MyBot_ShouldReturnSameText()
        {
            // アダプターを作成
            var adapter = new TestAdapter();

            // テスト対象のクラスをインスタンス化
            var bot = new MyBot();
            await new TestFlow(adapter, bot.OnTurnAsync)
                .Test("foo", "foo")
                .StartTestAsync();
        }
    }
}

2. 次に MyMiddleware 用のテストを作成。MyBotUnitTest クラスに以下のメソッドを追加。ここでは添付ファイルを送信した場合に、「テキストを送ってください」とメッセージが変えることを検証。

[TestMethod]
public async Task MyMiddleware_ShouldStopProcessingWithAttachment()
{            
    // アダプターを作成し、利用するミドルウェアを追加。
    var adapter = new TestAdapter()
        .Use(new MyMiddleware());

    // 添付ファイルを送る
    var activityWithAttachment = new Activity(ActivityTypes.Message)
    {
        Attachments = new List<Attachment>() { new Attachment() }
    };

    // テストの実行
    await new TestFlow(adapter)
    .Send(activityWithAttachment)
    .AssertReply("テキストを送ってください")
    .StartTestAsync();
}

3. 続いて添付ファイルが無い場合を検証するため、以下のメソッドを追加。

  • MiddlewareSet に実行したいミドルウェアを追加
  • ReceiveActivityWithStatusAsync メソッドでメッセージを送信
  • 登録したミドルウェアが全て実行された際に呼び出されるコールバックとして ValidateMiddleware を作成し結果を検証
[TestMethod]
public async Task MyMiddleware_ShouldProcessingWithoutAttachment()
{
    var nextMiddlewareCalled = false;

    // 登録したミドルウェがすべて呼ばれた後に呼び出されるコールバック
    Task ValidateMiddleware(ITurnContext turnContext, CancellationToken cancellationToken)
    {
        // 今回は turnContext の中身を検証する必要はないため、
        // 次のミドルウェアが呼び出されたこと自体で検証を成功とする。
        nextMiddlewareCalled = true;
        return Task.CompletedTask;
    }
    // MiddlewareSet にテスト対象のミドルウェアを追加。
    var middlewareSet = new MiddlewareSet();
    middlewareSet.Use(new MyMiddleware());

    // テキストメッセージと ITurnContext を作成。
    var activityWithoutAttachment = new Activity(ActivityTypes.Message)
    {
        Text = "foo"
    };
    var ctx = new TurnContext(new TestAdapter(), activityWithoutAttachment);

    // MiddlewareSet にメッセージを送信。
    await middlewareSet.ReceiveActivityWithStatusAsync(ctx, ValidateMiddleware, default(CancellationToken));

    Assert.IsTrue(nextMiddlewareCalled);
}

4. ソリューションをビルド後、テスト ｜ 実行 ｜すべてのテストをクリックしてテストを実行。

5. テストエクスプローラーより結果を確認。

まとめ

ミドルウェアのテストはその性質により実装を変える必要がありますが、BotBuilder SDK だけで実装できるのは便利です。ミドルウェアとメインロジックのテストはしっかり分離してください。次回はダイアログとステートのユニットテストを見ていきます。

次の記事へ
目次へ戻る

この記事のサンプルコード