Moqでのout / refパラメーターの割り当て


293

Moq(3.0以降)を使用してout/ refパラメーターを割り当てることは可能ですか?

私は使用を検討しましたが、ジェネリックに基づいているため、refパラメーターをサポートしてCallback()Action<>ません。またIt.Isrefパラメーターの入力に制約()を設定することもできますが、コールバックで実行できます。

Rhino Mocksがこの機能をサポートしていることは知っていますが、私が取り組んでいるプロジェクトはすでにMoqを使用しています。


4
このQ&AはMoq 3に関するものです。Moq4.8では、-like It.IsAny<T>()マッチャー(ref It.Ref<T>.IsAny)からセットアップのサポート、.Callback()および.Returns()メソッドシグネチャと一致するカスタムデリゲートタイプを介したサポートまで、参照パラメータのサポートが大幅に改善されています。プロテクトメソッドも同様にサポートされます。たとえば、以下の私の回答を参照してください。
stakx-

outパラメータを使用するすべてのメソッドで、out It.Ref <TValue> .Isanyを使用できます。例:moq.Setup(x => x.Method(out It.Ref <string> .IsAny).Returns(TValue);
MikBTC

回答:


117

Moqバージョン4.8(またはそれ以降)では、参照によるパラメーターのサポートが大幅に改善されています。

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);
}

同じパターンがoutパラメーターに機能します。

It.Ref<T>.IsAnyC#7 inパラメーターでも機能します(これらも参照渡しであるため)。


2
これが解決策です。これにより、非ref入力で機能するのとまったく同じように、任意の入力をrefとして使用できます。これは確かに非常に優れた改善されたサポートです
grathad

5
これと同じソリューションは機能しませんoutが、そうですか?
ATD

1
@ATD部分的にはい。outパラメータを使用してデリゲートを宣言し、上記の構文を使用してコールバックに値を割り当てます
royalTS

モックしている関数に引数が多い場合、コールバックシグネチャは同じパターンに従う必要があります(ref / outパラメータだけでなく)
Yoav Feuerstein

320

「アウト」については、次のように機能します。

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


7
私が抱えていた問題は、メソッドから出力/参照パラメータを割り当てる方法がないということでしたSetup
Richard Szalay

1
refパラメーターを割り当てるためのソリューションがありません。この例では、「出力値」の値を「b」に割り当てます。Moqは、セットアップに渡した式を実行せず、それを分析して、出力値に「a」を提供していることを認識します。そのため、「a」の現在の値を確認し、後続の呼び出しでそれを記憶します。
Craig Celeste


9
独自の参照された出力変数を持つ別のスコープでMockedインターフェースメソッドを実行すると(たとえば、別のクラスのメソッド内で)、これは機能しません。上記の例は、実行が同じスコープで発生するので便利ですモック設定ですが、すべてのシナリオを解決するには単純すぎます。moqでは、out / ref値の明示的な処理のサポートが弱い(誰かが言ったように、実行時に処理される)。
John K

2
+1:これは役立つ回答です。しかし:出力パラメーターの型がクラスではなく、文字列のような組み込み型である場合-これが機能するとは思わない。今日それを試してみました。モックオブジェクトは呼び出しをシミュレートし、「out」パラメーターを介してnullを返します。
azheglov

86

編集:Moq 4.10では、outまたはrefパラメーターを持つデリゲートをコールバック関数に直接渡すことができます。

mock
  .Setup(x=>x.Method(out d))
  .Callback(myDelegate)
  .Returns(...); 

デリゲートを定義してインスタンス化する必要があります。

...
.Callback(new MyDelegate((out decimal v)=>v=12m))
...

4.10より前のMoqバージョンの場合:

Avner Kashtanが彼のブログで、コールバックから出力パラメーターを設定できる拡張メソッドを提供しています:Moq、CallbacksおよびOutパラメーター:特にトリッキーなエッジケース

ソリューションはエレガントでハックです。他の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);
    }



編集: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);
}

5
@ウィルバート、ボイドリターン関数の追加のオーバーロードで私の答えを更新しました。
スコットウェグナー2013年

2
私はこのソリューションをテストスイートで使用しており、作業を続けていました。ただし、Moq 4.10への更新以降、それは行われなくなりました。
Ristogod

