https://github.com/macacajs/macaca-reporter-java-plugin
Macaca Reporter Plugin For Java
https://github.com/macacajs/macaca-reporter-java-plugin
java macaca plugin reporter
Last synced: 6 months ago
JSON representation
Macaca Reporter Plugin For Java
- Host: GitHub
- URL: https://github.com/macacajs/macaca-reporter-java-plugin
- Owner: macacajs
- Created: 2020-03-04T06:59:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-06-17T02:58:09.000Z (over 3 years ago)
- Last Synced: 2025-04-15T18:19:55.803Z (6 months ago)
- Topics: java, macaca, plugin, reporter
- Language: Java
- Homepage:
- Size: 520 KB
- Stars: 10
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Macaca Reporter Plugin For Java
---
[](https://travis-ci.org/macacajs/macaca-reporter-java-plugin)
[  ](https://bintray.com/macaca/macaca-reporter-java-plugin/macaca-reporter-java-plugin/1.0/link)
## Contributors
|[
houseshi](https://github.com/houseshi)
|[
niaoshuai](https://github.com/niaoshuai)
|
| :---: | :---: |
## 使用方法
此工程是 [macaca-reporter](//github.com/macacajs/macaca-reporter) 的 maven 插件，你只需要在 pom.xml 文件中引入该插件即可，并使用 mvn 执行测试即可。
注意: 若是下载不到,请配置阿里云 maven 仓库
```xml
com.macacajs
macaca-reporter-java-plugin
1.0
```
[中文文档](./docs/guide.md)
## 依赖于 junit5 的实现
#### 实现原理
junit5 定制了 API 方法 TestExecutionListener，实现此方法可监听测试过程，在工程目录 `/resources`中文件中添加 `/META-INF/services/org.junit.platform.launcher.TestExecutionListener`，将自动加载和注册。
测试计划运行过程中，我们通过 TestExecutionListener 接口抓取我们需要的数据，根据 macaca-report 所需要的 json 数据，组合出对应的 json。
计划运行完毕，通过 `macaca-reporter -d 'test/fixtures/final` 生成报告的功能，产出对应的 Macaca 测试报告。
## 测试报告和json的保存位置
json会保存到当前工程目录的`report.js`文件。报告文件也会即时生成保存到当前工程目录的 `./reports/index.html`。测试运行完成，你只需要查看`./reports/index.html`即可。
## 功能
### 关于截图：
测试运行过程中用例如果执行失败，会在当前工程目录下的 `./screenshot` 文件中进行抓取，根据 `junit5` 的 `DisplayName` 特性，获取文件名称并检查是否有包含该条测试的截图，将其转换为 Base64 图片编码，保存到json数据中。
所以建议保存截图使用 `DisplayName` 的方式命名，否则可能获取不到截图。
如：
```java
@Override
public void testFailed(ExtensionContext context, Throwable cause) {
saveScreen(context.getDisplayName()+"_"+new SimpleDateFormat("yyyy_MM_dd_HH_mm_ss").format(new Date()));
}
```
### 关于测试面板
我们引入了 Macaca Current 的特性，你可以通过mvn命令指定增加项目 logo 图片。
引入之后会在首页显示出 Current Screen 、 Current status 两项，你也可以忽略这项功能。
```bash
$ mvn test -Dlogo=https://macacajs.github.io/macaca-logo/svg/monkey.svg
```
具体效果可以参考测试类：`MacacaTestExecutionListenerTest` 生成的测试结果。
### 关于测试计划名称
同测试面板，可以使用mvn进行配置 ，默认名称“Macaca测试报告”。
```bash
$ mvn test -DplanName=这是一个测试计划名称
```
## 基于 gitLab CI 自动执行
我们增加了 gitLab CI 的配置模板，可供参考 详见 `gitlab-ci.yml` 文件。
## Sample
## License
The MIT License (MIT)