JMockit 如何 mock 异常

2014-07-26 修改本文


后来发现用 JMockit 来 mock 异常根本没有之前文中描述的那么复杂,其实还是在那个 result 上,给它赋个异常实例就轻而易举的解决了,只需如此

1 new Expectations(MyService.class, ExternalService.class) {
2     {
3         ExternalService.fetchData();
4         result =  new NetworkException("No IPAddress ");
5     }
6 };

原文可不用看下去了。


做过几篇 JMockit 使用 Expectations 来 Mock 方法,私有方法,私有属性的的日志,今天工作上突然有个需求是要 Mock 异常。现在再也不能为了跑个单元测试而去拔下网线了,也不该人为的去制造其他混乱来测试。开始是想能不能用 Expectations 来 Mock 异常,尚未发现相关的属性可以设置,没有类似 result 那样的属性,比如想像中有个 exception/throwable 属性:
1new Expectations(MyService.class, ExternalService.class) {
2     {
3         ExternalService.fetchData();
4         throwable = new NetworkException("No IPAddress ");
5     }
6 };

可是没有 throwable 个属性,至少我还不知道如何用 Expectations 来 Mock 异常,此路不通,所以只得另辟溪径。我们可以直接 new MockUp 来创建类,这比创建一个 MockClass 来得轻量级些。

下面是一个完整例子,由四个类构成,今次列出

1. 要抛出的异常类 NetworkException.java
1package cc.unmi;
2
3public class NetworkException extends RuntimeException {
4    public NetworkException(String message) {
5        super(message);
6    }
7}

2. 被测试类 MyService.java
1package cc.unmi;
2
3public class MyService {
4    public static String fetchData(String name) {
5        return ExternalService.fetchByHttp(name);
6    }
7}

调用 ExternalService.fetchByHttp() 方法,我们的测试用例将要 Mock 住这个方法,并抛出 NetworkException 异常。

3. 外部类,待 Mock 的 ExternalService.java
 1package cc.unmi;
 2
 3public class ExternalService {
 4    public static String fetchByHttp(String name) {
 5        String result = null;
 6        try {
 7            // do something
 8        } catch (Exception ex) {
 9            throw new NetworkException(ex.getMessage());
10        }
11        return result;
12    }
13}

这是个示例方法,就上面的代码正常执行时肯定不会抛出 NetworkException 异常。我们假定在 //do something 的代码可能会抛出 NetworkException 异常,但我们可以在 Mock 方法中立即呈现出这个异常来。

4. 测试类 MyService.java,并完成异常的 Mock
 1package cc.unmi;
 2
 3import mockit.Mock;
 4import mockit.MockUp;
 5
 6import org.junit.Rule;
 7import org.junit.Test;
 8import org.junit.rules.ExpectedException;
 9
10public class MyServiceTest {
11
12    @Rule
13    public ExpectedException expectedEx = ExpectedException.none();
14
15    @Test
16    public void testFetchData() {
17        new MockUp<ExternalService>() {
18            @Mock
19            public String fetchByHttp(String name) {
20                throw new NetworkException("No IPAddress");
21            }
22        };
23
24        expectedEx.expect(NetworkException.class);
25        expectedEx.expectMessage("No IPAddress");
26
27        MyService.fetchData("Yanbin");
28    }
29}

这里用 new MockUp<>(){@Mock...} 的方式来 Mock 方法,我们也可以用 @MockClass..@Mock 的方式来创建 Mock 类/方法,但要笨重些。目前我们项目中基本摒弃了用 @MockClass 创建外部 Mock 类的做法,因为一般 Mock 类一般是与某一个测试方法紧密联系着的。

也要注意到 fetchByHttp() 本是个静态方法,但此处不能写成 public String static fetchByHttp(), 但去掉 static 也不会影响到 Mock 的效果。

JUnit 关于异常的测试可以参考 JUnit 4 如何正确测试异常

测试运行成功,能够断言到所期待的异常类型和消息。

下面为演示 Mock 异常的正确而有效性,故意把 expectedEx.epectMessage("No IPAddress") 改成 expectedEx.epectMessage("NoNo IPAddress"),这样 JUnit  更能爆出有助于理解的错误信息来

上面的错误信息告诉我们

第一个断言 expectedEx.expect(NetworkException.class) 是成功的
期待错误消息 NoNo IPAddress,但得到的是 No IPAddress,这正好从反面说明了我们 Mock 异常是成功的。 永久链接 https://yanbin.blog/jmockit-how-to-mock-excepction/, 来自 隔叶黄莺 Yanbin's Blog
[版权声明] 本文采用 署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0) 进行许可。