Apache RAT检查在Drools项目中遗漏drools-model目录的问题分析

Apache RAT（Release Audit Tool）是Apache软件基金会用于检查源代码许可证合规性的重要工具。在Apache孵化项目Kie Drools中，我们发现了一个关于RAT检查的有趣问题——它意外地跳过了drools-model目录的检查。

问题背景

在Kie Drools项目中，开发团队使用Apache RAT 0.16.1版本来检查源代码的许可证头信息。检查命令为java -jar apache-rat-0.16.1.jar -d . -E .rat-excludes，其中.rat-excludes文件用于指定需要排除检查的文件和目录。

问题现象

检查过程中发现，drools-model目录下的文件没有被正确检查。经过调查发现，这是因为.rat-excludes文件中包含了一个"drools-model"条目，而这个条目原本是为了排除kie-dmn/kie-dmn-core/src/test/filtered-resources/org/kie/dmn/core/drools-model路径下的文件。

技术分析

深入分析Apache RAT 0.16.1的源代码后，我们发现其排除机制存在以下特点：

1. RAT会创建三种过滤器来处理排除表达式：

   • 正则表达式过滤器(RegexFileFilter)
   • 名称过滤器(NameFileFilter)
   • 通配符过滤器(WildcardFileFilter)

2. 这三种过滤器都只基于文件名进行匹配，而不考虑完整路径。这意味着当它们遇到"drools-model"这个排除项时：

   • 会匹配kie-dmn/.../drools-model文件
   • 也会匹配drools-model目录
   • 因为两者都包含"drools-model"这个名称

3. 在当前的实现中，无法区分相同名称但位于不同路径的文件和目录。

解决方案

由于这个问题是Apache RAT工具本身的限制，在等待新版本修复的同时，我们采用了以下临时解决方案：

1. 首先在项目根目录执行常规的RAT检查
2. 然后进入drools-model目录
3. 再次执行RAT检查，但使用../.rat-excludes作为排除文件

这种分层检查的方法确保了drools-model目录能够被正确检查，同时不影响原有的排除逻辑。

经验总结

这个问题提醒我们在使用构建工具时需要注意：

1. 排除规则的设计要谨慎，特别是当项目中有同名但不同路径的文件/目录时
2. 了解工具的内部工作机制有助于找到更合理的解决方案
3. 对于开源工具的限制，有时需要创造性的变通方案
4. 定期关注工具更新，以便在问题修复后及时升级

这个案例也展示了开源社区如何协作解决技术问题，从发现问题、分析原因到实施解决方案的完整过程。