測試框架 Mocha 例項教程

阮一峰發表於2015-12-03

Mocha(發音”摩卡”)誕生於2011年,是現在最流行的JavaScript測試框架之一,在瀏覽器和Node環境都可以使用。

所謂”測試框架”,就是執行測試的工具。通過它,可以為JavaScript應用新增測試,從而保證程式碼的質量。

本文全面介紹如何使用Mocha,讓你輕鬆上手。如果你以前對測試一無所知,本文也可以當作JavaScript單元測試入門。值得說明的是,除了Mocha以外,類似的測試框架還有JasmineKarmaTape等,也很值得學習。

一、安裝

我為本文寫了一個示例庫Mocha-demos,請先安裝這個庫。

如果你的電腦沒裝Git,可以直接下載zip壓縮包,進行解壓。

然後,進入mocha-demos目錄,安裝依賴(你的電腦必須有Node)。

上面程式碼會在目錄內部安裝Mocha,為了操作的方便,請在全面環境也安裝一下Mocha

二、測試指令碼的寫法

Mocha的作用是執行測試指令碼,首先必須學會寫測試指令碼。所謂”測試指令碼”,就是用來測試原始碼的指令碼。

下面是一個加法模組add.js的程式碼。

要測試這個加法模組是否正確,就要寫測試指令碼。

通常,測試指令碼與所要測試的原始碼指令碼同名,但是字尾名為.test.js(表示測試)或者.spec.js(表示規格)。比如,add.js的測試指令碼名字就是add.test.js

上面這段程式碼,就是測試指令碼,它可以獨立執行。測試指令碼里面應該包括一個或多個describe塊,每個describe塊應該包括一個或多個it塊。

describe塊稱為”測試套件”(test suite),表示一組相關的測試。它是一個函式,第一個引數是測試套件的名稱(”加法函式的測試”),第二個引數是一個實際執行的函式。

it塊稱為”測試用例”(test case),表示一個單獨的測試,是測試的最小單位。它也是一個函式,第一個引數是測試用例的名稱(”1 加 1 應該等於 2″),第二個引數是一個實際執行的函式。

三、斷言庫的用法

上面的測試指令碼里面,有一句斷言。

所謂”斷言”,就是判斷原始碼的實際執行結果與預期結果是否一致,如果不一致就丟擲一個錯誤。上面這句斷言的意思是,呼叫add(1, 1),結果應該等於2。

所有的測試用例(it塊)都應該含有一句或多句的斷言。它是編寫測試用例的關鍵。斷言功能由斷言庫來實現,Mocha本身不帶斷言庫,所以必須先引入斷言庫。

斷言庫有很多種,Mocha並不限制使用哪一種。上面程式碼引入的斷言庫是chai,並且指定使用它的expect斷言風格。

expect斷言的優點是很接近自然語言,下面是一些例子。

基本上,expect斷言的寫法都是一樣的。頭部是expect方法,尾部是斷言方法,比如equala/anokmatch等。兩者之間使用toto.be連線。

如果expect斷言不成立,就會丟擲一個錯誤。事實上,只要不丟擲錯誤,測試用例就算通過。

上面的這個測試用例,內部沒有任何程式碼,由於沒有丟擲了錯誤,所以還是會通過。

四、Mocha的基本用法

有了測試指令碼以後,就可以用Mocha執行它。請進入demo01子目錄,執行下面的命令。

上面的執行結果表示,測試指令碼通過了測試,一共只有1個測試用例,耗時是8毫秒。

mocha命令後面緊跟測試指令碼的路徑和檔名,可以指定多個測試指令碼。

Mocha預設執行test子目錄裡面的測試指令碼。所以,一般都會把測試指令碼放在test目錄裡面,然後執行mocha就不需要引數了。請進入demo02子目錄,執行下面的命令。

這時可以看到,test子目錄裡面的測試指令碼執行了。但是,你開啟test子目錄,會發現下面還有一個test/dir子目錄,裡面還有一個測試指令碼multiply.test.js,並沒有得到執行。原來,Mocha預設只執行test子目錄下面第一層的測試用例,不會執行更下層的用例。

為了改變這種行為,就必須加上--recursive引數,這時test子目錄下面所有的測試用例—-不管在哪一層—-都會執行。

五、萬用字元

命令列指定測試指令碼時,可以使用萬用字元,同時指定多個檔案。

上面的第一行命令,指定執行spec目錄下面的my.jsawesome.js。第二行命令,指定執行test/unit目錄下面的所有js檔案。

除了使用Shell萬用字元,還可以使用Node萬用字元。

上面程式碼指定執行test目錄下面任何子目錄中、檔案字尾名為jsjsx的測試指令碼。注意,Node的萬用字元要放在單引號之中,否則星號(*)會先被Shell解釋。

上面這行Node萬用字元,如果改用Shell萬用字元,要寫成下面這樣。

六、命令列引數

除了前面介紹的--recursive,Mocha還可以加上其他命令列引數。請在demo02子目錄裡面,執行下面的命令,檢視效果。

6.1 –help, -h

--help-h引數,用來檢視Mocha的所有命令列引數。

6.2 –reporter, -R

--reporter引數用來指定測試報告的格式,預設是spec格式。

除了spec格式,官方網站還提供了其他許多報告格式

上面是tap格式報告的顯示結果。

--reporters引數可以顯示所有內建的報告格式。

使用mochawesome模組,可以生成漂亮的HTML格式的報告。

然後,測試結果報告就在mochaawesome-reports子目錄生成。

6.3 –growl, -G

