mirror of
https://github.com/alibaba/testable-mock.git
synced 2025-01-10 20:30:11 +08:00
58 lines
2.8 KiB
Markdown
58 lines
2.8 KiB
Markdown
# TestableMock
|
||
|
||
换种思路写Mock，让单元测试更简单。
|
||
|
||
无需初始化，不挑测试框架，甭管要换的是私有方法、静态方法、构造方法还是其他任何类的任何方法，也甭管要换的对象是怎么创建的。写好Mock定义，加个`@MockMethod`注解，一切统统搞定。
|
||
|
||
- 文档：https://alibaba.github.io/testable-mock/
|
||
- 国内文档镜像：http://freyrlin.gitee.io/testable-mock/ （速度快，内容稍有延迟）
|
||
|
||
阅读[这里](https://mp.weixin.qq.com/s/KyU6Eu7mDkZU8FspfSqfMw)了解更多故事。
|
||
|
||
> 特别说明
|
||
> 1. 如有遇到启动报空指针异常或"Operand stack overflow"错误，请升级`TestableMock`版本，这是BUG，已修复😛
|
||
> 2. 如遇到"Attempt to access none-static member in mock method"错误，参见[常见问题](https://alibaba.github.io/testable-mock/#/zh-cn/doc/frequently-asked-questions)第8条
|
||
> 3. 如果有遇到其他任何使用问题和建议，请直接在[Issue](https://github.com/alibaba/testable-mock/issues)中提出，也可通过[Pull Request](https://github.com/alibaba/testable-mock/pulls)提交您的代码，我们将在24小时内回复并处理
|
||
|
||
-----
|
||
|
||
## 版本计划
|
||
|
||
`TestableMock`正在持续迭代演进，以下版本计划可能在开发过程中发生调整，请以最新内容为准
|
||
|
||
- `0.4.x` 当前版本，进行中的工作内容参考[Issue](https://github.com/alibaba/testable-mock/issues)清单
|
||
- `0.5` 实现以"Mock方法集"为单元的Mock方法复用机制，让测试类之间可以方便复用相同的Mock方法
|
||
- `0.6` 实现第四项单元测试增强能力"万能入参构造器"。不论被测方法所需的参数结构多么错综复杂、甚至没有合适的构造方法、甚至需要私有内部类对象... 呼唤TestableMock，马上递给您~
|
||
|
||
## 目录结构
|
||
|
||
```bash
|
||
|-- testable-parent ➜ 提供各子模块的公共父pom文件
|
||
|-- testable-all ➜ 依赖聚合，便于一次性引用所有子模块功能
|
||
|-- testable-processor ➜ 编译期代码预处理模块，提供测试辅助功能
|
||
|-- testable-agent ➜ JavaAgent模块，提供Mock测试相关功能
|
||
|-- testable-core ➜ 基础功能模块，提供Mock相关注解和工具类
|
||
|-- testable-maven-plugin ➜ Maven插件模块，用于简化JavaAgent注入
|
||
|-- demo
|
||
| |-- java-demo ➜ Java语言的示例代码
|
||
| `-- kotlin-demo ➜ Kotlin语言的示例代码
|
||
`-- docs ➜ 项目使用文档
|
||
```
|
||
|
||
## 构建项目
|
||
|
||
主项目使用JDK 1.6+和Maven 3+版本构建，其中`demo`子项目需要JDK 1.8+版本。
|
||
|
||
```bash
|
||
mvn clean install
|
||
```
|
||
|
||
## 本地生成文档
|
||
|
||
```bash
|
||
docsify serve docs
|
||
```
|
||
|
||
> TestableMock文档使用`docsify`工具生成，构建前请安装[nodejs](https://nodejs.org/en/download/)运行时，并使用`npm install -g docsify`命令安装文档生成工具。
|
||
|