将自定义注释挂接到 Maven 中的 JUnit 测试器
Hook custom annotation to the JUnit Tester in Maven
当前,当 运行 构建一个 Maven 时,我所有的测试都是 运行 并且一个 surefire-report 被创建为一个 XML 日志(称为 TEST-my.project.TestApp) .
我创建了我自己的自定义注解,@Trace(RQ = "requirement it tests") 以便 link 我的测试符合它正在验证的特定要求。
我想要的是,当在构建期间使用 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 class 运行ner?或者如何将它连接到创建报告的 surefire 插件?
好的,我设法做了一些对我来说非常有效的事情:
首先我做我的自定义注释:
@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 报告或其他任何东西。
当前,当 运行 构建一个 Maven 时,我所有的测试都是 运行 并且一个 surefire-report 被创建为一个 XML 日志(称为 TEST-my.project.TestApp) .
我创建了我自己的自定义注解,@Trace(RQ = "requirement it tests") 以便 link 我的测试符合它正在验证的特定要求。
我想要的是,当在构建期间使用 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 class 运行ner?或者如何将它连接到创建报告的 surefire 插件?
好的,我设法做了一些对我来说非常有效的事情:
首先我做我的自定义注释:
@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 报告或其他任何东西。