1.21 jigowatts

Great Scott!

【.NET Core】MoqのQuickstartをやってみる(Properties)

概要

MoqのQuickstartをやってみる。次はプロパティの扱いについてです。

github.com

環境
  • macOS Sierra バージョン 10.12.6
  • .NET Core 2.0
  • Moq 4.7.137

テストコード

書かれていない部分はこんな感じなのかなと考えながら書くのでミニヨクツクはず。

using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;
using MoqQuickstart;

namespace MoqQuickstart.Tests
{
    [TestClass]
    public class Properties
    {
        [TestMethod]
        public void setup()
        {
            var mock = new Mock<IFoo>();
            mock.Setup(foo => foo.Name).Returns("bar");

            Assert.AreEqual("bar",mock.Object.Name);
        }

        [TestMethod]
        public void auto_mocking_hierarchies()
        {
            var mock = new Mock<IFoo>();
            mock.Setup(foo => foo.Bar.Baz.Name).Returns("baz");

            Assert.AreEqual("baz",mock.Object.Bar.Baz.Name);
        }

        [TestMethod]
        public void expects_an_invocation_to_set_the_value_to_foo()
        {
            var mock = new Mock<IFoo>(MockBehavior.Strict);
            mock.SetupSet(foo => foo.Name = "foo");

            mock.Object.Name = "foo";
        } 

        [TestMethod]
        public void or_verify_the_setter_directly()
        {
            var mock = new Mock<IFoo>();
            mock.Object.Name = "foo";

            mock.VerifySet(foo => foo.Name = "foo");
        }

        [TestMethod]
        public void setup_a_property_so_that_it_will_automatically_start_tracking_its_value()
        {
            var mock = new Mock<IFoo>();
            // start "tracking" sets/gets to this property
            mock.SetupProperty(f => f.Name);

            // alternatively, provide a default value for the stubbed property
            mock.SetupProperty(f => f.Name, "foo");


            // Now you can do:
            IFoo foo = mock.Object;
            // Initial value was stored
            Assert.AreEqual("foo", foo.Name);

            // New value set which changes the initial value
            foo.Name = "bar";
            Assert.AreEqual("bar", foo.Name);
        }

        [TestMethod]
        public void stub_all_properties_on_a_mock()
        {
            var mock = new Mock<IFoo>();
            mock.SetupAllProperties();

            mock.Object.Name = "foo";
            mock.Object.Value = 123;

            Assert.AreEqual("foo", mock.Object.Name);
            Assert.AreEqual(123, mock.Object.Value);
        }
    }
}

モックに対してプロパティを設定していく方法も何通りかあるんですね。

個人的にSetupSetメソッドがよくわかりませんでした。 プロパティに"foo"が設定されることを期待しているということは、"foo"が設定されなかったらテスト失敗するのかと思っていたのですが、これだと失敗しません。

var mock = new Mock<IFoo>();
mock.SetupSet(foo => foo.Name = "foo");
mock.Object.Name = "bar";

リポジトリ内を検索してみたらMockBehavior.Strictを渡しているサンプルを見つけました。厳密な振る舞いのモック?

var mock = new Mock<IFoo>(MockBehavior.Strict);
mock.SetupSet(foo => foo.Name = "foo");
mock.Object.Name = "bar";

テストを実行してみると失敗します。

$ dotnet test --filter "FullyQualifiedName=MoqQuickstart.Tests.Properties.expects_an_invocation_to_set_the_value_to_foo"
Build started, please wait...
Build completed.

Test run for /Users/soil/src/github/unit-testing-using-dotnet-test/PrimeService.Tests/bin/Debug/netcoreapp2.0/PrimeService.Tests.dll(.NETCoreApp,Version=v2.0)
Microsoft (R) Test Execution Command Line Tool Version 15.3.0-preview-20170628-02
Copyright (c) Microsoft Corporation.  All rights reserved.

テスト実行を開始しています。お待ちください...
失敗   MoqQuickstart.Tests.Properties.expects_an_invocation_to_set_the_value_to_foo
エラー メッセージ:
 Test method MoqQuickstart.Tests.Properties.expects_an_invocation_to_set_the_value_to_foo threw exception: 
Moq.MockException: IFoo.Name = "bar" invocation failed with mock behavior Strict.
All invocations on the mock must have a corresponding setup.
スタック トレース:
    at Moq.ExtractProxyCall.HandleIntercept(ICallContext invocation, InterceptorContext ctx, CurrentInterceptContext localctx)
   at Moq.Interceptor.Intercept(ICallContext invocation)
   at Castle.DynamicProxy.AbstractInvocation.Proceed()
   at MoqQuickstart.Tests.Properties.expects_an_invocation_to_set_the_value_to_foo() in /Users/soil/src/github/unit-testing-using-dotnet-test/PrimeService.Tests/Properties.cs:line 35


テストの合計数: 1。成功: 0。失敗:1。スキップ: 0。
テストの実行に失敗しました。
テスト実行時間: 2.4992 秒

他にはCallbackと組み合わせているコードがありました。
MockBehavior.StrictにしてしまうとCallback使うとき不便ですよね。

[TestMethod]
public void setupSet_and_callback()
{
    var mock = new Mock<IFoo>();

    var when = true;
    var positive = false;

    mock.When(() => when).SetupSet(x => x.Name = "foo").Callback(() => positive = true);

    // Strictモードだと"baz"を設定した時点でテスト失敗
    mock.Object.Name = "baz";
    Assert.IsFalse(positive);

    mock.Object.Name = "foo";
    Assert.IsTrue(positive);
}

であればVerifySetを使った方が、プロパティに"foo"が設定されることを期待しているケースでは直感的な感じ。

var mock = new Mock<IFoo>();
mock.Object.Name = "foo";

mock.VerifySet(foo => foo.Name = "foo");

手段が多いことはいいことですmo(^q^)