使用JUnit4进行单元测试(一)

时间:2021-04-19 00:34:03

快速入门

第一步.创建被测试项目及类

我们使用Maven项目向导创建一个项目test1,编写一个Calculator类,这是一个能够简单实现加减乘除、平方、开方的计算器类,然后对这些功能进行单元测试。这个类并不完整,我们故意保留了一些bug用于演示,这些bug在注释中都有说明。该类代码如下:

package com.freesky.test1;

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){

       //TODO:

    }

    public void divide(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;

    }

}

第二步.引入JUnit4单元测试包

将JUnit4单元测试包引入到这个项目,当前最新的版本是4.7,我们在该项目的pom文件中加入该依赖。

<dependency>

        <groupId>junit</groupId>

        <artifactId>junit</artifactId>

        <version>4.4</version>

</dependency>

第三步.生成JUnit测试框架

在Eclipse的Package Explorer中用右键点击该类创建一个新的JUnit单元测试类,如下图:

使用JUnit4进行单元测试(一)

然后对新的测试类做一些修改,这里我们使用New JUnit 4 test同时把测试类保存在src/test/java目录下

使用JUnit4进行单元测试(一)

点击[Next]后,系统会自动列出你这个类中包含的方法,选择你要进行测试的方式,此例中,我们仅对”加、减、乘、除”四个方法进行测试,如下图所示:

使用JUnit4进行单元测试(一)

之后系统会自动生成一个新类CalculatorTest,里面包含一些空的测试用例,你只需要将这些测试用例稍作修改即可使用。我的测试用例代码如下:

package com.freesky.test1; 

import static org.junit.Assert.*;

import org.junit.*; 

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.divide(2);

 

       assertEquals(4, calculator.getResult());

    }

    @Test(timeout=2000)

    public void testSquareRoot(){

       calculator.squareRoot(4);

       Assert.assertEquals(2, calculator.getResult()); 

    }

    @Test(expected=ArithmeticException.class)

    public void testDivideByZero(){

       calculator.divide(0);

    }

}

第四步.运行测试代码

按照上述代码修改完毕后,我们在CalculatorTest类上点击右键,选择 Run AS → Junit Test就可以运行我们的测试,运行完毕后可以看到一些结果:

进度条是红颜色表示发现错误,具体的测试结果会告诉你共运行了几个测试,有几个测试被忽略,有几个测试失败,有几个测试有错误。

同时也可以在项目上点击右键运行Maven test来运行测试,不过这样的结果不是特别直观。

         至此,我们已经完整体验了在Eclipse中使用JUnit 4的方法。

用注释进行测试

在测试类中用到了JUnit4框架,自然要把相应的Package包含进来。最主要的一个Package就是org.junit.*,把它包含进来,绝大部分功能就有了。还有一句话也非常重要”import static org.junit.Assert.*”,我们在测试时使用的一系列assertEquals方法就来自这个包。注意这是一个静态包含(static),是JDK5中新增加的一个功能。也就是说,assertEquals是Assert类中一系列的静态方法,一般的使用方式是Assert.assertEquals(),但是使用了静态包含后,前面的类名就可以省略了,使用起来更加方便。

测试类的声明

我们的测试类是一个独立的类,没有任何父类,这与JUnit 3.8有所不同。而且你要是使用Run AS → Junit Test运行时,测试类的名字也可以任意命名,没有任何局限性,但要是使用Maven test,我们还是需要按JUnit 3.8的规范来,这里建议以Test作为测试的结尾。

创建一个待测试的对

你要测试哪个类,那么你首先就要创建一个该类的对象,为了测试Calculator类,我们必须创建一个calculator对象。  

     private static Calculator calculator = new Calculator();

测试方法的声明

在测试类中,并不是每一个方法都是用于测试的,你必须使用“注释”来明确表明哪些是测试方法。“注释”也是JDK5的一个新特性,用在此处非常恰当。我们可以看到,在某些方法的前有@Before、@Test、@Ignore等字样,这些就是注释,以一个“@”作为开头。这些注释都是JUnit4自定义的,熟练掌握这些注释的含义非常重要。

编写一个简单的测试方法

