0°

JUnit + Mockito 单元测试(三)

这里假设我们没有 Tomcat(虽然不太可能,假设吧!),那就使用 Mockito 模拟一个看看怎么样。本文结合 RESTful 接口来进行回归测试的目的。

模拟 ServletContextListener

Listener 是启动 App 的第一个模块,相当于执行整个 Web 项目的初始化工作,所以也必须先模拟 ServletContextListener 对象。通过初始化的工作是安排好项目的相关配置工作和先缓存一些底层的类(作为 static 成员保存在内存中)。


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
1package ajaxjs.test;
2
3import static org.junit.Assert.assertNotNull;
4import static org.junit.Assert.assertTrue;
5import static org.mockito.Mockito.*;
6import java.io.IOException;
7import javax.servlet.ServletContext;
8import javax.servlet.ServletContextEvent;
9import javax.servlet.ServletException;
10import ajaxjs.config.Application;
11import org.junit.Before;
12import org.junit.Test;
13import ajaxjs.Constant;
14
15public class TestApplication {
16  private Application app;
17  private ServletContext sc;
18 
19  @Before
20  public void setUp() throws Exception {
21      sc = mock(ServletContext.class);
22      // 指定类似 Tomcat 的虚拟目录,若设置为 "" 表示 Root 根目录
23      when(sc.getContextPath()).thenReturn("/zjtv");
24      // 设置项目真实的目录,当前是 返回 一个特定的 目录,你可以不执行该步
25      when(sc.getRealPath(anyString())).thenReturn("C:\\project\\zjtv\\WebContent" + Constant.ServerSide_JS_folder);
26      // 设置 /META-INF 目录,当前使用该目录来保存 配置
27      when(sc.getRealPath("/META-INF")).thenReturn("C:\\project\\zjtv\\WebContent\\META-INF");
28     
29       app = new Application();
30       }
31 
32  @Test
33  public void testContextInitialized() throws IOException, ServletException {
34      ServletContextEvent sce = mock(ServletContextEvent.class);
35      when(sce.getServletContext()).thenReturn(sc);
36      app.contextInitialized(sce);
37      assertNotNull(sce);
38      assertTrue("App started OK!", Application.isConfig_Ready);
39  }
40}
41

上述代码中 Application app 是 javax.servlet.ServletContextListener 的实现。你可通过修改 setUp() 里面的相关配置,应适应你的测试。

模拟 Servlet

背景简介:由于这是 JSON RESTful 接口的原因,所以我使用同一个 Servlet 来处理,即 BaseServlet,为 HttpServlet 的子类,而且采用 Servlet 3.0 的注解方式定义 URL Mapping,而非配置 web.xml 的方式,代码组织更紧凑。——从而形成针对最终业务的 zjtvServlet 类,为 BaseServlet 的子类,如下,


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
1package zjtv;
2
3import javax.servlet.annotation.WebServlet;
4import javax.servlet.annotation.WebInitParam;
5import ajaxjs.service.BaseServlet;
6
7@WebServlet(
8   urlPatterns = {"/service/*", "/admin_service/*"},
9   initParams = {
10      @WebInitParam (name = "news",         value = "ajaxjs.data.service.News"),
11      @WebInitParam (name = "img",      value = "ajaxjs.data.service.subObject.Img"),
12      @WebInitParam (name = "catalog",  value = "zjtv.SectionService"),
13      @WebInitParam (name = "live",         value = "ajaxjs.data.ext.LiveService"),
14      @WebInitParam (name = "vod",      value = "ajaxjs.data.ext.VodService"),
15      @WebInitParam (name = "compere",  value = "zjtv.CompereService"),
16      @WebInitParam (name = "misc",         value = "zjtv.MiscService"),
17      @WebInitParam (name = "user",         value = "ajaxjs.data.user.UserService"),
18  }
19)
20public class zjtvServlet extends BaseServlet{
21  private static final long serialVersionUID = 1L;
22}
23

其中我们注意到,


1
2
1urlPatterns = {"/service/*", "/admin_service/*"},
2

就是定义接口 URL 起始路径,因为使用了通贝符 *,所以可以允许我们 /service/news/、/service/product/200 形成各种各样的 REST 接口。

但是,我们不对 zjtvServlet 直接进行测试,而是其父类 BaseServlet 即可。个中原因是我们模拟像 WebServlet 这样的注解比较不方便。虽然是注解,但最终还是通过某种形式的转化,形成 ServletConfig 对象被送入到 HttpServlet.init 实例方法中去。于是我们采用后一种方法。

