アクションでの品質レポートの設定 - Amazon CodeCatalyst
自動検出と手動レポートレポートの成功基準の設定品質レポート YAML の例

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

アクションでの品質レポートの設定

このセクションでは、 アクションで品質レポートを設定する方法について説明します。

自動検出と手動レポート

自動検出が有効になっている場合、 はアクションに渡されたすべての入力と、アクション自体によって生成されたすべてのファイル CodeCatalyst を検索し、テスト、コードカバレッジ、ソフトウェアコンポジション分析 (SCA)、静的分析 (SA) レポートを探します。これらの各レポートは、 で表示および操作できます CodeCatalyst。

生成されるレポートを手動で設定することもできます。生成するレポートのタイプとファイル形式を指定できます。詳細については、「品質レポートタイプ」を参照してください。

レポートの成功基準の設定

テスト、コードカバレッジ、ソフトウェアコンポジション分析 (SCA)、または静的分析 (SA) レポートの成功基準を決定する値を設定できます。

成功基準は、レポートが成功するか失敗するかを決定するしきい値です。 CodeCatalyst は、最初にテスト、コードカバレッジ、SCA、SA レポートなどのレポートを生成し、生成されたレポートに成功基準を適用します。次に、成功基準がどの程度満たされたかを示します。レポートが指定された成功基準を満たさない場合、成功基準を指定した CodeCatalyst アクションは失敗します。

例えば、SCA レポートの成功基準を設定する場合、最も重要度の高いものから最も重要度の低いものまでの有効な脆弱性値はCRITICAL、、HIGH、MEDIUM、LOW、 ですINFORMATIONAL。HIGH 重要度が 1 つの脆弱性をスキャンするように基準を設定すると、HIGH重要度が 1 つ以上の脆弱性があるか、重要度が 1 つの脆弱性など、HIGH重要度がより高いレベルで少なくとも 1 つの脆弱性がある場合、レポートは失敗しますCRITICAL。

成功基準を指定しない場合は、次のようになります。

  • raw CodeCatalyst レポートに基づいて生成されたレポートには、成功基準は表示されません。

  • 成功基準は、関連付けられたワークフローアクションが成功するか失敗するかを判断するために使用されません。

Visual
成功基準を設定するには

  1. ナビゲーションペインで CI/CD を選択し、ワークフロー を選択します。

  2. レポートを生成するアクションを含むワークフローを選択します。これは、成功基準を適用するレポートです。ワークフローが定義されているソースリポジトリまたはブランチ名でフィルタリングすることも、ワークフロー名でフィルタリングすることもできます。

  3. [編集] を選択します。

  4. ビジュアル を選択します。

  5. ワークフロー図で、 CodeCatalyst レポートを生成するように設定したアクションを選択します。

  6. [出力] タブを選択します。

  7. レポートの自動検出 または レポートを手動で設定 で、成功基準 を選択します。

    成功基準が表示されます。前の選択内容によっては、これらのオプションの一部またはすべてが表示される場合があります。

    パスレート

    関連する CodeCatalystレポートが合格としてマークされるようにするために合格する必要があるテストレポート内のテストの割合を指定します。有効な値には 10 進数が含まれます。例: 50、60.5。合格率基準はテストレポートにのみ適用されます。テストレポートの詳細については、「」を参照してくださいテストレポート。

    ラインカバレッジ

    コードカバレッジレポートで、関連するレポートが合格としてマークされる CodeCatalyst ためにカバーする必要がある行の割合を指定します。有効な値には 10 進数が含まれます。例: 50、60.5。行カバレッジ基準は、コードカバレッジレポートにのみ適用されます。コードカバレッジレポートの詳細については、「」を参照してくださいコードカバレッジレポート。

    ブランチカバレッジ

    コードカバレッジレポートで、関連するレポートが合格としてマークされる CodeCatalyst ためにカバーする必要があるブランチの割合を指定します。有効な値には 10 進数が含まれます。例: 50、60.5。ブランチカバレッジ基準は、コードカバレッジレポートにのみ適用されます。コードカバレッジレポートの詳細については、「」を参照してくださいコードカバレッジレポート。

    脆弱性 (SCA)

    SCA レポートで許可される脆弱性の最大数と重要度を指定して、関連する CodeCatalyst レポートが合格としてマークされるようにします。脆弱性を指定するには、以下を指定する必要があります。

    • カウントに含める脆弱性の最小重要度。最も重要度の高い値から低い値までの有効な値は、CRITICAL、HIGH、、MEDIUMLOW、 ですINFORMATIONAL。

      例えば、 を選択するとHIGH、 HIGHと のCRITICAL脆弱性が集計されます。

    • 許可する指定された重要度の脆弱性の最大数。この数を超えると、 CodeCatalyst レポートは失敗としてマークされます。有効な値は整数です。

    脆弱性基準は SCA レポートにのみ適用されます。SCA レポートの詳細については、「」を参照してくださいソフトウェア構成分析レポート。

    バグ

    SA レポートで許可されるバグの最大数と重要度を指定して、関連する CodeCatalyst レポートが合格としてマークされるようにします。バグを指定するには、以下を指定する必要があります。

    • カウントに含めるバグの最小重要度。最も重要度の高い値から低い値までの有効な値は、CRITICAL、HIGH、、MEDIUMLOW、 ですINFORMATIONAL。

      例えば、 を選択するとHIGH、 HIGHと CRITICAL のバグが集計されます。

    • 許可する指定された重要度のバグの最大数。この数を超えると、 CodeCatalyst レポートは失敗としてマークされます。有効な値は整数です。

    バグ基準は、 PyLint および ESLint SA レポートにのみ適用されます。SA レポートの詳細については、「」を参照してください静的分析レポート。

    セキュリティの脆弱性

    SA レポートで許可されているセキュリティ脆弱性の最大数と重要度を指定し、関連する CodeCatalyst レポートが合格としてマークされるようにします。セキュリティの脆弱性を指定するには、以下を指定する必要があります。

    • カウントに含めるセキュリティ脆弱性の最小重要度。最も重要度の高い値から低い値までの有効な値は、CRITICAL、HIGH、、MEDIUMLOW、 ですINFORMATIONAL。

      例えば、 を選択するとHIGH、 HIGHと CRITICAL セキュリティの脆弱性が集計されます。

    • 許可する指定された重要度のセキュリティ脆弱性の最大数。この数を超えると、 CodeCatalyst レポートは失敗としてマークされます。有効な値は整数です。

    セキュリティの脆弱性基準は、 PyLint および ESLint SA レポートにのみ適用されます。SA レポートの詳細については、「」を参照してください静的分析レポート。

    品質の問題

    SA レポートで許可される品質問題の最大数と重要度を指定して、関連する CodeCatalyst レポートが合格としてマークされるようにします。品質問題を指定するには、以下を指定する必要があります。

    • カウントに含める品質問題の最小重要度。最も重要度の高い値から低い値までの有効な値は、CRITICAL、HIGH、、MEDIUMLOW、 ですINFORMATIONAL。

      例えば、 を選択するとHIGH、 HIGHと CRITICAL品質の問題が集計されます。

    • 許可する指定された重要度の品質問題の最大数。この数を超えると、 CodeCatalyst レポートは失敗としてマークされます。有効な値は整数です。

    品質問題基準は、 PyLint および ESLint SA レポートにのみ適用されます。SA レポートの詳細については、「」を参照してください静的分析レポート。

  8. [Commit] (コミット) を選択します。

  9. ワークフローを実行して、成功基準を raw レポート CodeCatalyst に適用し、成功基準情報を含む関連 CodeCatalyst レポートを再生成します。詳細については、「ワークフローの手動実行の開始」を参照してください。