開啟--growl引數,就會將測試結果在桌面顯示。

6.4 –watch,-w

--watch引數用來監視指定的測試指令碼。只要測試指令碼有變化,就會自動執行Mocha。

上面命令執行以後,並不會退出。你可以另外開啟一個終端視窗,修改test目錄下面的測試指令碼add.test.js,比如刪除一個測試用例,一旦儲存,Mocha就會再次自動執行。

6.5 –bail, -b

--bail引數指定只要有一個測試用例沒有通過,就停止執行後面的測試用例。這對持續整合很有用。

6.6 –grep, -g

--grep引數用於搜尋測試用例的名稱(即it塊的第一個引數),然後只執行匹配的測試用例。

上面程式碼只測試名稱中包含”1 加 1″的測試用例。

6.7 –invent, -i

--invert參數列示只執行不符合條件的測試指令碼,必須與--grep引數配合使用。

七,配置檔案mocha.opts

Mocha允許在test目錄下面,放置配置檔案mocha.opts,把命令列引數寫在裡面。請先進入demo03目錄,執行下面的命令。

上面這個命令有三個引數--recursive--reporter tap--growl

然後,把這三個引數寫入test目錄下的mocha.opts檔案。

然後,執行mocha就能取得與第一行命令一樣的效果。

如果測試用例不是存放在test子目錄,可以在mocha.opts寫入以下內容。

上面程式碼指定執行server-tests目錄及其子目錄之中的測試指令碼。

八、ES6測試

如果測試指令碼是用ES6寫的,那麼執行測試之前,需要先用Babel轉碼。進入demo04目錄,開啟test/add.test.js檔案,可以看到這個測試用例是用ES6寫的。

ES6轉碼,需要安裝Babel。

然後,在專案目錄下面,新建一個.babelrc配置檔案。

最後,使用--compilers引數指定測試指令碼的轉碼器。

上面程式碼中,--compilers引數後面緊跟一個用冒號分隔的字串,冒號左邊是檔案的字尾名,右邊是用來處理這一類檔案的模組名。上面程式碼表示,執行測試之前,先用babel-core/register模組,處理一下.js檔案。

下面是另外一個例子,使用Mocha測試CoffeeScript指令碼。測試之前,先將.coffee檔案轉成.js檔案。

注意,Babel預設不會對Iterator、Generator、Promise、Map、Set等全域性物件,以及一些全域性物件的方法(比如Object.assign)轉碼。如果你想要對這些物件轉碼,就要安裝babel-polyfill

然後,在你的指令碼頭部加上一行。

九、非同步測試

Mocha預設每個測試用例最多執行2000毫秒,如果到時沒有得到結果,就報錯。對於涉及非同步操作的測試用例,這個時間往往是不夠的,需要用-t--timeout引數指定超時門檻。

進入demo05子目錄,開啟測試指令碼timeout.test.js

上面的測試用例,需要4000毫秒之後,才有執行結果。所以,需要用-t--timeout引數,改變預設的超時設定。

上面命令將測試的超時時限指定為5000毫秒。

另外,上面的測試用例裡面,有一個done函式。it塊執行的時候,傳入一個done引數,當測試結束的時候,必須顯式呼叫這個函式,告訴Mocha測試結束了。否則,Mocha就無法知道,測試是否結束,會一直等到超時報錯。你可以把這行刪除試試看。

Mocha預設會高亮顯示超過75毫秒的測試用例,可以用-s--slow調整這個引數。

上面命令指定高亮顯示耗時超過1000毫秒的測試用例。

下面是另外一個非同步測試的例子async.test.js

執行下面命令,可以看到這個測試會通過。

另外,Mocha內建對Promise的支援,允許直接返回Promise,等到它的狀態改變,再執行斷言,而不用顯式呼叫done方法。請看promise.test.js

十、測試用例的鉤子

Mocha在describe塊之中,提供測試用例的四個鉤子:before()after()beforeEach()afterEach()。它們會在指定時間執行。

進入demo06子目錄,可以看到下面兩個例子。首先是beforeEach的例子beforeEach.test.js

上面程式碼中,beforeEach會在it之前執行,所以會修改全域性變數。

另一個例子beforeEach-async.test.js則是演示,如何在beforeEach之中使用非同步操作。

十一、測試用例管理

大型專案有很多測試用例。有時,我們希望只執行其中的幾個,這時可以用only方法。describe塊和it塊都允許呼叫only方法,表示只執行某個測試套件或測試用例。

進入demo07子目錄,測試指令碼test/add.test.js就使用了only

上面程式碼中,只有帶有only方法的測試用例會執行。

此外,還有skip方法,表示跳過指定的測試套件或測試用例。

上面程式碼的這個測試用例不會執行。

十二、瀏覽器測試

除了在命令列執行,Mocha還可以在瀏覽器執行。

首先,使用mocha init命令在指定目錄生成初始化檔案。

執行上面命令,就會在demo08目錄下生成index.html檔案,以及配套的指令碼和樣式表。

然後,新建一個原始碼檔案add.js

然後,把這個檔案,以及斷言庫chai.js,加入index.html

最後,在tests.js裡面寫入測試指令碼。

現在,在瀏覽器裡面開啟index.html,就可以看到測試指令碼的執行結果。

十三、生成規格檔案

Mocha支援從測試用例生成規格檔案。

進入demo09子目錄,執行下面的命令。

上面命令根據test目錄的所有測試指令碼,生成一個規格檔案spec.md-R markdown引數指定規格報告是markdown格式。

如果想生成HTML格式的報告spec.html,使用下面的命令。

(完)

相關文章