在談 jQuery TDD 之前,先確認什麼才算一個合格的測試框架。我認為至少要滿足六個條件:
QUnit 這六點都做到了,這也是我推薦它的原因。
另一個加分是 QUnit 目前已能脫離 jQuery 獨立運行。嚴格說它已經不是一個 jQuery 測試框架,而是通用的 JavaScript 測試框架。有意思的是它的註解曾發生過細微變化,某程度上反映了這段獨立化的歷程:
原始碼在 https://github.com/jquery/qunit,那裡的版本最新。實務上只需要 qunit.js 與 qunit.css 兩個檔案。
QUnit 的初始化簡單到只需要一段 HTML。這幾個 id 是固定約定,測試結果會被寫進對應元素:
<!DOCTYPE html> <html> <head> <title>My Foo Tests</title> <link href="qunit.css" type="text/css" rel="stylesheet"/> <script src="jquery-1.4.2.js" type="text/javascript"></script> <script src="qunit.js" type="text/javascript"></script> </head> <body> <h1 id="qunit-header">QUnit Test Suite</h1> <h2 id="qunit-banner"></h2> <div id="qunit-testrunner-toolbar"></div> <h2 id="qunit-userAgent"></h2> <ol id="qunit-tests"></ol> </body> </html>
打開這個頁面,你會看到一個標準化的測試介面:紅色代表該案例未通過,綠色代表通過。每個框對應一個測試函式,框標題上的 (x, y, z) 表示總共 z 個斷言、y 個正確、x 個錯誤。
| 函式 | 說明 |
|---|---|
| expect(amount) | 宣告某個測試中預期會有幾個斷言,通常寫在開頭。實際數量不符時會報錯,可避免「因為提前 return 而漏跑斷言」卻仍顯示通過。 |
| module(name) | 把後續測試歸入某個模組,UI 上會依模組分類顯示。 |
| ok(state, message) | 布林斷言,state 為真則通過。message 顯示在介面上用以區分不同斷言。 |
| equal(actual, expected, message) | 相等斷言,用 == 比較。 |
| strictEqual(actual, expected, message) | 嚴格相等斷言,用 === 比較,型別不同即失敗。 |
| deepEqual(actual, expected, message) | 深度比較,會遞迴比對子元素。對陣列與自訂物件特別有用。 |
(早期版本的 equals 與 same 已分別更名為 equal 與 deepEqual,新專案請用新名稱。)
假設有一個再單純不過的函式:
function CalculateAPlusB(a, b) {
return a + b;
}
另開一個 test.js 專門放測試,並在 qunit.js 之後引入(因為要用到 QUnit 定義的函式):
<script src="test.js" type="text/javascript"></script>
測試程式本身:
test("basic calculation", function() {
expect(3);
equal(CalculateAPlusB(1, 5), 6, "1+5=6");
equal(CalculateAPlusB(1.2, 5.5), 6.7, "1.2+5.5=6.7");
equal(CalculateAPlusB(-1, 10), 9, "-1+10=9");
});
test("pass null test", function() {
expect(3);
ok(isNaN(CalculateAPlusB(null, 5)), "pass null as the first argument");
ok(isNaN(CalculateAPlusB(5, null)), "pass null as the second argument");
ok(isNaN(CalculateAPlusB(null, null)), "no argument pass in");
});
其中 test 的第一個參數是案例名稱,第二個參數是實作。equal 比對期望值與實際值,ok 判斷結果是否為真。
一切順利的話會看到全綠的結果:
這時可以恭喜自己了。當然這只是兩個簡單例子,實際上你應該寫更多案例——例如測試數值溢位、傳入字串、傳入 undefined 等邊界情況。TDD 的精神正在於此:先把「什麼叫正確」寫清楚,再讓程式去滿足它。
前面範例都是同步的。若被測對象是 ajax 或動畫回呼,要用 asyncTest 搭配 start():
asyncTest("async ajax", function() {
expect(1);
$.getJSON("/api/status", function(res){
equal(res.code, 200, "回傳狀態碼應為 200");
start(); // 告訴 QUnit 這個非同步案例結束了
});
});
少了 start(),QUnit 會永遠等下去直到逾時。
test/unit/core.js,是閱讀大型專案如何組織測試的絕佳範本最後提醒:本文範例基於 jQuery 1.4 年代的 QUnit API。若你在新專案中使用 QUnit 2.x,模組宣告改為 QUnit.module()、斷言需從 assert 參數取得(assert.equal),且已移除全域的 test 與 equal 等函式。觀念不變,寫法有差。