maven findbugs“高水位线”

Question

[findbugs 是这里的例子，问题适用于任何这样的 Maven 插件]

我不久前参加了一个构建讲座，其中谈到的一个我非常喜欢的模式是：当向链中添加一个新工具时，你从 n 开始违规，您应该保持 n 减少（高水位线），并且仅当当前检查超过 n 的最后一个值时构建才会失败。

findbugs 刚刚被引入到我们的构建中，我们正在寻找一种方法来实现此模式。我们看不到任何通过插件配置来做到这一点的方法，所以很好奇是否有人可以提及他们是如何实现这一目标的。我想显而易见的方法是自定义插件，但在我们继续前进之前，想听听其他人的想法。

Answer 1

Findbugs（以及我所知道的所有其他代码指标插件）生成 一个 XML 文件。我要做的是编写一个专门读取这些 xml 文件的 Maven 插件。它将在某处保留一个私有查找表，用于存储每个构建、每个指标的最后值。

它将使用一个通用的解析器接口，您必须为每个指标插件实现该接口。配置将是这样的：

<plugin>
    <groupId>com.yourcompany</groupId>
            <artifactId>your-plugin-id</artifactId>
            <version>1.0</version>
            <executions>
                    <execution>
                        <id>readmetrics</id>
                        <phase>process-classes</phase>
                        <goals>
                            <goal>analyse-metrics</goal>
                        </goals>
                    </execution>
             </executions>
             <configuration>
                  <metrics>
                      <metric>
                          <type>findbugs</type>
                          <file>${project.reporting.outputDirectory}/findbugs/output.xml</file>
                      </metric>
                      <metric>
                          <type>checkstyle</type>
                          <file>${project.reporting.outputDirectory}/checkstyle/output.xml</file>
                      </metric>
                      <metric>
                          <type>pmd</type>
                          <file>${project.reporting.outputDirectory}/pmd/output.xml</file>
                      </metric>
                  </metrics>
              </configuration>
        </plugin>

Answer 2

我认为 FindBugs 的情况有点特殊：违规不仅仅是表面上的，它们可能是真正的错误，因此应该修复，至少是高优先级错误（即使用高阈值时）。

以防万一，我们遵循类似的模式（我们对完成的定义包括不增加技术债务），但我们没有在 Maven 中实现它（并且我们不会使构建失败）。我们使用 Sonar 及其 时间机器 跟踪指标演变（我们跟踪每日演变）。它对我们来说效果很好，即使它不如构建失败那么强大。

Answer 3

我在 Maven findbugs 跟踪器中提出了这个问题（请参阅 http://jira.codehaus.org/浏览/MFINDBUGS-115）。

此外，作为提出这个问题的一部分，我编写了一个提交的补丁。我们在大型多模块项目中成功运行了此补丁。

您可以按照 findbugs-maven-plugin 站点上的说明同步代码并应用补丁，或者希望该补丁或其派生版本可能会被插件的未来版本所接受。

Answer 4

有趣的是你提到了这一点，因为我现在正在为我的雇主做这件事。我们剥离了一个开源项目来开展这项工作，名为 dybdob；因为它非常是一项正在进行中的工作，所以现在存储库中的代码相当糟糕并且非常硬编码/hacky。然而，计划或多或少地按照 Seanizer 的建议进行：解析 XML，保留计数，如果增加则失败。

我实现的第一件事（同样：硬编码、hacky 和未记录）是一个插件，用于实际计算构建中发出的 javac 编译器警告，并在数量增加时中断构建。现在可以了，我目前正在并行处理 findbugs、checkstyle 和 pmd 警告。

希望您能检查一下，如果您有兴趣提供帮助（或者只是想看看它是如何演变的），请给我写信。