编写分片式 IRemoteTest 测试运行程序

在编写测试运行程序时,考虑可扩展性非常重要。问问自己,“如果我的测试运行程序必须运行 20 万个测试用例”,需要多长时间?

分片是 Trade Federation 中可用的解决方案之一。它需要将运行程序所需的所有测试拆分为可以并行化的多个块。

本页介绍如何使您的运行程序可分片,以用于 Tradefed。

需要实现的接口

要被 TF 视为可分片的,最需要实现的接口是 IShardableTest,其中包含两个方法:split(int numShard)split()

如果您的分片将取决于请求的分片数量,则应实现 split(int numShard)。否则,实现 split()

当使用分片参数 --shard-count--shard-index 执行 TF 测试命令时,TF 会遍历所有 IRemoteTest 以查找实现 IShardableTest 的测试。如果找到,它将调用 split 以获取新的 IRemoteTest 对象,从而为特定分片运行测试用例的子集。

关于 split 实现,我应该了解什么?

  • 您的运行程序可能仅在某些条件下分片;在这种情况下,如果您没有分片,则返回 null
  • 尝试尽可能多地进行分片:将您的运行程序拆分为对其有意义的执行单元。这实际上取决于您的运行程序。例如:HostTest 是在类级别进行分片的,每个测试类都放在一个单独的分片中。
  • 如果有意义,请添加一些选项来稍微控制分片。例如:AndroidJUnitTest 具有 ajur-max-shard,用于指定它可以拆分的最大分片数,而与请求的数量无关。

详细的示例实现

这是一个实现 IShardableTest 的示例代码片段,您可以参考。完整代码位于 (https://android.googlesource.com/platform/tools/tradefederation/+/refs/heads/main/test_framework/com/android/tradefed/testtype/InstalledInstrumentationsTest.java)。

/**
 * Runs all instrumentation found on current device.
 */
@OptionClass(alias = "installed-instrumentation")
public class InstalledInstrumentationsTest
        implements IDeviceTest, IResumableTest, IShardableTest {
    ...

    /** {@inheritDoc} */
    @Override
    public Collection<IRemoteTest> split(int shardCountHint) {
        if (shardCountHint > 1) {
            Collection<IRemoteTest> shards = new ArrayList<>(shardCountHint);
            for (int index = 0; index < shardCountHint; index++) {
                shards.add(getTestShard(shardCountHint, index));
            }
            return shards;
        }
        // Nothing to shard
        return null;
    }

    private IRemoteTest getTestShard(int shardCount, int shardIndex) {
        InstalledInstrumentationsTest shard = new InstalledInstrumentationsTest();
        try {
            OptionCopier.copyOptions(this, shard);
        } catch (ConfigurationException e) {
            CLog.e("failed to copy instrumentation options: %s", e.getMessage());
        }
        shard.mShardIndex = shardIndex;
        shard.mTotalShards = shardCount;
        return shard;
    }
    ...
}

此示例只是创建了自身的新实例并为其设置了分片参数。但是,拆分逻辑可能因测试而异;只要它是确定性的并且产生集体详尽的子集,就可以。

独立性

分片需要是独立的!您的运行程序中 split 的实现创建的两个分片不应相互依赖或共享资源。

分片拆分需要是确定性的!这也是强制性的,在相同条件下,您的 split 方法应始终返回完全相同的分片列表,且顺序相同。

注意:由于每个分片都可以在不同的 TF 实例上运行,因此至关重要的是要确保 split 逻辑产生的子集是互斥且集体详尽的,并且是以确定性的方式进行的。

在本地分片测试

要在本地 TF 上分片测试,您只需将 --shard-count 选项添加到命令行即可。

tf >run host --class com.android.tradefed.UnitTests --shard-count 3

然后,TF 将自动为每个分片生成命令并运行它们。

tf >l i
Command Id  Exec Time  Device          State
3           0m:03      [null-device-2]  running stub on build 0 (shard 1 of 3)
3           0m:03      [null-device-1]  running stub on build 0 (shard 0 of 3)
3           0m:03      [null-device-3]  running stub on build 0 (shard 2 of 3)

测试结果聚合

由于 TF 不会对分片调用执行任何测试结果聚合,因此您需要确保您的报告服务支持它。