代码质量测试 code-quality-testing

了解管道代码质量测试的工作方式以及其提高部署质量的方式。

简介 introduction

代码质量测试根据一组质量规则评估应用程序代码。 它是代码质量专用管道的主要目的，并在所有生产和非生产管道的构建步骤之后立即执行。

请参阅配置您的 CI-CD 管道，了解更多有关不同类型管道的信息。

代码质量规则 understanding-code-quality-rules

代码质量测试将扫描源代码以确保它符合特定的质量标准。 结合 SonarQube 和使用 OakPAL 的内容包级别检查来实现这一点。 有 100 多条规则结合了通用 Java 规则和特定于 AEM 的规则。 一些特定于 AEM 的规则基于来自 AEM Engineering 的最佳实践而创建，这些规则称作自定义代码质量规则。

三层评级 three-tiered-gate

代码质量测试确定的问题被分配到三个类别中的一个。

评级 ratings

此步骤的结果以​ 评级 ​的形式提供。

下表总结了每个关键、重要和信息类别的额定值和故障阈值。

处理误报 dealing-with-false-positives

质量扫描过程并不完善，有时会错误地识别出实际上并不是问题的问题。 此情况称作​ 误报。

在这些情况下，可以使用标准 Java @SuppressWarnings 注释为源代码添加注释，并将规则 ID 指定为注释属性。例如，一种常见误报是用于检测硬编码密码的 SonarQube 规则可能会妨碍识别硬编码密码的方式。

以下代码在 AEM 项目中相当常见，其中包含用于连接到某些外部服务的代码。

@Property(label = "Service Password")
private static final String PROP_SERVICE_PASSWORD = "password";

之后，SonarQube 将引发阻断漏洞。 不过，在查看代码后，您会发现这并不是漏洞，并且可以使用适当的规则 ID 注释代码。

@SuppressWarnings("squid:S2068")
@Property(label = "Service Password")
private static final String PROP_SERVICE_PASSWORD = "password";

然而，如果代码的实际情况如此：

@Property(label = "Service Password", value = "mysecretpassword")
private static final String PROP_SERVICE_PASSWORD = "password";

那么，正确的解决方案是删除硬编码的密码。

内容包扫描优化 content-package-scanning-optimization

在质量分析过程中，Cloud Manager 会对 Maven 构建生成的内容包进行分析。 Cloud Manager 提供优化功能以加速此过程，当遵守某些打包限制时，这些优化功能将生效。 最重要的是对输出单个内容包（通常称为“完整”包）的项目执行的优化，其中包含构建生成的几个其他内容包（这些内容包标记为已跳过）。 当 Cloud Manager 检测到此情况时，它不会解压缩“所有”包，而是直接扫描各个内容包并根据依赖关系对它们进行排序。 例如，考虑以下构建输出。

如果 myco-all-1.0.0-SNAPSHOT.zip 中的唯一项目是两个跳过的内容包，则会扫描两个嵌入包而不是“所有”内容包。

对于产生数十个嵌入包的项目，此优化已被证明可将每次管道执行时间节省 10 分钟以上。

当“所有”内容包包含跳过的内容包和 OSGi 捆绑包的组合时，可能会出现特殊情况。 例如，如果 myco-all-1.0.0-SNAPSHOT.zip 包含前面提到的两个嵌入式包以及一个或多个 OSGi 捆绑包，则仅使用 OSGi 捆绑包构建一个新的最小内容包。 此包始终名为 cloudmanager-synthetic-jar-package，并且包含的捆绑包将放置在 /apps/cloudmanager-synthetic-installer/install 中。