작업의 품질 보고서 구성 - 아마존 CodeCatalyst
자동 검색 및 수동 보고서보고서의 성공 기준 구성품질 보고서 YAML 예제

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

작업의 품질 보고서 구성

이 섹션에서는 액션에서 품질 보고서를 구성하는 방법을 설명합니다.

자동 검색 및 수동 보고서

자동 검색이 활성화되면 작업에 전달된 모든 입력과 작업 자체에서 생성된 모든 파일을 CodeCatalyst 검색하여 테스트, 코드 적용 범위, SCA (소프트웨어 구성 분석) 및 SA (정적 분석) 보고서를 찾습니다. 에서 이러한 각 보고서를 보고 조작할 수 있습니다. CodeCatalyst

생성할 보고서를 수동으로 구성할 수도 있습니다. 생성하려는 보고서 유형과 파일 형식을 지정할 수 있습니다. 자세한 정보는 품질 보고서 유형을 참조하세요.

보고서의 성공 기준 구성

테스트, 코드 적용 범위, 소프트웨어 구성 분석 (SCA) 또는 정적 분석 (SA) 보고서의 성공 기준을 결정하는 값을 설정할 수 있습니다.

성공 기준은 보고서의 합격 또는 불합격 여부를 결정하는 임계값입니다. CodeCatalyst 먼저 테스트, 코드 적용 범위, SCA 또는 SA 보고서가 될 수 있는 보고서를 생성한 다음 생성된 보고서에 성공 기준을 적용합니다. 그런 다음 성공 기준의 충족 여부와 어느 정도까지 충족되었는지를 보여줍니다. 보고서가 지정된 성공 기준을 충족하지 않는 경우 성공 기준을 지정한 CodeCatalyst 작업이 실패합니다.

예를 들어, SCA 보고서의 성공 기준을 설정할 때 유효한 취약성 값 범위는 가장 심각도가 높은 것부터 가장 심각하지 않은 것까지 다양합니다. CRITICAL HIGH MEDIUM LOW INFORMATIONAL 심각도에 따라 취약성 하나를 검사하도록 기준을 설정한 경우 HIGH 심각도에 해당하는 취약성이 하나 이상 있거나 심각도에 취약성이 없는 경우 보고서가 실패합니다. 예를 들어 HIGH 심각도가 더 높은 취약성 하나 (예: 심각도 수준의 취약성 하나). HIGH CRITICAL

성공 기준을 지정하지 않는 경우:

  • 원시 CodeCatalyst 보고서를 기반으로 생성된 보고서에는 성공 기준이 표시되지 않습니다.

  • 성공 기준은 관련 워크플로 작업의 성공 또는 실패 여부를 결정하는 데 사용되지 않습니다.

