Help us understand the problem. What is going on with this article?

[.NET] 単体テストがさくっと書ける!モック化の枠組み(Moq + Unity)

モックライブラリ Moq とDIコンテナ Unity(※1)を使用してモック化する例です。
単体テストの基底クラスにモックの生成、検証を抽出することで、Verify 漏れを防ぎ、素早く、すっきりテストコードを書くことができます。

※1 ゲームエンジンの方ではありません。Microsoft patterns & practices のプロジェクトとして開発された軽量DIコンテナで、現在はその手を離れ、オープンソースで運営されています。

■プロダクションコード

Unity のヘルパー

クライアントクラスのコンストラクタから使用します。
共用するDIコンテナを保持しています。

internal static class UnityHelper
{
    /// <summary>
    /// シングルトンインスタンス向けのコンテナ。
    /// </summary>
    public static IUnityContainer SingletonContainer { get; } = CreateSingletonContainer();

    /// <summary>
    /// プロパティインジェクションを自動化したコンテナを取得する。
    /// </summary>
    public static IUnityContainer GetPropertInjectionContainer<T>(T instance)
    {
        SingletonContainer.BuildUp<T>(instance);
        return SingletonContainer;
    }

    /// <summary>
    /// シングルトンインスタンス向けの親コンテナを引き継いだ子コンテナを作成する。
    /// </summary>
    /// <remarks>インスタンスは子コンテナ内でシングルトンとなる(別コンテナでは別インスタンス)。</remarks>
    public static IUnityContainer CreateSingletonBasedContainer()
    {
        return SingletonContainer.CreateChildContainer();
    }

    /// <summary>
    /// シングルトンインスタンス向けのコンテナを作成する。
    /// </summary>
    private static IUnityContainer CreateSingletonContainer()
    {
        var container = new UnityContainer();

        // アセンブリ内の全具象クラスをシングルトンインスタンスで登録する。
        // ※必要に応じて絞り込んだり、個別に登録したりする。
        // ※public コンストラクタが複数あると引数の多い方が選択されてしまうようなので、回避する場合は個別に Register する。
        container.RegisterTypes(
            AllClasses.FromLoadedAssemblies(),
            WithMappings.FromMatchingInterface,
            WithName.Default,
            t => new ContainerControlledLifetimeManager(),
            overwriteExistingMappings: true);

        return container;
    }
}

クライアントクラス(System Under Test)

public class Client
{
    /// <summary>
    /// DIコンテナ。
    /// </summary>
    internal IUnityContainer DiContainer { get; set; }

    /// <summary>
    /// コンストラクタ。
    /// </summary>
    public Client()
    {
       // プロパティインジェクションが自動化されたコンテナを取得
        this.DiContainer = UnityHelper.GetPropertInjectionContainer(this);

        /* インスタンス生成のタイミング等を変えたい場合は子コンテナで構成する。
        this.DiContainer = UnityHelper.CreateSingletonBasedContainer();

        // テスト対象オブジェクト内で一つのインスタンスを共用する場合
        this.DiContainer.RegisterInstance<Service>(new Service());

        // コンポーネントを毎回デフォルトコンストラクタで生成する場合
        this.DiContainer.RegisterType<Service>(new TransientLifetimeManager(), new InjectionConstructor());

        // 毎回の生成ロジックを調整する場合
        this.DiContainer.RegisterType<Service>(
            new InjectionFactory(c => {
                return new Service("Production_InjectionFactory");
            }));
        */
    }

    /// <summary>
    /// 依存サービス。
    /// </summary>
    [Dependency]
    protected Service Service { get; set; }

    /// <summary>
    /// テスト対象メソッド。
    /// </summary>
    public string Act()
    {
        // プロパティ経由でDIコンテナから依存オブジェクトを取得して使用する。
        return this.Service.GetText();
    }
}

依存サービス(Depended-On Component)

public class Service
{
    private readonly string text = "Production";

    public Service()
    {
    }

    internal Service(string text)
    {
        this.text = text;
    }

    public virtual string GetText()
    {
        return this.text;
    }
}

■単体テスト

テストの基底クラス

DIコンテナの管理、モックオブジェクトの生成、管理、検証(Verify)を担います。
ほかのDIコンテナに切り替えるときは、個々のテストコードは変えずに基底クラスを差し替えます。

MSTest例
public abstract class UnityTestBase
{
    /// <summary>
    /// モックオブジェクトのリスト。
    /// </summary>
    private List<Mock> mocks;

    /// <summary>
    /// 単体テスト用にモックオブジェクトを提供するDIコンテナ。
    /// </summary>
    private IUnityContainer diContainer;

    /// <summary>
    /// テストの初期処理。
    /// </summary>
    [TestInitialize]
    public void BaseTestInitialize()
    {
        this.diContainer = new UnityContainer();
        this.mocks = new List<Mock>();
    }

    /// <summary>
    /// テストの終了処理。
    /// </summary>
    [TestCleanup]
    public void BaseTestCleanup()
    {
        // モックが期待どおりに呼び出されたことを検証する。
        foreach (var mock in this.mocks)
        {
            mock.VerifyAll();
        }

        this.diContainer.Dispose();
    }

    /// <summary>
    /// Mock インスタンスを生成する。
    /// </summary>
    protected Mock<T> CreateMock<T>()
        where T : class
    {
        return CreateMock<T>(false);
    }

    /// <summary>
    /// Mock インスタンスを生成する。
    /// </summary>
    protected Mock<T> CreateMock<T>(bool callBase)
        where T : class
    {
        var mock = new Mock<T> { CallBase = callBase };

        this.diContainer.RegisterInstance(mock.Object);
        this.mocks.Add(mock);

        return mock;
    }

    /// <summary>
    /// テスト用のDIコンテナを取得する。
    /// </summary>
    protected IUnityContainer GetDiContainer<T>(T instance)
    {
        this.diContainer.BuildUp<T>(instance);
        return this.diContainer;
    }
}

テストクラス

モックをDIコンテナに詰めて渡すので、依存コンポーネントをモックに差し替えるためだけに、Client を継承した Testable クラスを用意する必要はありません。

モックインスタンスは、個々のテストメソッドに必要なものだけ生成します。

MSTest例
[TestClass]
public class ClientTest : UnityTestBase
{
    [TestMethod]
    public void Act_Mocking()
    {
        // モック設定
        var serviceMock = CreateMock<Service>();
        serviceMock.Setup(s => s.GetText()).Returns("UnitTest");

        // テスト対象オブジェクトを生成(モック用のDIコンテナを設定)
        var client = new Client();
        client.DiContainer = GetDiContainer(client);

        // テスト対象メソッドを実行
        string result = client.Act();

        // 戻り値の検証
        // ※モックの検証は基底クラスで自動的に行われる。
        Assert.AreEqual("UnitTest", result);
    }
}

※掲載コードはサンプルですので、実際のプロジェクトでは、細かい点を調整してご活用ください。

※Autofac 版は こちら をご覧ください。

CodeOne
【品質と生産性にこだわるシステム開発】 .NET(C#/VB.NET)専門・リモート開発歴10年。即日・1時間から頼める常駐しないエンジニア。確かな技術で開発チームを手堅くサポートします。
https://codeone.jp/
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした