代碼質量測試

瞭解管道的代碼質量測試如何工作以及它如何提高部署質量。

簡介

代碼質量測試根據一組質量規則評估您的應用程式碼。 它是僅代碼質量管道的主要目的，並且在所有生產和非生產管道的構建步驟後立即執行。

請參閱文檔 配置CI-CD管道 瞭解有關不同類型管道的詳細資訊。

代碼質量規則

代碼質量測試掃描原始碼以確保它滿足某些質量標準。 這是通過SonarQube和使用OakPAL的內容包級檢查的組合來實現的。 有100多個規則，將通用Java規則和特定AEM規則組合在一起。 某些特AEM定規則是根據工程部門的最AEM佳做法建立的，稱為 自定義代碼質量規則。

三層評級

由代碼質量測試確定的問題被分配給三個類別中的一個。

• 關鍵 — 這些問題導致管道立即失效。

• 重要 — 這些問題導致管道進入暫停狀態。 部署經理、項目經理或業務所有者可以覆蓋問題，在這種情況下，管道將繼續，或者他們可以接受問題，在這種情況下，管道將因失敗而停止。

• 資訊 — 這些問題純粹是為了提供資訊而提供的，對管道執行沒有影響

此步驟的結果將作為 評級。

下表匯總了每個關鍵、重要和資訊類別的評級和故障閾值。

處理誤報

質量掃描過程不完善，有時會錯誤地識別實際上沒有問題的問題。 這稱為 假陽性。

在這些情況下，可以使用標準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";

然後，正確的解決方案是刪除硬編碼密碼。

內容包掃描優化

作為質量分析流程的一部分，Cloud Manager會對Maven構建生成的內容包進行分析。 Cloud Manager提供優化功能以加速此過程，當觀察到某些打包約束時，此功能非常有效。 最重要的是，對輸出單個內容包的項目執行的優化，通常稱為「全部」包，其中包含由生成生成的許多其他內容包，這些內容包被標籤為已跳過。 當Cloud Manager檢測到此方案，而不是解包「全部」包時，將直接掃描各個內容包並根據相關性對其進行排序。 例如，請考慮以下生成輸出。

• all/myco-all-1.0.0-SNAPSHOT.zip （內容包）
• ui.apps/myco-ui.apps-1.0.0-SNAPSHOT.zip （跳過的內容包）
• ui.content/myco-ui.content-1.0.0-SNAPSHOT.zip （跳過的內容包）

如果只有內部項 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。