View a markdown version of this page

Configurazione dei report sulla qualità in un'azione - Amazon CodeCatalyst
Auto-discovery e report manualiConfigurazione dei criteri di successo per i reportRapporti sulla qualità (esempio YAML)

Amazon non CodeCatalyst è più aperto a nuovi clienti. I clienti esistenti possono continuare a utilizzare il servizio normalmente. Per ulteriori informazioni, consulta Come migrare da CodeCatalyst.

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Configurazione dei report sulla qualità in un'azione

Questa sezione descrive come configurare un rapporto sulla qualità in un'azione.

Auto-discovery e report manuali

Quando il rilevamento automatico è abilitato, CodeCatalyst cerca tutti gli input passati all'azione e tutti i file generati dall'azione stessa, cercando report di test, copertura del codice, analisi della composizione software (SCA) e analisi statica (SA). È possibile visualizzare e manipolare ciascuno di questi report in. CodeCatalyst

È inoltre possibile configurare manualmente quali report vengono generati. Puoi specificare il tipo di rapporto che desideri generare e il formato del file. Per ulteriori informazioni, consulta Tipi di report sulla qualità.

Configurazione dei criteri di successo per i report

È possibile impostare i valori che determinano i criteri di successo per un report di test, copertura del codice, analisi della composizione software (SCA) o analisi statica (SA).

I criteri di successo sono soglie che determinano se un report viene superato o meno. CodeCatalyst genera innanzitutto il report, che può essere un test, un report sulla copertura del codice, un report SCA o SA, quindi applica i criteri di successo ai report generati. Mostra quindi se i criteri di successo sono stati soddisfatti e in che misura. Se un report non soddisfa i criteri di successo specificati, l' CodeCatalyst azione che ha specificato i criteri di successo ha esito negativo.

Ad esempio, quando si impostano i criteri di successo per il report SCA, i valori di vulnerabilità validi che vanno dal più grave al meno grave sono:CRITICAL,,, HIGHMEDIUM,LOW. INFORMATIONAL Se imposti i criteri per la scansione di una vulnerabilità di HIGH gravità, il report fallirà se è presente almeno una vulnerabilità HIGH grave o nessuna vulnerabilità grave, ma almeno una vulnerabilità a un livello di HIGH gravità più elevato, ad esempio una vulnerabilità di gravità. CRITICAL

Se non specifichi i criteri di successo, allora:

  • Il CodeCatalyst rapporto generato in base ai report non elaborati non visualizzerà i criteri di successo.

  • I criteri di successo non verranno utilizzati per determinare se l'azione associata al flusso di lavoro viene completata o meno.

