코드 품질 테스트
파이프라인의 코드 품질 테스트가 어떻게 작동하고 배포 품질을 어떻게 개선할 수 있는지 알아봅니다.
소개
코드 품질 테스트는 일련의 품질 규칙을 기반으로 애플리케이션 코드를 평가합니다. 코드 품질 전용 파이프라인의 주요 목적이며 모든 프로덕션 및 비프로덕션 파이프라인에서 빌드 단계 직후에 실행됩니다.
다양한 파이프라인 유형에 대한 자세한 내용은 CI-CD 파이프라인 구성을 참조하십시오.
코드 품질 규칙
코드 품질 테스트는 소스 코드를 스캔하여 특정 품질 기준을 충족하는지 확인합니다. SonarQube와 OakPAL을 사용한 콘텐츠 패키지 수준 검사의 조합은 이 단계를 구현합니다. 일반적인 Java 규칙과 AEM 관련 규칙을 결합한 100개 이상의 규칙이 있습니다. 일부 AEM 관련 규칙은 AEM 엔지니어링의 모범 사례를 기반으로 하며 사용자 지정 코드 품질 규칙이라고 합니다.
이 링크를 사용하여 규칙의 최신 전체 목록을 다운로드할 수 있습니다.
IMPORTANT3계층 등급
코드 품질 테스트를 통해 식별된 문제는 세 가지 범주 중 하나에 할당됩니다.
-
심각 - 파이프라인의 즉각적인 실패를 초래하는 문제입니다.
-
중요 - 파이프라인을 일시 중지 상태로의 전환을 초래하는 문제입니다. 배포 관리자, 프로젝트 관리자 또는 비즈니스 소유자는 문제를 재정의하여 파이프라인을 진행할 수 있습니다. 또는 파이프라인이 오류로 중단되는 경우 문제를 수락할 수 있습니다.
-
정보 - 순전히 정보 제공 목적으로 제공되며 파이프라인 실행에 영향을 미치지 않는 문제
NOTE등급
이 단계의 결과는 등급 으로 전달됩니다.
다음 테이블에는 심각, 중요 및 정보 범주 각각에 대한 등급 및 오류 임계값이 요약되어 있습니다.
| 이름 | 정의 | 범주 | 오류 임계값 |
|---|---|---|---|
| 보안 등급 | A = 취약점 없음 B = 1개 이상의 사소한 취약점 C = 1개 이상의 주요 취약점 D = 1개 이상의 심각한 취약점 E = 1개 이상의 차단 취약점 | 심각 | < B |
| 안정성 등급 | A = 버그 없음 B = 1개 이상의 사소한 버그 C = 1개 이상의 주요 버그 D = 1개 이상의 심각한 버그 E = 1개 이상의 차단 버그 | 심각 | < D |
| 유지 가능성 등급 |
코드 스멜에 대한 미해결 교정 비용으로 정의되며, 애플리케이션에 이미 들어간 시간의 백분율입니다.
| 중요 | < A |
| 범위 |
다음 공식을 사용하여 단위 테스트 라인 범위와 조건 범위의 혼합으로 정의됩니다.
| 중요 | < 50% |
| 건너뛴 단위 테스트 | 건너뛴 단위 테스트 수 | 정보 | > 1 |
| 미해결 문제 | 전반적인 문제 유형 - 취약점, 버그 및 코드 스멜 | 정보 | > 0 |
| 중복 라인 |
중복된 블록과 관련된 라인의 수로 정의됩니다. 다음 조건에서는 코드 블록이 중복된 것으로 간주됩니다.
Java 프로젝트:
중복 요소를 감지할 때 들여쓰기 및 문자열 리터럴의 차이는 무시됩니다. | 정보 | > 1% |
| Cloud Service 호환성 | 식별된 Cloud Service 호환성 문제 수 | 정보 | > 0 |
NOTENOTE긍정 오류 처리
품질 검사 프로세스가 완벽하지 않으며 실제로 문제가 아닌 문제를 잘못 식별하기도 합니다. 이 상태를 긍정 오류 이라고 합니다.
이러한 경우 소스 코드는 규칙 ID를 주석 속성으로 지정하는 표준 Java @SuppressWarnings 주석으로 추가할 수 있습니다. 예를 들어 한 가지 일반적인 긍정 오류는 하드코딩된 암호를 탐지하는 SonarQube 규칙이 하드코딩된 암호를 식별하는 방법에 대해 공격적일 수 있다는 것입니다.
다음 코드는 일부 외부 서비스에 연결하는 코드가 있는 AEM 프로젝트에서 상당히 일반적입니다.
@Property(label = "Service Password")
private static final String PROP_SERVICE_PASSWORD = "password";
SonarQube는 차단 취약점을 발생시킵니다. 그러나 코드를 검토한 후 이 문제는 취약점이 아니며 적절한 규칙 ID로 코드에 주석을 달 수 있다는 것을 알게 됩니다.
@SuppressWarnings("squid:S2068")
@Property(label = "Service Password")
private static final String PROP_SERVICE_PASSWORD = "password";
단, 코드가 실제로 다음과 같은 경우
@Property(label = "Service Password", value = "mysecretpassword")
private static final String PROP_SERVICE_PASSWORD = "password";
이때 하드 코딩된 암호를 제거하는 것이 올바른 해결 방법입니다.
NOTE@SuppressWarnings 주석을 가능한 구체적으로 만드는 것이 가장 좋지만(문제를 일으키는 문이나 블록에만 주석 추가) 클래스 수준에서 주석을 추가하는 것도 가능합니다.NOTE콘텐츠 패키지 검색 최적화
품질 분석 프로세스의 일환으로 Cloud Manager는 Maven 빌드에서 생성된 콘텐츠 패키지에 대한 분석을 수행합니다. Cloud Manager은 이 프로세스를 가속화하기 위한 최적화를 제공하며, 이는 특정 패키징 제한이 관찰될 때 효과적입니다. 가장 중요한 최적화는 빌드에서 건너뛴 것으로 표시된 여러 콘텐츠 패키지를 포함하는 단일 "모든" 패키지를 생성하는 프로젝트를 타겟팅합니다. Cloud Manager가 이 시나리오를 감지하면 “모든” 패키지의 압축을 푸는 대신 개별 콘텐츠 패키지가 직접 스캔되고 종속성에 따라 정렬됩니다. 예를 들어 다음 빌드 출력을 고려해 보십시오.
all/myco-all-1.0.0-SNAPSHOT.zip(content-package)ui.apps/myco-ui.apps-1.0.0-SNAPSHOT.zip(skipped-content-package)ui.content/myco-ui.content-1.0.0-SNAPSHOT.zip(skipped-content-package)
myco-all-1.0.0-SNAPSHOT.zip 내에 있는 항목만 건너뛴 두 개의 콘텐츠 패키지인 경우, “모든” 콘텐츠 패키지 대신 임베드된 두 개의 패키지가 스캔됩니다.
수십 개의 임베드된 패키지를 생성하는 프로젝트의 경우, 이 최적화는 파이프라인 실행당 10분 이상 절약되는 것으로 나타났습니다.
“모든” 콘텐츠 패키지에 건너뛴 콘텐츠 패키지와 OSGi 번들의 조합이 포함된 경우 특별한 경우가 발생할 수 있습니다. 예를 들어 myco-all-1.0.0-SNAPSHOT.zip에 앞서 언급한 두 개의 임베드된 패키지가 포함된 경우, 하나 이상의 OSGi 번들로만 구성된 새로운 최소 콘텐츠 패키지가 구성됩니다. 이 패키지의 이름은 항상 cloudmanager-synthetic-jar-package이고 포함된 번들은 /apps/cloudmanager-synthetic-installer/install에 배치됩니다.
NOTE- 이 최적화는 AEM에 배포된 패키지에 영향을 주지 않습니다.
- 임베드된 콘텐츠 패키지와 건너뛴 콘텐츠 패키지 간의 일치는 파일 이름을 사용합니다. 건너뛴 여러 패키지가 동일한 파일 이름을 공유하거나 임베드 중에 파일 이름이 변경되는 경우에는 이 최적화를 수행할 수 없습니다.