Visual
성공 기준을 구성하려면

  1. 탐색 창에서 CI/CD를 선택한 다음 워크플로를 선택합니다.

  2. 보고서를 생성하는 작업이 포함된 워크플로를 선택합니다. 성공 기준을 적용하려는 보고서입니다. 워크플로가 정의된 소스 리포지토리 또는 브랜치 이름을 기준으로 필터링하거나 워크플로 이름을 기준으로 필터링할 수 있습니다.

  3. 편집을 선택합니다.

  4. Visual을 선택합니다.

  5. 워크플로 다이어그램에서 CodeCatalyst 보고서를 생성하도록 구성한 작업을 선택합니다.

  6. 출력 탭을 선택합니다.

  7. 보고서 자동 검색 또는 보고서 수동 구성에서 성공 기준을 선택합니다.

    성공 기준이 표시됩니다. 이전 선택에 따라 다음 옵션 중 일부 또는 전체가 표시될 수 있습니다.

    합격률

    테스트 보고서의 테스트 중 통과해야 관련 CodeCatalyst 보고서가 통과된 것으로 표시되는 테스트 비율을 지정합니다. 유효한 값에는 10진수가 포함됩니다. 예: 50, 60.5. 합격률 기준은 테스트 보고서에만 적용됩니다. 테스트 보고서에 대한 자세한 내용은 을 참조하십시오테스트 보고서.

    회선 커버리지

    관련 보고서가 통과된 것으로 표시되기 위해 포함되어야 하는 코드 커버리지 CodeCatalyst 보고서의 라인 비율을 지정합니다. 유효한 값에는 10진수가 포함됩니다. 예: 50, 60.5. 라인 커버리지 기준은 코드 커버리지 보고서에만 적용됩니다. 코드 커버리지 보고서에 대한 자세한 내용은 을 참조하십시오코드 범위 보고서.

    브랜치 커버리지

    코드 커버리지 보고서에서 관련 CodeCatalyst 보고서를 통과한 것으로 표시하기 위해 반드시 포함해야 하는 브랜치의 비율을 지정합니다. 유효한 값에는 10진수가 포함됩니다. 예: 50, 60.5. 브랜치 커버리지 기준은 코드 커버리지 보고서에만 적용됩니다. 코드 커버리지 보고서에 대한 자세한 내용은 을 참조하십시오코드 범위 보고서.

    취약성 (SCA)

    관련 CodeCatalyst 보고서가 통과된 것으로 표시되도록 SCA 보고서에서 허용되는 최대 취약성 수와 심각도를 지정합니다. 취약성을 지정하려면 다음을 지정해야 합니다.

    • 집계에 포함하려는 취약성의 최소 심각도. 가장 심각한 값부터 가장 심각하지 않은 값까지 유효한 값은,CRITICAL,, HIGH MEDIUMLOW, INFORMATIONAL 입니다.

      예를 들어HIGH, 선택하면 HIGH CRITICAL 취약성이 집계됩니다.

    • 허용하려는 지정된 심각도 내에서 허용되는 최대 취약성 수입니다. 이 수를 초과하면 CodeCatalyst 보고서가 실패로 표시됩니다. 유효한 값은 정수입니다.

    취약성 기준은 SCA 보고서에만 적용됩니다. SCA 보고서에 대한 자세한 내용은 을 참조하십시오. 소프트웨어 구성 분석 보고서

    버그

    관련 CodeCatalyst 보고서가 통과된 것으로 표시되도록 SA 보고서에서 허용되는 최대 버그 수와 심각도를 지정하십시오. 버그를 지정하려면 다음을 지정해야 합니다.

    • 카운트에 포함하려는 버그의 최소 심각도. 가장 심각한 값부터 가장 심각하지 않은 값까지 유효한 값은CRITICAL,,HIGH, MEDIUMLOW, INFORMATIONAL 입니다.

      예를 들어HIGH, 선택하면 HIGH CRITICAL 버그가 집계됩니다.

    • 허용하려는 지정된 심각도의 최대 버그 수입니다. 이 숫자를 초과하면 CodeCatalyst 보고서가 실패로 표시됩니다. 유효한 값은 정수입니다.

    버그 기준은 ESLint SA 보고서에만 적용됩니다 PyLint . SA 보고서에 대한 자세한 내용은 을 참조하십시오. 정적 분석 보고서

    보안 취약성

    관련 CodeCatalyst 보고서가 통과된 것으로 표시되도록 SA 보고서에서 허용되는 보안 취약성의 최대 수와 심각도를 지정하십시오. 보안 취약성을 지정하려면 다음을 지정해야 합니다.

    • 카운트에 포함하려는 보안 취약성의 최소 심각도. 가장 심각한 값부터 가장 심각하지 않은 값까지 유효한 값은,CRITICAL,, HIGH MEDIUMLOW, INFORMATIONAL 입니다.

      예를 들어HIGH, 선택하면 HIGH CRITICAL 보안 취약성이 집계됩니다.

    • 허용하려는 지정된 심각도의 최대 보안 취약성 수입니다. 이 수를 초과하면 CodeCatalyst 보고서가 실패로 표시됩니다. 유효한 값은 정수입니다.

    보안 취약성 기준은 ESLint SA PyLint 보고서에만 적용됩니다. SA 보고서에 대한 자세한 내용은 을 참조하십시오. 정적 분석 보고서

    품질 문제

    관련 CodeCatalyst 보고서를 통과로 표시하기 위해 SA 보고서에서 허용되는 품질 문제의 최대 수와 심각도를 지정하십시오. 품질 문제를 지정하려면 다음을 지정해야 합니다.

    • 집계에 포함하려는 품질 문제의 최소 심각도. 가장 심각한 값부터 가장 심각하지 않은 값까지 유효한 값은CRITICAL,,HIGH, MEDIUMLOW, INFORMATIONAL 입니다.

      예를 들어HIGH, 선택하면 HIGH CRITICAL 품질 문제가 집계됩니다.

    • 허용하려는 지정된 심각도의 품질 문제 최대 개수. 이 수를 초과하면 CodeCatalyst 보고서가 실패로 표시됩니다. 유효한 값은 정수입니다.

    품질 문제 기준은 ESLint SA 보고서에만 적용됩니다 PyLint . SA 보고서에 대한 자세한 내용은 을 참조하십시오. 정적 분석 보고서

  8. 커밋을 선택합니다.

  9. 워크플로를 실행하여 원시 보고서에 성공 기준을 CodeCatalyst 적용하고 성공 기준 정보가 포함된 관련 CodeCatalyst 보고서를 다시 생성하십시오. 자세한 정보는 워크플로우 수동 실행 시작을 참조하세요.

YAML
성공 기준을 구성하려면

  1. 탐색 창에서 CI/CD를 선택한 다음 워크플로를 선택합니다.

  2. 보고서를 생성하는 작업이 포함된 워크플로를 선택합니다. 성공 기준을 적용하려는 보고서입니다. 워크플로가 정의된 소스 리포지토리 또는 브랜치 이름을 기준으로 필터링하거나 워크플로 이름을 기준으로 필터링할 수 있습니다.

  3. 편집을 선택합니다.

  4. YAML을 선택합니다.

  5. 워크플로 다이어그램에서 CodeCatalyst 보고서를 생성하도록 구성한 작업을 선택합니다.

  6. 세부 정보 창에서 출력 탭을 선택합니다.

  7. 액션, AutoDiscoverReports 섹션 또는 섹션에서,,, PassRate LineCoverage BranchCoverage Vulnerabilities StaticAnalysisBugStaticAnalysisSecurity, 및 SuccessCriteria속성과 함께 StaticAnalysisQuality 속성을 추가합니다. Reports

    각 속성에 대한 설명은 를 참조하십시오액션 YAML 정의 빌드 및 테스트.

  8. 커밋을 선택합니다.

  9. 워크플로를 실행하여 원시 보고서에 성공 기준을 CodeCatalyst 적용하고 성공 기준 정보가 포함된 관련 CodeCatalyst 보고서를 재생성하십시오. 워크플로우 시작에 대한 자세한 내용은 을 참조하십시오워크플로우 수동 실행 시작.

품질 보고서 YAML 예제

다음 예제는 테스트 보고서, 코드 커버리지 보고서, 소프트웨어 구성 분석 보고서, 정적 분석 보고서 등 네 가지 보고서를 수동으로 구성하는 방법을 보여줍니다.

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