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项目主页。
