1.21 jigowatts

Great Scott!

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

C# .NET Core Moq

概要

MoqのQuickstartをやってみる。Callbackメソッドについてです。

github.com

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

テストコード

Callbackメソッドの使い方に関しては特に何もないですね。そのまま使えばいいと思うmo(^q^)

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

namespace MoqQuickstart.Tests
{
    [TestClass]
    public class Callbacks
    {
        [TestMethod]
        public void callback()
        {
            var expected = 2;
            var mock = new Mock<IFoo>();
            var calls = 0;

            mock.Setup(foo => foo.DoSomething("ping"))
                .Returns(true)
                .Callback(() => calls++);

            var f = mock.Object;
            f.DoSomething("ping");
            f.DoSomething("pong");
            f.DoSomething("ping");

            Assert.AreEqual(expected, calls);
        }

        [TestMethod]
        public void access_invocation_arguments()
        {
            var expected = new List<string>(){"foo", "bar", "baz"};
            var mock = new Mock<IFoo>();
            var callArgs = new List<string>();

            mock.Setup(foo => foo.DoSomething(It.IsAny<string>()))
                .Returns(true)
                .Callback((string s) => callArgs.Add(s));

            var f = mock.Object;
            f.DoSomething("foo");
            f.DoSomething("bar");
            f.DoSomething("baz");

            CollectionAssert.AreEqual(expected, callArgs);
        }

        [TestMethod]
        public void calalternate_equivalent_generic_method_syntax()
        {
            var expected = new List<string>(){"foo", "bar", "baz"};
            var mock = new Mock<IFoo>();
            var callArgs = new List<string>();

            mock.Setup(foo => foo.DoSomething(It.IsAny<string>()))
                .Returns(true)
                .Callback<string>(s => callArgs.Add(s));

            var f = mock.Object;
            f.DoSomething("foo");
            f.DoSomething("bar");
            f.DoSomething("baz");

            CollectionAssert.AreEqual(expected, callArgs);
        }
        [TestMethod]
        public void access_arguments_for_methods_with_multiple_parameters()
        {
            var expected = new List<string>(){"foo", "bar", "baz"};

            var mock = new Mock<IFoo>();
            var callArgs = new List<string>();

            mock.Setup(foo => foo.DoSomething(It.IsAny<int>(), It.IsAny<string>()))
                .Returns(true)
                .Callback<int, string>((i, s) => callArgs.Add(s));

            var f = mock.Object;
            f.DoSomething(1, "foo");
            f.DoSomething(2, "bar");
            f.DoSomething(3, "baz");

            CollectionAssert.AreEqual(expected, callArgs);
        }

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

            mock.Setup(foo => foo.DoSomething("ping"))
                .Callback(() => Console.WriteLine("Before returns"))
                .Returns(true)
                .Callback(() => Console.WriteLine("After returns"));

            var actual = mock.Object.DoSomething("ping");

            Assert.IsFalse(actual);
        }
    }
}

テストを実行してみましょう。callbacks_can_be_specified_before_and_after_invocationはテスト失敗時に標準出力メッセージが確認できますね。

$ dotnet test --filter "FullyQualifiedName~MoqQuickstart.Tests.Callbacks"
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.Callbacks.callbacks_can_be_specified_before_and_after_invocation
エラー メッセージ:
 Assert.IsFalse failed. 
スタック トレース:
   at MoqQuickstart.Tests.Callbacks.callbacks_can_be_specified_before_and_after_invocation() in /Users/soil/src/github/unit-testing-using-dotnet-test/PrimeService.Tests/Callbacks.cs:line 100

標準出力メッセージ:
 Before returns
 After returns


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

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

C# .NET Core Moq

概要

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^)

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

C# .NET Core Moq

概要

前回.NET Coreのチュートリアルをやってみた流れでMoqのQuickstartもやってみます。こちらも以前、雑に触ってみた続きになります。

github.com

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

