| 1 | ## 单元测试规范（2016.3.25 liub）
|
| 2 |
|
| 3 | ## 运行环境
|
| 4 |
|
| 5 | 1、安装运行环境：安装 node7.8.0
|
| 6 | 2、安装项目依赖：项目根目录下运行 npm i
|
| 7 | 3、安装测试工具：npm i mocha -g
|
| 8 | 4、安装开发环境（可选）：安装 vs code
|
| 9 | 5、书写单元测试文件，统一放于项目根目录下的test中
|
| 10 | 6、运行单元测试：项目根目录下运行 mocha 即可回归所有单元测试. note: 压测时需要调高 mocha.opts 中 -t 参数的数值
|
| 11 | 7、单元测试中的修饰符
|
| 12 | 可以为任意describe或it 添加 .only 以进行单独测试；改写为 .skip 则进行忽略
|
| 13 | 可以为describe添加 before after beforeEach afterEach 等事件处理
|
| 14 |
|
| 15 | ## API列表
|
| 16 |
|
| 17 | 1、任务相关：task.js
|
| 18 | 2、验证相关：auth.js
|
| 19 | 4、商城相关：shop.js
|
| 20 | 5、内政相关（掷骰子、升级建筑等）：action.js
|
| 21 | 6、配置信息相关：config.js
|
| 22 | 客户端从服务端获取各类配置文件，建议启动时一次性获取全部配置文件
|
| 23 |
|
| 24 | 附加说明：
|
| 25 | 1. 服务端返回结果的JSON格式:
|
| 26 | ```json
|
| 27 | {
|
| 28 | "code":"ReturnCode",
|
| 29 | "data":{}
|
| 30 | }
|
| 31 | ```
|
| 32 | 其中code代表操作结果码，详查服务端ReturnCode的定义
|
| 33 | data代表操作结果集，包含本次操作需要返回客户端的所有有效信息
|
| 34 | 除code和data之外，返回结果中不应该再包括任何其他字段。
|
| 35 |
|
| 36 | 2. 客户端和服务端的交互模式
|
| 37 | - JSONP模式：发送Req报文并提供对应回调函数
|
| 38 | - Notify模式：发送Req报文，不提供回调函数
|
| 39 | - 监听模式：主动监听服务端主动推送的Notify类型的消息
|