View a markdown version of this page

Konfiguration von Qualitätsberichten in einer Aktion - Amazon CodeCatalyst
Auto-discovery und manuelle BerichteErfolgskriterien für Berichte konfigurierenBeispiel für Qualitätsberichte (YAML)

Amazon CodeCatalyst ist nicht mehr offen für neue Kunden. Bestandskunden können den Service weiterhin wie gewohnt nutzen. Weitere Informationen finden Sie unter Wie migriert man von CodeCatalyst.

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Konfiguration von Qualitätsberichten in einer Aktion

In diesem Abschnitt wird beschrieben, wie Sie einen Qualitätsbericht in einer Aktion konfigurieren.

Auto-discovery und manuelle Berichte

Wenn die automatische Erkennung aktiviert ist, werden alle an die Aktion übergebenen Eingaben und alle durch die Aktion selbst generierten Dateien CodeCatalyst durchsucht. Dabei wird nach Berichten zu Tests, Codeabdeckung, Software-Composition Analysis (SCA) und statischen Analysen (SA) gesucht. Sie können jeden dieser Berichte in anzeigen und bearbeiten. CodeCatalyst

Sie können auch manuell konfigurieren, welche Berichte generiert werden. Sie können die Art des Berichts, den Sie generieren möchten, sowie das Dateiformat angeben. Weitere Informationen finden Sie unter Typen von Qualitätsberichten.

Erfolgskriterien für Berichte konfigurieren

Sie können die Werte festlegen, die die Erfolgskriterien für einen Test-, Codeabdeckung-, Software Composition Analysis (SCA) oder einen Bericht zur statischen Analyse (SA) bestimmen.

Erfolgskriterien sind Schwellenwerte, die bestimmen, ob ein Bericht erfolgreich ist oder nicht. CodeCatalyst generiert zuerst Ihren Bericht, bei dem es sich um einen Test-, Codeabdeckung-, SCA- oder SA-Bericht handeln kann, und wendet dann die Erfolgskriterien auf die generierten Berichte an. Anschließend wird angezeigt, ob und in welchem Umfang die Erfolgskriterien erfüllt wurden. Wenn ein Bericht die angegebenen Erfolgskriterien nicht erfüllt, schlägt die CodeCatalyst Aktion, die die Erfolgskriterien angegeben hat, fehl.

Wenn Sie beispielsweise die Erfolgskriterien für Ihren SCA-Bericht festlegen, lauten die gültigen Sicherheitsanfälligkeitswerte, die von der höchsten bis zur geringsten Schwere reichenCRITICAL, wie folgt: HIGHMEDIUM,LOW,,INFORMATIONAL. Wenn Sie die Kriterien für die Suche nach einer Sicherheitslücke mit HIGH Schweregrad festlegen, schlägt der Bericht fehl, wenn entweder mindestens eine Sicherheitslücke mit HIGH Schweregrad oder keine Sicherheitslücke mit HIGH Schweregrad vorhanden ist, aber mindestens eine Sicherheitslücke mit einem höheren Schweregrad, z. B. eine Schwachstelle mit CRITICAL Schweregrad.

Wenn Sie keine Erfolgskriterien angeben, dann:

  • Der CodeCatalyst Bericht, der auf der Grundlage Ihrer Rohberichte generiert wird, zeigt keine Erfolgskriterien an.

  • Erfolgskriterien werden nicht verwendet, um festzustellen, ob die zugehörige Workflow-Aktion erfolgreich ist oder nicht.

