如何模拟返回值为void的静态方法

  在编写代码时,经常需要调用别人已经写好的工具类方法,而这些方法经常又是使用静态方法实现的。而我们在测试自己的代码时,又不想真正执行这些方法,此时就需要对这些静态方法进行mock。在如何使用Powermock对静态方法进行mock文章中,我们介绍了如何对带有返回值的方法进行mock。那么对于返回值为void的方法如何模拟呢?
  同样的,我们先看下待测试类:

public class Utility {
    public static void doSomething(String var) {
        throw new UnsupportedOperationException();
    }
}

public class UtilityHelper {
   public void call() {
       Utility.doSomething("test");
   }
}
1、不做任何方法模拟

  我们先不mock该静态方法,看下效果:

@RunWith(PowerMockRunner.class)
@PrepareForTest({Utility.class})
public class UtilityHelperTest {
    private UtilityHelper utilityHelper;

    @Test(expected = UnsupportedOperationException.class)
    public void testCall() throws Exception {
        utilityHelper = new UtilityHelper();
        utilityHelper.call();
    }
}

  执行该测试方法,会返回UnsupportedOperationException,正好和我们期望的结果相同,所以该测试用例执行正确。

2、模拟静态类

  下面我们加一行代码,再看看效果:

@RunWith(PowerMockRunner.class)
@PrepareForTest({Utility.class})
public class UtilityHelperTest {
    private UtilityHelper utilityHelper;

    @Test(expected = UnsupportedOperationException.class)
    public void testCall() throws Exception {
        PowerMockito.mockStatic(Utility.class);

        utilityHelper = new UtilityHelper();
        utilityHelper.call();
    }
}

  由于我们加了一行对Utility类进行mock的语句,导致Utility里面的所有方法都不会被真正执行,此时调用doSomething方法时不会抛出UnsupportedOperationException,该测试方法执行错误。

java.lang.AssertionError: Expected exception: java.lang.UnsupportedOperationException

    at org.powermock.modules.junit4.internal.impl.PowerMockJUnit44RunnerDelegateImpl$PowerMockJUnit44MethodRunner.runTestMethod(PowerMockJUnit44RunnerDelegateImpl.java:318)
    at org.junit.internal.runners.MethodRoadie$2.run(MethodRoadie.java:89)
    at org.junit.internal.runners.MethodRoadie.runBeforesThenTestThenAfters(MethodRoadie.java:97)
    at org.powermock.modules.junit4.internal.impl.PowerMockJUnit44RunnerDelegateImpl$PowerMockJUnit44MethodRunner.executeTest(PowerMockJUnit44RunnerDelegateImpl.java:300)
    at org.powermock.modules.junit4.internal.impl.PowerMockJUnit47RunnerDelegateImpl$PowerMockJUnit47MethodRunner.executeTestInSuper(PowerMockJUnit47RunnerDelegateImpl.java:131)
    at org.powermock.modules.junit4.internal.impl.PowerMockJUnit47RunnerDelegateImpl$PowerMockJUnit47MethodRunner.access$100(PowerMockJUnit47RunnerDelegateImpl.java:59)
    at org.powermock.modules.junit4.internal.impl.PowerMockJUnit47RunnerDelegateImpl$PowerMockJUnit47MethodRunner$TestExecutorStatement.evaluate(PowerMockJUnit47RunnerDelegateImpl.java:147)
    at org.powermock.modules.junit4.internal.impl.PowerMockJUnit47RunnerDelegateImpl$PowerMockJUnit47MethodRunner.evaluateStatement(PowerMockJUnit47RunnerDelegateImpl.java:107)
    at org.powermock.modules.junit4.internal.impl.PowerMockJUnit47RunnerDelegateImpl$PowerMockJUnit47MethodRunner.executeTest(PowerMockJUnit47RunnerDelegateImpl.java:82)
    at org.powermock.modules.junit4.internal.impl.PowerMockJUnit44RunnerDelegateImpl$PowerMockJUnit44MethodRunner.runBeforesThenTestThenAfters(PowerMockJUnit44RunnerDelegateImpl.java:288)
    at org.junit.internal.runners.MethodRoadie.runTest(MethodRoadie.java:87)
    at org.junit.internal.runners.MethodRoadie.run(MethodRoadie.java:50)
    at org.powermock.modules.junit4.internal.impl.PowerMockJUnit44RunnerDelegateImpl.invokeTestMethod(PowerMockJUnit44RunnerDelegateImpl.java:208)
    at org.powermock.modules.junit4.internal.impl.PowerMockJUnit44RunnerDelegateImpl.runMethods(PowerMockJUnit44RunnerDelegateImpl.java:147)
    at org.powermock.modules.junit4.internal.impl.PowerMockJUnit44RunnerDelegateImpl$1.run(PowerMockJUnit44RunnerDelegateImpl.java:121)
    at org.junit.internal.runners.ClassRoadie.runUnprotected(ClassRoadie.java:34)
    at org.junit.internal.runners.ClassRoadie.runProtected(ClassRoadie.java:44)
    at org.powermock.modules.junit4.internal.impl.PowerMockJUnit44RunnerDelegateImpl.run(PowerMockJUnit44RunnerDelegateImpl.java:123)
    at org.powermock.modules.junit4.common.internal.impl.JUnit4TestSuiteChunkerImpl.run(JUnit4TestSuiteChunkerImpl.java:121)
    at org.powermock.modules.junit4.common.internal.impl.AbstractCommonPowerMockRunner.run(AbstractCommonPowerMockRunner.java:53)
    at org.powermock.modules.junit4.PowerMockRunner.run(PowerMockRunner.java:59)
    at org.junit.runner.JUnitCore.run(JUnitCore.java:137)
    at com.intellij.junit4.JUnit4IdeaTestRunner.startRunnerWithArgs(JUnit4IdeaTestRunner.java:68)
    at com.intellij.rt.execution.junit.IdeaTestRunner$Repeater.startRunnerWithArgs(IdeaTestRunner.java:47)
    at com.intellij.rt.execution.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:242)
    at com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:70)

