JUnit4 与 JMock 之双剑合璧

引言

单元测试可以保证代码的质量，最大程度降低修复系统 bug 的时间和成本。能被称为测试的阶段有：单元测试、集成测试、系统测试和用户测试。修复系统 bug 的时间和成本随着这些阶段的推移呈指数级增长，特别是客户发现问题的时候，不仅是时间跟成本的损失，更是客户忠诚度的损失。由此可以看出单元测试的重要性。

JUnit 是作为 Java 开发人员单元测试的利器。据统计，目前单元测试的框架中使用最多的是 JUnit，占 35% 以上的比重。下面要介绍的是 JUnit4，是 JUnit 最新的版本。JUnit4 使用了 Java 5 注解让测试的过程变得更方便和灵活，因此备受开发者的青睐。

通常待测的类不可避免地使用其他类的方法。在不能保证其他类方法正确性的前提下，如何通过单元测试的方式保证待测试的类方法是正确的呢？或者假如待测试的方法依赖的其他类的代码还没有实现而只是定义了接口，那么待测试的方法可以测试呢？ JMock 的出现解决了上面的问题。JMock 提供给开发者切断待测方法对其他类依赖的能力，使开发者能够将全部的注意力都集中于待测方法的逻辑上，而不用担心其他类方法是否能够返回正确的结果。这样的测试更具有针对性，更容易定位到潜在问题。

因此，JUnit4 与 JMock 的组合就成为 Java 开发人员写单元测试必备的利器。本文对 JUnit4 与 JMock 的组合使用、测试用例设计、常遇到的问题及可重用性方面进行了深入的探讨。


--------------------------------------------------------------------------------

回页首

JUnit4 应用

Eclipse 是 Java 开发人员非常熟悉的 IDE（集成开发环境）。目前我们选择 Eclipse 3.5 以上版本，安装配置 Sun JDK 1.5 以上版本。Eclipse 中已包含 JUnit4 的 Library，用户可以方便的导入使用。

由于在 Developerworks 上已经有许多介绍 JUnit4 应用的教程和文章，因此这里就不再赘述。对 JUnit4 还不熟悉的读者，本文推荐 《深入探索 JUnit4 》作为入门教程。


--------------------------------------------------------------------------------

回页首

JMock 应用于 JUnit4 中

使用 JMock，项目需要导入 JMock 相关的一系列 Jar 包。我们可以通过 JMock 的官方网站得到这些 Jar 包。这样项目中就可以使用 JMock 的技术来辅助我们更好的完成单元测试了。


清单 1. 依赖其他类方法的类 TestJunit4.java

public class TestJunit4 {
private IMathfun util;
public TestJunit4(IMathfun util){
this.util = util;
}
public int cal(int num){
return 10* util.abs(num);
}
}




我们定义了一个很简单的类，在这个类中有 cal 方法，这个方法需要调用 IMathfun 接口中的 abs 方法。已知 cal 的作用就是对其参数取绝对值，然后再乘 10 返回。那么，cal 方法依赖于接口 IMathfun 的方法 abs 完成取绝对值，我们可以通过 Mock IMathfun 实例及方法来切断对其依赖性。


清单 2. 测试类 TestJunit4Test.java

1 public class TestJunit4Test extends TestCase{
2    private Mockery context = new JUnit4Mockery();
3    private IMathfun math = null;
4    private TestJunit4 test = null;
5 @Before
6 public void setUp() throws Exception {
7 super.setUp();
8 math = context.mock(IMathfun.class);
9 test = new TestJunit4(math);
10 context.checking(new Expectations(){
11 {
12 exactly(1).of(math).abs(-10);will(returnValue(10));
13 }
14 });
15 }
16 @After
17 public void tearDown() throws Exception {
18 }
19 @Test
20 public void test(){
21 assertEquals(100,test.cal(-10));
22 }
23}




