SignalR アプリケーションの単体テスト

[アーティクル]
07/13/2023

警告

このドキュメントは、SignalR の最新バージョン用ではありません。 SignalR の ASP.NET Coreを見てみましょう。

この記事では、SignalR 2 の単体テスト機能の使用について説明します。

このトピックで使用するソフトウェアのバージョン

Visual Studio 2013

.NET 4.5

SignalR バージョン 2

質問とコメント

このチュートリアルを気に入った方法と、ページの下部にあるコメントで改善できる内容に関するフィードバックをお寄せください。チュートリアルに直接関連していない質問がある場合は、 ASP.NET SignalR フォーラムまたは StackOverflow.com に投稿できます。

SignalR アプリケーションの単体テスト

SignalR 2 の単体テスト機能を使用して、SignalR アプリケーションの単体テストを作成できます。 SignalR 2 には IHubCallerConnectionContext インターフェイスが含まれています。これを使用してモックオブジェクトを作成し、テスト用のハブメソッドをシミュレートできます。

このセクションでは、XUnit.net と Moq を使用して、はじめにチュートリアルで作成したアプリケーションの単体テストを追加します。

XUnit.net は、テストを制御するために使用されます。Moq は、テスト用のモックオブジェクトを作成するために使用されます。必要に応じて、他のモックフレームワークを使用できます。 N置換も良い選択です。このチュートリアルでは、2 つの方法でモックオブジェクトを設定する方法について説明します。1 つ目は、(.NET Framework 4 で導入された) オブジェクトを使用dynamicする方法と、2 つ目の方法でインターフェイスを使用する方法です。

内容

このチュートリアルには、次のセクションが含まれています。

動的を使用した単体テスト
種類別の単体テスト

動的を使用した単体テスト

このセクションでは、動的オブジェクトを使用して、はじめにチュートリアルで作成したアプリケーションの単体テストを追加します。

