Назначение параметров out / ref в Moq
-
21-08-2019 - |
Вопрос
Можно ли назначить out
/ref
параметр, использующий Moq (3.0+)?
Я рассматривал возможность использования Callback()
, но Action<>
не поддерживает параметры ref, поскольку он основан на дженериках.Я бы также предпочел установить ограничение (It.Is
) на входе в ref
параметр, хотя я могу сделать это при обратном вызове.
Я знаю, что 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' при вызове Setup и запоминает его.
Для ref
, Я тоже ищу ответ.
Я нашел полезным следующее руководство по быстрому запуску:https://github.com/Moq/moq4/wiki/Quickstart
Редактировать:В Moq 4.10 теперь вы можете передать делегат с параметром out или ref непосредственно функции обратного вызова:
mock
.Setup(x=>x.Method(out d))
.Callback(myDelegate)
.Returns(...);
Вам нужно будет определить делегат и создать его экземпляр:
...
.Callback(new MyDelegate((out decimal v)=>v=12m))
...
Для версии Moq до версии 4.10:
Авнер Каштан предоставляет метод расширения в своем блоге, который позволяет установить параметр out из обратного вызова: Moq, параметры обратного вызова и выхода:особенно сложный пограничный случай
Решение одновременно элегантное и халтурное.Элегантный в том смысле, что он обеспечивает плавный синтаксис, который отлично сочетается с другими обратными вызовами Moq.И хакерский, потому что он полагается на вызов некоторых внутренних API Moq через отражение.
Метод расширения, представленный по ссылке выше, не был скомпилирован для меня, поэтому я предоставил отредактированную версию ниже.Вам нужно будет создать подпись для каждого имеющегося у вас количества входных параметров;Я предоставил 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, вам просто нужно добавить новые методы перегрузки:
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());
}
Я боролся со многими приведенными здесь предложениями, прежде чем просто создал экземпляр нового "Поддельного" класса, который реализует любой интерфейс, который вы пытаетесь воспроизвести.Затем вы можете просто установить значение параметра 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
из YourMethod
тогда это будет работать нормально.