JUnit 簡介與應用
Horance Chou (horance@freera.net)
一.前言:
"測試"的目的, 是為了找出"產品"和"設計"之間的差異。在軟體開發的領域,測試更是驗証軟體功能的重要工作。測試的方法很多,但其中最基本,最直覺的測試,就是由程式開發人員在撰寫程式元件時所進行的"單元測試"(Unit Test)。在現今各種軟體開發方法論中,單元測試之功效漸受重視;在最近幾年被提出的"極道程式設計法"*(Extreme Programming, 以下簡稱XP)[1]和"測試導向開發方法"(Test-Driven Development, 以下簡稱TDD)[2]之中,單元測試也都被列為推行此兩方法論的要點之一。本文將介紹如何利用Java程式語言最常被使用的單元測試平台-JUnit[3]來撰寫測試案例(Test Case),以加速開發/測試循環(Developing/Testing iteration)。
*註:此一譯名為唐宗漢先生(Autrijus Tang)在Taipei.PM聚會演講Extreme Programming時所採用的名詞,個人覺得非常貼切,在此沿用他的譯名。
二.JUnit簡介
JUnit 是Erich Gamma及Kent Beck兩位所開發之迴歸測試平台(Regression Testing Framework)。顧名思義,此一平台即是提供Java程式開發人員實作單元測試案例相關API(Application Programming Interfaces, 應用程式介面)。JUnit是一個自由軟體(Open Source Software)[4]。JUnit的授權方式為Common Public License 1.0版,最新的穩定版本是3.8.1,可由Sourceforge[5]取得此一平台的最新釋出版本。
三.為什麼要使用JUnit
不論您所參與的專案是否遵循XP或TDD,單元測試都是免不了的。在XP所定義的規則和實作(Rules and Practices)裡,單元測試佔有很大比重[6]。而由於Java物件導向的語言特性,以及JUnit平台良好的設計架構,我們至少可以獲得下列益處:
1.不用為了單元測試撰寫重覆的程式碼:
使用JUnit,可以讓開發人員很輕易地建立測試案例,以測試現有物件中的方法(Methods)。使用JUnit平台撰寫單元測試案例,就如同在撰寫一些由5~10行程式碼所組成的方法一樣簡單-事實上,如果搭配某些開發工具,您甚至不需要撰寫任何程式碼。稍後我們會在實例中證明這一點。
2.JUnit的測試案例可以被組織成測試組合(Test Suites):
JUnit的測試案組合可以包念數個測試案例或其它的測試組合,如此一來開發人員便可以在一個測試動作中完成相關元件的測試。
3.JUnit的測試結果是很容易收集到的:
JUnit套件中提供了基本的測試執行環境,例如在文字模式執行的junit.textui.TestRunner,以及在圖型化介面(GUI)下執行的junit.swingui.TestRunner,兩者都有助於開發人員簡單地執行已完成的測試組合或測試案例。
最後,也是最重要的一點:JUnit是自由軟體。
四.如何使用JUnit
1.安裝JUnit:
您可以在任何一個SourceForge映射站台(Mirror site)的下載頁面取得JUnit Framework,如:
http://umn.dl.sourceforge.net/sourceforge/junit/junit3.8.1.zip
取後junit3.8.1.zip後,您可以使用慣用的解壓縮工具將junit3.8.1.zip解開至指定的目錄。若您希望在您的java執行環境中直接使用JUnit Framework,可以在CLASSPATH環境變數加入junit.jar,請參考各種作業系統下的環境變數設定方式自行設定。
2.範例:MoneyTest
public static void main(String[] args) {
Money m12CHF = new Money(12, "CHF");
Money m14CHF = new Money(14, "CHF");
Money res = m12CHF.add(m14CHF);
System.out.println("res: " + res.amount() + " " + res.currency());
}
接著,您打開一個命令列視窗,用 javac compile 您的 Money.java接著以
java junit.samples.Money
來執行這個程式,然後祈導輸出結果是:
res: 26 CHF
這樣的寫法是許多程式開發人員最常用的方法,但如此一來,您就必需以人工判斷程式執行是否正常。 現在,讓我們看看如何使用JUnit來建立一個測試案例:
在您取得的junit3.8.1.zip中包含有一個簡單的JUnit範例,您可以在junit/samples目錄中找到這個範例的原始碼。 現在,您想寫幾個測試案例來測試這個Money物件中的add()方法。回想一下,您是否曾經做過這樣的動作: 在Money物件中加上一段這樣的程式碼:(註:CHF為Swiss Francs的貨幣縮寫,在此保留JUnit範例中的原始用法)
1.撰寫一個 MoneyTest並繼承 junit.framework.TestCase(請參考junit/samples/MoneyTest.java)
2.撰寫一個 testSimpleAdd() method,內容為:
public void testSimpleAdd () {
Money m12CHF = new Money(12,"CHF");
Money m14CHF = new Money(14,"CHF");
Money expectedReturn = new Money(26,"CHF");
Money actualReturn = m12CHF.add(m14CHF);
assertTrue(expectedReturn.equals(actualReturn));
}
要注意的是,當沒有覆載(Override)junit.framework.TestCase物件中的runTest()方法時,TestRunner將會自動執行所有命名以"test"為開頭的方法,如testSimpleAdd,testSimpleSub(如果有被定義的話)等等。 在testSimpleAdd()方法中最後一行的assertTrue()則是JUnit Framework中用來檢查測試結果的API,在本例中若expectedReturn和actualReturn相等時(以equals()方法之傳回值來認定),JUnit才會認為此一測試通過。JUnit Framework中還有許多其它的assert方法,例如assertEquals(),assertNotEquals()等,請參考JUnit API Javadoc文件[7]。
3.執行TestRunner,例如:
java -cp ${CLASSPATH}:
/path/to/junit.jar:. junit.textui.TestRunner junit.samples.money.MoneyTest
.
Time: 0.01
OK (1 tests)
此處是以文字模示的junit.textui.TestRunner來進行JUnit測試。您可以看到JUnit順利的執行了您的MoneyTest,並回覆"OK (1 tests)",表示TestRunner進行了一項測試,結果全部通過。您可以將範例中的junit.textui.TestRunner改為junit.swingui.TestRunner,觀察一下有什麼不同。
4.若您想要在一個測試案例中,進行數項不同測試,而又不想在每個測試方法中撰寫物件宣告實體化測試物件(即new Money(?)),此時就可以覆載setUp()和tearDown()方法來預先建立您的"測試配置"(Test Fixtures):
public class MoneyTest extends TestCase {
private Money f12CHF;
private Money f14CHF;
private Money f28USD;
protected void setUp() {
f12CHF= new Money(12, "CHF");
f14CHF= new Money(14, "CHF");
f28USD= new Money(28, "USD");
}
}
TestRunner在執行時會自動呼叫setUp(),並在結束前呼叫tearDown()方法。物件中所有的測試方法直接使用這三個Money物件。因此,前例的testSimpleAdd可以改寫成:
public void testSimpleAdd() {
// [12 CHF] + [14 CHF] == [26 CHF]
Money expected= new Money(26, "CHF");
assertEquals(expected, f12CHF.add(f14CHF));
}
5.那麼,要如何在一次執行中進行多個測試呢? 您可以使用Test Suite(測試組合)來達成:在您的MoneyTest類別加入suite()靜態方法:
public static Test suite() {
TestSuite suite= new TestSuite();
suite.addTest(new MoneyTest("testMoneyEquals"));
suite.addTest(new MoneyTest("testSimpleAdd"));
return suite;
}
如此一來,TestRunner在執行時,便會依您定義的測試組合進行測試。若您沒有為您的TestCase類別定義suite()方法,那麼TestRunner會自動執行所有以"test"開頭之測試方法。 以上介紹了JUnit Framework的基本用法,若您需要更進階的用法,請見第六點中提供的參考資料及延申閱讀。
五.結語
JUnit之所以廣受歡迎,不只是因為他是自由軟體,而是新的開發方法論-如XP及TDD開始受到重視,且開發人員感受到使用JUnit所帶給他們的好處,因而在Java開發人員中日漸被採用。本文著重介紹JUnit的安裝與基本運用,若能配合XP及TDD等相關開發方法,應該更能體會其中奧妙。最後,希望這篇文章能讓各位對JUnit有初步的了解,並融入您的開發流程,對您未來的專案開發工作產生助益。
六.參考資料
http://www.extremeprogramming.org/
http://www.testdriven.com/
http://www.junit.org/
http://www.opensource.org/
http://sourceforge.net/projects/junit/
http://www.extremeprogramming.org/rules.html
http://junit.sourceforge.net/javadoc/index.html
延申閱讀:
Extreme Programming: A gentle introduction. http://www.extremeprogramming.org/
極道程式設計法 by Autrijus Tang http://aut.dyndns.org/xp/slides/start.html
JUnit Documentation: http://junit.sourceforge.net/#Documentation
JUnit Primer http://www.clarkware.com/articles/JUnitPrimer.html
Introducing JUnit by Alan Griffiths http://www.octopull.demon.co.uk/java/Introducing_JUnit.html