首先,你要在方法的前面使用@Test注释,以表明这是一个测试方法。对于方法的声明也有如下要求:名字可以随便取,没有任何限制,但是返回值必须为void,而且不能有任何参数。如果违反这些规定,会在运行时抛出一个异常。至于方法内该写些什么,那就要看你需要测试些什么了。比如:

@Test

    public void testAdd(){

       calculator.add(2);

       calculator.add(3);

       assertEquals(5, calculator.getResult());

    }

我们想测试一下“加法”功能时候正确,就在测试方法中调用几次add函数,初始值为0,先加2,再加3,我们期待的结果应该是5。如果最终实际结果也是5,则说明add方法是正确的,反之说明它是错的。assertEquals(5, calculator.getResult());就是来判断期待结果和实际结果是否相等,第一个参数填写期待结果,第二个参数填写实际结果,也就是通过计算得到的结果。这样写好之后,JUnit会自动进行测试并把测试结果反馈给用户。

忽略测试某些尚未完成的方法

如果你在写程序前做了很好的规划,那么哪些方法是什么功能都应该实现定下来。因此,即使该方法尚未完成,他的具体功能也是确定的,这也就意味着你可以为他编写测试用例。但是,如果你已经把该方法的测试用例写完,但该方法尚未完成,那么测试的时候一定是“失败”。这种失败和真正的失败是有区别的,因此JUnit提供了一种方法来区别他们,那就是在这种测试函数的前面加上@Ignore标注,这个标注的含义就是“某些方法尚未完成,暂不参与此次测试”。这样的话测试结果就会提示你有几个测试被忽略,而不是失败。一旦你完成了相应函数,只需要把@Ignore标注删去,就可以进行正常的测试。

Fixture(固定代码段)

Fixture的含义就是“在某些阶段必然被调用的代码”。比如我们上面的测试,由于只声明了一个Calculator对象,他的初始值是0,但是测试完加法操作后,他的值就不是0了;接下来测试减法操作,就必然要考虑上次加法操作的结果。这绝对是一个很糟糕的设计!我们非常希望每一个测试都是独立的,相互之间没有任何耦合度。因此,我们就很有必要在执行每一个测试之前,对Calculator对象进行一个“复原”操作,以消除其他测试造成的影响。因此,“在任何一个测试执行之前必须执行的代码”就是一个Fixture,我们用@Before来标注它,如前面例子所示:

@Before
public void setUp() throws Exception{
    calculator.clear();
}
这里不在需要@Test标注,因为这不是一个test,而是一个Fixture。同理,如果“在任何测试执行之后需要进行的收尾工作”也是一个Fixture,使用@After来标注。

刚才我们介绍了两个Fixture注释,分别是@Before和@After,我们来看看他们是否适合完成如下功能:有一个类是负责对大文件(超过500兆)进行读写,他的每一个方法都是对文件进行操作。换句话说,在调用每一个方法之前,我们都要打开一个大文件并读入文件内容,这绝对是一个非常耗费时间的操作。如果我们使用@Before和@After,那么每次测试都要读取一次文件,效率及其低下。这里我们所希望的是在所有测试一开始读一次文件,所有测试结束之后释放文件,而不是每次测试都读文件。JUnit的作者显然也考虑到了这个问题,它给出了@BeforeClass 和 @AfterClass两个Fixture来帮我们实现这个功能。从名字上就可以看出,用这两个Fixture注释的函数,只在测试用例初始化时执行@BeforeClass方法,当所有测试执行完毕之后,执行@AfterClass进行收尾工作。在这里要注意一下,每个测试类只能有一个方法被标注为@BeforeClass 或 @AfterClass,并且该方法必须是Public和Static的。

限时测试

还记得我在初级篇中给出的例子吗,那个求平方根的函数有Bug,是个死循环:

public void squateRoot(int n){
         for (;;);
}

如果测试的时候遇到死循环,你的脸上绝对不会露出笑容。因此,对于那些逻辑很复杂,循环嵌套比较深的程序,很有可能出现死循环,因此一定要采取一些预防措施。限时测试是一个很好的解决方案。我们给这些测试函数设定一个执行时间,超过了这个时间,他们就会被系统强行终止,并且系统还会向你汇报该函数结束的原因是因为超时,这样你就可以发现这些Bug了。要实现这一功能,只需要给@Test注释加一个参数即可,代码如下:

