测试驱动开发with Junit(三)

第三章：使用mork进行测试开发：
       什么是mork？简单地说mork就是模型，模拟我们测试时需要的对象及测试数据。比如，用过Struts的朋友都知道，Struts中的action类要运行必须依靠服务器的支持，只有服务器可以提供HttpServletRequest，HttpServletResponse对象，如果不启动服务器，那么就没有办法对action类进行单元测试(当然了，使用mock测试除外)。对struts的Action进行测试是很困难的。即使当业务逻辑很好的被限定在业务层，Struts action通常还是会包含很重要的数据验证、数据转换和数据流控制代码。不对Struts action 支路进行测试在代码的覆盖率上会有很多的不足。单单依靠启动服务器运行程序来测试action太过于麻烦。如果让action脱离容器，那么测试就变得极为简单。脱离了容器，request与response对象如何获得？这时可以使用mork来模拟request与response对象，这样测试 action类就会变得极为简单。下面就简单的介绍一下如何使用StrutsTestCase来进行action的测试。

StrutsTestCase介绍
       StrutsTestCase工程提供了一种在JUnit框架下测试struts action的灵活、便利的方法。你可以通过设置请求参数，检查在Action被调用后的输出请求或Session状态这种方式对Struts Action做白盒测试。StrutsTestCase 提供了用框架模拟web容器的模拟测试方法也提供了真实的web容器（比如：Tomcat）下的测试方法。所有的StrutsTestCase单元测试类都源于模拟测试的 MockStrutsTestCase或容器内测试的CactusStrutsTestCase。
       下面的例子就是使用mock测试，因为它需要更少的启动和更快的运行。
要使用StrutsTestCase请在下列地址下载最新的发行包
http://sourceforge.net/project/showfiles.php?group_id=39190

      下面就开始我们的action测试之旅。首先先让我们了解一下要实现的程序的功能：在index.jsp中输入班级编号以列表形式在result.jsp页面中显示相关班级学员信息
在result.jsp中点击学员姓名在info.jsp中显示该学生的详细信息。
(注：这里数据库查询使用基本的jdbc实现，我们假设DAO层已经通过测试，因为这不是我们这里关注的重点，数据库使用SqlServer2000，同时假定你已经具备使用eclipse开发struts的相关知识)
       在pubs数据库中新建一个student表，在表中插入如下测试数据。

use pubs
go

create table student
([id] int primary key identity(1,1),
stuName varchar(20) not null,
stuAge int not null,
stuSex varchar(20)not null,
stuClass varchar(20) not null
)
go

insert into student values('jack',23,'man','GS2T11')
insert into student values('mohindar',24,'man','GS2T11')
insert into student values('tim',21,'man','GS2T11')
insert into student values('rose',23,'woman','GS2T11')
insert into student values('sakura',22,'woman','GS2T11')

insert into student values('dess',23,'man','GS2T12')
insert into student values('hiruku',24,'man','GS2T12')
insert into student values('lucy',21,'woman','GS2T12')
insert into student values('liky',23,'woman','GS2T12')
insert into student values('desr',22,'woman','GS2T12')
go

       先让我们来看看第一个功能如何实现：
  
       在search.jsp中填入数据，然后将其提交给SearchAction类来处理。SearchAction类调用业务逻辑层查询，将结果保存至 request对象的属性"result"中，并且跳转至info.jsp页面。如果查询不到结果，就构造一个ActionMessage，封装错误信息，并转向到error.jsp页面。
      下面的请求URL将会显示调用SearchAction类：
      search.do?method=search
      具体步骤如下：
      步骤1：在eclipse中放入strutstests-2.1.3.jar，junit.jar、commons-collections.jar
    
      步骤2：构造一个名为SearchForm的ActionForm和一个名为SearchAction 的action。SearchForm的属性为：clazzName

      步骤3：更改相应的配置文件

<form-beans>
    <form-bean name="searchForm" type="com.struts.form.SearchForm" />
