BlogJava-子在川上曰-随笔分类-Test

有配置文件有关的测试

陈刚 — Wed, 29 Mar 2006 07:42:00 GMT

问题：
一个系统有一些信息放在一个XML文件中，由于此XML文件会经常变动，所以写Test Case不能依赖此XML文件，否则在使用中每一次XML正常的变动都会导致TestCase出错。那么该如何测试呢。

解决方案一：
将XML的内容用字符串的方式写在TestCase中。如下所示，这个TestCase主要是测试ViewXMLParser这个类的parse方法，这个方法的作用是将XML配置文件中的信息转化成一个个的Bean。

import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.util.List;

import junit.framework.TestCase;

import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;

/**
* @author chengang 2006-3-6
*/
public class TestViewParser extends TestCase {
    private String xml1;
    private String xml2;

    public TestViewParser() {
        {
            //一个完整的测试,及测试可选项
            StringBuffer sb = new StringBuffer();
            sb.append(""1.0\" encoding=\"GB2312\"?>");
            sb.append("");
            sb.append("     ");
            sb.append("       "LogTestView\">");
            sb.append("             "storeConfig1\"/>");
            sb.append("             ");
            sb.append("                   "times\" description=\"时间值\"/>");
            sb.append("                   "logs\" description=\"日志数\"/>");
            sb.append("             ");
            sb.append("       ");
            sb.append("       "LogConfigView\" class=\"com.wxxr.management.admin.console.jmx.custom.ui.CustomComposite\"/>");
            sb.append("     ");
            sb.append("");
            xml1 = sb.toString();
        }
        {
            //测试特别情况
            StringBuffer sb = new StringBuffer();
            sb.append(""1.0\" encoding=\"GB2312\"?>");
            sb.append("");
            sb.append("     ");
            sb.append("     ");
            sb.append("");
            xml2 = sb.toString();
        }
    }

    /*
     * Test method for 'com.wxxr.management.admin.console.jmx.custom.JmxXmlReader.getGroupNodes()'
     */
    public void testParse() throws Exception {
        Element viewsElement = getViewsElement(xml1);
        List<ViewBean> list = new ViewXMLParser().parse(viewsElement);
        assertEquals(2, list.size());
        {
            ScriptViewBean bean = (ScriptViewBean) list.get(0);
            assertEquals("LogTestView", bean.getId());
            assertEquals(ScriptComposite.class.getName(), bean.getViewClass());
            assertEquals("org.jnp.interfaces.NamingContextFactory", node.getFactory());
            assertEquals("jnp://localhost:1099", node.getUrl());
            assertEquals("jmx/rmi/RMIAdaptor", node.getJndi());
        }
        {
            CustomViewBean bean = (CustomViewBean) list.get(1);
            assertEquals("LogConfigView", bean.getId());
            assertEquals("com.wxxr.management.admin.console.jmx.custom.ui.CustomComposite", bean.getViewClass());
        }
    }

    private Element getViewsElement(String xml) {
        InputStream inputStream = new ByteArrayInputStream(xml.getBytes());
        Document doc = null;
        try {
            SAXReader reader = new SAXReader();
            doc = reader.read(inputStream);
        } catch (DocumentException e) {
            e.printStackTrace();
        }

        Element root = doc.getRootElement();
        Element viewsElement = root.element("views");
        return viewsElement;
    }

}

说明：
（1）将XML写在一个String里。
（2）InputStream inputStream = new ByteArrayInputStream(xml.getBytes());是关键，这是用一个string生成一个InputStream，这样就能替代读取XML文件的效果。

陈刚 2006-03-29 15:42 发表评论

利用IoC模式使类更易于测试

陈刚 — Tue, 14 Mar 2006 03:27:00 GMT

文/陈刚 from http://blog.chengang.com.cn

有一个需要被测试的类如下：

public class ViewManager {
    private static XmlBeanFactory factory = Context.getInstance().getXmlBeanFactory();

    public View getView(String viewId) {
        List<ViewBean> list = factory.getViews();
        for (ViewBean bean : list) {
            if (bean.getId().equals(viewId))
                return bean.getView();
        }
        return new NullComposite();
    }
｝

问题：如果要测试getView方法该怎么办呢？

显然由于此方法依赖于factory（XmlBeanFactory ），XmlBeanFactory 内含有比较复杂的逻辑，而且还要读取XML文件，这导致getView不可能被单独测试（一个单元测试的要点：简单独立，一次只测试一个类）。为了让ViewManager能剔除掉XmlBeanFactory，而被单独测试，我们需要做一些改变－－让XmlBeanFactory由外界注入，这样就可以写一个逻辑简单的Mock类来替代XmlBeanFactory，实现ViewManager的单独测试。具体实现的方法是加一个构造函数，让XmlBeanFactory可以通过构造函数注入，当然为了保持原有代码的兼容性，默认的factory也不可少。代码如下：

public class ViewManager {
    private static XmlBeanFactory factory;

