검증 체크리스트
개요
이 체크리스트는 프로젝트의 산출물, 테스트, CI/CD, 운영 요소를 독립적으로 검증하기 위한 기준을 제공합니다.
D. Documentation (문서화)
| 항목 ID |
검증 항목 |
검증 방법 |
상태 |
| D-01 |
CHECKLIST.md 파일 존재 |
파일 존재 여부 확인 |
pending |
| D-02 |
EVIDENCE_REPORT.md 파일 존재 |
파일 존재 여부 확인 |
pending |
| D-03 |
README.md 파일 존재 |
파일 존재 여부 확인 |
pending |
| D-04 |
API 문서 존재 |
docs/api.md 또는 docs/API.md 파일 확인 |
pending |
| D-05 |
아키텍처 문서 존재 |
docs/architecture.md 또는 docs/ARCHITECTURE.md 파일 확인 |
pending |
T. Test (테스트)
| 항목 ID |
검증 항목 |
검증 방법 |
상태 |
| T-01 |
테스트 디렉토리 존재 |
src/test 디렉토리 존재 확인 |
pending |
| T-02 |
테스트 파일 존재 |
*Test.java 파일 존재 확인 |
pending |
| T-03 |
JaCoCo 테스트 커버리지 ≥70% |
JaCoCo 리포트 분석 (target/site/jacoco) |
pending |
| T-04 |
단위 테스트 존재 |
*Test.java 파일 개수 확인 |
pending |
| T-05 |
통합 테스트 존재 |
*IntegrationTest.java 또는 *IT.java 파일 확인 |
pending |
C. CI/CD
| 항목 ID |
검증 항목 |
검증 방법 |
상태 |
| C-01 |
CI/CD 설정 파일 존재 |
.github/workflows/*.yml 파일 확인 |
pending |
| C-02 |
빌드 스크립트 존재 |
build.sh 또는 Makefile 파일 확인 |
pending |
| C-03 |
테스트 실행 CI 단계 존재 |
CI 설정에서 mvn test/gradle test 확인 |
pending |
| C-04 |
코드 품질 검사 CI 단계 존재 |
CI 설정에서 checkstyle/pmd/sonarqube 확인 |
pending |
| C-05 |
배포 자동화 단계 존재 |
CI 설정에서 deploy/release 확인 |
pending |
O. Operations (운영)
| 항목 ID |
검증 항목 |
검증 방법 |
상태 |
| O-01 |
로깅 설정 존재 |
logback.xml 파일 확인 |
pending |
| O-02 |
환경 설정 파일 존재 |
application.properties 또는 application.yml 확인 |
pending |
| O-03 |
헬스체크 엔드포인트 존재 |
Health 또는 *Actuator 파일 확인 |
pending |
| O-04 |
메트릭스 수집 설정 존재 |
pom.xml에서 micrometer/prometheus 확인 |
pending |
| O-05 |
장애 복구 매커니즘 존재 |
Retry, Circuit, *Fallback 파일 확인 |
pending |
| O-06 |
보안 설정 존재 |
Security, *Auth 파일 확인 |
pending |
검증 실행
cd verification
./run_verification.sh
결과 해석
- pass: 검증 항목 충족
- pending: 검증 불가 (선택적 항목 또는 사전 조건 미충족)
- fail: 검증 항목 미충족