在Moq中分配输出/参考参数


293

是否可以使用Moq(3.0+)分配out/ ref参数?

我看过使用Callback(),但Action<>不支持ref参数,因为它基于泛型。尽管我可以在回调函数中执行此操作,但我最好还是It.Isref参数的输入上添加一个约束()。

我知道Rhino Mocks支持此功能,但是我正在从事的项目已经在使用Moq。


4
此问题与解答有关的是Moq3。Moq 4.8对by-ref参数的支持得到了很大的改进,范围从类似的It.IsAny<T>()matcher(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

Answers:


116

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

相同的模式适用于 out参数。

It.Ref<T>.IsAny也适用于C#7 in参数(因为它们也是by-ref)。


2
这是解决方案,它使您可以将任何输入都用作参考,就像在非参考输入中一样。确实,这是一个非常不错的改进支持
grathad 18'Jan

5
相同的解决方案out虽然行不通,对吗?
ATD

1
@ATD部分是。使用out参数声明一个委托,并使用上面的语法在回调中分配值
royalTS '19

值得一提的是,如果要模拟的函数具有更多参数,则回调签名应遵循相同的模式(而不仅仅是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);
}

我猜想当您调用Setup并记住它时,Moq会查看'expectedValue'的值。

对于ref,我也在寻找答案。

我发现以下快速入门指南很有用:https : //github.com/Moq/moq4/wiki/Quickstart


7
我认为我遇到的问题是,在哪里没有从该方法分配 out / ref参数的方法Setup
Richard Szalay 2010年

1
我没有分配ref参数的解决方案。本示例确实为“ b”分配了“输出值”的值。Moq不会执行您传递给Setup的Expression,而是对其进行分析,并意识到您为输出值提供了“ a”,因此它查看“ a”的当前值并记住以供后续调用。
Craig Celeste 2010年

另请参见out和ref示例:code.google.com/p/moq/wiki/QuickStart
TrueWill 2010年

9
当Mocked接口方法在具有自己的引用输出变量的其他范围内执行(例如,在另一个类的方法内部)时,这对我不起作用。上面给出的示例很方便,因为执行与模拟设置,但是解决所有情况都太简单了。最小起订量对显式处理out / ref值的支持较弱(正如其他人所说,在执行时进行了处理)。
约翰·K

2
+1:这是一个有用的答案。但是:如果out参数类型是类,而不是字符串之类的内置类型-我认为这不会起作用。今天试过了。模拟对象模拟该调用,并通过“ out”参数返回null。
azheglov 2011年

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在他的博客中提供了一个扩展方法,该方法允许从回调中设置out参数:Moq,Callbacks和Out参数:一种特别棘手的情况

该解决方案既优雅又hacky。优雅之处在于它提供了流利的语法,可以与其他Moq回调一起使用。hacky是因为它依赖于通过反射调用一些内部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);
}

..具有以下最小起订量设置:

    [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返回方法,您只需要添加新的重载方法:

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
@Wilbert,我用无效返回函数的其他重载更新了我的答案。
Scott Wegner

2
我一直在我们的测试套件中使用此解决方案,并且一直在工作。但是,由于更新到Moq 4.10,因此不再有效。
Ristogod

2
看起来在此commitgithub.com/moq/moq4/commit/…中已被破坏。也许现在有更好的方法可以做到这一点?
sparkplug

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,对Moq 4.10进行了更新,您现在可以将具有out或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的答案相同,并且具有相同的限制,因为它不能根据输入更改out值,也不能响应ref参数。
理查德·萨雷

@Richard Szalay,您可以,但是您需要使用单独的“ outString”参数进行单独的设置
Sielu 2013年


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接受两个ref参数的函数。我需要将两者都设置为模拟存根中的特定日期,第三个参数是模拟数据库上下文。但是委托方法只是没有被调用。Moq似乎期望与“ MyMethod”函数传递的本地匹配。这就是您的示例的工作方式吗?谢谢。
格雷格·韦尔斯

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的答案相同,并且具有相同的限制,因为它不能根据输入更改out值,也不能响应ref参数。
理查德·萨雷

1

在我简单地创建一个新的“ Fake”类的实例之前,我在这里尝试了许多建议,这些实例实现了您要模拟的任何接口。然后,您可以使用方法本身简单地设置out参数的值。


0

我今天下午为此苦了一个小时,在任何地方都找不到答案。在独自玩耍之后,我提出了一个对我有用的解决方案。

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 valueYourMethod那么它将很好用。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.