上面的代码中有几个需要注意地方：1. 测试类继承了 TestCase（line1）。2. 创建了 Mockery 的对象 context（line2）。3 利用 context 对象来 mock 接口的实例（line8）及对应的方法（line12）。在这个简单的例子中我们 mock 了 math 及其方法，这样程序在运行的时候就不会去执行真正 IMathfun 实现类的代码，而转到 line12 的地方。给定数值 -10，直接返回 10。

更多关于 JMock 的知识请参阅 http://www.jmock.org/cookbook.html.


--------------------------------------------------------------------------------

回页首

用例设计与 Coverage 分析

初学者在组合使用 JUnit4 和 JMock 技术写单元测试的时候，往往只能发现很少的问题甚至发现不了问题。因此，开发人员就需要一些方法和指标来保证与规范单元测试的质量。其中单元测试用例设计原则和覆盖率指标就是重要的指导原则与指标。

Grenford J. Mayer 在《 The Art of Software Testing 》一书中提出：一个好的测试用例 (test case) 是指很可能找到迄今为止尚未发现的错误的测试。开发者不能只凭借自己主观或直观的想法来设计测试用例，应该要以一些比较成熟的测试用例设计方法为指导，再加上设计人员自己的经验积累才能做好用例设计。因此，也只有将用例设计方法与丰富的实践经验相融合才能设计出高质量的测试用例。

测试用例设计有三条基本指导原则：

测试用例的代表性：能够代表并覆盖各种合理的和不合理、合法的和非法的、边界的和越界的以及极限的输入数据。
测试结果的可判定性：测试执行结果的正确性是可判定的，每一个测试用例都应有相应的期望结果。
测试结果的可再现性：即对同样的测试用例，系统的执行结果应当是相同的。
写测试用例的过程也是对代码进行重新审查的过程，首先需要弄清楚待测的方法的功能是什么。其次多角度考虑这个方法该怎么写才是正确的、可靠的、高效的。再次，多考虑一些边界跟异常的情况。

通常 case 的数量是由参数的个数决定的。对于每一个参数，我们需要设计三种情况对其方法进行测试，即：为 null 值，正确值和错误值。这样如果方法有 n 个参数，那么理论上 case 的数量需要 3n个。这个数量所带来的工作量是非常大的，而且也是低效的。实际工作中，我们还需要另一个指标来衡量 case 的设计是否全面，那就是覆盖率。

Emma 是一个 Eclipse 的标准插件，通过这个工具我们可以得到类级别的语句覆盖率（statement coverage）和包级别的覆盖率（package coverage）。运行 Emma 后，工具会根据是否被执行将源代码行标注为不同的颜色，标记为红色的代码表示没有被执行，标记为绿色的代码表示已经被执行。我们可以通过以下步骤安装：

在 Eclipse IDE 中点击 help->install new software.
在弹出的页面地址栏中输入：http://update.eclemma.org/，会出现名为 EclEmma Java Code Coverage 的插件，选中并安装。安装成功后工具栏会出现一个运行 coverage 的小图标。
覆盖率是另一个用来衡量测试用例是否全面的指标。关于 coverage 还可以细分为三个更小的指标：语句覆盖率（statement coverage）、分支覆盖率（branch coverage）、以及路径覆盖率（path coverage）。


图 1.三种覆盖率示例图


语句覆盖率是指方法中代码行被执行的百分比。例如上图中共有 5 条语句，如果执行的步骤是 1-3-5。那么语句覆盖率是 60%。如果要提高到 100% 的话，至少需要 2 个 case 来覆盖：1-3-5 与 1-2-4-5。环境准备小节中提到的 Emma 可以提供语句覆盖率。具体执行过程：右键点击测试类 ->Coverage as->Junit test。语句的覆盖率会在 coverage 的视图中出现，并且根据是否被执行将源代码标注成不同的颜色。

