{"id":20630209,"url":"https://github.com/macacajs/macaca-reporter-java-plugin","last_synced_at":"2025-04-15T18:20:00.961Z","repository":{"id":37134003,"uuid":"244830207","full_name":"macacajs/macaca-reporter-java-plugin","owner":"macacajs","description":"Macaca Reporter Plugin For Java","archived":false,"fork":false,"pushed_at":"2022-06-17T02:58:09.000Z","size":532,"stargazers_count":10,"open_issues_count":2,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-15T18:19:55.803Z","etag":null,"topics":["java","macaca","plugin","reporter"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/macacajs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-04T06:59:59.000Z","updated_at":"2025-03-10T10:56:35.000Z","dependencies_parsed_at":"2022-09-04T06:50:57.455Z","dependency_job_id":null,"html_url":"https://github.com/macacajs/macaca-reporter-java-plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/macacajs%2Fmacaca-reporter-java-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/macacajs%2Fmacaca-reporter-java-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/macacajs%2Fmacaca-reporter-java-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/macacajs%2Fmacaca-reporter-java-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/macacajs","download_url":"https://codeload.github.com/macacajs/macaca-reporter-java-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249126056,"owners_count":21216716,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java","macaca","plugin","reporter"],"created_at":"2024-11-16T14:07:12.321Z","updated_at":"2025-04-15T18:20:00.938Z","avatar_url":"https://github.com/macacajs.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Macaca Reporter Plugin For Java\n\n---\n\n[![Build Status](https://www.travis-ci.org/macacajs/macaca-reporter-java-plugin.svg?branch=master)](https://travis-ci.org/macacajs/macaca-reporter-java-plugin)\n[ ![Download](https://api.bintray.com/packages/macaca/macaca-reporter-java-plugin/macaca-reporter-java-plugin/images/download.svg?version=1.0) ](https://bintray.com/macaca/macaca-reporter-java-plugin/macaca-reporter-java-plugin/1.0/link)\n\n\u003c!-- GITCONTRIBUTOR_START --\u003e\n\n## Contributors\n\n|[\u003cimg src=\"https://avatars3.githubusercontent.com/u/50022460?v=4\" width=\"100px;\"/\u003e\u003cbr/\u003e\u003csub\u003e\u003cb\u003ehouseshi\u003c/b\u003e\u003c/sub\u003e](https://github.com/houseshi)\u003cbr/\u003e|[\u003cimg src=\"https://avatars1.githubusercontent.com/u/5117373?v=4\" width=\"100px;\"/\u003e\u003cbr/\u003e\u003csub\u003e\u003cb\u003eniaoshuai\u003c/b\u003e\u003c/sub\u003e](https://github.com/niaoshuai)\u003cbr/\u003e|\n| :---: | :---: | \n\n\u003c!-- GITCONTRIBUTOR_END --\u003e\n\n## 使用方法\n\n此工程是 [macaca-reporter](//github.com/macacajs/macaca-reporter) 的 maven 插件，你只需要在 pom.xml 文件中引入该插件即可，并使用 mvn 执行测试即可。\n\n注意: 若是下载不到,请配置阿里云 maven 仓库\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.macacajs\u003c/groupId\u003e\n    \u003cartifactId\u003emacaca-reporter-java-plugin\u003c/artifactId\u003e\n    \u003cversion\u003e1.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n[中文文档](./docs/guide.md)\n\n## 依赖于 junit5 的实现\n\n#### 实现原理\n\njunit5 定制了 API 方法 TestExecutionListener，实现此方法可监听测试过程，在工程目录 `/resources`中文件中添加 `/META-INF/services/org.junit.platform.launcher.TestExecutionListener`，将自动加载和注册。\n\n测试计划运行过程中，我们通过 TestExecutionListener 接口抓取我们需要的数据，根据 macaca-report 所需要的 json 数据，组合出对应的 json。\n\n计划运行完毕，通过 `macaca-reporter -d 'test/fixtures/final` 生成报告的功能，产出对应的 Macaca 测试报告。\n\n## 测试报告和json的保存位置\n\njson会保存到当前工程目录的`report.js`文件。报告文件也会即时生成保存到当前工程目录的 `./reports/index.html`。测试运行完成，你只需要查看`./reports/index.html`即可。\n\n## 功能\n\n### 关于截图：\n\n测试运行过程中用例如果执行失败，会在当前工程目录下的 `./screenshot` 文件中进行抓取，根据 `junit5` 的 `DisplayName` 特性，获取文件名称并检查是否有包含该条测试的截图，将其转换为 Base64 图片编码，保存到json数据中。\n\n所以建议保存截图使用 `DisplayName` 的方式命名，否则可能获取不到截图。\n\n如：\n\n```java\n@Override\npublic void testFailed(ExtensionContext context, Throwable cause) {\n    saveScreen(context.getDisplayName()+\"_\"+new SimpleDateFormat(\"yyyy_MM_dd_HH_mm_ss\").format(new Date()));\n}\n```\n\n### 关于测试面板\n\n我们引入了 Macaca Current 的特性，你可以通过mvn命令指定增加项目 logo 图片。\n引入之后会在首页显示出 Current Screen 、 Current status 两项，你也可以忽略这项功能。\n\n```bash\n$ mvn test -Dlogo=https://macacajs.github.io/macaca-logo/svg/monkey.svg\n```\n\n具体效果可以参考测试类：`MacacaTestExecutionListenerTest` 生成的测试结果。\n\n### 关于测试计划名称\n\n同测试面板，可以使用mvn进行配置 ，默认名称“Macaca测试报告”。\n\n```bash\n$ mvn test -DplanName=这是一个测试计划名称\n```\n\n## 基于 gitLab CI 自动执行\n\n我们增加了 gitLab CI 的配置模板，可供参考 详见 `gitlab-ci.yml` 文件。\n\n## Sample\n\n![图1](docs/image/macaca1.png)\n\n![图2](docs/image/macaca2.png)\n\n![图3](docs/image/macaca3.png)\n\n## License\n\nThe MIT License (MIT)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmacacajs%2Fmacaca-reporter-java-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmacacajs%2Fmacaca-reporter-java-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmacacajs%2Fmacaca-reporter-java-plugin/lists"}