在Moq中分配out/ref参数

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

我已经考虑过使用Callback()，但Action<>不支持ref参数，因为它是基于泛型的。我还希望在ref参数的输入上放置一个约束(It.Is)，尽管我可以在回调中这样做。

我知道Rhino Mocks支持这个功能，但是我正在做的项目已经在使用Moq了。

184690 次浏览
小开

似乎不可能开箱即用。看来有人想要解决问题

请看这个论坛帖子 http://code.google.com/p/moq/issues/detail?id=176 < / p > < p >这个问题 用最小订货量验证参考参数的值 < / p >

小开

对于“out”，下面的方法似乎对我有用。

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 < / p >
小开

这是一个解决方案。

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


}
小开

这是来自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);
小开

编辑:在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在他的博客中提供了一个扩展方法，允许从回调Moq, callback和Out参数:一个特别棘手的边缘情况中设置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);
}

．． 最小起订量设置如下:

    [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);
}
< p >
< br > 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);
}
小开

今天下午，我为此纠结了一个小时，但在任何地方都找不到答案。在我自己玩了一圈之后，我能够想出一个适合我的解决方案。

string firstOutParam = "first out parameter string";
string secondOutParam = 100;
mock.SetupAllProperties();
mock.Setup(m=>m.Method(out firstOutParam, out secondOutParam)).Returns(value);

这里的关键是mock.SetupAllProperties();，它将为你去掉所有属性。这可能并不适用于每个测试用例场景，但如果你所关心的只是获得YourMethod的return value，那么这将很好地工作。

小开

为了返回一个值和设置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;
}));
}
小开
最佳答案

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

小开

在我简单地创建一个新的“Fake”类的实例来实现您试图Mock的任何接口之前，我在这里的许多建议中苦苦挣扎。然后，您可以简单地使用方法本身设置out参数的值。

小开

我相信斯科特的解决方案在某种程度上是有效的，

但是不使用反射来窥探私有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);
}
小开

在Billy Jakes awnser的基础上，我用一个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);
小开

在VS2022中，你可以简单地做:

foo.Setup(e => e.TryGetValue(out It.Ref<ExampleType>.IsAny))
.Returns((ref ExampleType exampleType) => {
exampleType = new ExampleType();
return true;
})
小开

下面是一个正在工作的例子。

[Fact]
public void DeclineLowIncomeApplicationsOutDemo()
{
var mockValidator = new Mock<IFrequentFlyerNumberValidator>();


var isValid = true; // Whatever we set here, thats what we will get.


mockValidator.Setup(x => x.IsValid(It.IsAny<string>(), out isValid));


var sut = new CreditCardApplicationEvaluator(mockValidator.Object);


var application = new CreditCardApplication
{
GrossAnnualIncome = 19_999,
Age = 42
};


var decision = sut.EvaluateUsingOut(application);


Assert.Equal(CreditCardApplicationDecision.AutoDeclined, decision);
}


public interface IFrequentFlyerNumberValidator
{
bool IsValid(string frequentFlyerNumber);
void IsValid(string frequentFlyerNumber, out bool isValid);
}

注意在设置中没有的回报，因为没有返回值。

小开

就像这样:

被嘲笑的方法是

public bool GenerateClient(out Client client);

那么模拟部分将是:

Client client = new Client();
clintMockBll
.Setup(x => x.GenerateClient(out client))
.Returns((Client client1) =>
{
client = new Client(){Name="Something"};
return true;
});
小开

对于任何希望使用It.IsAny作为out形参的人来说，Craig Celeste的答案得到了增强:

public interface IService
{
void DoSomething(out string a);
}


[TestMethod]
public void Test()
{
var service = GetService();
string actualValue;
service.Object.DoSomething(out actualValue);
Assert.AreEqual(expectedValue, actualValue);
}


private IService GetService()
{
var service = new Mock<IService>();
var anyString = It.IsAny<string>();
service.Setup(s => s.DoSomething(out anyString))
.Callback((out string providedString) =>
{
providedString = "SomeValue";
});
return service.Object;
}

如果你的方法也需要返回一些东西，你也可以使用Returns来代替Callback。


提交答案