Visual Studio 2013の XUnit Runner 拡張機能をインストールします。
はじめにチュートリアルを完了するか、MSDN コードギャラリーから完成したアプリケーションをダウンロードします。
はじめにアプリケーションのダウンロードバージョンを使用している場合は、パッケージマネージャーコンソールを開き、[復元] をクリックして SignalR パッケージをプロジェクトに追加します。
単体テストのソリューションにプロジェクトを追加します。 ソリューションエクスプローラーでソリューションを右クリックし、[追加]、[新しいプロジェクト]、[...] の順に選択します。[C#] ノードで、Windows ノードを選択します。 [ クラスライブラリ] を選択します。新しいプロジェクトに TestLibrary という名前を付け、[OK] をクリック します。
テストライブラリプロジェクトの参照を SignalRChat プロジェクトに追加します。 TestLibrary プロジェクトを右クリックし、[追加]、[参照...] の順に選択します。[ソリューション] ノードの下にある [プロジェクト] ノードを選択し、[SignalRChat] をチェックします。 [OK] をクリックします。
SignalR、Moq、XUnit パッケージを TestLibrary プロジェクトに追加します。 パッケージマネージャーコンソールで、[既定のプロジェクト] ドロップダウンを [TestLibrary] に設定します。コンソールウィンドウで次のコマンドを実行します。
- Install-Package Microsoft.AspNet.SignalR
- Install-Package Moq
- Install-Package XUnit
テストファイルを作成します。 TestLibrary プロジェクトを右クリックし、[追加]、[クラス] の順にクリックします。新しいクラスに Tests.cs という名前を付けます。

Tests.cs の内容を次のコードに置き換えます。

using System;
using Xunit;
using SignalRChat;
using Microsoft.AspNet.SignalR.Hubs;
using Moq;
using System.Dynamic;

namespace TestLibrary
{
    public class Tests
    {
        [Fact]
        public void HubsAreMockableViaDynamic()
        {
            bool sendCalled = false;
            var hub = new ChatHub();
            var mockClients = new Mock<IHubCallerConnectionContext<dynamic>>();
            hub.Clients = mockClients.Object;
            dynamic all = new ExpandoObject();
            all.broadcastMessage = new Action<string, string>((name, message) => {
                sendCalled = true;
            });
            mockClients.Setup(m => m.All).Returns((ExpandoObject)all);
            hub.Send("TestUser", "TestMessage");
            Assert.True(sendCalled);
        }
    }
}

上記のコードでは、テストクライアントは、IHubCallerConnectionContext 型の Moq ライブラリのオブジェクトを使用してMock作成されます (SignalR 2.1 では、型パラメーターに代入dynamicします)。インターフェイスはIHubCallerConnectionContext、クライアントでメソッドを呼び出すプロキシオブジェクトです。 broadcastMessageその後、モッククライアントに対して関数が定義され、 ChatHub クラスから呼び出すことができます。その後、テストエンジンはクラスのメソッドをChatHub呼び出Sendし、モック関数broadcastMessageを呼び出します。

F6 キーを押してソリューションをビルドします。
単体テストを実行します。 Visual Studio で、[テスト]、[Windows]、[テストエクスプローラー] を選択します。 [テストエクスプローラー] ウィンドウで、[HubsAreMockableViaDynamic] を右クリックし、[選択したテストの実行] を選択します。
[テストエクスプローラー] ウィンドウの下のペインを確認して、テストが成功したことを確認します。ウィンドウに、テストが成功したことを示すメッセージが表示されます。

種類別の単体テスト

このセクションでは、テストするメソッドを含むインターフェイスを使用して、はじめにチュートリアルで作成したアプリケーションのテストを追加します。

上記の「動的を使用した単体テスト」チュートリアルの手順 1 から 7 を完了します。
Tests.cs の内容を次のコードに置き換えます。
```
using Xunit;
using SignalRChat;
using Microsoft.AspNet.SignalR.Hubs;
using Moq;

namespace TestLibrary
{
    public class Tests
    {
       
       public interface IClientContract
       {
           void broadcastMessage(string name, string message);
       }
       [Fact]
       public void HubsAreMockableViaType()
       {
           var hub = new ChatHub();
           var mockClients = new Mock<IHubCallerConnectionContext<dynamic>>();
           var all = new Mock<IClientContract>();
           hub.Clients = mockClients.Object;
           all.Setup(m => m.broadcastMessage(It.IsAny<string>(), 
                It.IsAny<string>())).Verifiable();
           mockClients.Setup(m => m.All).Returns(all.Object);
           hub.Send("TestUser", "TestMessage");
           all.VerifyAll();
       }
    }
}
```
上記のコードでは、テストエンジンがモッククライアントを作成するメソッドの broadcastMessage シグネチャを定義するインターフェイスが作成されます。その後、IHubCallerConnectionContext 型のオブジェクトをMock使用してモッククライアントが作成されます (SignalR 2.1 では、型パラメーターに割り当てますdynamic)。インターフェイスはIHubCallerConnectionContext、クライアントでメソッドを呼び出すプロキシオブジェクトです。

次に、テストによっての ChatHubインスタンスが作成され、メソッドの broadcastMessage モックバージョンが作成されます。その後、ハブでメソッドを Send 呼び出すことによって呼び出されます。
F6 キーを押してソリューションをビルドします。
単体テストを実行します。 Visual Studio で、[テスト]、[Windows]、[テストエクスプローラー] を選択します。 [テストエクスプローラー] ウィンドウで、[HubsAreMockableViaDynamic] を右クリックし、[選択したテストの実行] を選択します。
[テストエクスプローラー] ウィンドウの下のペインを確認して、テストが成功したことを確認します。ウィンドウに、テストが成功したことを示すメッセージが表示されます。

SignalR アプリケーションの単体テスト

このトピックで使用するソフトウェアのバージョン

質問とコメント

SignalR アプリケーションの単体テスト

内容

動的を使用した単体テスト

種類別の単体テスト

フィードバック

フィードバック

その他のリソース