コード品質テスト

最終更新日： 2025年1月14日
  • 適用対象：
  • Experience Manager as a Cloud Service

作成対象：

  • 管理者
  • 開発者

パイプラインのコード品質テストの仕組みと、デプロイメントの品質を向上させる方法について説明します。

はじめに

コード品質テストは、一連の品質ルールに基づいてアプリケーションコードを評価します。これはコード品質のみのパイプラインの主な目的であり、実稼動および非実稼動のすべてのパイプラインで、ビルド手順の直後に実行されます。

様々なタイプのパイプラインの詳細については、CI/CD パイプラインの設定を参照してください。

コード品質ルール

コード品質テストでは、ソースコードをスキャンし、一定の品質基準を満たしていることを確認します。このステップは、SonarQube と、OakPAL を使用したコンテンツパッケージレベルの調査の組み合わせによって実装されます。汎用の Java ルールとAEM固有のルールを組み合わせたルールは 100 以上あります。 AEM固有のルールの一部は、AEM エンジニアリングのベストプラクティスに基づいており、 カスタムコード品質ルールと呼ばれます。

現在のルールの完全なリストをダウンロードするには、このリンクを使用します。

IMPORTANT
2025年2月13日木曜日（PT）（Cloud Manager 2025.2.0）以降、Cloud Manager コード品質では、更新された SonarQube 9.9 バージョンと、ここからダウンロードできる更新されたルールのリストが使用されます。

3 層評価

コード品質テストによって特定された問題は、3 つのカテゴリーのいずれかに分類されます。

  • 重大 - パイプラインの即時失敗を引き起こす問題です。

  • 重要 - パイプラインの一時停止状態を引き起こす問題です。 デプロイメントマネージャー、プロジェクトマネージャーまたはビジネスオーナーは、問題を無視して、パイプラインを続行することができます。または、問題を受け入れることもできますが、それによってエラーが発生した際にパイプラインが停止する可能性があります。

  • 情報 - 情報提供だけを目的とした問題です。パイプライン実行には影響しません。

NOTE
コード品質専用パイプラインでは、コード品質テストステップがパイプラインの最終ステップであるため、コード品質ゲートでの重要なエラーはオーバーライドできません。

評価

このステップの結果は、評価 ​として提供されます。

次の表に、重大、重要、情報の各カテゴリの評価と失敗のしきい値を示します。

名前
定義
カテゴリ
不合格のしきい値
セキュリティ評価
A = 脆弱性なし
B = 軽度の脆弱性が 1 つ以上
C = 重要な脆弱性が 1 つ以上
D = 重大な脆弱性が 1 つ以上
E = 致命的な脆弱性が 1 つ以上
重大
< B
信頼性評価
A = バグなし
B = 軽度のバグが 1 つ以上
C = 重要なバグが 1 つ以上
D = 重大なバグが 1 つ以上
E = 致命的なバグが 1 つ以上
重大
< D
保守性評価

コードスメルの未処理の修正コストによって、アプリケーションに既に投入された時間の割合として定義されます。

  • A = <=5%
  • B = 6～10%
  • C = 11～20%
  • D = 21～50%
  • E = >50%
重要
< A
カバレッジ

次の式を使用して、単体テストラインのカバレッジと条件のカバレッジを組み合わせて定義します。
Coverage = (CT + CF + LC)/(2*B + EL)

  • CT = 単体テストの実行中に少なくとも 1 回は true と評価された条件
  • CF = 単体テストの実行中に少なくとも 1 回は false と評価された条件
  • LC = 被覆線 = lines_to_cover - uncovered_lines
  • B = 条件の合計数
  • EL = 実行可能な行の総数 (lines_to_cover)
重要
< 50％
スキップした単体テスト
スキップした単体テストの数
情報
> 1
未解決の問題
問題の全体的なタイプ - 脆弱性、バグ、コードスメル
情報
> 0
重複行

重複したブロックに含まれる行の数として定義されます。 コードブロックは、次の条件下で重複していると見なされます。
Java 以外のプロジェクト：

  • 100 個以上の連続した重複トークンが必要です。
  • これらのトークンは、少なくとも次の場所に分散している必要があります。
  • 30 行の COBOL コード
  • 20 行の ABAP コード
  • 10 行の他言語コード

Java プロジェクト：

  • トークンと行の数にかかわらず、10 個以上の連続した重複ステートメントが必要です。

重複を検出する際は、インデントの違いと文字列リテラルの違いは無視されます。

情報
> 1％
Cloud Service の互換性
特定された Cloud Service の互換性に関する問題の数
情報
> 0
NOTE
詳しくは、SonarQube の指標の定義を参照してください。
NOTE
Cloud Manager で実行されるカスタムコード品質ルールについて詳しくは、カスタムコード品質ルールを参照してください。