Visual
Um Erfolgskriterien zu konfigurieren

  1. Wählen Sie im Navigationsbereich CI/CD und dann Workflows aus.

  2. Wählen Sie einen Workflow aus, der eine Aktion enthält, die einen Bericht generiert. Dies ist der Bericht, für den Sie Erfolgskriterien anwenden möchten. Sie können nach dem Quell-Repository oder dem Branchnamen filtern, in dem der Workflow definiert ist, oder nach Workflow-Namen oder -Status filtern.

  3. Wählen Sie Bearbeiten aus.

  4. Wählen Sie Visuell.

  5. Wählen Sie im Workflow-Diagramm die Aktion aus, die Sie zum Generieren von CodeCatalyst Berichten konfiguriert haben.

  6. Wählen Sie die Registerkarte Outputs.

  7. Wählen Sie unter Auto-discover Berichte oder unter Berichte manuell konfigurieren die Option Erfolgskriterien aus.

    Erfolgskriterien werden angezeigt. Abhängig von Ihrer vorherigen Auswahl werden Ihnen möglicherweise eine oder alle dieser Optionen angezeigt:

    Rate des Bestehens

    Geben Sie den Prozentsatz der Tests in einem Testbericht an, die bestanden werden müssen, damit der zugehörige CodeCatalyst Bericht als bestanden markiert wird. Gültige Werte beinhalten Dezimalzahlen. Zum Beispiel: 50, 60.5. Die Kriterien für die Erfolgsquote gelten nur für Testberichte. Weitere Informationen zu Testberichten finden Sie unterTestberichte.

    Netzabdeckung

    Geben Sie den Prozentsatz der Zeilen in einem Codeabdeckungsbericht an, die abgedeckt sein müssen, damit der zugehörige CodeCatalyst Bericht als bestanden markiert wird. Gültige Werte beinhalten Dezimalzahlen. Zum Beispiel: 50, 60.5. Die Kriterien für die Leitungsabdeckung werden nur auf Berichte zur Codeabdeckung angewendet. Weitere Informationen zu Berichten zur Codeabdeckung finden Sie unterCode-Abdeckungsberichte.

    Abdeckung durch Filialen

    Geben Sie den Prozentsatz der Filialen in einem Codeabdeckungsbericht an, der abgedeckt sein muss, damit der zugehörige CodeCatalyst Bericht als bestanden markiert wird. Gültige Werte beinhalten Dezimalzahlen. Zum Beispiel: 50, 60.5. Die Kriterien für die Filialabdeckung werden nur auf Berichte zur Codeabdeckung angewendet. Weitere Informationen zu Berichten zur Codeabdeckung finden Sie unterCode-Abdeckungsberichte.

    Sicherheitslücken (SCA)

    Geben Sie die maximale Anzahl und den Schweregrad der Sicherheitslücken an, die im SCA-Bericht zulässig sind, damit der zugehörige CodeCatalyst Bericht als bestanden markiert wird. Um Sicherheitslücken zu spezifizieren, müssen Sie Folgendes angeben:

    • Der Mindestschweregrad der Sicherheitslücken, die Sie in die Anzahl einbeziehen möchten. Gültige Werte (vom höchsten bis zum geringsten Schweregrad) sind: CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.

      Wenn Sie beispielsweise wählen HIGHHIGH, werden alle CRITICAL Sicherheitslücken gezählt.

    • Die maximale Anzahl von Sicherheitslücken mit dem angegebenen Schweregrad, die Sie zulassen möchten. Wird diese Zahl überschritten, wird der CodeCatalyst Bericht als fehlgeschlagen markiert. Gültige Werte sind ganze Zahlen.

    Die Kriterien für Sicherheitslücken werden nur auf SCA-Berichte angewendet. Weitere Informationen zu SCA-Berichten finden Sie unterBerichte zur Analyse der Softwarekomposition.

    Bugs

    Geben Sie die maximale Anzahl und den Schweregrad der Fehler an, die im SA-Bericht zulässig sind, damit der zugehörige CodeCatalyst Bericht als bestanden markiert wird. Um Fehler zu spezifizieren, müssen Sie Folgendes angeben:

    • Der Mindestschweregrad der Fehler, die Sie in die Zählung einbeziehen möchten. Gültige Werte (vom höchsten bis zum geringsten Schweregrad) sind: CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.

      Wenn Sie zum Beispiel wählen HIGHHIGH, werden CRITICAL Fehler gezählt.

    • Die maximale Anzahl von Bugs mit dem angegebenen Schweregrad, die Sie zulassen möchten. Wird diese Zahl überschritten, wird der CodeCatalyst Bericht als fehlgeschlagen markiert. Gültige Werte sind ganze Zahlen.

    Die Kriterien für Fehler werden nur auf PyLint Berichte von ESLint SA angewendet. Weitere Informationen zu SA-Berichten finden Sie unterStatische Analyseberichte.

    Sicherheitslücken

    Geben Sie die maximale Anzahl und den Schweregrad der Sicherheitslücken an, die im Sicherheitsbericht zulässig sind, damit der zugehörige CodeCatalyst Bericht als bestanden markiert wird. Um Sicherheitslücken zu spezifizieren, müssen Sie Folgendes angeben:

    • Der Mindestschweregrad der Sicherheitslücken, die Sie in die Anzahl einbeziehen möchten. Gültige Werte (vom höchsten bis zum geringsten Schweregrad) sind: CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.

      Wenn Sie beispielsweise wählenHIGH, werden HIGH alle CRITICAL Sicherheitslücken gezählt.

    • Die maximale Anzahl von Sicherheitslücken mit dem angegebenen Schweregrad, die Sie zulassen möchten. Wird diese Zahl überschritten, wird der CodeCatalyst Bericht als fehlgeschlagen markiert. Gültige Werte sind ganze Zahlen.

    Die Kriterien für Sicherheitslücken werden nur auf PyLint Berichte von ESLint SA angewendet. Weitere Informationen zu SA-Berichten finden Sie unterStatische Analyseberichte.

    Qualitätsprobleme

    Geben Sie die maximale Anzahl und den Schweregrad der Qualitätsprobleme an, die im SA-Bericht zulässig sind, damit der zugehörige CodeCatalyst Bericht als bestanden markiert wird. Um Qualitätsprobleme zu spezifizieren, müssen Sie Folgendes angeben:

    • Der Mindestschweregrad der Qualitätsprobleme, die Sie in die Zählung einbeziehen möchten. Gültige Werte (vom höchsten bis zum geringsten Schweregrad) sind: CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.

      Wenn Sie beispielsweise wählen HIGHHIGH, werden CRITICAL Qualitätsprobleme gezählt.

    • Die maximale Anzahl von Qualitätsproblemen mit dem angegebenen Schweregrad, die Sie zulassen möchten. Wird diese Zahl überschritten, wird der CodeCatalyst Bericht als nicht erfolgreich markiert. Gültige Werte sind ganze Zahlen.

    Die Kriterien für Qualitätsprobleme werden nur auf PyLint Berichte von ESLint SA angewendet. Weitere Informationen zu SA-Berichten finden Sie unterStatische Analyseberichte.

  8. Wählen Sie Commit (Übergeben).

  9. Führen Sie Ihren Workflow so aus, dass Erfolgskriterien auf Ihre Rohberichte CodeCatalyst angewendet werden, und generieren Sie die zugehörigen CodeCatalyst Berichte mit Informationen zu den Erfolgskriterien erneut. Weitere Informationen finden Sie unter Manuelles Starten einer Workflow-Ausführung.