Visual
Per configurare i criteri di successo

  1. Nel riquadro di navigazione, scegli CI/CD, quindi scegli Flussi di lavoro.

  2. Scegli un flusso di lavoro contenente un'azione che genera un report. Questo è il report per il quale desideri applicare i criteri di successo. È possibile filtrare in base al nome del repository di origine o della filiale in cui è definito il flusso di lavoro oppure in base al nome o allo stato del flusso di lavoro.

  3. Scegli Modifica.

  4. Scegli Visual.

  5. Nel diagramma del flusso di lavoro, scegli l'azione che hai configurato per generare CodeCatalyst report.

  6. Seleziona la scheda Outputs (Output).

  7. In Auto-discover Rapporti o in Configurazione manuale dei report, scegli Criteri di successo.

    Vengono visualizzati i criteri di successo. A seconda delle selezioni precedenti, potresti visualizzare una o tutte queste opzioni:

    Percentuale di passaggio

    Specifica la percentuale di test in un rapporto di prova che deve essere superata affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. I valori validi includono numeri decimali. Ad esempio, 50, 60.5. I criteri della percentuale di superamento vengono applicati solo ai report dei test. Per ulteriori informazioni sui rapporti di prova, vedereReport sui test.

    Copertura della linea

    Specificate la percentuale di righe in un rapporto sulla copertura del codice che devono essere coperte affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. I valori validi includono numeri decimali. Ad esempio, 50, 60.5. I criteri di copertura delle linee vengono applicati solo ai report sulla copertura del codice. Per ulteriori informazioni sui report sulla copertura del codice, vedereReport di copertura del codice.

    Copertura delle filiali

    Specifica la percentuale di filiali in un rapporto sulla copertura del codice che deve essere coperta affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. I valori validi includono numeri decimali. Ad esempio, 50, 60.5. I criteri di copertura delle filiali vengono applicati solo ai report sulla copertura del codice. Per ulteriori informazioni sui report sulla copertura del codice, vedereReport di copertura del codice.

    Vulnerabilità (SCA)

    Specifica il numero massimo e la gravità delle vulnerabilità consentite nel rapporto SCA affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. Per specificare le vulnerabilità, è necessario specificare:

    • La gravità minima delle vulnerabilità da includere nel conteggio. I valori validi, dal più grave al meno grave, sono:CRITICAL,HIGH,, MEDIUMLOW,INFORMATIONAL.

      Ad esempio, se scegliHIGH, verranno HIGH CRITICAL conteggiate le vulnerabilità.

    • Il numero massimo di vulnerabilità della gravità specificata che desideri consentire. Il superamento di questo numero fa sì che la CodeCatalyst segnalazione venga contrassegnata come non riuscita. I valori validi sono numeri interi.

    I criteri di vulnerabilità vengono applicati solo ai report SCA. Per ulteriori informazioni sui report SCA, vedere. Rapporti di analisi della composizione del software

    Bug

    Specifica il numero massimo e la gravità dei bug consentiti nel rapporto SA affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. Per specificare i bug, è necessario specificare:

    • La gravità minima dei bug da includere nel conteggio. I valori validi, dal più grave al meno grave, sono: CRITICALHIGH,,MEDIUM,LOW,INFORMATIONAL.

      Ad esempio, se lo desideriHIGH, verranno HIGH conteggiati i CRITICAL bug.

    • Il numero massimo di bug della gravità specificata che desideri consentire. Il superamento di questo numero fa sì che la CodeCatalyst segnalazione venga contrassegnata come non riuscita. I valori validi sono numeri interi.

    I criteri relativi ai bug vengono applicati solo ai PyLint report di ESLint SA. Per ulteriori informazioni sui report SA, vedere. Rapporti di analisi statica

    Vulnerabilità di sicurezza

    Specifica il numero massimo e la gravità delle vulnerabilità di sicurezza consentite nel rapporto SA affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. Per specificare le vulnerabilità di sicurezza, è necessario specificare:

    • La gravità minima delle vulnerabilità di sicurezza che desideri includere nel conteggio. I valori validi, dal più grave al meno grave, sono:CRITICAL,HIGH,, MEDIUMLOW,INFORMATIONAL.

      Ad esempio, se si sceglieHIGH, verranno HIGH conteggiate le vulnerabilità di CRITICAL sicurezza.

    • Il numero massimo di vulnerabilità di sicurezza della gravità specificata che desideri consentire. Il superamento di questo numero fa sì che il CodeCatalyst rapporto venga contrassegnato come non riuscito. I valori validi sono numeri interi.

    I criteri relativi alle vulnerabilità di sicurezza vengono applicati solo ai report PyLint di ESLint SA. Per ulteriori informazioni sui report SA, vedere. Rapporti di analisi statica

    Problemi di qualità

    Specifica il numero massimo e la gravità dei problemi di qualità consentiti nel rapporto SA affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. Per specificare i problemi di qualità, è necessario specificare:

    • La gravità minima dei problemi di qualità da includere nel conteggio. I valori validi, dal più grave al meno grave, sono: CRITICALHIGH,,MEDIUM,LOW,INFORMATIONAL.

      Ad esempio, se scegliHIGH, verranno HIGH conteggiati i problemi di CRITICAL qualità.

    • Il numero massimo di problemi di qualità della gravità specificata che si desidera consentire. Il superamento di questo numero fa sì che il CodeCatalyst rapporto venga contrassegnato come non riuscito. I valori validi sono numeri interi.

    I criteri relativi ai problemi di qualità vengono applicati solo ai PyLint report di ESLint SA. Per ulteriori informazioni sui report SA, vedere. Rapporti di analisi statica

  8. Scegli Applica.

  9. Esegui il tuo flusso di lavoro per CodeCatalyst applicare i criteri di successo ai report non elaborati e rigenera i CodeCatalyst report associati con le informazioni sui criteri di successo incluse. Per ulteriori informazioni, consulta Avvio manuale dell’esecuzione di un flusso di lavoro.

YAML
Per configurare i criteri di successo

  1. Nel riquadro di navigazione, scegli CI/CD, quindi scegli Flussi di lavoro.

  2. Scegli un flusso di lavoro contenente un'azione che genera un report. Questo è il report per il quale desideri applicare i criteri di successo. È possibile filtrare in base al nome del repository di origine o della filiale in cui è definito il flusso di lavoro oppure in base al nome o allo stato del flusso di lavoro.

  3. Scegli Modifica.

  4. Scegli YAML.

  5. Nel diagramma del flusso di lavoro, scegli l'azione che hai configurato per generare CodeCatalyst report.

  6. Nel riquadro dei dettagli, scegli la scheda Output.

  7. Nell'azione, nella AutoDiscoverReports sezione o nella Reports sezione, aggiungi una SuccessCriteria proprietà, insieme a PassRateLineCoverage,BranchCoverage,Vulnerabilities, StaticAnalysisBugStaticAnalysisSecurity, e StaticAnalysisQuality proprietà.

    Per una spiegazione di ciascuna di queste proprietà, consulta ilCostruisci e testa azioni YAML.

  8. Scegli Applica.

  9. Esegui il tuo flusso di lavoro per CodeCatalyst applicare i criteri di successo ai report non elaborati e rigenera i CodeCatalyst report associati con le informazioni sui criteri di successo incluse. Per ulteriori informazioni sull'avvio di un flusso di lavoro, vedereAvvio manuale dell’esecuzione di un flusso di lavoro.

Rapporti sulla qualità (esempio YAML)

L'esempio seguente mostra come configurare manualmente quattro report: un report di test, un report sulla copertura del codice, un report di analisi della composizione del software e un report di analisi statica.

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