提要 本文将向你介绍如何实现从JUnit 3.8向JUnit 4的迁移。同时,还讨论JUnit 4中的一些新特征,特别包括对注解的使用;最后,简要介绍这个新版本的IDE集成现状。
一、 引言
在本文开始,我将假定,你已经了解由Kent Beck和Erich Gamma发明的这个Java单元测试框架并因此而略过必要的简介。所以,我将集中分析从JUnit 3.8到最新版本-JUnit 4的迁移过程以及其在IDE和Ant中的集成。
JUnit 4是一种与其之前的版本完全不同的API,它根据Java 5.0中的新特征(注解,静态导入等)构建而成。如你所见,JUnit 4更简单、更丰富和更易于使用,而且它引入了更为灵活的初始化和清理工作,还有限时的和参数化测试用例。
代码实例最能说明问题。因此,在本文中,我将使用一个例子来展示不同的测试用例:一个计算器。该示例计算器很简单,效率并不高,甚至还有一些错误;它仅 仅操作整数,并且把结果存储在一个静态变量中。Substract方法并不返回一个有效的结果,而且也没有实现乘法运算,而且看上去在 squareRoot方法中还存在一个错误:无限循环。这些错误将帮助说明使用JUnit 4进行测试的有效性。你可以打开和关闭这个计算器,而且你可以清除这些结果。下面是其实现代码:
package calc;
public class Calculator {
private static int result; //存储结果的静态变量
public void add(int n) {
result = result + n;
}
public void substract(int n) {
result = result - 1; //错误:应该是"result = result - n"
}
public void multiply(int n) {} //还没实现
public void divide(int n) {
result = result / n;
}
public void square(int n) {
result = n * n;
}
public void squareRoot(int n) {
for (; ;) ; //错误:无限循环
}
public void clear() { //清除结果
result = 0;
}
public void switchOn() { //打开屏幕,显示"hello",并报警
result = 0; //实现其它的计算器功能
}
public void switchOff() { } //显示"bye bye",报警,并关闭屏幕
public int getResult() {
return result;
}
} |
二、 迁移一个测试类
现在,我将把一个已经使用JUnit 3.8编写成的简单的测试类迁移到JUnit 4。这个类有一些缺陷:它没有测试所有的业务方法,而且看上去在testDivide方法中还存在一个错误(8/2不等于5)。因为还没有实现乘法运算功能,所以对其测试将被忽略。
下面,我们把两个版本的框架之间的差别以粗体显示出现于表格1中。
表格1.分别以JUnit 3.8和JUnit 4实现的CaculatorTest。
JUnit 3.8
package junit3;
import calc.Calculator;
import junit.framework.TestCase;
public class CalculatorTest extends TestCase {
private static Calculator calculator = new Calculator();
@Override protected void setUp() { calculator.clear(); }
public void testAdd() {
calculator.add(1);
calculator.add(1);
assertEquals(calculator.getResult(), 2);
}
public void testSubtract() {
calculator.add(10);
calculator.subtract(2);
assertEquals(calculator.getResult(), 8);
}
public void testDivide() {
calculator.add(8);
calculator.divide(2);
assert calculator.getResult() == 5;
}
public void testDivideByZero() {
try {
calculator.divide(0);
fail();
}
catch (ArithmeticException e) { }
}
public void notReadyYetTestMultiply() {
calculator.add(10);
calculator.multiply(10);
assertEquals(calculator.getResult(), 100);
}
} |
JUnit 4
package JUnit 4;
import calc.Calculator;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;
import static org.junit.Assert.*;
public class CalculatorTest {
private static Calculator calculator = new Calculator();
@Before public void clearCalculator() {
calculator.clear();
}
@Test public void add() {
calculator.add(1);
calculator.add(1);
assertEquals(calculator.getResult(), 2);
}
@Test public void subtract() {
calculator.add(10);
calculator.subtract(2);
assertEquals(calculator.getResult(), 8);
}
@Test public void divide() {
calculator.add(8);
calculator.divide(2);
assert calculator.getResult() == 5;
}
@Test(expected = ArithmeticException.class)
public void divideByZero() {
calculator.divide(0);
}
@Ignore("not ready yet")
@Test
public void multiply() {
calculator.add(10);
calculator.multiply(10);
assertEquals(calculator.getResult(), 100);
}
} |
三、 包
首先,你可以看到,JUnit 4使用org.junit.*包而JUnit 3.8使用的是junit.framework.*。当然,为了向后兼容性起见,JUnit 4jar文件发行中加入了这两种包。
四、 继承
在中,测试类不必再扩展junit.framework.TestCase;事实上,它们不必须扩展任何内容。但是,JUnit 4中使用的是注解。为了以一个测试用例方式执行,一个JUnit 4类中至少需要一个@Test注解。例如,如果你仅使用@Before和@After注解而没有至少提供一个@Test方法来编写一个类,那么,当你试图 执行它时将得到一个错误:
java.lang.Exception: No runnable methods.
五、 断言(Assert)方法
因为在JUnit 4中一个测试类并不继承自TestCase(在JUnit 3.8中,这个类中定义了assertEquals()方法),所以你必须使用前缀语法(举例来说,Assert.assertEquals())或者 (由于JDK5.0)静态地导入Assert类。这样以来,你就可以完全象以前一样使用assertEquals方法(举例来说, assertEquals())。
另外,在JUnit 4中,还引入了两个新的断言方法,它们专门用于数组对象的比较。如果两个数组包含的元素都相等,那么这两个数组就是相等的。
public static void assertEquals(String message, Object[] expecteds, Object[] actuals);
public static void assertEquals(Object[] expecteds, Object[] actuals); |
由于JDK 5.0的自动装箱机制的出现,原先的12个assertEquals方法全部去掉了。例如,原先JUnit 3.8中的assertEquals(long,long)方法在JUnit 4中要使用assertEquals(Object,Object)。对于assertEquals(byte,byte)、assertEquals (int,int)等也是这样。这种改进将有助于避免反模式。
在JUnit 4中,新集成了一个assert关键字(见我们的例子中的divide()方法)。你可以象使用assertEquals方法一样来使用它,因为它们都抛 出相同的异常(java.lang.AssertionError)。JUnit 3.8的assertEquals将抛出一个junit.framework.AssertionFailedError。注意,当使用assert时, 你必须指定Java的"-ea"参数;否则,断言将被忽略。
六、 预设环境(Fixture)
Fixture是在测试期间初始化和释放任何普通对象的方法。在JUnit 3.8中,你要使用setUp()来实现运行每一个测试前的初始化工作,然后使用tearDown()来进行每个测试后的清理。这两个方法在 TestCase类中都得到重载,因此都被唯一定义。注意,我在这个Setup方法使用的是Java5.0内置的@Override注解-这个注解指示该 方法声明要重载在超类中的方法声明。在JUnit 4中,则代之使用的是@Before和@After注解;而且,可以以任何命名(在我们的例子中是clearCalculator())来调用这些方法。 在本文后面,我将更多地解释这些注解。
七、 测试
JUnit 3.8通过分析它的签名来识别一个测试方法:方法名必须以"test"为前缀,它必须返回void,而且它必须没有任何参数(举例来说, publicvoidtestDivide())。一个不遵循这个命名约定的测试方法将被框架简单地忽略,而且不抛出任何异常(指示发生了一个错误)。
JUnit 4不使用与JUnit 3.8相同的约定。一个测试方法不必以'test'为前缀,但是要使用@Test注解。但是,正如在前一个框架中一样,一个测试方法也必须返回void并 且是无参数的。在JUnit 4中,可以在运行时刻控制这个要求,并且不符合要求的话会抛出一个异常:
java.lang.Exception: Method xxx should have no parameters
java.lang.Exception: Method xxx should be void
@Test注解支持可选参数。它声明一个测试方法应该抛出一个异常。如果它不抛出或者如果它抛出一个与事先声明的不同的异常,那么该测试失败。在我们的例子中,一个整数被零除应该引发一个ArithmeticException异常。
八、 忽略一个测试
记住,不能执行多个方法。然而,如果你不想让测试失败的话,你可以仅仅忽略它。那么,在JUnit 3.8中,我们是如何实现临时禁止一个测试的呢?方法是:通过注释掉它或者改变命名约定,这样测试运行机就无法找到它。在我的例子中,我使用了方法名 notReadyYetTestMultiply()。它没有以"test"开头,所以它不会被识别出来。现在的问题是,在成百上千的测试中间,你可能记 不住重命名这个方法。
在JUnit 4中,为了忽略一个测试,你可以注释掉一个方法或者删除@Test注解(你不能再改变命名约定,否则将抛出一个异常)。然而,该问题将保留:该运行机将不 报告这样一个测试。现在,你可以把@Ignore注解添加到@Test的前面或者后面。测试运行机将报告被忽略的测试的个数,以及运行的测试的数目和运行 失败的测试数目。注意,@Ignore使用一个可选参数(一个String),如果你想记录为什么一个测试被忽略的话。
九、 运行测试
在JUnit 3.8中,你可以选择使用若干运行机:文本型,AWT或者Swing。JUnit 4仅仅使用文本测试运行机。注意,JUnit 4不会显示任何绿色条来通知你测试成功了。如果你想看到任何类型的绿色的话,那么你可能需要使用JUnit扩展或一种集成了JUnit的IDE(例如 IDEA或者Eclipse)。
首先,我想使用老式但好用的junit.textui.TestRunner来运行该JUnit 3.8测试类(考虑到使用assert关键字,我使用了-ea参数)。
java -ea junit.textui.TestRunner junit3.CalculatorTest
..F.E.
There was 1 error:
1) testDivide(junit3.CalculatorTest)java.lang.AssertionError
at junit3.CalculatorTest.testDivide(CalculatorTest.java:33)
There was 1 failure:
1) testSubtract(junit3.CalculatorTest)junit.framework.AssertionFailedError: expected:<9> but was:<8>
at junit3.CalculatorTest.testSubtract(CalculatorTest.java:27)
FAILURES!!!
Tests run: 4, Failures: 1, Errors: 1 |
TestDivide产生一个错误,因为断言确定了8/2不等于5。TestSubstract产生一个失败,因为10-2应该等于8,但是在这个实现中存在一个错误:它返回9。
现在,我使用新的org.junit.runner.JUnitCore运行机来运行这两个类。注意,它能执行JUnit 4和JUnit 3.8测试,甚至是这二者的结合。
java -ea org.junit.runner.JUnitCore junit3.CalculatorTest
JUnit version 4.1
..E.E.
There were 2 failures:
1) testSubtract(junit3.CalculatorTest)
junit.framework.AssertionFailedError: expected:<9> but was:<8>
at junit.framework.Assert.fail(Assert.java:47)
2) testDivide(junit3.CalculatorTest)
java.lang.AssertionError
at junit3.CalculatorTest.testDivide(CalculatorTest.java:33)
FAILURES!!!
Tests run: 4, Failures: 2
***
java -ea org.junit.runner.JUnitCore JUnit 4.CalculatorTest
JUnit version 4.1
...E.EI
There were 2 failures:
1) subtract(JUnit 4.CalculatorTest)
java.lang.AssertionError: expected:<9> but was:<8>
at org.junit.Assert.fail(Assert.java:69)
2) divide(JUnit 4.CalculatorTest)
java.lang.AssertionError
at JUnit 4.CalculatorTest.divide(CalculatorTest.java:40)
FAILURES!!!
Tests run: 4, Failures: 2 |
第一个非常明显的区别是,JUnit版本号被显示于控制台中(4.1)。第二个区别是,JUnit 3.8区分失败和错误;JUnit 4则仅使用失败进行简化。一个新奇的地方是,字母"I",它显示一个测试被忽略。