ILLDAN Backend 🚀 성능테스트

본 레포지토리는 ILLDAN 백엔드 서비스의 성능을 측정, 분석 및 관리하기 위한 테스트 스크립트 저장소입니다. 모든 테스트는 GitHub Actions를 통해 자동화되어 실행됩니다.

모니터링 / 성능 테스트 서버 아키텍처

⚙️ 테스트 워크플로우

1. Issue 생성: 성능 테스트가 필요한 경우, Issue 생성 템플릿에 맞춰 새로운 이슈를 등록합니다.
2. Branch 생성: 생성된 이슈 번호를 기반으로, Branch 컨벤션에 맞춰 브랜치를 생성합니다.
3. 스크립트 작성: 테스트 시나리오에 맞는 스크립트를 scripts/ 폴더에 작성 또는 수정합니다.
4. Commit: Commit Message 컨벤션에 맞춰 변경 사항을 커밋합니다.
5. Pull Request 생성: main 브랜치로 PR을 생성합니다. PR 생성 시 템플릿이 자동으로 적용됩니다.
6. 자동 테스트 실행: PR이 생성되면 GitHub Actions가 자동으로 트리거되어 테스트를 실행합니다.
7. 결과 확인 및 리뷰: Actions의 테스트 결과를 PR 템플릿에 기입하고 동료에게 리뷰를 요청합니다.
8. Merge: 리뷰가 완료되면 PR을 main 브랜치에 병합합니다.

🔒 Rules

원활한 협업과 자동화를 위해 아래 규칙을 반드시 준수합니다.

---

Branch

• main branch
  • 모든 테스트 스크립트 저장

브랜치는 {테스트-종류}/{이슈번호}/{간단한-설명} 컨벤션을 따릅니다.

• {테스트-종류}:
  • load: 목표 부하 수용 확인
  • stress: 시스템 한계점 확인
  • spike: 순간적인 트래픽 폭증 대응 확인
  • soak: 장시간 운영 시 안정성 확인
• {이슈번호}: 관련된 GitHub 이슈 번호를 기입합니다. (예: #42)
• {간단한-설명}: 브랜치의 목적을 간결하게 영어로 작성합니다. (하이픈 - 사용)

✅ 좋은 예시

load/#19/calendar-api- stress/#42/login-api-max-users

---

Commit Message

[type]: <subject> (#issue-number)

• type: 커밋의 종류를 나타냅니다.
  • feat: 새로운 테스트 스크립트 추가
  • fix: 기존 스크립트의 오류 수정
  • refactor: 스크립트 로직 변경 없이 구조 개선
  • docs: README 등 문서 수정
  • chore: 빌드, 패키지 매니저 설정 등
• subject: 커밋에 대한 간결한 요약 설명입니다.
• issue-number: 커밋에 해당하는 이슈 번호를 나타냅니다.

✅ 좋은 예시

[feat]: 로그인 API 스트레스 테스트 스크립트 추가 (#23)

---

Pull Request (PR)

PR 생성 시에는 .github/pull_request_template.md 템플릿이 자동으로 적용됩니다.

• Title: [{테스트-종류}]/#{이슈번호}] {PR 제목} 형식에 맞춰 작성합니다.

  • 예시: [Load/#42] 로그인 API 최대 사용자 스트레스 테스트

• Body: 템플릿의 모든 항목을 빠짐없이 기입해야 합니다.

  1. 관련 이슈: Closes #{이슈번호}를 작성하여 머지 시 관련 이슈가 자동으로 닫히도록 합니다.
  2. 테스트 시나리오: 이슈에 작성했던 시나리오를 바탕으로, 실제 구현된 내용을 기입합니다.
  3. 테스트 결과: 성공적으로 완료된 GitHub Actions 실행 링크와 주요 결과 지표를 반드시 요약하여 기입합니다.

• Checklist: 리뷰를 요청하기 전, 템플릿의 체크리스트 항목을 모두 확인하고 체크합니다.