-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathJenkinsfile
More file actions
562 lines (500 loc) · 26.7 KB
/
Jenkinsfile
File metadata and controls
562 lines (500 loc) · 26.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
pipeline {
agent any
// 파라미터 정의
parameters {
string(name: 'RESTORE_VERSION', defaultValue: '', description: '복원할 버전 (MMddHHmm 형식, 예: 06251130)')
booleanParam(name: 'RESTORE_MODE', defaultValue: false, description: '복원 모드를 활성화하려면 체크')
}
// Jenkins 파이프라인에서 사용할 환경 변수
environment {
// Docker Registry 설정
DOCKER_REGISTRY = 'registry.lyckabc.xyz'
IMAGE_NAME = 'sabangnet-api'
DOMAIN = 'alohastudio.co.kr'
DEV_DOMAIN = 'lyckabc.xyz'
SUBDOMAIN = 'api'
// Git 설정
GIT_REPO_URL = 'https://github.com/GopediaPro/sabangnet_API.git'
GIT_CREDENTIAL_ID = 'Iv23likhQak519AdkG6d'
// 인증 정보
REGISTRY_CREDENTIAL_ID = 'docker-registry-credentials'
SSH_CREDENTIAL_ID = 'alohastudio-ssh-key-id'
SSH_CREDENTIAL_ID_DEV = 'lyckabc-ssh-key-id'
DOCKER_REGISTRY_ID = 'docker-registry-id'
DOCKER_REGISTRY_PW = 'docker-registry-pw'
SABANGNET_ENV_FILE = 'sabangnet-env-file'
SABANGNET_ENV_FILE_DEV = 'sabangnet-env-file-dev'
DOCKER_COMPOSE_FILE_ID = 'sabangnet-docker-compose-file'
DOCKER_COMPOSE_ENV_FILE_ID = 'sabangnet-docker-compose-env-file'
DOCKER_COMPOSE_ENV_FILE_DEV_ID = 'sabangnet-docker-compose-env-file-dev'
// 배포 서버 설정 (브랜치별로 동적 설정)
DEPLOY_SERVER_PORT = '5022'
DEV_DEPLOY_SERVER_PORT = '50022'
// 브랜치별 설정을 위한 변수
IS_DEPLOYABLE = "${env.BRANCH_NAME in ['main', 'dev'] || env.BRANCH_NAME.contains('docker') ? 'true' : 'false'}"
// Docker 이미지 태그용 안전한 브랜치명 (슬래시를 하이픈으로 변환)
DOCKER_SAFE_BRANCH_NAME = "${env.BRANCH_NAME.replaceAll('/', '-')}"
// 테스트 관련 설정
PYTEST_ADDOPTS = "--tb=short --disable-warnings"
PYTHONPATH = "${WORKSPACE}:${PYTHONPATH}"
// MINIO 서버 업로드
MINIO_CREDENTIAL_ID = 'minio-credentials-id'
MINIO_SERVER_URL = 'https://minio.lyckabc.xyz'
MINIO_BUCKET_NAME = 'test'
}
stages {
stage('Environment Setup') {
steps {
script {
echo "🔍 현재 브랜치: ${env.BRANCH_NAME}"
// 브랜치별 환경 설정
if (env.BRANCH_NAME == 'main') {
env.DEPLOY_ENV = 'production'
env.DEPLOY_SERVER_USER_HOST = 'root@alohastudio.co.kr'
env.ACTUAL_SSH_CREDENTIAL_ID = SSH_CREDENTIAL_ID
env.ACTUAL_DEPLOY_SERVER_PORT = DEPLOY_SERVER_PORT
env.ACTUAL_DOMAIN = DOMAIN
} else if (env.BRANCH_NAME == 'dev' || env.BRANCH_NAME.contains('docker')) {
env.DEPLOY_ENV = 'development'
env.DEPLOY_SERVER_USER_HOST = 'root@lyckabc.xyz'
env.ACTUAL_SSH_CREDENTIAL_ID = SSH_CREDENTIAL_ID_DEV
env.ACTUAL_DEPLOY_SERVER_PORT = DEV_DEPLOY_SERVER_PORT
env.ACTUAL_DOMAIN = DEV_DOMAIN
} else {
env.DEPLOY_ENV = 'none'
echo "⚠️ 브랜치 '${env.BRANCH_NAME}'는 자동 배포 대상이 아닙니다."
}
// PR 빌드인지 확인
if (env.CHANGE_ID) {
echo "📋 PR #${env.CHANGE_ID} 빌드 - 배포 없이 빌드만 수행합니다."
env.IS_PR_BUILD = 'true'
} else {
env.IS_PR_BUILD = 'false'
}
}
}
}
stage('Initialize') {
steps {
script {
if (params.RESTORE_MODE) {
if (params.RESTORE_VERSION.trim().isEmpty()) {
error "❌ 복원 모드에서는 'RESTORE_VERSION'을 반드시 입력해야 합니다."
}
env.IMAGE_TAG = params.RESTORE_VERSION
echo "🔄 [복원 모드] 버전 ${env.IMAGE_TAG}(으)로 복원을 시작합니다."
} else {
def now = new Date()
def timestamp = now.format('MMddHHmm', TimeZone.getTimeZone('Asia/Seoul'))
// 브랜치명을 태그에 포함
if (env.BRANCH_NAME == 'main') {
env.IMAGE_TAG = "prod-${timestamp}"
} else if (env.BRANCH_NAME == 'dev') {
env.IMAGE_TAG = "dev-${timestamp}"
} else if (env.BRANCH_NAME.contains('docker')) {
env.IMAGE_TAG = "docker-${timestamp}"
} else {
env.IMAGE_TAG = "etc-${timestamp}"
}
echo "🚀 [빌드 모드] 새 버전 ${env.IMAGE_TAG}(을)를 생성합니다."
}
}
}
}
stage('Checkout from Git') {
when {
not { expression { params.RESTORE_MODE } }
}
steps {
echo 'Source 코드를 다운로드합니다...'
checkout scm
}
}
stage('Code Quality Check') {
when {
allOf {
not { expression { params.RESTORE_MODE } }
expression { env.IS_PR_BUILD == 'true' || env.IS_DEPLOYABLE == 'true' }
}
}
parallel {
stage('Lint') {
steps {
echo "코드 린팅을 수행합니다..."
// sh 'flake8 .'
// sh 'black --check .'
// sh 'isort --check-only .'
// sh 'mypy .'
}
}
stage('Test') {
agent {
docker {
image 'python:3.12-slim'
reuseNode true
}
}
steps {
script {
// 타임스탬프 변수를 Groovy에서 정의
def timeStamp = "${env.BUILD_NUMBER}_${new Date().format('MMdd_HHmmss')}"
// 브랜치별 환경 파일 선택
def envFileCredentialId = SABANGNET_ENV_FILE_DEV
if (env.BRANCH_NAME == 'main') {
envFileCredentialId = SABANGNET_ENV_FILE
echo "🔍 프로덕션 환경 파일 선택 완료"
}
// 환경 변수 파일 import
withCredentials([file(credentialsId: envFileCredentialId, variable: 'ENV_FILE')]) {
sh "cp ${ENV_FILE} .env"
}
echo "🔍 Python 환경 확인..."
sh 'python3 --version'
sh 'python3 -m pip --version'
echo "📦 의존성 설치 확인..."
sh 'python3 -m pip install -r requirements.txt'
echo "🧪 pytest 테스트를 수행합니다..."
sh """
# 테스트 환경 설정
export PYTHONPATH="\${WORKSPACE}:\${PYTHONPATH}"
export TIME_STAMP="${timeStamp}"
# 테스트 디렉토리 확인
echo "📁 테스트 디렉토리 구조 확인..."
ls -la tests/
# pytest 실행 (상세한 출력과 함께)
echo "🚀 pytest 실행 시작..."
python3 -m pytest tests/ \\
--verbose \\
--tb=short \\
--maxfail=3 \\
--disable-warnings \\
--junitxml=test-results-\${TIME_STAMP}.xml \\
--html=test-report-\${TIME_STAMP}.html \\
--self-contained-html \\
--durations=10 \\
--cov=tests \\
--cov-report=html:coverage-report-\${TIME_STAMP} \\
--cov-report=xml:coverage-\${TIME_STAMP}.xml
echo "✅ 테스트 완료"
# 테스트 결과 요약
echo "📊 테스트 결과 요약:"
if [ -f test-results-\${TIME_STAMP}.xml ]; then
echo "Pytest Unit XML 리포트 생성됨"
fi
if [ -f test-report-\${TIME_STAMP}.html ]; then
echo "Pytest HTML 리포트 생성됨"
fi
if [ -d coverage-report-\${TIME_STAMP} ]; then
echo "커버리지 리포트 생성됨"
fi
"""
// 파일명을 변수로 저장하여 post에서 사용
env.TEST_REPORT_HTML = "test-report-${timeStamp}.html"
env.COVERAGE_DIR = "coverage-report-${timeStamp}"
env.COVERAGE_XML = "coverage-${timeStamp}.xml"
env.TEST_RESULTS_XML = "test-results-${timeStamp}.xml"
// .env 파일 삭제
sh "rm -f .env"
}
}
post {
always {
echo "📊 테스트 결과 저장..."
// JUnit XML 결과 저장
junit 'test-results-*.xml'
// HTML 리포트 저장
publishHTML([
allowMissing: false,
alwaysLinkToLastBuild: true,
keepAll: true,
reportDir: '.',
reportFiles: env.TEST_REPORT_HTML,
reportName: 'Pytest HTML Report'
])
// 커버리지 리포트 저장
publishHTML([
allowMissing: true,
alwaysLinkToLastBuild: true,
keepAll: true,
reportDir: env.COVERAGE_DIR,
reportFiles: 'index.html',
reportName: 'Coverage Report'
])
// 커버리지 XML 결과 저장 (SonarQube 등과 연동용)
recordCoverage(
tools: [[parser: 'COBERTURA', pattern: env.COVERAGE_XML]],
name: 'Pytest Coverage',
sourceCodeRetention: 'EVERY_BUILD',
qualityGates: [
[threshold: 60.0, metric: 'LINE', baseline: 'PROJECT', unstable: true]
]
)
}
success {
echo "✅ 모든 테스트가 성공했습니다!"
}
failure {
script {
echo "❌ 일부 테스트가 실패했습니다. 빌드를 중단합니다."
currentBuild.result = 'FAILURE'
}
}
}
}
}
}
stage('Build Docker Image') {
when {
allOf {
not { expression { params.RESTORE_MODE } }
anyOf {
expression { env.IS_PR_BUILD == 'true' }
expression { env.IS_DEPLOYABLE == 'true' }
}
}
}
steps {
script {
echo "Docker 이미지를 빌드합니다: ${DOCKER_REGISTRY}/${IMAGE_NAME}:${env.IMAGE_TAG}"
echo "Docker 이미지를 빌드합니다: ${DOCKER_REGISTRY}/${IMAGE_NAME}:${DOCKER_SAFE_BRANCH_NAME}-latest"
// 브랜치별 환경 파일 선택
def envFileCredentialId = SABANGNET_ENV_FILE_DEV
if (env.BRANCH_NAME == 'main') {
envFileCredentialId = SABANGNET_ENV_FILE
echo "🔍 프로덕션 환경 파일 선택 완료"
}
withCredentials([file(credentialsId: envFileCredentialId, variable: 'ENV_FILE')]) {
sh "cp ${ENV_FILE} .env"
}
// Docker 이미지 빌드
sh """
docker build \
--build-arg BUILD_ENV=${env.DEPLOY_ENV} \
--build-arg BUILD_DATE=\$(date -u +'%Y-%m-%dT%H:%M:%SZ') \
--build-arg BUILD_VERSION=${env.IMAGE_TAG} \
--build-arg VCS_REF=\$(git rev-parse --short HEAD) \
-t ${DOCKER_REGISTRY}/${IMAGE_NAME}:${env.IMAGE_TAG} \
-t ${DOCKER_REGISTRY}/${IMAGE_NAME}:${DOCKER_SAFE_BRANCH_NAME}-latest \
.
"""
// .env 파일 삭제
sh "rm -f .env"
}
}
}
stage('Security Scan') {
when {
allOf {
not { expression { params.RESTORE_MODE } }
expression { env.IS_DEPLOYABLE == 'true' }
}
}
steps {
echo "Docker 이미지 보안 스캔을 수행합니다..."
// Trivy, Anchore 등의 도구를 사용한 보안 스캔
// sh "trivy image ${DOCKER_REGISTRY}/${IMAGE_NAME}:${env.IMAGE_TAG}"
}
}
stage('Push to Private Registry') {
when {
allOf {
not { expression { params.RESTORE_MODE } }
expression { env.IS_DEPLOYABLE == 'true' }
expression { env.IS_PR_BUILD == 'false' }
}
}
steps {
script {
echo "Private Registry에 로그인 및 이미지 푸시를 시작합니다..."
withCredentials([usernamePassword(
credentialsId: REGISTRY_CREDENTIAL_ID,
usernameVariable: 'REGISTRY_USER',
passwordVariable: 'REGISTRY_PASS'
)]) {
sh """
echo \${REGISTRY_PASS} | docker login ${DOCKER_REGISTRY} -u \${REGISTRY_USER} --password-stdin
# 버전 태그와 latest 태그 모두 푸시
docker push ${DOCKER_REGISTRY}/${IMAGE_NAME}:${env.IMAGE_TAG}
docker push ${DOCKER_REGISTRY}/${IMAGE_NAME}:${DOCKER_SAFE_BRANCH_NAME}-latest
docker logout ${DOCKER_REGISTRY}
"""
}
}
}
}
stage('Deploy to Server') {
when {
allOf {
expression { env.IS_DEPLOYABLE == 'true' }
expression { env.IS_PR_BUILD == 'false' }
anyOf {
expression { params.RESTORE_MODE == true }
not { expression { params.RESTORE_MODE } }
}
}
}
steps {
echo "배포 서버 ${ACTUAL_DOMAIN}에 (${DEPLOY_SERVER_USER_HOST})User의 ${DEPLOY_ENV} 환경으로 배포를 시작합니다..."
echo "SSH CREDENTIAL ID: ${ACTUAL_SSH_CREDENTIAL_ID}"
sshagent(credentials: [ACTUAL_SSH_CREDENTIAL_ID]) {
script {
// 브랜치별 환경 파일 선택
def envFileCredentialId = SABANGNET_ENV_FILE_DEV
def dockerComposeEnvFileId = DOCKER_COMPOSE_ENV_FILE_DEV_ID
if (env.BRANCH_NAME == 'main') {
envFileCredentialId = SABANGNET_ENV_FILE
dockerComposeEnvFileId = DOCKER_COMPOSE_ENV_FILE_ID // 프로덕션용 환경 파일
echo "🔍 프로덕션 환경 파일 선택 완료"
}
withCredentials([
file(credentialsId: envFileCredentialId, variable: 'ENV_FILE'),
file(credentialsId: DOCKER_COMPOSE_FILE_ID, variable: 'DOCKER_COMPOSE_FILE'),
file(credentialsId: dockerComposeEnvFileId, variable: 'DOCKER_COMPOSE_ENV_FILE'),
usernamePassword(
credentialsId: REGISTRY_CREDENTIAL_ID,
usernameVariable: 'REGISTRY_USER',
passwordVariable: 'REGISTRY_PASS'
)
]) {
// 환경 파일 내용을 변수에 저장
def envFileContent = sh(
script: "cat ${ENV_FILE}",
returnStdout: true
).trim()
def dockerComposeFileContent = sh(
script: "cat ${DOCKER_COMPOSE_FILE}",
returnStdout: true
).trim()
def dockerComposeEnvFileContent = sh(
script: "cat ${DOCKER_COMPOSE_ENV_FILE}",
returnStdout: true
).trim()
def randomChar = sh(
script: "cat /dev/urandom | tr -dc 'a-z0-9' | fold -w 1 | head -n 1",
returnStdout: true
).trim()
sh """
ssh -p ${ACTUAL_DEPLOY_SERVER_PORT} -o StrictHostKeyChecking=no ${DEPLOY_SERVER_USER_HOST} << 'EOF'
set -e
echo ">> 배포 디렉토리로 이동"
cd /morphogen/neunexus/sabangnet_api
echo ">> 백업 디렉토리 생성"
mkdir -p ./backup
echo ">> 이전 버전 백업"
BACKUP_TIMESTAMP=\$(date +%Y%m%d%H%M%S)
if [ -f .env ]; then
cp .env ./backup/.env.backup.\${BACKUP_TIMESTAMP}${randomChar}
fi
if [ -f .env.docker ]; then
cp .env.docker ./backup/.env.docker.backup.\${BACKUP_TIMESTAMP}${randomChar}
fi
if [ -f docker-compose.yml ]; then
cp docker-compose.yml ./backup/docker-compose.yml.backup.\${BACKUP_TIMESTAMP}${randomChar}
fi
echo ">> 배포용 환경변수 파일(.env) 생성"
cat > .env << 'ENV_EOF'
${envFileContent}
ENV_EOF
echo ">> Docker Compose 환경변수 파일(.env.docker) 생성"
cat > .env.docker << 'DOCKER_ENV_EOF'
${dockerComposeEnvFileContent}
IMAGE_TAG=${env.IMAGE_TAG}
DEPLOY_ENV=${env.DEPLOY_ENV}
DOCKER_ENV_EOF
echo ">> Docker Compose 파일(docker-compose.yml) 생성"
cat > docker-compose.yml << 'COMPOSE_EOF'
${dockerComposeFileContent}
COMPOSE_EOF
echo ">> Docker Registry 로그인 (비대화형)"
echo '${REGISTRY_PASS}' | docker login ${DOCKER_REGISTRY} -u '${REGISTRY_USER}' --password-stdin
echo ">> 최신 버전의 Docker 이미지를 다운로드합니다: ${env.IMAGE_TAG}"
docker compose --env-file .env.docker pull
echo ">> 헬스체크를 위한 이전 컨테이너 정보 저장"
OLD_CONTAINER_ID=\$(docker compose --env-file .env.docker ps -q ${IMAGE_NAME} 2>/dev/null || true)
echo ">> docker-compose를 사용하여 서비스 업데이트"
docker compose --env-file .env.docker up -d --force-recreate --no-build
echo ">> 헬스체크 수행 (30초 대기)"
sleep 30
# 간단한 헬스체크 (실제 환경에 맞게 수정 필요)
if docker compose --env-file .env.docker ps | grep -q "Up"; then
echo "✅ 배포 성공: ${env.IMAGE_TAG}"
# 이전 이미지 정리 (최근 3개 버전만 유지)
echo ">> 오래된 Docker 이미지 정리"
docker images ${DOCKER_REGISTRY}/${IMAGE_NAME} --format "{{.Tag}} {{.ID}}" | \\
grep -E "^(dev|prod|docker)-[0-9]{8}" | \\
sort -r | \\
tail -n +4 | \\
awk '{print \$2}' | \\
xargs -r docker rmi || true
else
echo "❌ 헬스체크 실패, 롤백을 시도합니다..."
if [ ! -z "\$OLD_CONTAINER_ID" ]; then
# 최신 백업 파일로 롤백
LATEST_BACKUP=\$(ls -t ./backup/.env.docker.backup.* 2>/dev/null | head -1)
if [ ! -z "\$LATEST_BACKUP" ]; then
cp "\$LATEST_BACKUP" .env.docker
docker compose --env-file .env.docker up -d --force-recreate --no-build
fi
fi
exit 1
fi
docker logout ${DOCKER_REGISTRY}
EOF
"""
}
}
}
}
}
stage('Post-Deploy Verification') {
when {
allOf {
expression { env.IS_DEPLOYABLE == 'true' }
expression { env.IS_PR_BUILD == 'false' }
not { expression { params.RESTORE_MODE } }
}
}
steps {
echo "배포 후 검증을 수행합니다..."
// E2E 테스트, API 헬스체크 등
script {
def deployUrl = env.BRANCH_NAME == 'main' ?
"https://${SUBDOMAIN}.${ACTUAL_DOMAIN}" :
"https://${SUBDOMAIN}.${ACTUAL_DOMAIN}"
// sh "curl -f ${deployUrl}/health || exit 1"
}
}
}
}
post {
always {
echo 'Jenkins Agent의 Workspace를 정리합니다...'
// Docker 이미지 정리 (PR 빌드의 경우)
script {
if (env.IS_PR_BUILD == 'true') {
sh """
docker rmi ${DOCKER_REGISTRY}/${IMAGE_NAME}:${env.IMAGE_TAG} || true
docker rmi ${DOCKER_REGISTRY}/${IMAGE_NAME}:${DOCKER_SAFE_BRANCH_NAME}-latest || true
"""
}
}
cleanWs()
}
success {
script {
if (env.IS_DEPLOYABLE == 'true' && env.IS_PR_BUILD == 'false') {
// Slack, Email 등으로 배포 성공 알림
echo "✅ ${env.DEPLOY_ENV} 환경에 버전 ${env.IMAGE_TAG} 배포 성공!"
}
}
}
failure {
script {
if (env.IS_DEPLOYABLE == 'true' && env.IS_PR_BUILD == 'false') {
// Slack, Email 등으로 배포 실패 알림
echo "❌ ${env.DEPLOY_ENV} 환경 배포 실패!"
}
}
}
}
}