我们试观察 BaseServlet.init(ServletConfig config) 方法,还有每次请求都会执行的 doAction(),发现这两步所执行过程中需要用到的对象,及其方法是这样的,


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
1/**
2 * 初始化所有 JSON 接口
3 * 为了方便测试,可以每次请求加载一次 js 文件,于是重载了一个子方法 private void init(String Rhino_Path)
4 */
5public void init(ServletConfig config) throws ServletException {
6   init(Application.Rhino_Path);
7  
8   // 遍历注解的配置,需要什么类,收集起来,放到一个 hash 之中
9   Enumeration<String> initParams = config.getInitParameterNames();
10  while (initParams.hasMoreElements()) {
11      String  initParamName   = initParams.nextElement(),
12              initParamValue  = config.getInitParameter(initParamName);
13     
14      System.out.println("initParamName:" + initParamName + ", initParamValue:" + initParamValue);
15
16      initParamsMap.put(initParamName, initParamValue);
17  }
18}
19……
20private void doAction(HttpServletRequest request, HttpServletResponse response){
21  // 为避免重启服务器,调试模式下再加载 js
22  if(Application.isDebug)init(Application.Rhino_Path);
23 
24  ajaxjs.net.Request.setUTF8(request, response);
25  response.setContentType("application/json");
26 
27//        System.out.println(ajaxjs.net.Request.getCurrentPage_url(request));/
28
29  Connection jdbcConn = DAO.getConn(getConnStr());
30
31  try {
32      Object obj = Application.jsRuntime.call("bf_controller_init", request, jdbcConn);
33      if(obj != null)
34          response.getWriter().println(obj.toString());
35  } catch (Exception e) {
36      e.printStackTrace();
37      ajaxjs.Util.catchException(e, "调用 bf.controller.init(); 失败!");
38  }
39 
40  output(request, response);
41  try {
42      jdbcConn.close();
43  } catch (SQLException e) {
44      e.printStackTrace();
45  }
46}
47

于是,我们遵循“依赖什么,模拟什么”的原则,让 Mockito 为我们生成模拟的对象,以假乱真。

首先,我们不能忘记这是一个 Web 项目,因此开头讲的那个 Listener 类也要首当其冲被初始化,才能有 Servlet 正确执行。于是,在 JUnit 单元测试的起始工作中,执行,


1
2
3
4
5
6
7
1@Before
2   public void setUp() throws Exception {
3       TestApplication app = new TestApplication();
4       app.setUp();
5       app.testContextInitialized();
6   }
7

同时也把 setUp()、testContextInitialized() 手动执行一遍,因为之前的时候,我们是让 JUnit 或者 Tomcat 自动执行的。运行这一步之后,我们就初始化完毕侦听器 Listener 了。

这里所涉及的对象和方法比较多,下面我们逐一分解。

模拟 ServletConfig 对象

接着,怎么通过“模拟注解”来初始化 Servlet 配置呢?这里涉及到一个 Enumeration 对象的模拟,——其实也挺好办,方法如下,


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
1/**
2    * 初始化 Servlet 配置,这里是模拟 注解
3    * @return
4    */
5private ServletConfig initServletConfig(){
6       ServletConfig servletConfig = mock(ServletConfig.class);
7       // 模拟注解
8       Vector<String> v = new Vector<String>();
9        v.addElement("news");
10        when(servletConfig.getInitParameter("news")).thenReturn("ajaxjs.data.service.News");
11        v.addElement("img");
12        when(servletConfig.getInitParameter("img")).thenReturn("ajaxjs.data.service.subObject.Img");
13        v.addElement("catalog");
14        when(servletConfig.getInitParameter("catalog")).thenReturn("zjtv.SectionService");
15        v.addElement("user");
16        when(servletConfig.getInitParameter("user")).thenReturn("ajaxjs.data.user.UserService");
17
18        Enumeration<String> e = v.elements();
19      when(servletConfig.getInitParameterNames()).thenReturn(e);
20     
21      return servletConfig;
22}
23

你可以定义更多业务对象,就像注解那样,结果无异。

模拟 Request 对象

下面所有虚拟的 Request 方法都可以按照你的项目配置进行修改


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
1/**
2 * 请求对象
3 * @return
4 */
5private HttpServletRequest initRequest(){
6    HttpServletRequest request = mock(HttpServletRequest.class);
7    when(request.getPathInfo()).thenReturn("/zjtv/service/news");
8    when(request.getRequestURI()).thenReturn("/zjtv/service/news");
9    when(request.getContextPath()).thenReturn("/zjtv");
10//        when(request.getSession()).thenReturn("/zjtv");
11    when(request.getMethod()).thenReturn("GET");
12    // 设置参数
13    when(request.getParameter("a")).thenReturn("aaa");
14    
15    final Map<String, Object> hash = new HashMap<String, Object>();
16    Answer<String> aswser = new Answer<String>() {  
17        public String answer(InvocationOnMock invocation) {  
18            Object[] args = invocation.getArguments();  
19            return hash.get(args[0].toString()).toString();  
20        }  
21    };
22    
23    when(request.getAttribute("isRawOutput")).thenReturn(true);  
24    when(request.getAttribute("errMsg")).thenAnswer(aswser);  
25    when(request.getAttribute("msg")).thenAnswer(aswser);  
26//        doThrow(new Exception()).when(request).setAttribute(anyString(), anyString());
27    
28    doAnswer(new Answer<Object>() {
29        public Object answer(InvocationOnMock invocation) {
30            Object[] args = invocation.getArguments();
31            // Object mock = invocation.getMock();  
32            System.out.println(args[1]);
33            hash.put(args[0].toString(), args[1]);
34            return "called with arguments: " + args;
35        }
36    }).when(request).setAttribute(anyString(), anyString());
37    
38    return request;
39}
40

