如何为Serenity JUnit测试用例添加自定义描述？

嘿，我来给你分享几种能给Serenity JUnit测试用例添加自定义描述的方法，让你的测试报告更清晰易懂：

方法1：用JUnit 5的@DisplayName注解（推荐JUnit 5环境） #

如果你的项目用的是JUnit 5（Jupiter），直接给测试方法加上@DisplayName注解就能轻松自定义显示名称，还能加上详细的描述信息：

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

@Test
@DisplayName("测试示例：验证核心业务流程的完整执行")
public void testSample() {
    step.callStep();
    step.callStepTwo();
}

这样Serenity生成的HTML报告里，这个测试用例就会显示你设置的这个详细名称，替代默认的“Test Sample”。

方法2：用Serenity专属的@Title注解 #

Serenity自己提供了@Title注解，专门用来给测试用例添加更丰富的描述，甚至支持多行文本，让描述更结构化：

import net.serenitybdd.junit.runners.SerenityRunner;
import net.serenitybdd.annotations.Title;
import org.junit.Test;
import org.junit.runner.RunWith;

@RunWith(SerenityRunner.class)
public class YourTestClass {

    @Test
    @Title("用户核心操作流程验证\n- 调用第一步服务完成初始化\n- 调用第二步服务完成业务闭环")
    public void testSample() {
        step.callStep();
        step.callStepTwo();
    }
}

这个注解的好处是能支持换行和分点描述，在Serenity报告里会完整展示这些内容，让测试的意图一目了然。

方法3：动态设置测试描述（适合运行时调整的场景） #

如果需要根据测试运行时的参数或状态动态生成描述，可以用Serenity的Serenity.setTestDescription()方法：

import net.serenitybdd.core.Serenity;
import org.junit.Test;

@Test
public void testSample() {
    // 可以根据实际场景动态生成描述内容
    Serenity.setTestDescription("动态测试描述：本次测试验证了两个核心步骤的协同执行逻辑");
    step.callStep();
    step.callStepTwo();
}

这种方式灵活度很高，适合需要动态调整描述的测试场景。

内容的提问来源于stack exchange，提问作者Viraj