将自定义注释挂钩到Maven中的JUnit Tester

时间:2017-02-02 13:39:38

标签: java maven junit annotations surefire

目前,当运行maven构建时,我的所有测试都会运行,并且会将surefire-report创建为XML日志(称为TEST-my.project.TestApp)。

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

我想要的是,在构建期间使用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类运行器?或者如何将它挂钩到创建报告的surefire插件?

1 个答案:

答案 0 :(得分:2)

好的,我设法做了一些非常适合我的事情:

首先我做自定义注释:

@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 build中生成我自己的xml报告,其中我有需求和测试之间的关联,我可以进一步用它来生成HTML报告或其他任何内容。