使用外部依赖项对apache beam有状态管道进行单元测试

Question

我有一个apache beam管道，它从pubsub读取数据，使用Redis丰富数据，最后写入pubsub。我试图编写测试来测试浓缩Dofn，这是一个有状态Dofn。在这里，内部状态充当近缓存，以减少对Redis的调用。为了实例化我的Redis客户机，我使用PipelineOptions中声明的工厂，例如

@Default.InstanceFactory(RedisClientFactory.class)
RedisClient getRedisClient();

void setRedisClient(RedisClient client);

理论上，上述客户机应该是每个工人的单人。在我的单元测试中，我试图模拟redis客户端中的一些东西。我的测试是这样的-

//setup pipeline
TestStream<MetricsInstance> inputStream =
        TestStream.create(...).advanceWatermarkToInfinity();
PCollection<MetricsInstance> enrichedDataStream  = pipeline.apply(inputStream)
.apply(ParDo.of(new ConvertToKeyValuePairDoFn<>()))
.apply(ParDo.of(new EnrichMetricsInstanceDoFn()));


CommonPipelineOptions options = PipelineOptionsFactory.as(CommonPipelineOptions.class);
RedisClient redisClient = options.getRedisClient();
JedisPool jedisPool = Mockito.mock(JedisPool.class);
jedis = Mockito.mock(Jedis.class);
Mockito.when(jedisPool.getResource()).thenReturn(jedis);
redisClient.setPool(jedisPool);
... some stubbing code and finally the pipeline run
PAssert.that(enrichedDataStream).containsInAnyOrder(expectedDataStream);
pipeline.run(options);

当我尝试运行这个测试时，我得到了一个类似这样的错误

java.lang.IllegalArgumentException: Failed to serialize and deserialize property 'redisClient' with value 'xxx.xxx.RedisClientImpl@529cfee5'

为了使框架不尝试序列化客户机，我可以在Options类的getRedisclient()上添加@jsonignore。但这会导致Redis实例在某个时候被重新创建，而我所有的嘲笑和攻击都消失了。我想知道测试这种场景的最佳方法是什么。

Answer 1

在对Apache Beam邮件列表进行了一些讨论后，我能够让这个东西工作起来。诀窍是设置RedisClientFactory，它使用管道选项中的另一个字段，该字段公开RedisClient类的名称。

所以选项看起来是这样的-

    @Default.Class(RedisClientImpl.class)
    Class<? extends RedisClient> getRedisClientClass();

    void setRedisClientClass(Class<? extends RedisClient> redisClientClass);

    @Default.InstanceFactory(RedisClientFactory.class)
    RedisClient getRedisClient();

    void setRedisClient(RedisClient client);

工厂是这样实施的--

public class RedisClientFactory implements DefaultValueFactory<RedisClient> {
  @Override
  public RedisClient create(PipelineOptions options) {

    CommonPipelineOptions pipelineOptions = options.as(CommonPipelineOptions.class);
    return InstanceBuilder.ofType(RedisClient.class)
        .fromClass(pipelineOptions.getRedisClientClass())
        .fromFactoryMethod("fromOptions")
        .withArg(PipelineOptions.class, options)
        .build();
  }

}

  public static RedisClientImpl fromOptions(PipelineOptions options) {
    return new RedisClientImpl(options.as(CommonPipelineOptions.class));
  }

使用此设置，我现在可以在单元测试中创建RedisClient的模拟实例。

options = PipelineOptionsFactory.as(CommonPipelineOptions.class);
options.setRedisClientClass(FakeRedisClient.class);
...
// setup fake data in the FakeRedisClient by calling static methods
FakeRedisClient.keyToValueMap.put(redisKey, redisReturnVal);
...
pipeline.run(options);

我们还需要确保FakeRedisClient类还公开了一个名为fromOptions的方法

  public static FakeRedisClient fromOptions(PipelineOptions options) {
    return new FakeRedisClient();
  }