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

[アーティクル]
05/29/2024

警告

このドキュメントは、最新版の SignalR を対象としていません。 ASP.NET Core SignalR に関する記事を参照してください。

この記事では、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 はテスト用のモックオブジェクトを作成するために使用します。必要に応じて他のモックフレームワークを使用してもいいでしょう。NSubstitute も良い選択肢です。このチュートリアルでは、モックオブジェクトを 2 つのやり方で設定する方法について説明します。1 つ目は dynamic オブジェクト (.NET Framework 4 で導入) を使用し、2 つ目はインターフェイスを使用します。

内容

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

Dynamic を使用した単体テスト
型別の単体テスト

Dynamic を使用した単体テスト

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

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」という名前を付けます。

Test.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" を右クリックし、[選択したテストの実行] を選択します。
[テストエクスプローラー] ウィンドウの下部のペインを確認して、テストが成功したことを確認します。このウィンドウには、テストが成功したことが表示されます。

型別の単体テスト

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

上記の「Dynamic を使用した単体テスト」のチュートリアルの中の手順 1 から 7 を完了してください。
Test.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 のインスタンスが作成され、次にハブ上の Send メソッドの呼び出しに続いて呼び出される broadcastMessage メソッドのモックバージョンが作成されます。
F6 キーを押して、このソリューションをビルドします。
単体テストを実行します。 Visual Studio 内で、[テスト]、[Windows]、[テストエクスプローラー] を選択します。 [テストエクスプローラー] ウィンドウ内で、"HubsAreMockableViaDynamic" を右クリックし、[選択したテストの実行] を選択します。
[テストエクスプローラー] ウィンドウの下部のペインを確認して、テストが成功したことを確認します。このウィンドウには、テストが成功したことが表示されます。

次の方法で共有

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

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

質問とコメント

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

内容

Dynamic を使用した単体テスト

型別の単体テスト

フィードバック

その他のリソース