totoro 淘寶開源的簡單易用的前端單元測試工具

totoro是由淘寶開源的一款簡單易用、穩定的前端單元測試工具。名字來自於宮崎駿導演的奇幻動畫電影《龍貓》。

0. 特性

• 在真實的瀏覽器中運行
• 支持全部的測試框架
• 支持調試
• 自動測試覆蓋率
• 足夠健壯，適用於生產環境

1. 安裝

node 版本要求

>= 0.8.17

從 npm 安裝

$ sudo npm install totoro -g

從 Github 安裝

能夠體驗開發中的最新功能

$ git clone git@github.com:totorojs/totoro.git
$ cd totoro
$ sudo npm install -g

2. 快速上手

簡單起見，咱們已經爲你準備好了一個可供測試的例子：

注意：測試前請先指定測試服務

totoro config --server-host={{yourServerHost}}

默認爲阿里巴巴集團的內部測試服務，你能夠 啓動本身的測試服務。

$ git clone git@github.com:totorojs/totoro.git
$ cd totoro/examples/simple
$ totoro

如無心外，你將看到以下結果：

• 小圓點爲即時進度反饋。成功顯示爲綠色圓點，失敗顯示爲紅色小叉。
• 單個瀏覽器測試結果中包含運行時間和測試覆蓋率。
• 測試成功的瀏覽器會以綠色字符輸出顯示，失敗或超時的瀏覽器會以紅色字符顯示，並輸出錯誤詳情。

推薦的項目目錄結構

project-dir/
    dist/
    src/ or lib/
    tests/ or test/
        runner.html or index.html

其中：

• 你須要在 project-dir/ 目錄運行 totoro 命令
• dist/ 爲編譯或打包後的輸出目錄
• src/ 或 lib/ 爲源碼目錄
• tests/ 或 test/ 爲測試目錄，其中的 runner.html 或 index.html 都能被識別爲 runner

3. 命令行配置項

3.1 totoro

--runner

測試 runner。接受本地路徑和 url 兩種形式。

默認：自動查找當前目錄，tests 或 test 子目錄下的 runner.html 或 index.html 都可被識別。

--adapter

測試框架的適配器，用於發送測試報告。接受內置關鍵字、本地路徑和 url 三種形式。

已支持的內置關鍵字有：mocha, jasmine。

自定義適配器寫法可參考 static/adapters/mocha.js。

默認：若是 --runner 指定的是本地路徑，則會先查看 runner 所在的位置是否有 totoro-adapter.js；若是沒找到或者 --runner 指定的是 url 則會自動掃描 runner 的內容嘗試查找匹配的內置關鍵字。

--browsers

指定要測試的瀏覽器，多個以逗號分隔。例如：

chrome,firefox,safari,ie  //不指定版本
ie/6,ie/7,ie/8,ie/9  //指定版本

默認：自動選取測試服務端可用的桌面瀏覽器。

--timeout

客戶端超時時間，單位爲分鐘。

默認：5

--server-host

測試服務 host。

默認：阿里的內部host

--server-port

測試服務 port。

默認：9999

--client-root

測試時，客戶端可能會起一個臨時的 HTTP 服務，該選項這個服務的根目錄，接受相對路徑和絕對路徑。

默認：根據 runner 和 adapter 進行猜想。

--skip-coverage

關閉代碼覆蓋率檢查.

默認：開啓

--verbose

顯示更詳細的信息:
- debug 日誌
- 若是啓用測試代碼覆蓋率, 將會顯示沒有覆蓋到行的詳細信息.

默認：false

3.2 totoro list

顯示當前可用的測試瀏覽器。配置項可經過 totoro list -h 查看。

3.3 tororo config

讀取或者設置全局配置。配置項可經過 totoro config -h 查看。

讀取全局配置

totoro config

設置全局配置

totoro config --server-host=10.15.52.87 --server-port=''

將 server-host 設置爲 10.15.52.87，將 server-port 置空。

4. 配置文件

除了命令行配置項和全局配置，你還能夠爲你的項目創建名爲 totoro-config.json 的配置文件，放在項目根目錄下。

這 3 種配置方式的優先級爲：命令行 > 配置文件 > 全局配置 > 內置默認配置。

如下爲一個配置文件的例子：

{
    "browsers": ["chrome", "ie/10.0"],
    "serverHost": "127.0.0.1",
    "serverPort": 9999
}

更多內容請看 tororo項目主頁。