testable-mock/docs/zh-cn/doc/use-maven-plugin.md

43 lines
2.0 KiB
Markdown
Raw Normal View History

2020-11-24 23:18:12 +08:00
使用Testable Maven插件
---
在使用Maven构建的项目里除了直接修改`maven-surefire-plugin`插件的运行参数,也可通过`testable-maven-plugin`插件获得相同效果:
```xml
<plugin>
<groupId>com.alibaba.testable</groupId>
<artifactId>testable-maven-plugin</artifactId>
<version>${testable.version}</version>
<executions>
<execution>
<id>prepare</id>
<goals>
<goal>prepare</goal>
</goals>
</execution>
</executions>
</plugin>
```
2020-12-17 13:17:56 +08:00
> 当使用`testable-maven-plugin`插件时,应该移除`maven-surefire-plugin`插件上的TestableMock相关配置
2020-11-24 23:18:12 +08:00
2020-11-26 07:04:41 +08:00
`testable-maven-plugin`插件能够与Jacoco插件直接同时使用无需额外适配因此能使`pom.xml`文件编写起来更简单且美观。
2020-11-24 23:18:12 +08:00
2020-12-17 13:17:56 +08:00
但需要注意的是当通过IDE运行单个测试用例时Mock功能会失效。
2020-11-24 23:18:12 +08:00
2020-11-26 07:04:41 +08:00
这是由于IDE运行单个测试用例时通常都只会运行`maven-surefire-plugin`插件,跳过了`testable-maven-plugin`插件执行导致Mock功能所需的JavaAgent没有随测试注入。
2020-12-19 22:43:51 +08:00
该问题可以通过额外配置IDE的测试参数绕过。以IntelliJ为例打开运行菜单的"编辑配置..."选型,如图中位置①
![modify-run-configuration](https://testable-code.oss-cn-beijing.aliyuncs.com/modify-run-configuration.png)
在"虚拟机参数"属性值末尾添加JavaAgent启动参数`-javaagent:${HOME}/.m2/repository/com/alibaba/testable/testable-agent/x.y.z/testable-agent-x.y.z.jar`,如图中位置②
2020-11-24 23:18:12 +08:00
> PS请将路径中的`x.y.z`替换成实际使用的版本号
2020-12-19 22:43:51 +08:00
![add-testable-javaagent](https://testable-code.oss-cn-beijing.aliyuncs.com/add-testable-javaagent.png)
最后点击运行单元测试,如图中位置③
2020-11-24 23:18:12 +08:00
2020-12-19 22:43:51 +08:00
总体来说,使用`testable-maven-plugin`带来的额外复杂性依然高于其对配置的简化作用。目前而言,直接在`pom.xml`文件中修改`maven-surefire-plugin`插件配置还是相对推荐的实用方案。