Picked up JAVA_TOOL_OPTIONS: -Dfile.encoding=UTF-8
3、去掉@Test后面的expected验证
@RunWith(PowerMockRunner.class)
@PrepareForTest({Utility.class})
public class UtilityHelperTest {
    private UtilityHelper utilityHelper;

    @Test
    public void testCall() throws Exception {
        PowerMockito.mockStatic(Utility.class);

        utilityHelper = new UtilityHelper();
        utilityHelper.call();
    }
}

  此例中,由于我们去掉了expected这个期望验证结果,导致该测试方法目前没有任何验证存在,显然该用例执行正确。

4、加个 doSomething方法被调用的验证

  没有任何验证的测试用例是无效的,下面我们在该用例中增加静态方法doSomething被调用的语句:

@RunWith(PowerMockRunner.class)
@PrepareForTest({Utility.class})
public class UtilityHelperTest {
    private UtilityHelper utilityHelper;

    @Test
    public void testCall() throws Exception {
        PowerMockito.mockStatic(Utility.class);

        utilityHelper = new UtilityHelper();
        utilityHelper.call();

        PowerMockito.verifyStatic(Mockito.times(1));
        Utility.doSomething(Mockito.any());
    }
}

  执行该测试用例,仍然执行正确,说明该静态方法确实是被调用了。此时我们可以看出,对于void类型的静态方法,我们不对该方法做任何的mock,仍然是执行正确的,这是因为mock整个类时,该类的所有方法就已经都被mock了,并且按照默认的方式进行处理,此时对于返回值为void的方法就是什么都不做。

5、显示对void方法进行mock

  虽然不对void方法进行mock也能正常工作,但是我们还是习惯显示的对相应的方法进行mock,那么如何对void类型的方法进行mock呢?下面我们介绍两种写法:

  • 方法一
PowerMockito.doNothing().when(Utility.class, "doSomething", Mockito.any());

  此处采取的when原型如下:

<T> void when(Class<T> classMock, String methodToExpect, Object... parameters) throws Exception;

  函数注释如下,可见该种方式主要适用于对私有静态且无返回值的方法进行mock。对私有静态方法且有返回值的可以参考使用Powermock对私有方法进行mock

Allows to mock a static private method based on method name and parameters when stubbing in doThrow()|doAnswer()|doNothing()|doReturn() style
Example:
  doThrow(new RuntimeException()).when(MyClass.class, "methodName", parameter1, parameter2);

  • 方法二
PowerMockito.doNothing().when(Utility.class);
Utility.doSomething(Mockito.any());

  此处采取的when原型如下:

void when(Class<?> classMock);

  函数注释如下,可见该种方式主要适用于对公有静态且无返回值的方法进行mock。

Allows to choose a static method when stubbing in doThrow()|doAnswer()|doNothing()|doReturn() style
Example:
  doThrow(new RuntimeException()).when(StaticList.class);
  StaticList.clear();

  综上所述,对于无返回值的静态方法,我们可以有两种方式实现mock:
  1) 隐式写法,即只需要mock静态类即可;
  2) 显示写法,此时需要根据方法是私有的还是公有的选择相应的格式;

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,366评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,521评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,689评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,925评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,942评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,727评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,447评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,349评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,820评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,990评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,127评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,812评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,471评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,017评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,142评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,388评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,066评论 2 355

推荐阅读更多精彩内容