Mockery配置迁移中的子包排除问题解析

Mockery作为Go语言中最流行的mock生成工具之一，其v3版本带来了许多配置格式的变化。在实际使用中，从v2到v3的配置迁移过程中，我们发现了一个关于子包排除(exclude-subpkg-regex)配置位置的潜在问题。

问题背景

在Mockery v2配置中，开发者可以通过exclude字段来指定需要排除的子包路径。当使用migrate命令将这些配置升级到v3格式时，工具会将exclude字段自动转换为exclude-subpkg-regex，但会错误地将其放置在package级别的config下，而非配置文件的根级别。

问题影响

这种错误的配置位置会导致子包排除功能失效。根据Mockery v3的设计规范，exclude-subpkg-regex应当位于配置文件的根级别才能正常工作。当它被错误地放置在package级别的config下时，Mockery将无法正确识别需要排除的子包。

配置对比

v2原始配置示例:

with-expecter: true
dir: "{{.InterfaceDirRelative}}/mocks"
outpkg: mocks
packages:
  package_name/internal:
    config:
      recursive: true
      disable-version-string: true
      all: true
      exclude:
        - app/migrate/migrator
        - pkg/tests

错误的v3迁移结果:

packages:
  package_name/internal:
    config:
      all: true
      exclude-subpkg-regex:  # 错误位置
        - app/migrate/migrator
        - pkg/tests
      recursive: true

正确的v3配置:

exclude-subpkg-regex:  # 正确位置
  - "package_name/internal/app/migrate/*"
  - "package_name/internal/tests/*"
packages:
  package_name/internal:
    config:
      all: true
      recursive: true

技术原理分析

Mockery v3对子包排除机制进行了重构，使其更加灵活和强大。exclude-subpkg-regex采用正则表达式匹配方式，可以更精确地控制需要排除的子包范围。这个配置需要放在根级别的原因是：

1. 它影响的是整个mock生成过程的子包扫描阶段
2. 需要在解析package配置之前就生效
3. 可以统一管理多个package的排除规则

解决方案

对于遇到此问题的用户，可以采取以下解决方案：

1. 手动调整迁移后的配置文件，将exclude-subpkg-regex移动到根级别
2. 注意路径格式变化，v3需要使用完整路径并支持正则表达式
3. 等待官方修复此迁移工具的问题

最佳实践建议

1. 迁移后务必检查配置文件的正确性
2. 对于复杂的排除规则，建议使用正则表达式提高灵活性
3. 可以在CI流程中加入配置验证步骤
4. 考虑使用更细粒度的package配置而非全局排除

总结