分支覆盖率指的是方法中分支被执行的百分比。例如图 1 中在第一个菱形的位置处分成二个分支，在第二个菱形的位置处分成二个分支。这样共有 4 个分支。如果执行的步骤是 1-2-3-5 的话，因为只执行了其中的两个分支，所以分支覆盖率是 50%。如果要提高到 100% 的话，至少需要 2 个 case 来覆盖：1-2-3-5 与 1-F-4-5（F 第一个分支处 false）。分支的覆盖率要比语句的覆盖率更能够保证 case 的质量。目前 Emma 还不能生成分支覆盖率。Cobertura 是一个可以生成语句覆盖率跟分支覆盖率的强大工具。Cobertura 的使用比 Emma 复杂一些，需要写 ant 脚本来运行 Cobertura。利用 Cobertura 生成 html, xml 等文件来显示类的语句及分支覆盖率的情况。

路径覆盖率指的是方法中路径被执行的百分比。这是一个比上面两个指标更全面的指标。路径指的是从方法的起点到终点的一条通路，如：1-2-3-5。如果想要路径的覆盖率达到 100%，那么必须要 4 个 case 才能完成：1-2-3-5,1-2-4-5，1-F-3-5，1-F-4-5。目前也有一些工具可以用来生成路径覆盖率。

在测试用例设计的过程中，我们需要兼顾用例设计的指导原则与覆盖率的一些指标，再结果开发人员自身的实践经验必定能设计出好的测试用例。


--------------------------------------------------------------------------------

回页首

可能遇到的困难

组合使用 JUnit4 与 JMock 写单元测试时，通常情况下类的覆盖率难以达到 100%，源于某些方法不能直接写测试。在这一小节里，对常见的问题提供了一些解决途径。

静态方法

静态方法是单元测试过程中常见的困难之一。程序中通常需要调用其他的类的静态方法获取运行的数据或者参数。在这种情况下，只有程序启动以后这些参数才是存在的，而单元测试却是在程序未启动的情况下执行的。静态方法是通过类调用，而不是对象调用，因此也不能通过 JMock 的方式解决。


清单 3. TestStatic.java

public class TestStatic{
public TestStatic(){}
public int getOSType(){
String os = Utils.getTargetOS();
if("Windows".equals(os))
    Return 0;
else if("Linux".equals(os)||"Unix".equals(os))
    Return 1;
else
    Return 2;
}
}




对TestStatic类的getOSType方法写单元测试的话，由于需要调用Utils类的静态方法getTargetOS。所以，如果不做任何处理的话，单元测试是不能进行的。有两种方法可以解决这个问题。

检查Utils类是否有带public修饰符类似于setTargetOS的方法。如果有并且能够通过调用的这个方法达到设置OS目的的话，我们只需要在测试方法调用此方法设置即可完成。
如果上述情况不能完成。那么考虑第二种办法 - 重构TestStatic与Utils。但是，这么做会引发一些争议。为了测试而修改源代码，值得吗？这是需要开发者去权衡的问题。。对于Utils的改动很小，只需要将其方法getTargetOS的修饰符static去掉。类TestStatic的修改变化要大一些：

清单 4. 修改后的 TestStatic.java

public class TestStatic{
private IUtils utils = null;
public TestStatic(IUtils utils){
    This.utils = utils;
}
public int getOSType(){
    String os = utils.getTargetOS();
if("Windows".equals(os))
    Return 0;
else if("Linux".equals(os)||"Unix".equals(os))
    Return 1;
else
    Return 2;
}
}




TestStatic.java的修该有几个地方：1. 增加了utils的成员变量。2. 修改了构造函数。3. 将类中调用外部类的静态方法改为调用非静态方法。


清单 5. TestStaticTest.java

