Java_UT_Mock系列之-01 Powermock与Thead.sleep

测试场景及问题

笔者在对某个JAVA socket通信程序进行UT的时候，遇到过以下一个场景，
客户端发出登陆请求，然后每隔500ms监查一下底层通信机的登陆状态，如果登陆成功，底层通信机会将其状态修改为LOGIN_SUCCESS/LOGIN_FAILED。客户端检查时如果发现登陆状态不是上述两个状态，则线程休眠500ms然后继续监查。上述逻辑要重复30次，也就是15秒后，如果登陆状态不是上述成功/失败的状态，则表示未收到登陆答复等逻辑，需要切换服务器继续登陆。
一个简化的过程如下：

public class SystemClass {
int j=0;
public void callThead() {
for(int i=0;i<30;i++) {
try {
Thread.sleep(500);
} catch (InterruptedException e) {
//e.printStackTrace();
break;
}
//end for
j++;
}
}

为了模拟登陆请求未收到答复的场景（如网络延迟），需要走完整个循环，也就是说需要等待500*30ms=15s的时间。对于UT 来说，这个时间是无法接受的。
解决办法及代码
因此，我们需要对Thread.class进行mock，缩短等待时间。 方案是在Thread.sleep方法被调用时，直接抛出InterruptedException ，让程序退出整个循环。示例程序如下：

import org.junit.Rule;
import org.junit.Test;
import org.mockito.Mockito;
import org.powermock.core.classloader.annotations.PrepareForTest;
import org.powermock.modules.junit4.rule.PowerMockRule;
import static org.powermock.api.mockito.PowerMockito.spy;
import static org.powermock.api.mockito.PowerMockito.doThrow;
import static org.junit.Assert.assertEquals;
/**
* Test class to demonstrate static mocking with PowerMockito.
*/
//@RunWith(PowerMockRunner.class)  // using @Rule
@PrepareForTest( { SystemClass.class})
public class SystemClassTest {
    @Rule
  public PowerMockRule rule = new PowerMockRule();
@Test
public void testMockStaticThatThrowsException() throws Exception {
spy(Thread.class);
// Expectations
doThrow(new InterruptedException()).when(Thread.class);
Thread.sleep(Mockito.anyLong());
//Test
SystemClass systemClass = new SystemClass();
systemClass.callThead();
assertEquals(0, systemClass.j);
}
}

案例分析

对于mock的挑战有两个，首先Thread.sleep是一个静态方法；其次，该方法没有返回值。对于Mockito等mock工具来说，这就是无法解决的问题了。得益于Powermockito对于静态方法进行Mock的能力，使用如下格式，就实现了预期的调用Thread.sleep时抛出中断异常的行为，从而实现了大大缩短程序执行时间的目标。
// Expectations
doThrow(new InterruptedException()).when(Thread.class);
Thread.sleep(Mockito.anyLong());
当然，为了能够mock某个类的静态方法，需要在测试类上加上一下注解，
@PrepareForTest( { SystemClass.class})
并且使用Powermockito.spy这个方法来部分mock Thread这个类。
spy(Thread.class);
另外，通过以下断言也能证实上述mock效果的有效性。
assertEquals(0, systemClass.j);
由于在循环的第一次执行过程中就中断退出，因此变量j==0;
实际程序中的断言也可参考这种方式。

遗留问题

由于Thread.class来自java.lang，是Java语言的一部分，因此对于Thread的mock会引起同样需要修改java 字节码的jacoco覆盖率统计工具的冲突，导致无法dump测试覆盖率报告。该问题将另文介绍。