YAML
成功基準を設定するには

  1. ナビゲーションペインで CI/CD を選択し、ワークフロー を選択します。

  2. レポートを生成するアクションを含むワークフローを選択します。これは、成功基準を適用するレポートです。ワークフローが定義されているソースリポジトリまたはブランチ名でフィルタリングすることも、ワークフロー名でフィルタリングすることもできます。

  3. [編集] を選択します。

  4. YAML を選択します。

  5. ワークフロー図で、 CodeCatalyst レポートを生成するように設定したアクションを選択します。

  6. 詳細ペインで、出力タブを選択します。

  7. アクション、 AutoDiscoverReportsセクション、または Reportsセクションで、SuccessCriteria、、、PassRate、LineCoverage、StaticAnalysisSecurity、および プロパティとともに BranchCoverage Vulnerabilities StaticAnalysisBugStaticAnalysisQualityプロパティを追加します。

    これらのプロパティの説明については、「」を参照してくださいビルドおよびテストアクションの YAML 定義。

  8. [Commit] (コミット) を選択します。

  9. ワークフローを実行して、未加工レポートに成功基準 CodeCatalyst を適用し、成功基準情報を含む関連する CodeCatalyst レポートを再生成します。ワークフローの開始の詳細については、「」を参照してくださいワークフローの手動実行の開始。

品質レポート YAML の例

次の例は、テストレポート、コードカバレッジレポート、ソフトウェア構成分析レポート、静的分析レポートの 4 つのレポートを手動で設定する方法を示しています。

Reports:
  MyTestReport:
    Format: JUNITXML
    IncludePaths:
      - "*.xml"
    ExcludePaths:
      - report1.xml
      SuccessCriteria:
        PassRate: 90
  MyCoverageReport:
    Format: CLOVERXML
    IncludePaths:
      - output/coverage/jest/clover.xml
      SuccessCriteria:
        LineCoverage: 75
        BranchCoverage: 75
  MySCAReport:
    Format: SARIFSCA
    IncludePaths:
      - output/sca/reports.xml
      SuccessCriteria:
        Vulnerabilities:
          Number: 5
          Severity: HIGH
  MySAReport:
    Format: ESLINTJSON
    IncludePaths:
      - output/static/eslint.xml
      SuccessCriteria:
        StaticAnalysisBug:
          Number: 10
          Severity: MEDIUM
        StaticAnalysisSecurity:
          Number: 5
          Severity: CRITICAL
        StaticAnalysisQuality:
          Number: 0
          Severity: INFORMATIONAL