@Test(timeout = 1000)
public void squareRoot(){
        calculator.squareRoot(4);
        assertEquals(2, calculator.getResult());
    }

Timeout参数表明了你要设定的时间,单位为毫秒,因此1000就代表1秒。

异常测试

JAVA中的异常处理也是一个重点,因此你经常会编写一些需要抛出异常的函数。那么,如果你觉得一个函数应该抛出异常,但是它没抛出,这算不算Bug呢?这当然是Bug,并JUnit也考虑到了这一点,来帮助我们找到这种Bug。例如,我们写的计算器类有除法功能,如果除数是一个0,那么必然要抛出“除0异常”。因此,我们很有必要对这些进行测试。代码如下:

@Test(expected = ArithmeticException.class)
 public void divideByZero() {
    calculator.divide(0); 
  }

如上述代码所示,我们需要使用@Test注释的expected属性,将我们要检验的异常传递给他,这样JUnit框架就能自动帮我们检测是否抛出了我们指定的异常。

Runner(运行器)

大家有没有想过这个问题,当你把测试代码提交给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的特有功能。

参数化

你可能遇到过这样的函数,它的参数有许多特殊值,或者说他的参数分为很多个区域。比如,一个对考试分数进行评价的函数,返回值分别为“优秀,良好,一般,及格,不及格”,因此你在编写测试的时候,至少要写5个测试,把这5中情况都包含了,这确实是一件很麻烦的事情。我们还使用我们先前的例子,测试一下“计算一个数的平方”这个函数,暂且分三类:正数、0、负数。测试代码如下:

import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import static org.junit.Assert.*;
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提出了“参数化测试”的概念,只写一个测试函数,把这若干种情况作为参数传递进去,一次性的完成测试。代码如下:

import static org.junit.Assert.assertEquals;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;
import java.util.Arrays;
import java.util.Collection;

@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就是预期的结果。这两个数据的顺序无所谓,谁前谁后都可以。之后是构造函数,其功能就是对先前定义的两个参数进行初始化。在这里你可要注意一下参数的顺序了,要和上面的数据集合的顺序保持一致。如果前面的顺序是{参数,期待的结果},那么你构造函数的顺序也要是“构造函数(参数, 期待的结果)”,反之亦然。最后就是写一个简单的测试例了,和前面介绍过的写法完全一样,在此就不多说。

打包测试

通过前面的介绍我们可以感觉到,在一个项目中,只写一个测试类是不可能的,我们会写出很多很多个测试类。可是这些测试类必须一个一个的执行,也是比较麻烦的事情。鉴于此,JUnit为我们提供了打包测试的功能,将所有需要运行的测试类集中起来,一次性的运行完毕,大大的方便了我们的测试工作。具体代码如下:

import org.junit.runner.RunWith;
import org.junit.runners.Suite;
@RunWith(Suite.class)
@Suite.SuiteClasses({
        CalculatorTest.class,
        SquareTest.class
        })
public class AllCalculatorTest {

}

大家可以看到,这个功能也需要使用一个特殊的Runner,因此我们需要向@RunWith注释传递一个参数Suite.class。同时,我们还需要另外一个注释@Suite.SuiteClasses,来表明这个类是一个打包测试类。我们把需要打包的类作为参数传递给该标注就可以了。有了这两个注释之后,就已经完整的表达了所有的含义,因此下面的类已经无关紧要,随便起一个类名,内容全部为空既可。

注意在使用打包测试时,在Maven环境下,若要只运行该打包测试类,应该在运行参数中指定该类名,否则Maven还是会运行其它测试类。

其他

Maven的测试到目前还没有完全实现JUnit4的所有细节,我现在发现的一个问题就是类名的定义还必须和JUnit 3.8一致,要以Test结尾,否则该测试类是不被Maven所执行的。

本文是我综合网络上的几篇文章而成,并非我原创,在此感谢网上那些具有爱心的高手了!!