    public ViewManager() {
        factory = Context.getInstance().getXmlBeanFactory();//默认的factory
    }

    public ViewManager(XmlBeanFactory factory) {//注入的factory
        this.factory = factory;
    }

    public View getView(String viewId) {
        List<ViewBean> list = factory.getViews();
        for (ViewBean bean : list) {
            if (bean.getId().equals(viewId))
                return bean.getView();
        }
        return new NullComposite();
    }

测试的代码如下：

public class TestViewManager extends TestCase {
    private ViewManager viewManager;

    @Override
    protected void setUp() throws Exception {
        super.setUp();
        viewManager = new ViewManager(new MockXmlBeanFactory());
    }

    public void testGetView() {
        View v = viewManager.getView("viewId002");
        assertEquals("viewId002", v.getViewId());
        assertEquals(CustomView.class, v.getClass());
    }

    public void testGetViewByNoneId() {
        View v = viewManager.getView("abc");
        assertEquals("abc", v.getViewId());
        assertEquals(NullComposite.class, v.getClass());
    }

    private static class MockXmlBeanFactory extends XmlBeanFactory { //XmlBeanFactory 的Mock类

        public List<ViewBean> getViews() {
            List<ViewBean> views = new ArrayList<ViewBean>();
            views.add(new CustomViewBean("viewId001", NullComposite.class.getName()));
            views.add(new CustomViewBean("viewId002", CustomView.class.getName()));
            return views;
        }

    }
}

在测试的时候报错了，错在assertEquals("abc", v.getViewId());。一查是没有把viewId赋给NullComposite对象。纠正错误的办法是：把ViewManager 的getView的方法最后一句改为return new NullComposite(viewId);。这是一个很隐蔽的BUG，以后在这里出问题可真够你花时间找的，现在一下子就测试出来了，这就是测试的好处吧。

陈刚 2006-03-14 11:27 发表评论

JUnit中如何测试异常

陈刚 — Tue, 07 Mar 2006 06:40:00 GMT

2005-11-04

　　很多时候，我们要写一些单元测试来测试我们程序是否能正确触发异常。比如下面的例子中，我们就写了一个test case来测试一个Email验证类EmailAddrValidator，这个类有一个doValidate(email)方法可以验证email是否合法，如果不合法则会抛出ValidationException异常。因此我们写了两个方法来进行单元测试，前一个方法testDoValidate用来测试正常值，后一个方法testDoValidateException用来测试对错误的email格式是否能正确触发异常。

import junit.framework.TestCase;

public class TestEmailAddrValidator extends TestCase {
    EmailAddrValidator validator = new EmailAddrValidator();

    public void testDoValidate() throws ValidationException {
        validator.doValidate("glchengang@163.com", null);
        validator.doValidate("glchen.gang@163.com", null);
        validator.doValidate("glchen_gang@163.com", null);
        validator.doValidate("glchen.gang@163_tom.com", null);
    }

    public void testDoValidateException() {
        testDoValidateException("@b.c");
        testDoValidateException("a@.c");
        testDoValidateException("a@b.");
        testDoValidateException("@.c");
        testDoValidateException("@...");
        testDoValidateException(" ");
        testDoValidateException(null);
    }

    private void testDoValidateException(String email) {
        try {
            validator.doValidate(email, null);
            fail("末抛出异常");
        } catch (ValidationException e) {
            assertTrue(true);
        }
    }
}

例程说明: 这个例子的关键是方法testDoValidateException(String email) 。

import java.util.Locale;
import com.hygensoft.common.configure.ConfigureObject;

public class EmailAddrValidator{

    protected static final String ERROR_CODE_INVALID_EMAIL_ADDR = "INVALID_EMAIL_ADDR";
    protected static final String ERROR_CODE_INVALID_INPUT = "INVALID_INPUT_OBJECT";

    public Object doValidate(Object input, Locale locale) throws ValidationException {
        if (!(input instanceof String)) {
            throw new ValidationException(ERROR_CODE_INVALID_INPUT, input);
        }
        String inputStr = (String) input;
        int idx = inputStr.indexOf('@');
        if (idx == -1 || idx == 0) {
            throw new ValidationException(ERROR_CODE_INVALID_INPUT, input);
        }
        int idx2 = inputStr.indexOf('.', idx);
        if (idx2 == -1 || idx2 == idx + 1) {
            throw new ValidationException(ERROR_CODE_INVALID_INPUT, input);
        }
        if (inputStr.endsWith(".")) {
            throw new ValidationException(ERROR_CODE_INVALID_INPUT, input);
        }
        return input;
    }

