mirror of
https://github.com/alibaba/testable-mock.git
synced 2025-01-09 20:00:21 +08:00
40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
|
# TestableMock
|
||
|
|
|
||
|
|
Write mock faster, make unit testing easier.
|
||
|
|
|
||
|
|
Any test framework, no initialization, no matter private method, static method, construction method, or any other method of any class, and no matter how the object created.
|
||
|
|
Write a mock method, add an `@MockMethod` annotation, everything is done.
|
||
|
|
|
||
|
|
Usage Document: https://alibaba.github.io/testable-mock/#/en-us/
|
||
|
|
|
||
|
|
## Directory Structure
|
||
|
|
|
||
|
|
```bash
|
||
|
|
|-- testable-parent ➜ Provide parent pom file shared by other modules
|
||
|
|
|-- testable-all ➜ Dependence aggration, for easily import all modules at once
|
||
|
|
|-- testable-processor ➜ Compile-time code preprocessing module, provides test assist functions
|
||
|
|
|-- testable-agent ➜ JavaAgent module, provides test mocking related functions
|
||
|
|
|-- testable-core ➜ Basic function module, provides Mock related class and annotation
|
||
|
|
|-- testable-maven-plugin ➜ Maven plugin module, for simplify JavaAgent injection
|
||
|
|
|-- demo
|
||
|
|
| |-- java-demo ➜ Java code example
|
||
|
|
| `-- kotlin-demo ➜ Kotlin code example
|
||
|
|
`-- docs ➜ Source code of usage document
|
||
|
|
```
|
||
|
|
|
||
|
|
## Build project
|
||
|
|
|
||
|
|
The project is built using JDK 1.6+ and Maven 3+, except for the `demo` sub-project requires JDK 1.8+.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
mvn clean install
|
||
|
|
```
|
||
|
|
|
||
|
|
## Generate document
|
||
|
|
|
||
|
|
```bash
|
||
|
|
docsify serve docs
|
||
|
|
```
|
||
|
|
|
||
|
|
> `TestableMock` document is generated by `docsify` tool, please install [nodejs](https://nodejs.org/en/download/) before execution, and run `npm install -g docsify` command to install the tool required.
|