JUnit报告--测试方法描述 [英] JUnit Reports -- Test Method Descriptions

问题描述

我正在尝试查看是否有一种方法可以通过javadoc在我的junit报告中包含"描述性文本"。JUnit4似乎不像TestNG那样支持@Test注释的"description"属性。

到目前为止，从我的研究来看，只有一个工具叫做javadoc-junit(http://javadoc-junit.sourceforge.net/)。但是，我无法让它工作，因为它似乎与Junit 4不兼容。

我想要的是通过某种方式在JUnit报告中的每个测试方法中提供一两句文本。JavaDoc不好，因为目标受众将不得不在JavaDoc和Junit报告之间来回切换才能查看文档和/或测试统计信息。

有没有人知道我还能用到什么，只需最小的努力？

最佳， 射线J

推荐答案

在JUnit 5中有一种使用@DisplayName注释每个测试的方法。声明的测试类可以有text、special characters和emojis。

test runners和test reports可以看到每个测试上声明的文本。

---

Javadoc表示：

public @interface DisplayName

@displayName用于声明带注释的测试类或测试方法的自定义显示名称。 显示名称通常用于IDE和生成工具中的测试报告，可以包含空格、特殊字符甚至表情符号。

和User Guide：

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() {
    }
}

这篇关于JUnit报告--测试方法描述的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！