form-beans>

<action-mappings>
    <action attribute="searchForm" input="/search.jsp"
        name="searchForm" parameter="method" path="/search" scope="request"
        type="com.struts.action.SearchAction" validate="false">
        <forward name="error" path="/error.jsp" />
        <forward name="success" path="/result.jsp" />
    action>
action-mappings>

     步骤4：编写测试类
构造一个名为SearchActionTest的类并继承MockStrutsTestCase。在该类中添
加测试方法testSearchSuccess

import servletunit.struts.MockStrutsTestCase;

public class SearchActionTest extends MockStrutsTestCase
{
   public void testSearchSuccess()
   {
      setRequestPathInfo("/search.do");          //1行
      addRequestParameter("method", "search");  //2行
      actionPerform();                          //3行
  }
}

       代码解释：
       1行：设置请求SearchAction类的请求路径
       2行：在请求路径后加上一个请求参数
                1行与2行就构成了/search.do?method=search
       3行：调用actionPerform()来执行action类
       注：以上代码就是对一个测试方法的初始化。可以根据需要自行修改

       步骤5：根据struts-config.xml文件完善testSearch方法。先验证可以按照班级名称查询出所需要的数据，主要做以下事情：
       a)   初始化提交数据
       b)   验证request中"result"属性是否有值
       c)   是否返回result.jsp页面    
       代码如下：

public class SearchActionTest extends MockStrutsTestCase
{
    public void testSearchSuccess()
    {
        setRequestPathInfo("/search.do");
        addRequestParameter("method", "search");

        addRequestParameter("clazzName","gs2t11");      //1行
        actionPerform();

        assertNotNull(request.getAttribute("result"));  //2行
        verifyForward("success");                       //3行
    }
}

       代码解释：
       1行：添加提交数据，该数据就相当与从search.jsp提交的数据
       2行：查询成功后，将结果放入request中，所以判断result中的"result"属性是否
                 有值来断定是否将结果成功放入request对象中。
       3行：验证查询成功后是否会返回success.jsp页面
       运行junit，如果出现以下错误(具体如下图)：(请参考附件吧。这里所有的图都省略……)
       那么请在src下建立一个名WEB-INF的目录，将WebRoot下的WEB-INF中的web.xml文件与struts-config.xml文件拷贝过去即可。如图：

       步骤6：在SearchAction中用最简单的代码先去实现步骤5中的功能
       代码如下：           

public class SearchAction extends DispatchAction
{
    private SearchHandler sh;

    public ActionForward search(ActionMapping mapping,ActionForm
              form, HttpServletRequest request, HttpServletResponse response)
    {
        SearchFormsearchForm = (SearchForm) form;
        //获取表单中输入的班级
        String className = searchForm.getClazzName();

        //查询该班级的信息
        sh = new SearchHandler();
        List list=sh.searchByClassName(className);

        if(list!=null)
        {
            //将班级信息保存至request中，并返回result.jsp
            request.setAttribute("result",list);
            return mapping.findForward("success");
        }
        else
            return null;
    }
}

           注释比较详细，就不再多解释了
        运行测试类结果如下(成功部分编写完毕)

        步骤7：编写不能成功取出数据的测试。在SearchActionTest类中添加一个名为testSearchFail的方法
       代码如下：      

public void testSearchFail()
{
    setRequestPathInfo("/search.do");
    addRequestParameter("method", "search");

    addRequestParameter("clazzName","gs2txx");       //1行
    actionPerform();

    verifyActionMessages(new String[] {"no.stuclass.found"});//2行
    verifyForward("error");                            //3行

    verifyForwardPath("/error.jsp");                              //4行
}

       代码解释：
       1行：输入一个不存在的班级
       2行：验证向ActionMessages中放入的消息文本
       3行：验证返回地址
       4行：验证页面地址是否与转向的error对应

      步骤8：更改SearchAction类，实现步骤7的功能
      代码如下：(粗体为增加部分)

