使用Mock对象进行单元测试

关键字: 测试之道

1.出了什么问题？
      单元测试的目标是一次只验证一个方法，小步的前进，细粒度的测试，但是假如某个方法依赖于其他一些难以操控的东东，比如说网络连接，数据库连接，或者是Servlet容器，那么我们该怎么办呢？
      要是你的测试依赖于系统的其他部分，甚至是系统的多个其他部分呢？在这种情况下，倘若不小心，你最终可能会发现自己几乎初始化了系统的每个组件，而这只是为了给一个测试创造足够的运行环境让它们可以运行起来。忙乎了大半天，看上去我们好像有点违背了测试的初衷了。这样不仅仅消耗时间，还给测试过程引入了大量的耦合因素，比如说，可能有人兴致冲冲地改变了一个接口或者数据库的一张表，突然，你那卑微的单元测试的神秘的挂掉了。在这种情况发生几次之后，即使是最有耐心的开发者也会泄气，甚至最终放弃所有的测试，那样的话后果就不能想像了。
   再让我们看一个更加具体的情况：在实际的面向对象软件设计中，我们经常会碰到这样的情况，我们在对现实对象进行构建之后，对象之间是通过一系列的接口来实现。这在面向对象设计里是最自然不过的事情了，但是随着软件测试需求的发展，这会产生一些小问题。举个例子，用户A现在拿到一个用户B提供的接口，他根据这个接口实现了自己的需求，但是用户A编译自己的代码后，想简单模拟测试一下，怎么办呢？这点也是很现实的一个问题。我们是否可以针对这个接口来简单实现一个代理类，来测试模拟，期望代码生成自己的结果呢？
      幸运的是，有一种测试模式可以帮助我们：mock对象。Mock对象也就是真实对象在调试期的替代品。

2.现在需要Mock对象吗？
      关于什么时候需要Mock对象，Tim Mackinnon给我们了一些建议：
        ----- 真实对象具有不可确定的行为(产生不可预测的结果，如股票的行情)
        ----- 真实对象很难被创建(比如具体的web容器)
        ----- 真实对象的某些行为很难触发(比如网络错误)
        ----- 真实情况令程序的运行速度很慢
        ----- 真实对象有用户界面
        ----- 测试需要询问真实对象它是如何被调用的(比如测试可能需要验证某个回调函数是否被调用了)
        ----- 真实对象实际上并不存在(当需要和其他开发小组，或者新的硬件系统打交道的时候，这是一个普遍的问题)
 
3.如何实现Mock对象？
      使用mock对象进行测试的时候，我们总共需要3个步骤，分别是：
       ----- 使用一个接口来描述这个对象
       ----- 为产品代码实现这个接口
       ----- 以测试为目的，在mock对象中实现这个接口
      在此我们又一次看到了针对接口编程的重要性了，因为被测试的代码只会通过接口来引用对象，所以它完全可以不知道它引用的究竟是真实的对象还是mock对象，下面看一个实际的例子：一个闹钟根据时间来进行提醒服务，如果过了下午5点钟就播放音频文件提醒大家下班了，如果我们要利用真实的对象来测试的话就只能苦苦等到下午五点，然后把耳朵放在音箱旁...我们可不想这么笨，我们应该利用mock对象来进行测试，这样我们就可以模拟控制时间了，而不用苦苦等待时钟转到下午5点钟了。下面是代码：

public interface Environmental {
      private boolean playedWav = false;
      public long getTime();
      public void playWavFile(String fileName);
      public boolean wavWasPlayed();
      public void resetWav();
}

      真实的实现代码：

public class SystemEnvironment implements Environmental {
      public long getTime() {
         return System.currentTimeMillis();
      }
      public void playWavFile(String fileName) {
         playedWav = true;
      }
      public boolean wavWasPlayed() {
         return playedWav;
      }
      public void resetWav() {
         playedWav = false;
      }
}

      下面是mock对象：

public class MockSystemEnvironment implements Environmental {
      private long currentTime;
      public long getTime() {
         return currentTime;
      }
      public void setTime(long currentTime) {
         this.currentTime = currentTime;
      }
      public void playWavFile(String fileName) {
         playedWav = true;
      }
      public boolean wavWasPlayed() {
         return playedWav;
      }
      public void resetWav() {
         playedWav = false;
      }
}

      下面是一个调用getTime的具体类：

import java.util.Calendar;

public class Checker {
      private Environmental env;
      public Checker(Environmental env) {
         this.env = env;
      }
      public void reminder() {
         Calendar cal = Calendar.getInstance();
         cal.setTimeInMills(env.getTime());
         int hour = cal.get(Calendar.HOUR_OF_DAY);
         if(hour >= 17) {
            env.playWavFile("quit_whistle.wav");
         }
      }
}

      使用env.getTime()的被测代码并不知道测试环境和真实环境之间的区别，因为它们都实现了相同的接口。现在，你可以借助mock对象，通过把时间设置为已知值，并检查行为是否如预期那样来编写测试。

