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

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

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

■プロダクションコード

Autofac のヘルパー

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

internal static class AutofacHelper
{
    /// <summary>
    /// protected set アクセサを持つプロパティのセレクタ。
    /// </summary>
    public static readonly IPropertySelector ProtectedSetterSelector =
        new DelegatePropertySelector((p, o) => p.CanWrite && (p.SetMethod?.IsFamily ?? false));

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

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

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

        // アセンブリ内の全具象クラスをシングルトンインスタンスで登録する。
        // ※必要に応じて絞り込んだり、個別に登録したりする。
        //  ここでは DependencyResolutionException 対策として Moq のインターフェイスプロキシを除外。
        containerBuilder.RegisterAssemblyTypes(AppDomain.CurrentDomain.GetAssemblies())
            .Where(t => t.Namespace != "Castle.Proxies")
            .AsImplementedInterfaces()
            .AsSelf()
            .UsingConstructor(new DefaultOrFewestConstructorSelector())
            .SingleInstance();

        return containerBuilder.Build();
    }
}

/// <summary>
/// 引数なしか最も少ないコンストラクタを優先する選択クラス。
/// </summary>
public class DefaultOrFewestConstructorSelector : IConstructorSelector
{
    public ConstructorParameterBinding SelectConstructorBinding(ConstructorParameterBinding[] constructorBindings)
    {
        return constructorBindings.OrderBy(b => b.TargetConstructor.GetParameters().Length).FirstOrDefault();
    }
}

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

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

    /// <summary>
    /// コンストラクタ。
    /// </summary>
    public Client()
    {
        // プロパティインジェクションが自動化されたコンテナを取得
        // ※Resolve のたびにインスタンスを生成、オーナーオブジェクト内で一つのインスタンスを共用したいなど、
        //  インスタンス生成のタイミング等を変えたい場合は独自に ContainerBuilder で構成する。
        this.DiContainer = AutofacHelper.GetPropertInjectionContainer(this);
    }

    /// <summary>
    /// 依存サービス。
    /// </summary>
    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()
    {
    }

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

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

■単体テスト

テストの基底クラス

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

MSTest例
/// <summary>
/// 単体テストの基底クラス。
/// </summary>
public abstract class AutofacTestBase
{
    /// <summary>
    /// モックオブジェクトのリスト。
    /// </summary>
    private List<Mock> mocks;

    /// <summary>
    /// 単体テスト用にモックオブジェクトを提供するDIコンテナのビルダー。
    /// </summary>
    internal ContainerBuilder DiContainerBuilder { get; private set; }

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

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

    /// <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.DiContainerBuilder.RegisterInstance(mock.Object);
        this.mocks.Add(mock);

        return mock;
    }

    /// <summary>
    /// テスト用のDIコンテナを取得する。
    /// </summary>
    protected IContainer GetDiContainer(object instance)
    {
        var container = this.DiContainerBuilder.Build();
        container.InjectProperties(instance, AutofacHelper.ProtectedSetterSelector);
        return container;
    }
}

テストクラス

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

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

MSTest例
[TestClass]
public class ClientTest : AutofacTestBase
{
    [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);
    }
}

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

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

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
ユーザーは見つかりませんでした