public class SearchAction extends DispatchAction
{
    private SearchHandler sh;

    public ActionForward search(ActionMapping mapping,ActionForm
             form, HttpServletRequest request, HttpServletResponse response)
    {
        SearchFormsearchForm = (SearchForm) form;
        //获取表单中输入的班级
        String className = searchForm.getClazzName();

        //查询该班级的信息
        sh = new SearchHandler();
        List list=sh.searchByClassName(className);

        if(list!=null)
        {
            //将班级信息保存至request中，并返回result.jsp
            request.setAttribute("result",list);
            return mapping.findForward("success");
        }
        else
        {
             //构造一个ActionMessage保存一条消息
             ActionMessages messages=new ActionMessages();
             messages.add(Globals.MESSAGE_KEY, new ActionMess("no.stuclass.found")); 
                 saveMessages(request,messages);
             //返回error.jsp
             return mapping.findForward("error");
        }
    }
}

       运行测试类，正确

       至此第一个功能测试开发完毕
       接着我们一起来完成第二个功能:
                      
       在result.jsp页面中，点击学生的姓名后将其提交给DisplayAction类来处理。DisplayAction类调用业务逻辑层查询，将结果保存至request对象的属性"stu"中，并且跳转至info.jsp页面
       下面的请求URL将会显示调用SearchAction类：
        display.do?method=display&stuName=jack
       具体步骤如下：
       步骤1：构造一个名为DisplayForm的ActionForm和一个名为DisplayAction的Action。DisplayForm的属性为stuName
       步骤2：修改相应的struts-config.xml

<form-beans>
    <form-bean name="displayForm" type="com.struts.form.DisplayForm"/>
form-beans>

<action-mappings>
    <action attribute="displayForm"
        name="displayForm" parameter="method" path="/display" scope="request"
        type="com.struts.action.DisplayAction" validate="false">
        <forward name="info" path="/info.jsp" />
    action>
action-mappings>

       步骤3、编写DisplayAction的测试类DisplayActionTest，在其中加入一个名为testShowInfo()的方法。该方法完成以下事情：
       a) 初始化提交数据
       b) 验证request中"stu"属性是否有值
       c) 是否返回info.jsp页面
       代码如下：     

public class DisplayActioTest extends MockStrutsTestCase
{
    public void testShowInfo()
    {
        setRequestPathInfo("/display.do");
        addRequestParameter("method","display");
        addRequestParameter("stuName", "jack");

        actionPerform();

        assertNotNull(request.getAttribute("stu"));
        verifyForward("info");

    }
}

 

        步骤4：更改DisplayAction类，用最简短的代码实现其功能
       代码如下：

public class DisplayAction extends DispatchAction
{
    private SearchHandler sh;
    public ActionForward display(ActionMapping mapping, ActionForm form,
                     HttpServletRequest request, HttpServletResponse response)
    {
        sh=new SearchHandler();
        DisplayForm displayForm = (DisplayForm) form;
        String name=displayForm.getStuName();

        Student stu=sh.displayByName(name);
        request.setAttribute("stu",stu);

        return mapping.findForward("info");
    }
}

      
       步骤5：运行测试类，结果正确

       至此，第二个功能测试开发完毕
       经过前面两个功能的测试与运行，两个功能都可以单独测试通过，由于第二个功能是以第一个功能成功查询为前提才能运行，所以再编写一个测试，将两个 action功能整合。这样就可以测试整个功能模块是否正确。在DisplayActioTest中编写一个名为 testSearchAndDisplay()的方法来完成这个测试吧。

       代码如下:

public void testSearchAndDisplay()
{
    //先调用SearchAction来取得数据
    setRequestPathInfo("/search.do");
    addRequestParameter("method", "search");

    addRequestParameter("clazzName","gs2t11");
    actionPerform();

    List list=(List) request.getAttribute("result");
    Student student=(Student) list.get(0);

    //调用DisplayAction类显示在result.jsp中选择的数据
    setRequestPathInfo("/display.do");
    addRequestParameter("method","display");
    addRequestParameter("stuName", student.getStuName());

    actionPerform();

    assertNotNull(request.getAttribute("stu"));
    verifyForward("info");
}

        运行测试类，测试成功

        整个模块到这里全部开发测试完毕，但是还没完，作为测试驱动开发最重要的一环就是重构，这样才能保证你程序的健壮性、可读性、可维护性及优雅性。这里重构主要是针对Action类进行重构，你也可以用同样的方法在编写完测试代码之后对测试代码进行重构。这里主要针对以下几个地方进行重构
        1)   抽取Action类中的变量：

               SearchAction类中：

SearchForm searchForm= (SearchForm) form;
String className = searchForm.getClazzName();
sh = new SearchHandler();
List list=sh.searchByClassName(className);

               可以用下列代码替换：

sh = new SearchHandler();
List list=sh.searchByClassName(((SearchForm) form).getClazzName());

                DisplayAction类中：

DisplayForm displayForm = (DisplayForm) form;
String name=displayForm.getStuName();
Student stu=sh.displayByName(name);
request.setAttribute("stu",stu);

               可以用下列代码替换：

request.setAttribute("stu",sh.displayByName(((DisplayForm)form).getStuName()));

        2)  抽取常量：

               SearchAction类中：

request.setAttribute("result",list);

               可以用下列代码替换

private static final String RESULT = "result";
request.setAttribute(RESULT,list);

              SearchAction类中

request.setAttribute("stu",sh.displayByName(((DisplayForm) form).getStuName()));

              可以用下列代码替换

private static final String STUDENT = "stu";
request.setAttribute(STUDENT,sh.displayByName(((DisplayForm) form).getStuName()));

        构造一个名为BaseAction的类，继承DispatchAction类，并在其中初始化一个SearchHandler对象

public class BaseAction extends DispatchAction
{
    protected SearchHandler sh=new SearchHandler();
}

        SearchAction类与DisplayAction类可改为

public class SearchAction extends BaseAction
public class DisplayAction extends BaseAction

        同时要去掉两个类中的SearchHandler属性

        SearchAction类中下列代码可以抽取成方法：

ActionMessages messages=new ActionMessages();
messages.add(Globals.MESSAGE_KEY, new ActionMessage("no.stuclass.found"));
saveMessages(request,messages);

        可以用下列代码替换：

addResultMessage(request,"no.stuclass.found");

private void addResultMessage(HttpServletRequest request,String message)
{
     ActionMessages messages=new ActionMessages();
     messages.add(Globals.MESSAGE_KEY, new ActionMessage("no.stuclass.found"));
     saveMessages(request,messages);
}

       由于在别的Action中也要经常生成ActionMessages对象，所以再将该方法 抽取到BaseAction中。

       最后BaseAction类代码如下:

public class BaseAction extends DispatchAction
{
    protected SearchHandler sh=new SearchHandler();

    protected void addResultMessage(HttpServletRequest request, String message)
    {
        ActionMessages messages=new ActionMessages();
        messages.add(Globals.MESSAGE_KEY, new ActionMessage(message));
        saveMessages(request,messages);
    }
}

        最后代码效果请参考源代码。

        4)    重构注意事项：

               a) 每次要一点点的重构，万万不要一次重构很多地方。

               b) 每重构完一个地方要运行测试类来保证其正确性。

               c) 不要怕麻烦。在后期重构的优势就会越来越明显。

       到此为止，全部的测试与代码编写已经结束。还等什么，将已经做好的页面套上去吧，感受一下不用启动服务器来开发web应用程序的乐趣吧，感受测试驱动开发给你带来的开发思想的质的飞跃……

评论

2 楼 jiapumin 2010-09-27  

学习了，很实用的

1 楼 chian_xxp 2009-09-29  

在你这里，学习到我想要的东西。谢谢。