テストプロジェクトにパッケージ参照追加

$ dotnet add package moq

テストプロジェクトファイルの中身を見てみるとMoqが追記されました。

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netcoreapp2.0</TargetFramework>
    <IsPackable>false</IsPackable>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.3.0-preview-20170628-02" />
    <PackageReference Include="moq" Version="4.7.137" />
    <PackageReference Include="MSTest.TestAdapter" Version="1.1.18" />
    <PackageReference Include="MSTest.TestFramework" Version="1.1.18" />
  </ItemGroup>
  <ItemGroup>
    <ProjectReference Include="..\PrimeService\PrimeService.csproj" />
  </ItemGroup>
</Project>

ベースになるインターフェイスとクラスの作成

■MoqQuickstart.cs

namespace MoqQuickstart
{
    public interface IFoo
    {
        Bar Bar { get; set; }
        string Name { get; set; }
        int Value { get; set; }
        bool DoSomething(string value);
        bool DoSomething(int number, string value);
        string DoSomethingStringy(string value);
        bool TryParse(string value, out string outputValue);
        bool Submit(ref Bar bar);
        int GetCount();
        bool Add(int value);
    }

    public class Bar 
    {
        public virtual Baz Baz { get; set; }
        public virtual bool Submit() { return false; }
    }

    public class Baz
    {
        public virtual string Name { get; set; }
    }
}

テストプロジェクトにテストクラスを作成

■MatchingArguments.cs

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

namespace MoqQuickstart.Tests
{
    [TestClass]
    public class MatchingArguments
    {
        [TestMethod]
        public void any_value()
        {
            var mock = new Mock<IFoo>();
            mock.Setup(foo => foo.DoSomething(It.IsAny<string>())).Returns(true);

            var f = mock.Object;
            var actual = f.DoSomething("hoge");

            Assert.IsTrue(actual);
        }

        [DataTestMethod]
        [DataRow(-1)]
        [DataRow(1)]
        [DataRow(3)]
        public void matching_Func_int_lazy_evaluated(int value)
        {
            var mock = new Mock<IFoo>();
            mock.Setup(foo => foo.Add(It.Is<int>(i => i % 2 == 0))).Returns(true); 
            
            var f = mock.Object;
            var actual = f.Add(value);

            Assert.IsFalse(actual, $"{value} has a remainder of 0");
        }

        [DataTestMethod]
        [DataRow(-1)]
        [DataRow(11)]
        public void matching_ranges(int value)
        {
            var mock = new Mock<IFoo>();
            mock.Setup(foo => foo.Add(It.IsInRange<int>(0, 10, Range.Inclusive))).Returns(true); 

            var f = mock.Object;
            var actual = f.Add(value);

            Assert.IsFalse(actual, $"{value} is in range");
        }

        [DataTestMethod]
        [DataRow("a")]
        [DataRow("A")]
        [DataRow("hack")]
        public void matching_regex(string value)
        {
            var mock = new Mock<IFoo>();
            mock.Setup(x => x.DoSomethingStringy(It.IsRegex("[a-d]+", RegexOptions.IgnoreCase))).Returns("foo");

            var f = mock.Object;
            var actual = f.DoSomethingStringy(value);

            Assert.AreEqual("foo", actual);            
        }
    }
}

指定したフルネームでテストを実行

メソッド名まで指定しないとダメっぽい。メソッド単位でテストしたいときに。

$ dotnet test --filter "FullyQualifiedName=MoqQuickstart.Tests.MatchingArguments.any_value"
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.

テスト実行を開始しています。お待ちください...

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

指定した名前を含むテストを実行

クラス単位で指定してみます。名前空間単位でも指定できたのでお好みの範囲で。

$ dotnet test --filter "FullyQualifiedName~MoqQuickstart.Tests.MatchingArguments"
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.

テスト実行を開始しています。お待ちください...

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

今までIt.IsAnyメソッド一本槍でした(足軽感)。