public class TestStaticTest extends TestCase{
    Mockery context = new JUnit4Mockery();
    IUtils utils = null;
    TestStatic stat = null;
@Before
public void setUp(){
    utils = context.mock(IUtils.class);
    Stat = new TestStatic(utils);
}
@After
public void tearDown(){}
@Test
public TestOSTypeWin(){
    context.checking(new Expectations(){
    {
            exactly(1).of(utils).getTargetOS();will(returnValue("Windows"));
    }
});
    assertEquals(0,stat.getOSType());
}
@Test
public TestOSTypeLN(){
    context.checking(new Expectations(){
    {
            atLeast(1).of(utils).getTargetOS();
/*27*/            will(onConsecutiveCalls(
                       returnValue("Linux"),
                       returnValue("Unix")));
    }
});
    assertEquals(1,stat.getOSType());// return value:Linux
    assertEquals(1,stat.getOSType());// return value:Unix
}
}




这里需要解释一下第27行，这样写的结果是：如果函数第一次被调用则返回"Linux"，如果是第二次调用返回"Unix"。

私有方法

私有方法也是写单元测试过程中常会遇到的困难。类中的私有方法主要是供公有方法调用。测试公有方法之前需要保证私有方法的正确性。通常，开发者会在测公有方法之时测私有方法。这么做会产生一些问题，首先，为了测公有方法里的某一个私有方法，我们需要重复此私有方法调用之前的工作。其次，如果一个公有方法里调用大量私有方法时，用这种方法的写出来的测试代码会非常复杂，不利于测试。如果我们能够首先独立测试私有方法，那么就会极大地减轻公有方法的测试工作量。

解决这个问题，有两种方法。

由于开发者通常会将测试类跟待测试的类置于同一包下，所以，最简单的方法是将私有方法前的修饰符修改为 protected，这样的话测试代码就可以访问原来的私有方法了。值得注意的是这样做需要修改源代码。
另一种方法不需要修改源代码，利用 Java 反射可以实现。

清单 6.Data.java

public class Data {
private String name = "Na";
public String getName(){
return name;
}
private void setName(String str){
name = str;
}
}




Data类中的setName是私有方法。我们可以通过反射的方式对其测试。


清单 7. DataTest.java

public class DataTest extends TestCase{
@Before
public void setUp(){
}
@After
public void tearDown(){
}
@Test
public void test() throws Exception{
Data data = new Data();
System.out.println(data.getName());
Method m = data.getClass().getDeclaredMethod("setName", String.class);
m.setAccessible(true);
m.invoke(data, "Joh");
System.out.println(data.getName());
}
}




清单 8. 输出结果

Na
Joh




从输出结果我们可以看出，我们通过反射调用了Data的私有方法setName，成功将其name值改变为Joh。关于Java 反射的特性，可以参阅 Java 编程思想。

JMock 的一些问题

Mock concrete Object
由于目前推崇面向接口（interface）的设计，Mockery 对象（context）的 mock 方法通常的参数是接口类型（context.mock（Interface.class））。但是，实际情况中我们偶然会遇到 mock 实体对象的情况。如果需要 mock 实体对象的话，跟 mock 接口有所不同，不能通过直接传实体类来构造。在 mock 实体对象之前，需要调用 context 的一个方法：setImposteriser(ClassImposteriser.INSTANCE)，同时需要导入相关的三个 jar 包。

Mock 对象的方法多次调用返回不同结果
在代码清单 8 中已经给出了一个例子，对象 utils 第一次调用 getTargetOS 返回"Linux"，第二次调用返回"Unix"。

Mock 对象的方法参数不能指定具体值
有些时候我们在 mock 对象的方法时，不能获取相应的参数时，解决办法是指定一个类型即可。例如：exactly(1).of(computer).getOSType(with(any(String.class)));will(returnValue(2));

如果有多个参数时，参数的匹配模式必须是一致的。也就是说要么参数都是指定类型的，要么参数都是具体值的，混合使用会由于匹配模式不一致而抛出异常。另外，数组的类型比较特别，如 String 数组的类型为 String[].class。

方法没有返回值，但是会改变其成员的值。
遇到这种情况会比较复杂，需要定义一个类去实现 Action 接口。详细见 http://www.jmock.org/custom-actions.html 。