import java.util.Calendar;
import junit.framework.TestCase;

public class TestChecker extends TestCase {
       public void testQuittingTime() {
            MockSystemEnvironment env = new MockSystemEnvironment();
            Calendar cal = Calendar.getInstance();
            cal.set(Calendar.YEAR, 2006);
            cal.set(Calendar.MONTH, 11);
            cal.set(Calendar.DAY_OF_MONTH,7);
            cal.set(Calendar.HOUR_OF_DAY, 16);
            cal.set(Calendar.MINUTE, 55);
            long t1 = cal.getTimeInMillis();
            env.setTime(t1);
            Checker checker = new Checker(env);
            checker.reminder();
            assertFalse(env.wavWasPlayed());
             t1 += (5*60*1000);
            env.setTime(t1);
            checker.reminder();
            assertTrue(env.wavWasPlayed());
            env.resetWav();
            t1 += 2*60*60*1000;
            env.setTime(t1);
            checker.reminder();
           assertTrue(env.wavWasPlayed());
      }
}

       这就是mock对象的全部：伪装出真实世界的某些行为，使你可以集中精力测试好自己的代码。

4.好像有一些麻烦
      如果每次都像上面那样自己写具体的mock对象，问题虽然解决了，但是好像有一些麻烦，不要着急，已经有一些第三方现成的mock对象供我们使用了。使用Mock Object进行测试，主要是用来模拟那些在应用中不容易构造(如HttpServletRequest必须在Servlet容器中才能构造出来)或者比较复杂的对象(如JDBC中的ResultSet对象)从而使测试顺利进行的工具。目前，在Java阵营中主要的Mock测试工具有JMock，MockCreator，Mockrunner，EasyMock，MockMaker等，在微软的.Net阵营中主要是Nmock，.NetMock等。
      下面就以利用EasyMock模拟测试Servlet组件为例，代码如下：      编译并将其当做一个Test Case运行，会发现两个测试方法均测试成功。我们可以看到easymock已经帮助我们实现了一些servlet组件的mock对象，这样我们就可以摆脱web容器和servlet容器来轻松的测试servlet了。

import org.easymock.*;
import junit.framework.*;
import javax.servlet.http.*;

public class MockRequestTest extends TestCase{
      private MockControl control;
      private HttpServletRequest mockRequest;
      public void testMockRequest(){
         //创建一个Mock HttpServletRequest的MockControl对象
         control = MockControl.createControl(HttpServletRequest.class);
         //获取一个Mock HttpServletRequest对象
         mockRequest = (HttpServletRequest) control.getMock();
         //设置期望调用的Mock HttpServletRequest对象的方法
         mockRequest.getParameter("name");
         //设置调用方法期望的返回值，并指定调用次数
         //以下后两个参数表示最少调用一次，最多调用一次
         control.setReturnValue("kongxx" ,1 ,1);
         //设置Mock HttpServletRequest的状态，
         //表示此Mock HttpServletRequest对象可以被使用
         control.replay();
         //使用断言检查调用
         assertEquals("kongxx",mockRequest.getParameter("name"));
         //验证期望的调用
         control.verify();
     }
}

       编译并将其当做一个Test Case运行，会发现两个测试方法均测试成功。我们可以看到easymock已经帮助我们实现了一些servlet组件的mock对象，这样我们就可以摆脱web容器和servlet容器来轻松的测试servlet了。

5.底层技术是什么？
      让我们来回忆一下，如果用户使用C++和java的程序的生成，C++在最后的阶段还需要连接才能生成一个整体程序，这在灵活性与java源代码的机制是不能比的，java的各个类是独立的，打包的那些类也是独立的，只有在加载进去才进行连接，这在代码被加载进去的时候，我们还可以执行很多的动作，如插入一些相关的业务需求，这也是AOP的一个焦点，javassit代码库的实现类似于这，正是利用这些，所以用java实现Mock对象是很简单的。

6.一些相关的资源
      MockObject的主页  http://www.mockobjects.com/ 介绍了关键Mock Object的基本概念和目前在各个环境下主要的Mock测试工具。
      JMock的主页http://www.jmock.org/ 可以获取JMock的最新代码和开发包，以及一些说明文档。
      EasyMock的主页http://www.easymock.org/ 可以获取JMock的最新代码和开发包，以及一些说明文档。
      NMock的主页http://www.nmock.org/ 介绍了在Microsoft .Net平台上进行Mock测试的开发工具。