testable-mock/README_EN.md

47 lines
1.8 KiB
Markdown
Raw Normal View History

2020-12-23 08:45:53 +08:00
# 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.
2021-11-03 11:44:44 +08:00
Write a mock method, add an `@MockInvoke` annotation, everything is done.
2020-12-23 08:45:53 +08:00
Usage Document: https://alibaba.github.io/testable-mock/#/en-us/
## Roadmap
2021-02-01 23:49:16 +08:00
2022-02-02 19:40:53 +08:00
`TestableMock` is still under heavy development, if you get sucked somehow, just go ahead raise an [issue](https://github.com/alibaba/testable-mock/issues) for it.
2021-02-01 23:49:16 +08:00
2020-12-23 08:45:53 +08:00
## 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
2020-12-24 16:14:18 +08:00
|-- testable-core ➜ Basic function module, provides mock related class and annotation
2020-12-23 08:45:53 +08:00
|-- testable-maven-plugin ➜ Maven plugin module, for simplify JavaAgent injection
2021-04-01 09:22:28 +08:00
|-- tool ➜ Scripts for project maintain
2020-12-23 08:45:53 +08:00
|-- demo
| |-- java-demo ➜ Java code example
2022-02-02 19:40:53 +08:00
| |-- kotlin-demo ➜ Kotlin code example
| |-- android-demo ➜ Android app code example
| `-- spock-demo ➜ Spock framwork code example
2020-12-23 08:45:53 +08:00
`-- 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.