--------------------------------------------------------------------------------

回页首

可重用性方面

组合使用 JUnit4 和 JMock 写单元测试如果没有使用重用性技巧会产生大量重复性的劳动。可重用性分为两个方面：多个类的可重用性和单类的可重用性。

常常会遇到一种情况：在多个测试类中都需要 mock 相同对象及其方法，我们可以将这一过程提取出来。通常测试类都继承于 TestCase，为了实现重用性，需要再定义一个类，取名为 GeneralTest，使 GeneralTest 继承 TestCase。在 GeneralTest.java 中将在多个测试类中用到的相同对象的 mock 工作封装进去。然后其他的测试类全部继承自 GeneralTest，这样测试类中就可以反复使用 GeneralTest 提供给我们的方法来 mock 对象了，我们需要做的就是简单传入几个参数而已。这样不仅能够省去大量的重复劳动，还能使测试代码看起来更简单、清晰，给我们的测试工作带来非常大的好处。

在单个测试类中也可以提高可重用性。在单个测试类中也会有一些需要 mock 的对象在多个测试方法重用。可以将这些可重用的 mock 对象作为测试类的成员，将这些对象的 mock 工作置于 @Before 修饰的方法中，那么在需要用到这些对象的时候直接使用即可，不需要在每一个测试方法中重新做一遍。所带来的好处与上面一种情况是类似的。


--------------------------------------------------------------------------------

回页首

结束语

对于 Java 而言，大部分开发者会使用到 JUnit4 跟 JMock 这两项技术。本文循序渐进地对 JUnit4 应用、JMock 与 JUnit4 的结合使用、用例设计、困难解决和可重用性多个阶段全面地阐述了作者在单元测试过程中的心得。在介绍的过程中，同时也会照顾一些入门级的读者，对一些操作给出了详细的步骤，并提供了大量的示例。

希望入门级的读者在阅读这篇文章后对单元测试有一个全面的认识，更希望有经验的读者阅读后会有所收获。



参考资料

学习

www.jmock.org/cookbook.htm：JMock 官方网站


http://www.junit.org：JUnit 官方网站


“让编译和测试过程自动化 Ant 和 JUnit 让您与 XP 梦想更近一步”（developerWorks，2001 年 10 月）：逐步递增测试和持续编译是极端编程方法基础的两种。把两者合并成为一个单独的、自动进行的过程 — 加上自动生成电子邮件报告 — 您就将在向 XP 梦想前进的道路上迈出坚实的步子。请跟随 Erik Hatcher，他向您展示了他是如何修改流行的 Ant 1.3 和 JUnit 测试框架，以达到让编译和测试过程完全的、用户化的自动化。


“用 Jython 构建 JUnit 测试包”（developerWorks，2004 年 5 月）：开发人员有多种理由决定自动化单元测试。许多人甚至进一步发挥它，自动化这些测试的定位和执行。但是如果想要测试装具模块（test harness）像静态定义的那样运行呢？请跟随开发员 Michael Nadel，看看如何利用 Python 模拟静态定义的 JUnit TestSuite 类。


“JUnit 4 抢先看 ”（developerWorks，2005 年 10 月）：JUnit 是 Java 语言事实上的 标准单元测试库。JUnit 4 是该库三年以来最具里程碑意义的一次发布。它的新特性主要是通过采用 Java 5 中的标记（annotation）而不是利用子类、反射或命名机制来识别测试，从而简化测试。在本文中，执着的代码测试人员 Elliotte Harold 以 JUnit 4 为例，详细介绍了如何在自己的工作中使用这个新框架。注意，本文假设读者具有 JUnit 的使用经验。


developerWorks Java 技术专区：这里有数百篇关于 Java 编程各个方面的文章。


讨论

加入 developerWorks 中文社区。查看开发人员推动的博客、论坛、组和维基，并与其他 developerWorks 用户交流。