Gaffer项目FederatedStore模块测试优化实践

背景介绍

Gaffer作为图数据处理框架，其FederatedStore模块实现了联邦存储功能。在项目开发过程中，测试代码中出现了大量重复的配置代码片段，这些代码片段主要涉及FederatedStore的初始化配置。

问题分析

通过分析代码库发现，测试类中普遍存在硬编码的FederatedStoreProperties配置，例如在FederatedStoreVisibilityTest等测试类中，开发者需要手动创建并配置Properties对象。这种模式带来了几个问题：

1. 代码重复率高，维护成本增加
2. 配置分散，修改配置需要多处改动
3. 测试代码可读性降低

解决方案

项目组提出了统一使用配置文件管理的优化方案，具体实现要点包括：

1. 将通用配置提取到test/resources目录下的配置文件中
2. 使用FederatedStoreTestUtil工具类提供的getFederatedStorePropertiesWithHashMapCache方法加载配置
3. 简化测试代码，将原本多行的配置代码替换为单行调用

技术实现细节

优化后的代码结构更加清晰，例如原本需要手动设置cacheServiceClass的代码：

Properties properties = new Properties();
properties.setProperty("gaffer.cache.service.class", "uk.gov.gchq.gaffer.cache.impl.HashMapCacheService");

现在可以简化为：

Properties properties = FederatedStoreTestUtil.getFederatedStorePropertiesWithHashMapCache();

环境配置建议

在实施此类优化时，需要注意开发环境的兼容性问题：

1. 推荐使用Java 8作为开发环境
2. 高版本Java(如11+)可能引发ZooKeeper兼容性问题
3. 使用Maven构建时建议添加quick profile参数

优化效果

通过这次优化，Gaffer项目的FederatedStore模块测试代码实现了以下改进：

1. 代码复用率显著提高
2. 配置管理更加集中化
3. 测试用例的可维护性增强
4. 减少了因配置不一致导致的测试失败

这种配置集中化的思想也值得在其他模块的测试代码中推广，是测试代码优化的良好实践。