本期,我們要討論的話題是 JavaScript 的測試,以檢查組件的狀態和工作方式是否符合預期,還會介紹一個可以方便編寫測試案例的測試方法。這裡說的測試當然是使用自動化的測試手段,這是軟體品質保證(QA)的重要環節。就本系列文章介紹的 Smart Queue 來說,我們的測試目標包括:
- Task 對象的建立:第二期的代碼提供了多種建立方式,需要測試對象建立後的狀態。
- Queue 內的任務運行次序:我們提供了兩種改變運行次序的方式:優先順序和依賴配置,同樣也要測試各種配置對次序的影響。
對於第一個目標,只需檢查對象建立後的屬性是否符合預期即可。我們已經多次提到“符合預期”,斷言(Assert)正是為此而設計的。簡單的說,斷言就是確保所測試的運算式結果為“真”,否則,以某種方式通知測試人員,並協助其定位宣告失敗的測試案例。
第二個目標稍稍有點複雜。由於我們在組件編碼實現的時候,將排序後的隊列(_sorted
)隱藏在了閉包中,所以外部是無法訪問的。有兩種方法可以考慮:(1)重構代碼,增加代碼的可測試性,又有兩種重構方法:(a)設定 debug 開關,開啟時將 _sorted
暴露給外部;(b)增加獨立檔案,以構建的方式拼接代碼最終產生一個測試版本。(2)測試行為的結果而不是過程,前一種方法實質上是深入到組件的運行時狀態,而這個方法只是檢查組件的運行結果。本期選用後一種種測試方式,第一種測試方式留給有興趣的讀者練習:)
需要說明的是,我個人不贊成第一種的方法a. 為什麼呢?我先說一下這個任務隊列的設計理念:
- 它只是一個隊列,只負責“按需”調整任務的運行次序,不關注任務的個體細節。換句話說,它操作整體的任務,而不關心任務具體的行為和表現。
- 它是個安全的隊列,使用者(第一期提到的“客戶”)可以放心把任務添加進去,不用擔心這個任務資訊會被其他客戶看到。需要說明的是,第二期實現代碼中有
SmartQueue.Queue = [[], [], []]
, 結果是外部可以訪問到隊列項。代碼僅供介紹之用,你可以安全地刪除 SmartQueue.Queue =
來達成安全控制。
回到剛才討論的話題,設定 debug 開關後,任務資訊就潛在的泄漏可能性。進一步地,繼續改造代碼也可以達成在使用 debug 開關時的安全性,做法是將開關的控制放在 SmartQueue 的建構函式中,這樣要求 SmartQueue 實現 Singleton 模式(見上一篇文章);一旦建立對象後,不允許修改閉包內的 debug 標記。
在編寫具體測試代碼前,我們設計了一個測試方法,以簡化測試代碼(主要是用例)的編寫。簡單地說,就是將測試案例與測試本身的代碼分離——前者以語義良好的方式編寫,後者是一次性編寫,用於處理前者設定的測試案例。用例編寫者需要寫格式形如這樣的代碼:
<ul id="J_test_cases"> <li> <pre>task = new sq.Task({fn: function() { log('unamed') }})</pre> <ul> <li>typeof task.fn === 'function'</li> <li>task.name === 't0'</li> <li>task.level === 1</li> <li>task.dependencies.length === 0</li> <li>task.context == window</li> </ul> </li> <li> <pre>task = new sq.Task({fn: function() { log('unamed') }, name: 'hello'})</pre> <ul> <li>task.name === 'hello'</li> <li>task.level === 1</li> </ul> </li> </ul>
ul li pre (CSS 選取器路徑,下同)中寫要測試的代碼,相當於前置操作;ul ul li 中對這個代碼進行斷言測試,可以編寫多條斷言。這裡建議對基礎資料型別 (Elementary Data Type)使用 ===
和 !===
運算子以加強對資料類型的預期判斷。
接下來,我們編寫兩個 helper 方法用來輸出和測試:
function log(str) { node.value += str + '\n';}function assert(expression) { var flag; eval('flag = ' + expression); return typeof(flag) === 'boolean' && flag;}
log
用來向文字框追加資訊,assert
用來測試傳入運算式的值。測試方法如下(這裡使用了 jQuery):
var sq = SmartQueue, task, total = 0, passed = 0, failed = 0;$('#J_test_cases').children().each(function(index) { eval($('pre', this).text()); task.register(); $('li', this).each(function() { var item = $(this); var flag = assert(item.text()); if(flag) passed ++; else failed ++; item.prepend((flag ? '<font color="green">[PASS]</font>' : '<font color="red">[FAIL]</font>') + ' '); total++; }).wrap('<pre></pre>');}).end().before('<p>Total: ' + total + ', passed: '+ passed +', failed: ' + failed + '</p>');sq.fire();
這個結構還可改進一下,比如輸出測試說明而不是具體的代碼,也可以增加後置操作,這裡就不再示範了。你還可以查看完整的測試頁面,含有 23 個測試案例和完整的測試實現。
~~~~~~~~~~~~~ 八卦分割線 ~~~~~~~~~~~~~
好吧,我們已經體會到了思考和行動的樂趣,走到了系列文章的尾聲,但這隻是開始。我們經曆了一個很小的實用組件的實現全過程,領略到了 JavaScript 世界的精彩,讓我們繼續前行~