mirror of
https://github.com/alibaba/testable-mock.git
synced 2025-01-10 20:30:11 +08:00
46 lines
2.3 KiB
Markdown
46 lines
2.3 KiB
Markdown
全局运行参数
|
||
---
|
||
|
||
`TestableMock`的许多功能采用了基于JavaAgent的运行时字节码修改实现。在JavaAgent启动时，可以通过额外的全局参数来调整`TestableMock`的执行过程。
|
||
|
||
### 可用参数清单
|
||
|
||
| 参数 | 描述 | 可用值和示例（`N/A`表示无需赋值） |
|
||
| ---- | ---- | ---- |
|
||
| logLevel | 修改全局日志级别 | 可用值为：`mute`（禁止打印警告） / `debug`（打印调试信息） / `verbose`（打印非常详细的调试信息） |
|
||
| dumpPath | 将修改过后的字节码保存到本地指定目录（用于排查问题） | 例如 `/tmp/bytecode`（需要此目录事先存在） |
|
||
| pkgPrefix | 限定`TestableMock`仅对部分包生效 | 使用`,`分隔的包路径前缀列表，例如 `com.demo.svc,com.demo.dao` |
|
||
| mockScope | 修改默认的Mock生效范围（详见[Mock生效范围](zh-cn/doc/scope-of-mock)） | 可用值为：`global`（全局生效） / `associated`（只对关联的测试用例生效） |
|
||
| useThreadPool | 启用基于`TransmittableThreadLocal`的Mock上下文存储（用于包含线程池的测试用例） | `N/A` |
|
||
|
||
### 参数的连接
|
||
|
||
若参数有值，参数名和值之间用`=`符合连接。例如：
|
||
|
||
`useThreadPool`、`logLevel=debug`、`dumpPath=/tmp/debug`
|
||
|
||
多个参数之间使用`&`符号连接，例如：
|
||
|
||
`useThreadPool&logLevel=debug`、`logLevel=debug&dumpPath=/tmp/debug`
|
||
|
||
### 添加运行参数
|
||
|
||
与其他基于JavaAgent的工具相似，`TestableMock`通过在单元测试引入`testable-agent`包的末尾加上一个`=`符号，然后连接额外参数来传递用户的自定义参数。
|
||
|
||
对于Maven项目，可将参数追加到`maven-surefire-plugin`参数`testable-agent`包尾部，紧接着`.jar`的位置。例如：
|
||
|
||
```xml
|
||
<configuration>
|
||
<argLine>-javaagent:${settings.localRepository}/com/alibaba/testable/testable-agent/${testable.version}/testable-agent-${testable.version}.jar=mockScope=associated&pkgPrefix=com.demo.</argLine>
|
||
</configuration>
|
||
```
|
||
|
||
> 注意：在`xml`文件中，连接参数的`&`符号需要写为`&`
|
||
|
||
对于Gradle项目，同样是直接将参数追加到引入`testable-agent`的配置末尾。例如：
|
||
|
||
|
||
```groovy
|
||
jvmArgs "-javaagent:${classpath.find { it.name.contains("testable-agent") }.absolutePath}=mockScope=associated&pkgPrefix=com.demo."
|
||
```
|