Macaca macaca-reporter-java-plugin (基于 java-junit5 的 macaca 测试报告)

shixing · 2020年04月06日 · 3989 次阅读

macaca-reporter-java-plugin（基于 java-junit5 的 macaca 测试报告）

目前 mcaca-reporter 对 java 的测试代码没有很好的支持，公司目前的自动化一直使用 macaca 配合 java 和 junit5 进行，在这基础上，
为支持开源，对 macaca-reporter 进行了一些研究，试图在 java 的基础上开发出一个适用于 java 的 macaca 测试报告。

目前我们产出了第一个版本，也就是当前的macaca-reporter-java-plugin。报告效果如下：

（图 1，据说适当打码有益身心健康）

（图 2）

（图 3）

如何使用 macaca-reporter-java-plugin

因为我们目前是基于 junit5 进行开发，所以第一步你可能要在你的测试代码中引入 junit5

一、 pom.xml 引入 junit5

<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-api</artifactId>
    <version>5.6.0</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-params</artifactId>
    <version>5.6.0</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-engine</artifactId>
    <version>5.6.0</version>
    <scope>test</scope>
</dependency>

二、引入 macaca-reporter-java-plugin

<dependency>
    <groupId>com.macacajs</groupId>
    <artifactId>macaca-reporter-java-plugin</artifactId>
    <version>1.0</version>
</dependency>

如果你已经使用了 junit5 完成了你的测试代码，不妨直接运行尝试一下结果。

如果你需要使用 junit5 开始改造你的代码，你可能需要了解下 junit5。

junit5 官方文档

macaca-reporter-java-plugin 实现原理源于官方文档的6.1.5 章节

三、开始改造你的代码

监听用例状态并给错误截图

建议使用 junit5 的@DisplayName特性，你可以通过给用例添加该注解配置用例对应的标题，在用例失败的时候使用 getDisplayName 方法去命名错误图片。

用例如果失败，macaca-reporter-java-plugin 将通过当前工程的目录./screenshot下去获取图片名，并通过 DisplayName 去比对，找到对应的图片转换为 Base64 图片码保存到报告中。

junit5 监听用例状态，并截图参考方法：


@ExtendWith(BaseTest.class)
public class BaseTest  implements TestWatcher {
      @BeforeAll
      static void beforeAll() { ... }
      @BeforeEach
      void setUp() { ... }
      @Test
      @DisplayName("失败的用例")
      void name() { ... }
      @AfterEach
      void tearDown() { ... }
      @AfterAll
      static void afterAll() { ... }
      @Override
      public void testFailed(ExtensionContext context, Throwable cause) {
         //截图方法。
         saveScreen(context.getDisplayName()+"_"+new SimpleDateFormat("yyyy_MM_dd_HH_mm_ss").format(new Date()));
      }          
}