其中比较麻烦的 request.getAttribute() / setAttribute() 方法。鉴于 HttpServlet 是接口的缘故,我们必须实现一遍 getAttribute() / setAttribute() 的内部实现。此次我们只是简单地利用一个 map 来保存 reuqest.setAttribute() 的信息。然后使用 Mockito 的 Answer 接口获取真实的参数如何,从而让 request.getAttribute() 返回具体的值。

最初看到的做法是这样,


1
2
3
4
5
6
7
8
9
10
1class StubServletOutputStream extends ServletOutputStream {
2       public ByteArrayOutputStream baos = new ByteArrayOutputStream();
3       public void write(int i) throws IOException {
4           baos.write(i);
5       }
6       public String getContent() {
7           return baos.toString();
8       }
9   }
10

上述是个内部类,实例化如下,


1
2
3
4
5
6
1StubServletOutputStream servletOutputStream = new StubServletOutputStream();
2       when(response.getOutputStream()).thenReturn(servletOutputStream);
3                ……doPost(request, response);
4                byte[] data = servletOutputStream.baos.toByteArray();
5                System.out.println("servletOutputStream.getContent:" + servletOutputStream.baos.toString());
6

我不太懂 Steam 就没深入了,再 Google 下其他思路,结果有人提到把响应结果保存到磁盘中,我觉得不是太实用,直接返回 String 到当前测试上下文,那样就好了。


1
2
3
4
5
6
7
8
9
1// http://stackoverflow.com/questions/5434419/how-to-test-my-servlet-using-junit
2       HttpServletResponse response = mock(HttpServletResponse.class);
3       StubServletOutputStream servletOutputStream = new StubServletOutputStream();
4       when(response.getOutputStream()).thenReturn(servletOutputStream);
5       // 保存到磁盘文件 需要在 bs.doPost(request, response); 之后  writer.flush();
6//     PrintWriter writer = new PrintWriter("d:\\somefile.txt");
7       StringWriter writer = new StringWriter();
8                when(response.getWriter()).thenReturn(new PrintWriter(writer));
9

测试后,用 writer.toString() 返回服务端响应的结果。

模拟数据库

怎么模拟数据库连接?可以想象,模拟数据库的工作量比较大,干脆搭建一个真实的数据库得了。所以有人想到的办法是用 Mockito 绕过 DAO 层直接去测试 Service 层,对 POJO 充血。

不过我当前的方法,还是直接连数据库。因为是使用 Tomcat 连接池的,所以必须模拟 META-INF/context.xml 的配置,其实质是 Java Naming 服务。模拟方法如下,


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
1/**
2    * 模拟数据库 链接 的配置
3    * @throws NamingException
4    */
5   private void initDBConnection() throws NamingException{
6        // Create initial context
7        System.setProperty(Context.INITIAL_CONTEXT_FACTORY, "org.apache.naming.java.javaURLContextFactory");
8        System.setProperty(Context.URL_PKG_PREFIXES, "org.apache.naming");  
9        // 需要加入tomcat-juli.jar这个包,tomcat7此包位于tomcat根目录的bin下。
10        InitialContext ic = new InitialContext();
11        ic.createSubcontext("java:");
12        ic.createSubcontext("java:/comp");
13        ic.createSubcontext("java:/comp/env");
14        ic.createSubcontext("java:/comp/env/jdbc");
15        // Construct DataSource
16        try {
17          SQLiteJDBCLoader.initialize();
18      } catch (Exception e1) {
19          e1.printStackTrace();
20      }
21
22        SQLiteDataSource dataSource = new SQLiteDataSource();
23        dataSource.setUrl("jdbc:sqlite:c:\\project\\zjtv\\WebContent\\META-INF\\zjtv.sqlite");
24        
25        ic.bind("java:/comp/env/jdbc/sqlite", dataSource);
26  }
27

至此,我们就可以模拟一次 HTTP 请求,对接口进行测试了!

「点点赞赏,手留余香」

    还没有人赞赏,快来当第一个赞赏的人吧!