基于Java的Gatling如何生成JUnit XML断言结果报告？

Gatling本身没有内置JUnit XML格式的断言结果输出，但可以通过自定义逻辑捕获断言状态，手动生成符合规范的机器可读XML文件，具体实现如下：

核心思路 #

通过Gatling Simulation的生命周期钩子（如after方法）捕获所有断言的执行结果，再按照JUnit XML的结构规范拼接内容并写入文件。

具体实现步骤 #

1. 捕获断言执行结果 #

在你用Java编写的Gatling Simulation类中，重写after方法，提取断言的成功/失败状态、描述及失败信息：

import io.gatling.javaapi.core.Simulation;
import io.gatling.javaapi.core.Assertion;
import java.util.ArrayList;
import java.util.List;

public class LoadTestSimulation extends Simulation {

    // 这里定义你的场景、断言等配置...

    @Override
    public void after() {
        List<JUnitTestResult> testResults = new ArrayList<>();
        
        // 遍历所有断言，提取结果
        for (Assertion assertion : getAssertions()) {
            boolean isSuccess = assertion.result().isSuccess();
            String assertionName = assertion.toString();
            String failureMsg = isSuccess ? "" : assertion.result().message().orElse("断言失败");
            
            testResults.add(new JUnitTestResult(assertionName, isSuccess, failureMsg));
        }
        
        // 生成JUnit XML文件
        generateJUnitXml(testResults);
    }

    // 辅助类：存储单条断言结果
    private static class JUnitTestResult {
        String name;
        boolean success;
        String failureMessage;

        public JUnitTestResult(String name, boolean success, String failureMessage) {
            this.name = name;
            this.success = success;
            this.failureMessage = failureMessage;
        }
    }
}

2. 生成JUnit XML文件 #

实现generateJUnitXml方法，按照JUnit XML的标准结构拼接内容并写入文件：

import java.io.FileWriter;
import java.io.IOException;
import java.util.List;

private void generateJUnitXml(List<JUnitTestResult> testResults) {
    int totalTests = testResults.size();
    int failedTests = (int) testResults.stream().filter(r -> !r.success).count();
    
    // 构建XML内容
    StringBuilder xmlContent = new StringBuilder();
    xmlContent.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
    xmlContent.append(String.format("<testsuite name=\"GatlingAssertions\" tests=\"%d\" failures=\"%d\">\n", totalTests, failedTests));
    
    for (JUnitTestResult result : testResults) {
        xmlContent.append(String.format("  <testcase name=\"%s\">\n", escapeXml(result.name)));
        if (!result.success) {
            xmlContent.append(String.format("    <failure message=\"%s\"/>\n", escapeXml(result.failureMessage)));
        }
        xmlContent.append("  </testcase>\n");
    }
    
    xmlContent.append("</testsuite>");
    
    // 写入文件（可自行调整输出路径，比如Gatling默认报告目录target/gatling）
    try (FileWriter writer = new FileWriter("gatling-assertions-results.xml")) {
        writer.write(xmlContent.toString());
    } catch (IOException e) {
        System.err.println("生成JUnit XML报告失败：" + e.getMessage());
    }
}

// XML特殊字符转义，避免格式错误
private String escapeXml(String input) {
    if (input == null) return "";
    return input.replace("&", "&amp;")
                .replace("<", "&lt;")
                .replace(">", "&gt;")
                .replace("\"", "&quot;")
                .replace("'", "&apos;");
}

3. 关键注意事项 #

• 断言结果提取：Gatling的Assertion.result()返回AssertionResult对象，通过isSuccess()判断状态，message()获取失败详情（注意是Optional类型）。
• XML格式合规：必须对特殊字符进行转义，否则生成的XML会无法被解析工具识别。
• 路径配置：建议将输出文件放在Gatling的默认报告目录（如target/gatling），方便与HTML报告统一管理。

进阶方案：使用ReportingExtension扩展 #

如果需要更深度的集成，可以实现Gatling的ReportingExtension接口，在测试运行结束时自动触发JUnit XML生成：

import io.gatling.core.reporting.ReportingExtension;
import io.gatling.core.stats.StatsEngine;
import io.gatling.core.stats.writer.RunMessage;

public class JUnitReportExtension implements ReportingExtension {

    @Override
    public void initialize(StatsEngine statsEngine) {
        // 可在此注册监听，捕获断言结果
    }

    @Override
    public void onRunStart(RunMessage runMessage) {
        // 测试启动时的初始化操作
    }

    @Override
    public void onRunEnd() {
        // 测试结束时调用生成JUnit XML的逻辑
        generateJUnitXml(/* 传入断言结果 */);
    }
}

注册该扩展后，Gatling启动时会自动加载，无需在Simulation中手动调用。

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