Amazon ya no CodeCatalyst está abierto a nuevos clientes. Los clientes existentes pueden seguir utilizando el servicio con normalidad. Para obtener más información, consulte [Cómo migrar desde CodeCatalyst](migration.md).
Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
# Configuración de informes de calidad en una acción
En esta sección se describe cómo configurar un informe de calidad en una acción.
**Topics**
+ [Detección automática e informes manuales](#test.auto-discovery)
+ [Configuración de los criterios de éxito de los informes](#test.success-criteria)
+ [Ejemplo de informes de calidad en YAML](#test.success-criteria-example)
## Detección automática e informes manuales
Cuando la detección automática está habilitada, CodeCatalyst busca en todas las entradas transferidas a la acción y en todos los archivos generados por la propia acción, buscando informes de pruebas, cobertura de código, análisis de composición de software (SCA) y análisis estático (SA). Puede ver y manipular cada uno de estos informes en. CodeCatalyst
También puede configurar manualmente los informes que se generan. Puede especificar el tipo de informe que desea generar, así como el formato de archivo. Para obtener más información, consulte [Tipos de informes de calidad](test-workflow-actions.md#test-reporting).
## Configuración de los criterios de éxito de los informes
Puede establecer los valores que determinan los criterios de éxito de un informe de prueba, cobertura de código, análisis de composición de software (SCA) o análisis estático (SA).
Los criterios de éxito son umbrales que determinan si un informe se aprueba o no. CodeCatalyst primero genera el informe, que puede ser un informe de prueba, de cobertura de código, de SCA o SA, y, a continuación, aplica los criterios de éxito a los informes generados. A continuación, muestra si se han cumplido los criterios de éxito y en qué medida. Si algún informe no cumple los criterios de éxito especificados, la CodeCatalyst acción que especificó los criterios de éxito fallará.
Por ejemplo, al establecer los criterios de éxito del informe de SCA, los valores de vulnerabilidad válidos, que van del más al menos grave, son: `CRITICAL`, `HIGH`, `MEDIUM`, `LOW` y `INFORMATIONAL`. Si establece los criterios para buscar una vulnerabilidad de gravedad `HIGH`, el informe fallará si hay al menos una vulnerabilidad de gravedad `HIGH` o no hay ninguna vulnerabilidad de gravedad `HIGH`, pero hay al menos una vulnerabilidad de un nivel de gravedad superior, como una vulnerabilidad de gravedad `CRITICAL`.
Si no especifica los criterios de éxito, ocurrirá lo siguiente:
+ El CodeCatalyst informe que se genere a partir de sus informes sin procesar no mostrará los criterios de éxito.
+ Los criterios correctos no se utilizarán para determinar si la acción de flujo de trabajo asociada se aprueba o no.
------
#### [ Visual ]
**Configuración de los criterios de éxito**
1. En el panel de navegación, elija **CI/CD** y, a continuación, elija **Flujos de trabajo**.
1. Elija un flujo de trabajo que contenga una acción que genere un informe. Este es el informe al que quiera aplicar los criterios de éxito. Puede filtrar por el nombre del repositorio de código fuente o la ramificación donde esté definido el flujo de trabajo, o bien por el nombre o el estado del flujo de trabajo.
1. Elija **Edit (Edición de)**.
1. Elija **Visual**.
1. En el diagrama de flujo de trabajo, elija la acción que ha configurado para generar CodeCatalyst informes.
1. Elija la pestaña **Salidas**.
1. En **Informes de detección automática** o en **Configurar informes manualmente**, elija **Criterios de éxito**.
Aparecen los criterios de éxito. En función de las selecciones anteriores, podría ver alguna de estas opciones o todas ellas:
**Índice de aprobación**
Especifique el porcentaje de pruebas en un informe de prueba que deben aprobarse para que el CodeCatalyst informe asociado se marque como aprobado. Los valores válidos son números decimales. Por ejemplo: `50`, `60.5`. Los criterios del índice de aprobación se aplican únicamente a los informes de pruebas. Para obtener más información sobre los informes de pruebas, consulte [Informes de pruebas](test-workflow-actions.md#test-reports).
**Cobertura de línea**
Especifique el porcentaje de líneas de un informe de cobertura de código que deben cubrirse para que el CodeCatalyst informe asociado se marque como aprobado. Los valores válidos son números decimales. Por ejemplo: `50`, `60.5`. Los criterios de cobertura de línea se aplican únicamente a los informes de cobertura de código. Para obtener más información sobre los informes de cobertura de código, consulte [Informes de cobertura de código](test-workflow-actions.md#test-code-coverage-reports).
**Cobertura de ramificación**
Especifique el porcentaje de ramificaciones de un informe de cobertura de código que deben cubrirse para que el CodeCatalyst informe asociado se marque como aprobado. Los valores válidos son números decimales. Por ejemplo: `50`, `60.5`. Los criterios de cobertura de ramificaciones se aplican únicamente a los informes de cobertura de código. Para obtener más información sobre los informes de cobertura de código, consulte [Informes de cobertura de código](test-workflow-actions.md#test-code-coverage-reports).
**Vulnerabilidades (SCA)**
Especifique el número máximo y la gravedad de las vulnerabilidades permitidas en el informe de la SCA para que el CodeCatalyst informe asociado se marque como aprobado. Para especificar las vulnerabilidades, debe especificar lo siguiente:
+ La gravedad mínima de las vulnerabilidades que desea incluir en el recuento. Los valores válidos, desde el más al menos grave, son `CRITICAL`, `HIGH`, `MEDIUM`, `LOW` y `INFORMATIONAL`.
Por ejemplo, si elige `HIGH`, se contabilizan las vulnerabilidades `HIGH` y `CRITICAL`.
+ El número máximo de vulnerabilidades de la gravedad especificada que desea permitir. Si se supera este número, el CodeCatalyst informe se marca como fallido. Los valores válidos son números enteros.
Los criterios de vulnerabilidad se aplican únicamente a los informes de SCA. Para obtener más información acerca de los informes de SCA, consulte [Informes de análisis de composición de software](test-workflow-actions.md#test-sca-reports).
**Errores**
Especifique el número máximo y la gravedad de los errores permitidos en el informe de SA para que el CodeCatalyst informe asociado se marque como aprobado. Para especificar errores, debe especificar lo siguiente:
+ La gravedad mínima de los errores que desea incluir en el recuento. Los valores válidos, desde el más al menos grave, son `CRITICAL`, `HIGH`, `MEDIUM`, `LOW` y `INFORMATIONAL`.
Por ejemplo, si elige `HIGH`, se contabilizan los errores `HIGH` y `CRITICAL`.
+ El número máximo de errores de la gravedad especificada que desea permitir. Si se supera este número, el CodeCatalyst informe se marcará como fallido. Los valores válidos son números enteros.
Los criterios de errores se aplican únicamente a PyLint los informes de ESLint SA. Para obtener más información acerca de los informes de SA, consulte [Informes de análisis estático](test-workflow-actions.md#test-static-analysis-reports).
**Vulnerabilidades de seguridad**
Especifique el número máximo y la gravedad de las vulnerabilidades de seguridad permitidas en el informe de SA para que el CodeCatalyst informe asociado se marque como aprobado. Para especificar las vulnerabilidades de seguridad, debe especificar lo siguiente:
+ La gravedad mínima de las vulnerabilidades de seguridad que desea incluir en el recuento. Los valores válidos, desde el más al menos grave, son `CRITICAL`, `HIGH`, `MEDIUM`, `LOW` y `INFORMATIONAL`.
Por ejemplo, si elige `HIGH`, se contabilizan las vulnerabilidades de seguridad `HIGH` y `CRITICAL`.
+ El número máximo de vulnerabilidades de seguridad de la gravedad especificada que desea permitir. Si se supera este número, el CodeCatalyst informe se marca como fallido. Los valores válidos son números enteros.
Los criterios de vulnerabilidad de seguridad se aplican únicamente a PyLint los informes de ESLint SA. Para obtener más información acerca de los informes de SA, consulte [Informes de análisis estático](test-workflow-actions.md#test-static-analysis-reports).
**Problemas de calidad**
Especifique el número máximo y la gravedad de los problemas de calidad permitidos en el informe de SA para que el CodeCatalyst informe asociado se marque como aprobado. Para especificar problemas de calidad, debe especificar lo siguiente:
+ La gravedad mínima de los problemas de calidad que desea incluir en el recuento. Los valores válidos, desde el más al menos grave, son `CRITICAL`, `HIGH`, `MEDIUM`, `LOW` y `INFORMATIONAL`.
Por ejemplo, si elige `HIGH`, se contabilizan los problemas de calidad `HIGH` y `CRITICAL`.
+ El número máximo de problemas de calidad de la gravedad especificada que desea permitir. Si se supera este número, el CodeCatalyst informe se marca como fallido. Los valores válidos son números enteros.
Los criterios de calidad se aplican únicamente a PyLint los informes ESLint SA. Para obtener más información acerca de los informes de SA, consulte [Informes de análisis estático](test-workflow-actions.md#test-static-analysis-reports).
1. Elija **Confirmar**.
1. Ejecute su flujo de trabajo para CodeCatalyst aplicar los criterios de éxito a sus informes sin procesar y regenere los CodeCatalyst informes asociados con la información sobre los criterios de éxito incluida. Para obtener más información, consulte [Inicio manual de la ejecución de un flujo de trabajo](workflows-manually-start.md).
------
#### [ YAML ]
**Configuración de los criterios de éxito**
1. En el panel de navegación, elija **CI/CD** y, a continuación, elija **Flujos de trabajo**.
1. Elija un flujo de trabajo que contenga una acción que genere un informe. Este es el informe al que quiera aplicar los criterios de éxito. Puede filtrar por el nombre del repositorio de código fuente o la ramificación donde esté definido el flujo de trabajo, o bien por el nombre o el estado del flujo de trabajo.
1. Elija **Edit (Edición de)**.
1. Elija **YAML**.
1. En el diagrama de flujo de trabajo, elija la acción que ha configurado para generar CodeCatalyst informes.
1. En el panel de detalles, seleccione la pestaña **Salidas**.
1. En la acción, en la `AutoDiscoverReports` sección o en la `Reports` sección, añada una **SuccessCriteria**propiedad junto con `PassRate` `LineCoverage``BranchCoverage`,`Vulnerabilities`,`StaticAnalysisBug`,`StaticAnalysisSecurity`, y `StaticAnalysisQuality` propiedades.
Para obtener una explicación de cada una de estas propiedades, consulte la [Acciones de compilación y prueba de YAML](build-action-ref.md).
1. Elija **Confirmar**.
1. Ejecute su flujo de trabajo para CodeCatalyst aplicar los criterios de éxito a sus informes sin procesar y regenere los CodeCatalyst informes asociados con la información sobre los criterios de éxito incluida. Para obtener más información acerca del inicio de un flujo de trabajo, consulte [Inicio manual de la ejecución de un flujo de trabajo](workflows-manually-start.md).
------
## Ejemplo de informes de calidad en YAML
El siguiente ejemplo muestra cómo configurar manualmente cuatro informes: un informe de prueba, un informe de cobertura de código, un informe de análisis de composición de software y un informe de análisis estático.
```
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
```