建立JUnit测试类
建立项目: junitest
导入JUnit的架包
我用的是: junit-4.10.jar
测试目标
Calcuator.java
package com.tfj.junittest; public class Calculator { private static int result; // 静态变量,用于存储运行结果 public void add(int n) { result = result + n; } public void substract(int n) { result = result - 1; // Bug: 正确的应该是 result =result-n } public void multiply(int n) { } // 此方法尚未写好 public void division(int n) { result = result / n; } public void square(int n) { result = n * n; } public void squareRoot(int n) { for (;;) ; // Bug : 死循环 } public void clear() { // 将结果清零 result = 0; } public int getResult() { return result; } }
建立JUnit测试类
右击com.tfj.junittest,选择New—>Oher,选择Junit Test Case
输入名称(Name),命名规则一般建议采用:类名+Test。Browse...选择要测试的类,这里是Calcuator。
勾选要测试的方法,然后Finish
生成之后,增加测试内容,最终效果如下:
package com.tfj.junittest; //导入必要的包 import static org.junit.Assert.assertEquals; import org.junit.Before; import org.junit.Ignore; import org.junit.Test; // 测试类的声明,我们的测试类是一个独立的类,没有任何父类。测试类的名字也可以任意命名,没有任何局限性。所以我们不能通过类的声明来判断它是不是一个测试类, //它与普通类的区别在于它内部的方法的声明 public class CalculatorTest { // 创建一个待测试的对象。你要测试哪个类,那么你首先就要创建一个该类的对象 private static Calculator calculator = new Calculator(); // 测试方法的声明 @Before public void setUp() throws Exception { calculator.clear(); } @Test public void testAdd() { calculator.add(2); calculator.add(3); assertEquals(5, calculator.getResult()); } @Test public void testSubstract() { calculator.add(10); calculator.substract(2); assertEquals(8, calculator.getResult()); } @Ignore("multiply() not yet implemented") @Test public void testMultiply() { } @Test public void testDivide() { calculator.add(8); calculator.division(2); assertEquals(4, calculator.getResult()); } }
右击Run as,然后选择JUnit Test即可,会发现总共4个,运行了4个,1个忽略,0个错误,1个失败,忽略的是还没有写好的方法multiply(),所以注解为忽略,表明不用测试;失败的是Calculator中的substract()方法有Bug,这时可以回到代码中查找为什么会出现这个Bug,并进行修正。
核心——断言
断言是编写测试用例的核心实现方式,即期望值是多少,测试的结果是多少,以此来判断测试是否通过。
断言核心方法
assertArrayEquals(expecteds, actuals)
查看两个数组是否相等。
assertEquals(expected, actual)
查看两个对象是否相等。类似于字符串比较使用的equals()方法
assertNotEquals(first, second)
查看两个对象是否不相等。
assertNull(object)
查看对象是否为空。
assertNotNull(object)
查看对象是否不为空。
assertSame(expected, actual)
查看两个对象的引用是否相等。类似于使用“==”比较两个对象
assertNotSame(unexpected, actual)
查看两个对象的引用是否不相等。类似于使用“!=”比较两个对象
assertTrue(condition)
查看运行结果是否为true。
assertFalse(condition)
查看运行结果是否为false。
assertThat(actual, matcher)
查看实际值是否满足指定的条件
fail()
让测试失败
示例代码
package com.tfj.junittest; /** * @author Jacksile E-mail:tufujietec@foxmail.com * @date 2015年12月22日 下午7:00:30 * @function */ import static org.hamcrest.CoreMatchers.allOf; import static org.hamcrest.CoreMatchers.anyOf; import static org.hamcrest.CoreMatchers.equalTo; import static org.hamcrest.CoreMatchers.not; import static org.hamcrest.CoreMatchers.sameInstance; import static org.junit.Assert.assertThat; import org.junit.Test; public class AssertTests { @Test public void testAssertArrayEquals() { byte[] expected = "trial".getBytes(); byte[] actual = "trial".getBytes(); org.junit.Assert.assertArrayEquals("failure - byte arrays not same", expected, actual); } @Test public void testAssertEquals() { org.junit.Assert.assertEquals("failure - strings not same", 5l, 5l); } @Test public void testAssertNull() { org.junit.Assert.assertNull("should be null", null); } @Test public void testAssertNotNull() { org.junit.Assert.assertNotNull("should not be null", new Object()); } @Test public void testAssertSame() { Integer aNumber = Integer.valueOf(768); org.junit.Assert.assertSame("should be same", aNumber, aNumber); } @Test public void testAssertNotSame() { org.junit.Assert.assertNotSame("should not be same Object", new Object(), new Object()); } @Test public void testAssertFalse() { org.junit.Assert.assertFalse("failure - should be false", false); } @Test public void testAssertThatHamcrestCoreMatchers() { assertThat("good", not(allOf(equalTo("bad"), equalTo("good")))); assertThat("good", anyOf(equalTo("bad"), equalTo("good"))); assertThat(new Object(), not(sameInstance(new Object()))); } }
核心——注解
名词说明
@BeforeClass
针对所有测试,只执行一次,且必须为static void
@Before
初始化方法
Fixture的含义就是“在某些阶段必然被调用的代码”。比如我们上面的测试,由于只声明了一个Calculator对象,他的初始值是0,但是测试完加法操作后,他的值就不是0了;接下来测试减法操作,就必然要考虑上次加法操作的结果。这绝对是一个很糟糕的设计!我们非常希望每一个测试都是独立的,相互之间没有任何耦合度。因此,我们就很有必要在执行每一个测试之前,对Calculator对象进行一个“复原”操作,以消除其他测试造成的影响。因此,“在任何一个测试执行之前必须执行的代码”就是一个Fixture,我们用@Before来标注它,如前面例子所示,这里不在需要@Test标注,因为这不是一个test,而是一个Fixture。同理,如果“在任何测试执行之后需要进行的收尾工作”也是一个Fixture,使用@After来标注。由于本例比较简单,没有用到此功能。
@Test
测试方法,在这里可以测试期望异常和超时时间
@After
释放资源
@AfterClass
针对所有测试,只执行一次,且必须为static void
@Ignore
忽略的测试方法
如果你在写程序前做了很好的规划,那么哪些方法是什么功能都应该实现定下来。因此,即使该方法尚未完成,他的具体功能也是确定的,这也就意味着你可以为他编写测试用例。但是,如果你已经把该方法的测试用例写完,但该方法尚未完成,那么测试的时候一定是“失败”。这种失败和真正的失败是有区别的,因此JUnit提供了一种方法来区别他们,那就是在这种测试函数的前面加上@Ignore标注,这个标注的含义就是“某些方法尚未完成,暂不参与此次测试”。这样的话测试结果就会提示你有几个测试被忽略,而不是失败。一旦你完成了相应函数,只需要把@Ignore标注删去,就可以进行正常的测试。
@RunWith
指定测试类使用某个运行器
大家有没有想过这个问题,当你把测试代码提交给 JUnit 框架后,框架如何来运行你的代码呢?答案就是—— Runner 。在 JUnit 中有很多个 Runner ,他们负责调用你的测试代码,每一个 Runner 都有各自的特殊功能,你要根据需要选择不同的 Runner 来运行你的测试代码。可能你会觉得奇怪,前面我们写了那么多测试,并没有明确指定一个 Runner 啊?这是因为 JUnit 中有一个默认 Runner ,如果你没有指定,那么系统自动使用默认 Runner 来运行你的代码。换句话说,下面两段代码含义是完全一样的:
import org.junit.internal.runners.TestClassRunner;
import org.junit.runner.RunWith;
// 使用了系统默认的TestClassRunner,与下面代码完全一样
public class CalculatorTest {
...
}
@RunWith(TestClassRunner. class )
public class CalculatorTest {
...
}
从上述例子可以看出,要想指定一个 Runner ,需要使用 @RunWith 标注,并且把你所指定的 Runner 作为参数传递给它。另外一个要注意的是, @RunWith 是用来修饰类的,而不是用来修饰函数的。只要对一个类指定了 Runner ,那么这个类中的所有函数都被这个 Runner 来调用。最后,不要忘了包含相应的 Package 哦,上面的例子对这一点写的很清楚了。接下来,我会向你们展示其他 Runner 的特有功能。
@Parameters
指定测试类的测试数据集合
@Rule
允许灵活添加或重新定义测试类中的每个测试方法的行为
@FixMethodOrder
指定测试方法的执行顺序
执行顺序
一个测试类单元测试的执行顺序为:
@BeforeClass –> @Before –> @Test –> @After –> @AfterClass
每一个测试方法的调用顺序为:
@Before –> @Test –> @After
需求:
有一个类是负责对大文件(超过 500 兆)进行读写,他的每一个方法都是对文件进行操作。换句话说,在调用每一个方法之前,我们都要打开一个大文件并读入文件内容,这绝对是一个非常耗费时间的操作。如果我们使用 @Before 和 @After ,那么每次测试都要读取一次文件,效率及其低下。这里我们所希望的是在所有测试一开始读一次文件,所有测试结束之后释放文件,而不是每次测试都读文件。 JUnit 的作者显然也考虑到了这个问题,它给出了 @BeforeClass 和 @AfterClass 两个 Fixture 来帮我们实现这个功能。从名字上就可以看出,用这两个 Fixture 标注的函数,只在测试用例初始化时执行 @BeforeClass 方法,当所有测试执行完毕之后,执行 @AfterClass 进行收尾工作。在这里要注意一下,每个测试类只能有一个方法被标注为 @BeforeClass 或 @AfterClass ,并且该方法必须是 Public 和 Static 的。
JDemoTest.java
package com.tfj.junittest; /** * @author Jacksile E-mail:tufujietec@foxmail.com * @date 2015年12月22日 下午7:05:42 * @function */ import static org.junit.Assert.assertEquals; import static org.junit.Assert.fail; import org.junit.After; import org.junit.AfterClass; import org.junit.Before; import org.junit.BeforeClass; import org.junit.Ignore; import org.junit.Test; public class JDemoTest { @BeforeClass public static void setUpBeforeClass() throws Exception { System.out.println("BeforeClass..."); } @AfterClass public static void tearDownAfterClass() throws Exception { System.out.println("AfterClass..."); } @Before public void before() { System.out.println("Before..."); } @After public void after() { System.out.println("After..."); } @Test(timeout = 10000) public void testmultiply() { JDemo a = new JDemo(); assertEquals(2, a.multiply(1, 2)); System.out.println("Test...multiply"); } @Test public void testdivision() { JDemo a = new JDemo(); assertEquals(3, a.division(6, 2)); System.out.println("Test...Division"); } @Ignore @Test public void test_ignore_multiply() { JDemo a = new JDemo(); assertEquals(6, a.multiply(2, 3)); System.out.println("Test,Ignore...multiply"); } @Ignore @Test public void test_ignore_division() { JDemo a = new JDemo(); assertEquals(6, a.division(2, 3)); System.out.println("Test,Ignore...division"); } @Test public void teest_fail() { fail(); } } class JDemo extends Thread { int result; public int multiply(int a, int b) { try { sleep(1000); result = a * b; } catch (InterruptedException e) { } return result; } public int division(int a, int b) { return result = a / b; } }
图中左上红框中部分表示JUnit运行结果,总共5个,运行5个(2个忽略),0个错误,1个失败。(注意错误和失败不是一回事,错误说明代码有错误,而失败表示该测试方法测试失败)
左下红框中则表示出了各个测试方法的运行状态,可以看到成功、错误、失败、失败各自的图标是不一样的,还可以看到运行时间,最下面部分则是异常堆栈,可查看异常信息。。
参数化测试
有时一个测试方法,不同的参数值会产生不同的结果,那么我们为了测试全面,会把多个参数值都写出来并一一断言测试,这样有时难免费时费力,这是我们便可以采用参数化测试来解决这个问题。参数化测试就好比把一个“输入值,期望值”的集合传入给测试方法,达到一次性测试的目的。我们还使用我们先前的例子,测试一下“计算一个数的平方”这个函数,暂且分三类:正数、 0 、负数。测试代码如下:
AdvancedTest.java
package com.tfj.junittest; import static org.junit.Assert.assertEquals; import org.junit.Before; import org.junit.Test; public class AdvancedTest { private static Calculator calculator = new Calculator(); @Before public void clearCalculator() { calculator.clear(); } @Test public void square1() { calculator.square(2); assertEquals(4, calculator.getResult()); } @Test public void square2() { calculator.square(0); assertEquals(0, calculator.getResult()); } @Test public void square3() { calculator.square(-3); assertEquals(9, calculator.getResult()); } }
为了简化类似的测试, JUnit4 提出了“参数化测试”的概念,只写一个测试函数,把这若干种情况作为参数传递进去,一次性的完成测试。代码如下:
package com.tfj.junittest; import static org.junit.Assert.assertEquals; import java.util.Arrays; import java.util.Collection; import org.junit.Test; import org.junit.runner.RunWith; import org.junit.runners.Parameterized; import org.junit.runners.Parameterized.Parameters; @RunWith(Parameterized.class) public class SquareTest { private static Calculator calculator = new Calculator(); private int param; private int result; @Parameters public static Collection data() { return Arrays.asList(new Object[][] { { 2, 4 }, { 0, 0 }, { -3, 9 }, }); } // 构造函数,对变量进行初始化 public SquareTest(int param, int result) { this.param = param; this.result = result; } @Test public void square() { calculator.square(param); assertEquals(result, calculator.getResult()); } }
下面我们对上述代码进行分析。首先,你要为这种测试专门生成一个新的类,而不能与其他测试共用同一个类,此例中我们定义了一个SquareTest类。然后,你要为这个类指定一个Runner,而不能使用默认的Runner了,因为特殊的功能要用特殊的Runner嘛。@RunWith(Parameterized.class)这条语句就是为这个类指定了一个ParameterizedRunner。第二步,定义一个待测试的类,并且定义两个变量,一个用于存放参数,一个用于存放期待的结果。接下来,定义测试数据的集合,也就是上述的data()方法,该方法可以任意命名,但是必须使用@Parameters标注进行修饰。这个方法的框架就不予解释了,大家只需要注意其中的数据,是一个二维数组,数据两两一组,每组中的这两个数据,一个是参数,一个是你预期的结果。比如我们的第一组{2, 4},2就是参数,4就是预期的结果。这两个数据的顺序无所谓,谁前谁后都可以。之后是构造函数,其功能就是对先前定义的两个参数进行初始化。 在这里你可要注意一下参数的顺序了,要和上面的数据集合的顺序保持一致。如果前面的顺序是{参数,期待的结果},那么你构造函数的顺序也要是“构造函数(参数, 期待的结果)”,反之亦然。最后就是写一个简单的测试例了,和前面介绍过的写法完全一样,在此就不多说。
异常测试
异常测试与普通断言测试不同,共有三种方法,其中最为灵活的是第三种,可以与断言结合使用
Java中的异常处理也是一个重点,因此你经常会编写一些需要抛出异常的函数。那么,如果你觉得一个函数应该抛出异常,但是它没抛出,这算不算 Bug 呢?这当然是 Bug ,并且 JUnit 也考虑到了这一点,来帮助我们找到这种 Bug 。例如,我们写的计算器类有除法功能,如果除数是一个 0 ,那么必然要抛出“除 0 异常”。因此,我们很有必要对这些进行测试。代码如下:
@Test(expected = ArithmeticException.class)
public void divideByZero() {
calculator.divide(0);
}
第一种:
@Test(expected= IndexOutOfBoundsException.class) public void empty() { new ArrayList<Object>().get(0); }
第二种:
@Test public void testExceptionMessage() { try { new ArrayList<Object>().get(0); fail("Expected an IndexOutOfBoundsException to be thrown"); } catch (IndexOutOfBoundsException anIndexOutOfBoundsException) { assertThat(anIndexOutOfBoundsException.getMessage(), is("Index: 0, Size: 0")); } }
第三种:
@Rule public ExpectedException thrown = ExpectedException.none(); @Test public void shouldTestExceptionMessage() throws IndexOutOfBoundsException { List<Object> list = new ArrayList<Object>(); thrown.expect(IndexOutOfBoundsException.class); thrown.expectMessage("Index: 0, Size: 0"); list.get(0); Assert.assertEquals(1, list.get(0)); }
在上述几种方法中,无论是expected还是expect都表示期望抛出的异常,假如某一方法,当参数为某一值时会抛出异常,那么使用第一种方法就必须为该参数单独写一个测试方法来测试异常,而无法与其他参数值一同写在一个测试方法里,所以显得累赘。第二种方法虽然解决这个问题,但是写法不仅繁琐也不利于理解。而第三种犯法,不仅能动态更改期望抛出的异常,与断言语句结合的也非常好,因此推荐使用该方法来测试异常。
限时测试
如果测试的时候遇到死循环,你的脸上绝对不会露出笑容。因此,对于那些逻辑很复杂,循环嵌套比较深的程序,很有可能出现死循环,因此一定要采取一些预防措施。限时测试是一个很好的解决方案。我们给这些测试函数设定一个执行时间,超过了这个时间,他们就会被系统强行终止,并且系统还会向你汇报该函数结束的原因是因为超时,这样你就可以发现这些 Bug 了。要实现这一功能,只需要给@Test标注加一个参数即可,例如上例中求根的限时测试代码如下:
@Test(timeout = 1000) public void testsquareRoot() { calculator.squareRoot(4); assertEquals(2, calculator.getResult()); }
第二种:
public class HasGlobalTimeout { public static String log; @Rule public Timeout globalTimeout = new Timeout(10000); // 10 seconds max per method tested @Test public void testInfiniteLoop1() { log += "ran1"; for (;;) { } } @Test public void testInfiniteLoop2() { log += "ran2"; for (;;) { } } }
其中,第二种方法与异常测试的第三种方法的写法类似。也是推荐的写法。
打包测试
通过前面的介绍我们可以感觉到,在一个项目中,只写一个测试类是不可能的,我们会写出很多很多个测试类。可是这些测试类必须一个一个的执行,也是比较麻烦的事情。鉴于此, JUnit 为我们提供了打包测试的功能,将所有需要运行的测试类集中起来,一次性的运行完毕,大大的方便了我们的测试工作。具体代码如下:
import org.junit.runner.RunWith; import org.junit.runners.Suite; @RunWith(Suite. class ) @Suite.SuiteClasses( { CalculatorTest. class , SquareTest. class } ) public class AllCalculatorTests { }
大家可以看到,这个功能也需要使用一个特殊的 Runner ,因此我们需要向@RunWith 标注传递一个参数 Suite.class 。同时,我们还需要另外一个标注@Suite.SuiteClasses ,来表明这个类是一个打包测试类。我们把需要打包的类作为参数传递给该标注就可以了。有了这两个标注之后,就已经完整的表达了所有的含义,因此下面的类已经无关紧要,随便起一个类名,内容全部为空既可。