java - 将自定义注释 Hook 到 Maven 中的 JUnit 测试器

Question

当前，当运行 Maven 构建时，我的所有测试都会运行，并且会创建一个 Surefire-report 作为 XML 日志(称为 TEST-my.project.TestApp)。

我创建了自己的自定义注释 @Trace(RQ = "requirement ittests") 以便将我的测试链接到它正在验证的某个需求。

我想要的是，当在构建期间使用 Maven 运行测试时，在 Surefire-reports 中生成的 XML 日志中而不是:

<testcase time="0.113" classname="my.project.TestApp" name="FirstTest"/>

我应该得到:

<testcase time="0.113" classname="my.project.TestApp" name="FirstTest">
  <traceability>requirement it tests</traceability>
</testcase>

我的问题是:

如何将我的注释和所述注释处理的实现与 Maven 构建时使用的 JUnit 类运行器 Hook ？或者如何将其连接到创建报告的 Surefire 插件？

Answer 1

好吧，我成功地做了一些对我来说非常有效的事情:

首先我进行自定义注释:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD) //can use in method only.
public @interface Trace {
    public String[] RQ() default "";
}

然后我做一个监听器:

public class TestLogger extends RunListener {
private static Map<String[], String[]> requirementsMap = new LinkedHashMap<String[], String[]>();

public void testFinished(Description description) {
    if (description.getAnnotation(Trace.class) != null){
        String[] testDescription = { description.getClassName(), description.getMethodName() };
        requirementsMap.put(testDescription, description.getAnnotation(Trace.class).RQ());
    }
}

@Override
public void testRunFinished(Result result) throws Exception {

    XMLRequirementsReporter writer = new XMLRequirementsReporter();
    writer.writeXMLReport(requirementsMap);
    super.testRunFinished(result);
    }
}

然后我创建自己的 Junit 测试运行程序，在其中添加监听器:

public class TestRunner extends BlockJUnit4ClassRunner
{
    public TestRunner(Class<?> klass) throws InitializationError
    {
         super(klass);
    }

    @Override
    public void run(RunNotifier notifier)
    {
        notifier.addListener(new TestLogger()); 
        super.run(notifier);
    }
}

最后，我将以下内容添加到 pom XML:

<dependencies>
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
    </dependency>
</dependencies>

<build>
    <resources>
        <resource>
            <directory></directory>
            <targetPath>${project.build.directory}/surefire-reports</targetPath>
            <includes>
                <include>TEST-Traceability.xml</include>
            </includes>
            <filtering>true</filtering>
        </resource>
    </resources>
<build>

这将在 maven 构建中生成我自己的 xml 报告，其中我在需求和测试之间建立了关联，并且我可以进一步使用它来生成 HTML 报告或任何其他内容。