使用JavaDoc丰富JUnit测试报告

Question

对于客户，我们需要为集成测试生成详细的测试报告，该报告不仅显示所有内容都是绿色的，而且还显示测试的结果。我的同事和我都是懒惰的人，我们不想破坏电子表格或文本文档。

为此，我想到了一种在每个@Test带注释的方法和每个测试类上使用JavaDoc注释记录更复杂的集成测试的方法。对于测试人员来说，查看哪个要求，Jira票证或测试所链接的内容以及测试实际尝试执行的操作是一个很好的帮助。我们也希望将此信息提供给我们的客户。

现在的主要问题是：如何将每种方法和每个测试类的JavaDoc放入JUnit报告中？我们使用JUnit 4.9和Maven。

我知道，每个assertXXX（）都有一个描述，但是我们确实需要一个漂亮的HTML列表作为结果，或者一个PDF文档，其中列出了所有类以及那里的文档，下面是所有@Test方法及其描述，测试时间，结果以及失败的原因。

还是有另一种方法可以生成精美的测试脚本？（或者我们应该在此上启动一个开源项目！？;-)）

更新：
我问了另一个问题，关于如何向Eclipse中添加RunListener以使其在Eclipse中启动时也能在Eclipse中报告。带有自定义TestRunner的建议解决方案是获得测试结果报告的另一种可能性。

Answer 1

实现此目标的一种方法是使用自定义RunListener，但要注意的是，使用批注而不是javadoc会更容易。您将需要具有一个自定义注释，例如：

@TestDoc(text="tests for XXX-342, fixes customer issue blahblah")
@Test
public void testForReallyBigThings() {
    // stuff
}

RunListener 监听测试事件，例如测试开始，测试结束，测试失败，测试成功等。

public class RunListener {
    public void testRunStarted(Description description) throws Exception {}
    public void testRunFinished(Result result) throws Exception {}
    public void testStarted(Description description) throws Exception {}
    public void testFinished(Description description) throws Exception {}
    public void testFailure(Failure failure) throws Exception {}
    public void testAssumptionFailure(Failure failure) {}
    public void testIgnored(Description description) throws Exception {}
}

Description包含应用于测试方法的注释列表，因此使用上面的示例，您可以使用以下方法获取Annotation
TestDoc：

description.getAnnotation(TestDoc.class);

并正常提取文本。

然后，您可以使用RunListener生成所需的文件，以及该测试的专用文本，测试是通过还是失败，是否被忽略，花费的时间等。这将是您的自定义报告。

然后，在surefire中，您可以使用以下命令指定自定义侦听器：

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-surefire-plugin</artifactId>
  <version>2.10</version>
  <configuration>
    <properties>
      <property>
        <name>listener</name>
        <value>com.mycompany.MyResultListener,com.mycompany.MyResultListener2</value>
      </property>
  </configuration>
</plugin>

这是来自MavenSurefire插件，使用JUnit，使用自定义侦听器和报告器

这种解决方案的缺点是，就格式返回而言，就回车而言您没有javadoc的灵活性，但是它的优点是文档位于一个特定的位置，即注释TestDoc。