YAML
Um Erfolgskriterien zu konfigurieren

  1. Wählen Sie im Navigationsbereich CI/CD und dann Workflows aus.

  2. Wählen Sie einen Workflow aus, der eine Aktion enthält, die einen Bericht generiert. Dies ist der Bericht, für den Sie Erfolgskriterien anwenden möchten. Sie können nach dem Quell-Repository oder dem Branchnamen filtern, in dem der Workflow definiert ist, oder nach Workflow-Namen oder -Status filtern.

  3. Wählen Sie Bearbeiten aus.

  4. Wählen Sie YAML.

  5. Wählen Sie im Workflow-Diagramm die Aktion aus, die Sie zum Generieren von CodeCatalyst Berichten konfiguriert haben.

  6. Wählen Sie im Detailbereich die Registerkarte Ausgaben aus.

  7. Fügen Sie in AutoDiscoverReports der Aktion, im Reports Abschnitt oder im Abschnitt eine SuccessCriteria Eigenschaft zusammen mitPassRate,LineCoverage,BranchCoverage, Vulnerabilities StaticAnalysisBugStaticAnalysisSecurity, und StaticAnalysisQuality Eigenschaften hinzu.

    Eine Erläuterung der einzelnen Eigenschaften finden Sie imAktionen erstellen und testen YAML.

  8. Wählen Sie Commit (Übergeben).

  9. Führen Sie Ihren Workflow so aus, dass Erfolgskriterien auf Ihre Rohberichte CodeCatalyst angewendet werden, und generieren Sie die zugehörigen CodeCatalyst Berichte mit den Informationen zu den Erfolgskriterien erneut. Weitere Informationen zum Starten eines Workflows finden Sie unterManuelles Starten einer Workflow-Ausführung.

Beispiel für Qualitätsberichte (YAML)

Das folgende Beispiel zeigt, wie vier Berichte manuell konfiguriert werden: ein Testbericht, ein Bericht zur Codeabdeckung, ein Bericht zur Analyse der Softwarekomposition und ein statischer Analysebericht.

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