2
このコミットgithub.com/moq/moq4/commit/…で壊れているようです。たぶんこれを行うより良い方法はありますか?
スパークプラグ2018

1
Moq4のfyiは、MethodCallがセットアップのプロパティになっているため、上記のOutCallbackInternalの根性が次のように変更されますvar methodCall = mock.GetType().GetProperty("Setup").GetValue(mock); mock.GetType().Assembly.GetType("Moq.MethodCall") .InvokeMember("SetCallbackResponse", BindingFlags.InvokeMethod | BindingFlags.Public | BindingFlags.Instance, null, methodCall, new[] { action });
mike mckechnie

1
@Ristogodは、部品番号4.10にアップデートして、あなたは今、直接コールバック関数へのアウトまたはREFパラメータを持つデリゲートを渡すことができます:mock.Setup(x=>x.Method(out d)).Callback(myDelegate).Returns(...);あなたは、デリゲートを定義し、それをインスタンス化する必要があります:...Callback(new MyDelegate((out decimal v)=>v=12m))...;
esteuart

48

これは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);

5
これは基本的にParchedの回答と同じであり、同じ制限があります。入力に応じて出力値を変更できず、refパラメーターに応答できません。
Richard Szalay 2011

@Richard Szalay、そうかもしれませんが、個別の「outString」パラメーターを使用した個別のセットアップが必要になります
Sielu

17

箱から出してそれを行うことはできないようです。誰かが解決策を試みたようです

このフォーラムの投稿http://code.google.com/p/moq/issues/detail?id=176を参照して ください

この質問 はMoqで参照パラメータの値を確認します


確認してくださってありがとうございます。私は実際にこれらの2つのリンクを検索で見つけましたが、Moqがその機能の1つを「ref / outパラメーターのサポート」としてリストしていることにも気付いたので、確認したかったのです。
Richard Szalay、

3

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;
         }));
    }

yとして渡される変数にアクセスできない場合、これは機能しますか?DayOfWeekに2つのref引数をとる関数があります。これらの両方をモックスタブの特定の日に設定する必要があり、3番目の引数はモックデータベースコンテキストです。しかし、デリゲートメソッドが呼び出されていません。Moqは「MyMethod」関数に渡されるローカルyに一致すると期待しているようです。これはあなたの例ではどのように機能しますか?どうも。
グレッグベレス2017年

3

Billy Jakesのオーナに基づいて、outパラメータを使用して完全に動的なモックメソッドを作成しました。私はこれを便利だと思う人のためにここに投稿します(おそらく私だけが私です)。

// Define a delegate with the params of the method that returns void.
delegate void methodDelegate(int x, out string output);

// Define a variable to store the return value.
bool returnValue;

// Mock the method: 
// Do all logic in .Callback and store the return value.
// Then return the return value in the .Returns
mockHighlighter.Setup(h => h.SomeMethod(It.IsAny<int>(), out It.Ref<int>.IsAny))
  .Callback(new methodDelegate((int x, out int output) =>
  {
    // do some logic to set the output and return value.
    output = ...
    returnValue = ...
  }))
  .Returns(() => returnValue);

2

スコットの解決策はある時点で機能したと思いますが、

しかし、リフレクションを使用せずにプライベートAPIをのぞき見するのはよい議論です。それは今壊れています。

デリゲートを使用してパラメーターを設定することができました

      delegate void MockOutDelegate(string s, out int value);

    public void SomeMethod()
    {
        ....

         int value;
         myMock.Setup(x => x.TryDoSomething(It.IsAny<string>(), out value))
            .Callback(new MockOutDelegate((string s, out int output) => output = userId))
            .Returns(true);
    }

1

これは解決策となります。

[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());

}

1
これは基本的にParchedの回答と同じであり、同じ制限があります。入力に応じて出力値を変更できず、refパラメーターに応答できません。
Richard Szalay、2011

1

モックアウトしようとしているインターフェイスを実装する新しい 'Fake'クラスのインスタンスを単純に作成する前に、ここで提案の多くに苦労しました。次に、メソッド自体で出力パラメーターの値を設定するだけです。


0

私はこれを今日の午後1時間苦労し、どこにも答えを見つけることができませんでした。自分でいじってみたところ、自分に合った解決策を見つけることができました。

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であるYourMethod場合、これは正常に機能します。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.