Назначение параметров / ref в Moq

Можно ли назначить out/ref параметр с помощью Moq (3.0+)?

Я смотрел на использование Callback(), но Action<>не поддерживает параметры ref, потому что он основан на обобщениях. Я также предпочел бы поставить ограничение ( It.Is) на входе refпараметра, хотя я могу сделать это в обратном вызове.

Я знаю, что Rhino Mocks поддерживает эту функцию, но проект, над которым я работаю, уже использует Moq.

В 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).

Для «вне», мне кажется, что следующее работает

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 смотрит на значение «Ожидаемое значение» при вызове программы установки и запоминает его.

Для 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, Callbacks и Out: особенно сложный крайний случай

Решение элегантное и хакерское. Элегантный в том, что он обеспечивает свободный синтаксис, который чувствует себя как дома с другими обратными вызовами 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-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;
         }));
    }

Опираясь на 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);

Я уверен, что решение Скотта сработало в один момент,

Но это хороший аргумент для того, чтобы не использовать рефлексию, чтобы заглянуть в частный apis. Это сломано сейчас.

Я был в состоянии установить параметры с помощью делегата

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

Это может быть решением.

[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из , YourMethodто это будет прекрасно работать.