Terragrunt Catalog 中测试模块的可见性问题与解决方案探讨

问题背景

在使用 Terragrunt Catalog 功能时，开发人员发现一个值得关注的现象：当执行 terragrunt catalog 命令时，系统不仅会列出正式的业务模块，还会显示用于测试的辅助模块（fixture modules）。这种情况在使用 OpenTofu 测试框架时尤为常见，因为测试通常需要专门的辅助模块来构建环境或准备测试数据。

问题重现

典型的模块目录结构可能如下所示：

├── README.md
├── locals.tf
├── main.tf
├── outputs.tf
├── tests
│   ├── main.tftest.hcl
│   └── setup
│       └── main.tf
├── variables.tf
└── versions.tf

在这种结构中，tests/setup 目录下的内容实际上是测试专用的辅助模块，不应该出现在正式的模块目录中。然而，当前 Terragrunt Catalog 会无差别地列出所有包含 Terraform 配置文件的目录，导致测试辅助模块也被包含在内。

影响分析

这种设计可能会带来几个实际问题：

1. 团队协作时，新成员可能会误将测试模块当作正式模块使用
2. 模块列表变得冗长，降低了可用性
3. 可能造成配置管理上的混乱

现有解决方案

目前开发人员可以采用以下几种临时解决方案：

1. 目录结构调整：将测试辅助模块移出主模块目录，放置在独立的目录结构中
2. 命名约定：为测试模块使用特定的命名前缀或后缀，便于识别

未来改进方向

Terragrunt 团队正在考虑几种长期解决方案：

1. 排除文件机制：引入类似 .terragrunt-catalog-exclude 的配置文件，允许用户明确指定需要排除的目录
2. 配置块方案：新增 catalog 配置块，支持通过正则表达式精确控制需要包含的目录
3. 智能识别：系统自动识别并排除常见的测试目录结构（如 tests/、fixtures/ 等）

最佳实践建议

基于当前情况，建议开发团队：

1. 遵循模块化设计原则，将正式模块与测试辅助模块物理分离
2. 建立统一的测试目录命名规范
3. 在等待官方解决方案的同时，可以通过目录结构调整规避问题

这个问题反映了基础设施即代码(IaC)工具在测试支持方面的一个普遍挑战，随着测试在IaC中的重要性不断提升，类似的功能优化将变得越来越重要。