如何为Android Espresso测试生成的JUnit.xml添加自定义属性？

我使用JUnit4注解运行Android Espresso测试，测试完成后生成的JUnit.xml内容如下：

<?xml version="1.0"?>
<testsuites tests="1" failures="0" name="UITests" time="12">
    <testsuite tests="1" failures="0" name="Test" time="232.9559440612793">
        <testcase classname="Test" name="test()" time="42.36027908325195">
        </testcase>
    </testsuite>
</testsuites>

为了将测试用例导入到测试用例管理工具，我需要在该XML文件中添加自定义属性，期望得到的结果如下：

<?xml version="1.0"?>
<testsuites tests="1" failures="0" name="UITests" time="12">
    <testsuite tests="1" failures="0" name="Test" time="232.9559440612793">
        <testcase classname="Test" name="test()" time="42.36027908325195">
            <properties>
                <!-- using a custom "test_id" property -->
                <property name="test_id" value="1234567" />
            </properties>
        </testcase>
    </testsuite>
</testsuites>

请问是否可以通过自定义注解这类简便方式实现这一需求？

可以通过自定义注解+扩展JUnit4测试报告生成逻辑实现，以下是具体步骤：

1. 定义自定义测试ID注解 #

创建一个用于标记测试用例唯一ID的运行时注解：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface TestId {
    String value();
}

2. 用注解标记测试方法 #

在你的Espresso测试方法上添加该注解，指定对应的测试ID：

public class Test {
    @Test
    @TestId("1234567")
    public void test() {
        // 你的Espresso测试逻辑
    }
}

3. 自定义JUnit XML报告生成器 #

Android默认的JUnit XML报告由JUnitXmlReporter生成，我们可以继承该类，在写入测试用例节点时插入自定义属性：

public class CustomJUnitXmlReporter extends JUnitXmlReporter {
    public CustomJUnitXmlReporter(File reportDir, String reportName) {
        super(reportDir, reportName);
    }

    @Override
    protected void writeTestCase(XMLSerializer serializer, Description description, long elapsedTime, Throwable failure) throws IOException {
        // 先写入默认的testcase基础内容
        super.writeTestCase(serializer, description, elapsedTime, failure);
        
        // 检查当前测试方法是否带有TestId注解
        TestId testIdAnnotation = description.getAnnotation(TestId.class);
        if (testIdAnnotation != null) {
            // 插入properties节点及自定义test_id属性
            serializer.startTag(null, "properties");
            serializer.startTag(null, "property");
            serializer.attribute(null, "name", "test_id");
            serializer.attribute(null, "value", testIdAnnotation.value());
            serializer.endTag(null, "property");
            serializer.endTag(null, "properties");
        }
    }
}

4. 自定义测试运行器 #

继承AndroidJUnitRunner，替换默认的XML报告生成器为我们自定义的版本：

public class CustomTestRunner extends AndroidJUnitRunner {
    @Override
    public void onCreate(Bundle arguments) {
        super.onCreate(arguments);
        // 设置自定义的XML报告生成器
        File reportDir = new File(getTargetContext().getExternalFilesDir(null), "test-reports");
        setJUnitXmlReporter(new CustomJUnitXmlReporter(reportDir, "junit-report.xml"));
    }
}

5. 配置项目使用自定义测试运行器 #

在app模块的build.gradle中指定自定义测试运行器：

android {
    defaultConfig {
        testInstrumentationRunner "com.yourpackage.CustomTestRunner"
    }
}

完成以上配置后，运行Espresso测试时，生成的JUnit.xml会自动包含带有test_id的properties节点。

如果不想自定义测试运行器，也可以在测试完成后用脚本（如Python/Shell）批量修改XML文件，但这种方式自动化程度不如注解+自定义运行器方案。

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