Mockito 何时/然后不返回预期值

Question

我正在尝试使用“任何”匹配器来存根此 getKeyFromStream 方法。我尝试过更加明确和不明确（anyObject()），但似乎无论我尝试什么，这个存根都不会在我的单元测试中返回 fooKey。

我想知道是因为它受到保护还是我遗漏了其他东西或做错了什么。我在整个测试中还有其他 when/then 语句正在运行，但由于某种原因，这里不是。

注意：getKeyFromStream 一般使用 byteArrayInputStream，但我正在尝试将其与 InputStream 匹配，我都尝试过均无济于事。

public class FooKeyRetriever() //Mocked this guy
{
    public FooKey getKey(String keyName) throws KeyException {

        return getKeyFromStream(getKeyStream(keyName, false), keyName);
    }

    //Stubbed this method to return a key object which has been mocked
    protected FooKey getKeyFromStream(InputStream keyStream, String keyName){
        //Some code
        return fooKey;
    }
}

单元测试

@Mock
private FooKeyRetriever mockKeyRetriever;

@Mock
private FooKey fooKey;

@Before
public void setUp() throws Exception {
        MockitoAnnotations.initMocks(this);
}

@Test
public void testGetFooKey() throws Exception {



    when(foo.getKeyFromStream(any(InputStream.class),any(String.class))).thenReturn(fooKey);

    FooKey fooKey = mockKeyRetriever.getKey("irrelevant_key");

    assertNotNull(fooKey);
}

Answer 1

您的单元测试的问题是，您正在尝试模拟您想要测试的实际类的方法，但您实际上不能调用模拟方法，因为除非您声明模拟返回，否则这将返回 null该调用方法的值。通常，您只模拟外部依赖项。

实际上有两种方法可以创建测试对象：mock 和 spy。初级课程将根据您提供的类创建一个新对象，该类具有内部状态 null 并且在每个调用的方法上都返回 null。这就是为什么您需要为方法调用定义某些返回值的原因。另一方面，spy 创建一个真实的对象，如果为某些方法定义了“模拟定义”，则拦截方法调用。

Mockito 和 PowerMock 提供了两种定义模拟方法的方法：

// method 1
when(mockedObject.methodToMock(any(Param1.class), any(Param2.class),...)
    .thenReturn(answer);
when(mockedObject, method(Dependency.class, "methodToMock", Parameter1.class, Parameter2.class, ...)
    .thenReturn(answer);

或

// method 2
doReturn(answer).when(mockedObject).methodToMock(param1, param2);

不同之处在于，method 1 将执行方法实现，而后一个不会。如果您处理 spy 对象，这一点很重要，因为您有时不想在调用的方法中执行真正的代码，而只是替换代码或返回预定义的值！

虽然 Mockito 和 PowerMock 提供了一个 doCallRealMethod() 来代替 doReturn(...) 或 doThrow(...)，但您可以定义它，这将在您的真实对象中调用和执行代码，并忽略任何模拟的方法返回语句。不过，在您想模拟被测类的方法的情况下，这并不是很有用。

方法实现可以被

“覆盖”

doAnswer(Answer<T>() { 
    @Override 
    public T answer(InvocationOnMock invocation) throws Throwable {
        ...
    }
)

你可以简单地声明被调用方法的逻辑应该是什么。您可以利用它来返回受保护方法的模拟结果，因此如下所示：

import static org.hamcrest.core.IsSame.sameInstance;
import static org.junit.Assert.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Matchers.any;
import static org.mockito.Matchers.anyString;

import java.io.InputStream;

import org.junit.Test;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;

public class FooKeyRetrieverTest {

    @Test
    public void testGetFooKey() throws Exception {
        // Arrange
        final FooKeyRetriever sut = spy(new FooKeyRetriever());
        FooKey mockedKey = mock(FooKey.class);

        doReturn(mockedKey)
            .when(sut).getKeyFromStream(any(InputStream.class), anyString());
        doAnswer(new Answer<FooKey>() {

            public FooKey answer(InvocationOnMock invocation) throws Throwable {
                return sut.getKeyFromStream(null, "");
            }
        }).when(sut).getKey(anyString());

        // Act
        FooKey ret = sut.getKey("test");

        // Assert
        assertThat(ret, sameInstance(mockedKey));
    }
}

上面的代码有效，但是请注意，这与简单地将 getKey(...) 的返回值声明为具有相同的语义

doReturn(mockedKey).when(sut).getKey(anyString());

尝试仅修改 getKeyFromStream(...) 如下所示：

doReturn(mockedKey)
    .when(sut).getKeyFromStream(any(InputStream.class), anyString());

不修改您的被测系统 (SUT) 的 getKey(...) 将无法实现任何目标，因为 getKey(...) 的真实代码将被执行。但是，如果您模拟 sut 对象，则无法调用 // Act 部分中的方法，因为这将返回 null。如果你尝试

doCallRealMethod().when(sut).getKey(anyString());

在模拟对象上，将调用真正的方法，并且如前所述，这也将调用 getKeyFromStream(...) 和 getKeyStream(...) 的实际实现，无论您指定什么模拟方法。

正如您自己可能看到的那样，实际测试类的模拟方法并没有那么有用，并且给您带来的负担比它提供的任何好处都多。因此，如果您想要或需要测试私有/受保护的方法，或者您坚持只测试公共 API（我会推荐），这取决于您或您的企业的政策。您也可以使用refactor your code 来提高可测试性，尽管重构的主要目的应该是improve the overall design of your code。