    /* (non-Javadoc)
     * @see com.hygensoft.common.configure.Configurable#initialize(com.hygensoft.common.configure.ConfigureObject)
     */
    public void initialize(ConfigureObject conf) {}

}

例程说明：在这里Locale 参数并没有用到。

陈刚 2006-03-07 14:40 发表评论

关于单元测试的讨论

陈刚 — Tue, 07 Mar 2006 06:34:00 GMT

今天收到javaeye的一个有回复通告的邮件，一查原来是一个很久以前的帖子又人回复了。帖子原地址如下：http://forum.javaeye.com/viewtopic.php?p=110113#110113　

－－－－－－－下面的是顶帖：－－－－－－－－－－－－－－－

当项目进展到一定程度，也会产生出大量的单元测试代码。而且这些单元测试代码也被不断的增加、修改和删除。渐渐单元测试代码也变得难以维护了，里边夹杂了太多的业务逻辑。创建一个新的测试要做很多初始化的工作，很难在ide里直接运行所有测试，很难单独运行某项测试，运行所有的单元测试要比较长的时间......

我想了下，造成这种现象的原因有以下几种：
1.未及时对单元测试进行重构，删除不必要的测试，合并类似的测试。
2.单元测试粒度过大，造成测试类过于臃肿。应该把大粒度的测试抽出来单独作为功能测试运行。
3.大量依赖外界环境，如数据库。应使用mock object解除依赖关系。

－－－－－我对此帖的一点看法：－－－－－－－－－－－－－－

这个帖的楼主对单元测试显示理解有偏颇。

（1）“里边夹杂了太多的业务逻辑”，单元测试怎么能夹杂业务逻辑呢？！！！单元测试代码是用来测试业务逻辑的，楼主怎么还加入什么业务逻辑。单元测试应该尽量的简单和独立，简单性和独立性是单元测试代码的原则。细粒度是实现单元测试代码简单性和独立性的方法。

单元测试的目的是为了让我们今后维护时能更快的定位BUG，所以简单独立测试代码更易读、更利于这个目的。如果阅读一个单元测试代码要超过十分钟，我觉得这个单元测试就算是失败的。

（2）“创建一个新的测试要做很多初始化的工作”，其根本原因是在于楼主的单元测试做法有误，"单元测试粒度过大，造成测试类过于臃肿"，“大量依赖外界环境，如数据库”。

千万不要写类似这样的单元测试代码：[输入一个数据，然后数据经过业务逻辑处理，而经过Hibernate进入数据库，然后单元测试从数据库读出数据来看看数据是否正确]，这样的写单元测试的思路是根本错误的。试想，如果运行测试时出错，你就很难从如此庞大混杂的代码中定位问题是出在业务逻辑层面、还是中间层、还是数据存储层。

千万不要写上面那种一杆子捅到底的测试代码。你应该这样，针对[数据经过业务逻辑的处理]来写一个单元测试。只针对最复杂和最核心的逻辑来写单元测试，减少了单元测试代码的数量，也就减少了对测试代码本身的维护量。有一些不应该由单元测试来做的工作，还是留到集成测试和测试员的beta版测试吧。

（3）单元测试要尽量做到环境无关性。比如测试EJB的单元测试，运行它并不需要启动Weblogic等EJB容器才能测试的，因为我们主要是测试它的业务逻辑，业务逻辑和weblogic容器是无关的。要实现这个目的，也就要求我们在写代码时要把业务逻辑写得更单纯，让它和容器相关的代码分离开来。

数据库也是一个常见的环境无关性问题，我们必须让单元测试脱离数据库（也就是脱离环境）而能运行。解决的方法是：我们可以写一个假(mock)的数据库，这是很简单的：一个类加几个List变量就可以模拟库和表了。

-----------另一个帖子回道: -----------------------
小规模的项目和试验性项目才可能搞搞这么频繁的单元测试，大的项目从项目规模，时间上都不太现实

-----------我的看法和回复: -----------------------

如果你维护过大项目，你就不会说这样的话了。
（1）没有单元测试，你无法重构，因为你不知道你的修改是否正确。
（2）没有单元测试，你出错后，你无法最快的定位BUG所在。并且在修改BUG后，你无法得知自己的修改是否影响到了其他模块。
（3）没有单元测试，你很难进行需求的修改。

总之一句话：没有单元测试，就很难对代码做修改。所以说小项目可以没有单元测试代码，但大项目一定要有，不然没法维护。另外，单元测试代码逻辑简单，写起来并不是想想中的那样耗时。

陈刚 2006-03-07 14:34 发表评论