JUnit报告 - 测试方法描述

Question

我试图看看是否有办法通过javadocs在我的junit报告中包含"描述性文本".JUnit 4似乎不像TestNG那样支持@Test注释的'description'属性.

到目前为止,我所研究的只有一个工具叫做javadoc-junit(http://javadoc-junit.sourceforge.net/).但是我无法使用它,因为它似乎与Junit 4不兼容.

我想要的是在JUnit报告中用我的每个测试方法提供一个或两个文本的方法.JavaDoc并不好,因为目标受众必须在JavaDoc和Junit Report之间切换以查看文档和/或测试统计信息.

任何人都知道我能以最小的努力使用的其他东西吗？

最好的,雷杰

Answer 1

在JUnit 5有注释与每个测试的方式@DisplayName.声明的测试类可以有text,special characters和emojis.

每个测试的声明文本都是test runners和test reports.

该Javadoc中说:

public @interface DisplayName

@DisplayName用于为带注释的测试类或测试方法声明自定义显示名称.显示名称通常用于IDE和构建工具中的测试报告,可能包含空格,特殊字符甚至表情符号.

和用户指南:

import org.junit.gen5.api.DisplayName;
import org.junit.gen5.api.Test;

@DisplayName("A special test case")
class DisplayNameDemo {

    @Test
    @DisplayName("Custom test name containing spaces")
    void testWithDisplayNameContainingSpaces() {
    }

    @Test
    @DisplayName("?°?°??")
    void testWithDisplayNameContainingSpecialCharacters() {
    }

    @Test
    @DisplayName("")
    void testWithDisplayNameContainingEmoji() {
    }
}

Answer 2

还有一个名为Allure的最新解决方案.这是一个基于Java的测试执行报告,主要基于向代码添加补充注释.现有注释包括:

• 自定义说明:@Description("酷测试")
• 按功能或故事分组:@Features({"feature1","feature2"}),@ Stories({"story1","story2"})
• 在测试用例中执行的标记方法为步骤:@Step(甚至适用于私有方法)
• 附件:@Attachment(name ="Page screenshot",type ="image/png")

有关更多详细信息,请参阅其Wiki和示例项目.

Answer 3

我没有把javadoc放在JUnit测试中.我通常会使方法的名称描述性足够,因此它与我能提出的任何评论一样好或更好.