使用Cucumber Java生成JUnit XML报告时如何自定义测试套件名称？

问题场景 #

我使用Cucumber Java进行Selenium UI测试，对应的feature文件如下：

@space
Feature: Login
  Background:
    Given Person launched the login page of web
  Scenario: web should accept accounts.dev login credentials
    And person enters valid domain id from line 1
    When Person enters valid Email and Password
    And Person clicks on the Login button
    Then Person should be authenticated

为了将测试结果同步至TestRail，我通过JUnit:cucumber-xml生成XML格式报告，但生成的报告中测试套件名称默认填充为插件名io.cucumber.core.plugin.JUnitFormatter，示例报告如下：

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<testsuite errors="0" failures="0" name="io.cucumber.core.plugin.JUnitFormatter" skipped="0" tests="1" time="4.889">
    <testcase classname="Login" name="Spacecloud should accept accounts.dev login credentials" time="4.724">
        <system-out><![CDATA[Given Person launched the login page of SpaceCloud..........................passed
And person enters valid domain id from line 1...............................passed
When Person enters valid Email and Password.................................passed
And Person clicks on the Login button.......................................passed
Then Person should be authenticated.........................................passed
]]></system-out>
    </testcase>
</testsuite>

尝试过使用@标签自定义，但未生效，想了解如何自定义测试套件名称。

解决方法 #

方法1：通过配置参数直接指定 #

Cucumber 6.0及以上版本支持通过cucumber.junit-suite-name参数自定义测试套件名称，无需修改代码。

Maven配置方式

在pom.xml中配置Surefire插件，添加该参数：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>3.1.2</version>
    <configuration>
        <properties>
            <property>
                <name>cucumber.junit-suite-name</name>
                <value>Web登录测试套件</value>
            </property>
        </properties>
    </configuration>
</plugin>

命令行运行方式

直接在测试命令中添加参数：

mvn test -Dcucumber.junit-suite-name="Web登录测试套件"

方法2：自定义JUnitFormatter实现动态控制 #

如果需要根据Feature标签、环境等动态生成套件名称，可以自定义一个继承JUnitFormatter的插件类：

import io.cucumber.core.plugin.JUnitFormatter;
import io.cucumber.core.runner.Runner;

public class CustomJUnitSuiteFormatter extends JUnitFormatter {
    public CustomJUnitSuiteFormatter(Appendable out) {
        super(out);
    }

    @Override
    public void startTestRun(Runner runner) {
        // 可根据Feature的标签或其他逻辑生成自定义名称
        String customSuiteName = "SpaceCloud登录测试套件";
        // 替换默认的套件名称
        super.testSuite.setName(customSuiteName);
        super.startTestRun(runner);
    }
}

运行时指定使用该自定义插件：

mvn test -Dcucumber.plugin="com.yourpackage.CustomJUnitSuiteFormatter:target/cucumber-junit.xml"

注意事项 #

• 确保使用的Cucumber版本在6.0以上，否则cucumber.junit-suite-name参数不生效
• 自定义套件名称时，建议与TestRail中的目标测试套件名称保持一致，方便结果同步映射

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