Moq(3.0+)を使用してout
/ref
パラメーターを割り当てることはできますか?
Callback()
の使用を見てきましたが、Action<>
はジェネリックに基づいているため、refパラメーターをサポートしていません。また、コールバックで行うことはできますが、ref
パラメーターの入力に制約(It.Is
)を追加することもできます。
Rhino Mocksがこの機能をサポートしていることは知っていますが、私が取り組んでいるプロジェクトは既にMoqを使用しています。
質問はMoq 3に関するものですが(おそらくその年齢によるものです)、Moq 4.8のソリューションを投稿できます。これは、by-refパラメーターのサポートが大幅に改善されています。
public interface IGobbler
{
bool Gobble(ref int amount);
}
delegate void GobbleCallback(ref int amount); // needed for Callback
delegate bool GobbleReturns(ref int amount); // needed for Returns
var mock = new Mock<IGobbler>();
mock.Setup(m => m.Gobble(ref It.Ref<int>.IsAny)) // match any value passed by-ref
.Callback(new GobbleCallback((ref int amount) =>
{
if (amount > 0)
{
Console.WriteLine("Gobbling...");
amount -= 1;
}
}))
.Returns(new GobbleReturns((ref int amount) => amount > 0));
int a = 5;
bool gobbleSomeMore = true;
while (gobbleSomeMore)
{
gobbleSomeMore = mock.Object.Gobble(ref a);
}
ちなみに、It.Ref<T>.IsAny
は、C#7 in
パラメータでも機能します(これらはby-refでもあるため)。
「アウト」の場合、次のように動作します。
public interface IService
{
void DoSomething(out string a);
}
[TestMethod]
public void Test()
{
var service = new Mock<IService>();
var expectedValue = "value";
service.Setup(s => s.DoSomething(out expectedValue));
string actualValue;
service.Object.DoSomething(out actualValue);
Assert.AreEqual(expectedValue, actualValue);
}
Moqは、セットアップを呼び出して記憶するときに「expectedValue」の値を見ると推測しています。
ref
についても、答えを探しています。
次のクイックスタートガイドが役立つことがわかりました。 https://github.com/Moq/moq4/wiki/Quickstart
EDIT:Moq 4.10では、outまたはrefパラメーターを持つデリゲートをCallback関数に直接渡すことができるようになりました。
mock
.Setup(x=>x.Method(out d))
.Callback(myDelegate)
.Returns(...);
デリゲートを定義してインスタンス化する必要があります。
...
.Callback(new MyDelegate((out decimal v)=>v=12m))
...
4.10以前のMoqバージョンの場合:
Avner Kashtanは、彼のブログで、コールバックからoutパラメーターを設定できる拡張メソッドを提供しています。 Moq、CallbacksおよびOutパラメーター:特に扱いにくいEdgeの場合
解決策はエレガントでハッキングです。他のMoqコールバックと同じようにくつろげる流な構文を提供するという点でエレガントです。また、リフレクションを介していくつかの内部Moq APIを呼び出すことに依存しているため、ハッキーです。
上記のリンクで提供されている拡張メソッドはコンパイルされませんでしたので、以下の編集バージョンを提供しました。持っている入力パラメーターの数ごとに署名を作成する必要があります。 0と1を指定しましたが、さらに拡張するのは簡単です。
public static class MoqExtensions
{
public delegate void OutAction<TOut>(out TOut outVal);
public delegate void OutAction<in T1,TOut>(T1 arg1, out TOut outVal);
public static IReturnsThrows<TMock, TReturn> OutCallback<TMock, TReturn, TOut>(this ICallback<TMock, TReturn> mock, OutAction<TOut> action)
where TMock : class
{
return OutCallbackInternal(mock, action);
}
public static IReturnsThrows<TMock, TReturn> OutCallback<TMock, TReturn, T1, TOut>(this ICallback<TMock, TReturn> mock, OutAction<T1, TOut> action)
where TMock : class
{
return OutCallbackInternal(mock, action);
}
private static IReturnsThrows<TMock, TReturn> OutCallbackInternal<TMock, TReturn>(ICallback<TMock, TReturn> mock, object action)
where TMock : class
{
mock.GetType()
.Assembly.GetType("Moq.MethodCall")
.InvokeMember("SetCallbackWithArguments", BindingFlags.InvokeMethod | BindingFlags.NonPublic | BindingFlags.Instance, null, mock,
new[] { action });
return mock as IReturnsThrows<TMock, TReturn>;
}
}
上記の拡張メソッドを使用すると、次のような出力パラメータを使用してインターフェイスをテストできます。
public interface IParser
{
bool TryParse(string token, out int value);
}
..次のMoqセットアップを使用:
[TestMethod]
public void ParserTest()
{
Mock<IParser> parserMock = new Mock<IParser>();
int outVal;
parserMock
.Setup(p => p.TryParse("6", out outVal))
.OutCallback((string t, out int v) => v = 6)
.Returns(true);
int actualValue;
bool ret = parserMock.Object.TryParse("6", out actualValue);
Assert.IsTrue(ret);
Assert.AreEqual(6, actualValue);
}
Edit:void-returnメソッドをサポートするには、単に新しいオーバーロードメソッドを追加する必要があります。
public static ICallbackResult OutCallback<TOut>(this ICallback mock, OutAction<TOut> action)
{
return OutCallbackInternal(mock, action);
}
public static ICallbackResult OutCallback<T1, TOut>(this ICallback mock, OutAction<T1, TOut> action)
{
return OutCallbackInternal(mock, action);
}
private static ICallbackResult OutCallbackInternal(ICallback mock, object action)
{
mock.GetType().Assembly.GetType("Moq.MethodCall")
.InvokeMember("SetCallbackWithArguments", BindingFlags.InvokeMethod | BindingFlags.NonPublic | BindingFlags.Instance, null, mock, new[] { action });
return (ICallbackResult)mock;
}
これにより、次のようなインターフェイスをテストできます。
public interface IValidationRule
{
void Validate(string input, out string message);
}
[TestMethod]
public void ValidatorTest()
{
Mock<IValidationRule> validatorMock = new Mock<IValidationRule>();
string outMessage;
validatorMock
.Setup(v => v.Validate("input", out outMessage))
.OutCallback((string i, out string m) => m = "success");
string actualMessage;
validatorMock.Object.Validate("input", out actualMessage);
Assert.AreEqual("success", actualMessage);
}
これは Moqサイト のドキュメントです。
// out arguments
var outString = "ack";
// TryParse will return true, and the out argument will return "ack", lazy evaluated
mock.Setup(foo => foo.TryParse("ping", out outString)).Returns(true);
// ref arguments
var instance = new Bar();
// Only matches if the ref argument to the invocation is the same instance
mock.Setup(foo => foo.Submit(ref instance)).Returns(true);
箱から出してすぐにはできないようです。誰かが解決策を試みたようです
このフォーラムの投稿を参照してください http://code.google.com/p/moq/issues/detail?id=176
この質問 Moqで参照パラメーターの値を確認
Refパラメータの設定とともに値を返すためのコードは次のとおりです。
public static class MoqExtensions
{
public static IReturnsResult<TMock> DelegateReturns<TMock, TReturn, T>(this IReturnsThrows<TMock, TReturn> mock, T func) where T : class
where TMock : class
{
mock.GetType().Assembly.GetType("Moq.MethodCallReturn`2").MakeGenericType(typeof(TMock), typeof(TReturn))
.InvokeMember("SetReturnDelegate", BindingFlags.InvokeMethod | BindingFlags.NonPublic | BindingFlags.Instance, null, mock,
new[] { func });
return (IReturnsResult<TMock>)mock;
}
}
次に、モックされるメソッドのシグネチャに一致する独自のデリゲートを宣言し、独自のメソッド実装を提供します。
public delegate int MyMethodDelegate(int x, ref int y);
[TestMethod]
public void TestSomething()
{
//Arrange
var mock = new Mock<ISomeInterface>();
var y = 0;
mock.Setup(m => m.MyMethod(It.IsAny<int>(), ref y))
.DelegateReturns((MyMethodDelegate)((int x, ref int y)=>
{
y = 1;
return 2;
}));
}
これは解決策になります。
[Test]
public void TestForOutParameterInMoq()
{
//Arrange
_mockParameterManager= new Mock<IParameterManager>();
Mock<IParameter > mockParameter= new Mock<IParameter >();
//Parameter affectation should be useless but is not. It's really used by Moq
IParameter parameter= mockParameter.Object;
//Mock method used in UpperParameterManager
_mockParameterManager.Setup(x => x.OutMethod(out parameter));
//Act with the real instance
_UpperParameterManager.UpperOutMethod(out parameter);
//Assert that method used on the out parameter of inner out method are really called
mockParameter.Verify(x => x.FunctionCalledInOutMethodAfterInnerOutMethod(),Times.Once());
}
モックアウトしようとしているインターフェイスを実装する新しい「Fake」クラスのインスタンスを簡単に作成する前に、ここでの多くの提案に苦労しました。次に、メソッド自体でoutパラメーターの値を設定するだけです。
私は今日の午後にこれに苦労し、どこにも答えを見つけることができませんでした。それで自分で遊んだ後、私は私のために働いた解決策を思い付くことができました。
string firstOutParam = "first out parameter string";
string secondOutParam = 100;
mock.SetupAllProperties();
mock.Setup(m=>m.Method(out firstOutParam, out secondOutParam)).Returns(value);
ここで重要なのはmock.SetupAllProperties();
で、これはすべてのプロパティをスタブ化します。これは、すべてのテストケースシナリオで機能するわけではありませんが、return value
of YourMethod
を取得することだけが目的であれば、これは正常に機能します。