From d9fa4d1011bdda5b72efd3a1e0a917dad0d4d620 Mon Sep 17 00:00:00 2001 From: wangtianqi <1350217033@qq.com> Date: Wed, 25 Jun 2025 17:54:12 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0template?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...nsfile.template => Jenkinsfile.go-template | 497 ++++++++++++------ 1 file changed, 344 insertions(+), 153 deletions(-) rename Jenkinsfile.template => Jenkinsfile.go-template (59%) diff --git a/Jenkinsfile.template b/Jenkinsfile.go-template similarity index 59% rename from Jenkinsfile.template rename to Jenkinsfile.go-template index 8c05b3f..cec67d8 100644 --- a/Jenkinsfile.template +++ b/Jenkinsfile.go-template @@ -1,17 +1,38 @@ +// ================================================================= +// 🚀 Go项目通用Jenkins Pipeline模板 +// ================================================================= +// +// 📋 使用说明： +// 1. 复制此模板到你的Go项目根目录，重命名为Jenkinsfile +// 2. 修改下面的 "项目配置" 部分 +// 3. 确保Jenkins中已配置好相关工具和凭据 +// 4. 推送到Git仓库即可自动触发构建 +// +// 🔧 支持的特性： +// - ✅ Go模块化项目构建和测试 +// - ✅ SonarQube代码质量扫描（优化后11秒完成） +// - ✅ Docker镜像构建和测试 +// - ✅ 多环境自动部署（生产/测试） +// - ✅ 健康检查和回滚机制 +// - ✅ 测试覆盖率报告 +// - ✅ 构建产物归档 +// +// ================================================================= + pipeline { agent any - // 参数化配置 - 让模板更通用 + // 🎛️ 构建参数 - 支持手动构建时的自定义配置 parameters { choice( name: 'DEPLOY_ENV', - choices: ['auto', 'production', 'staging', 'development'], - description: '部署环境 (auto=根据分支自动选择)' + choices: ['auto', 'production', 'staging', 'development', 'skip'], + description: '部署环境 (auto=根据分支自动选择, skip=仅构建不部署)' ) booleanParam( name: 'SKIP_TESTS', defaultValue: false, - description: '跳过单元测试' + description: '跳过单元测试（不推荐）' ) booleanParam( name: 'SKIP_SONAR', @@ -19,19 +40,14 @@ pipeline { description: '跳过代码质量扫描' ) booleanParam( - name: 'FORCE_REBUILD', + name: 'FORCE_REBUILD_IMAGE', defaultValue: false, description: '强制重新构建Docker镜像' ) string( - name: 'GO_VERSION', - defaultValue: '1.21', - description: 'Go版本' - ) - string( - name: 'IMAGE_REGISTRY', + name: 'CUSTOM_TAG', defaultValue: '', - description: 'Docker镜像仓库 (留空使用本地)' + description: '自定义Docker镜像标签（留空使用构建号）' ) } @@ -48,29 +64,35 @@ pipeline { } tools { - go 'go' // Jenkins中配置的Go工具名称 + go 'go' // 确保Jenkins中已配置Go工具，名称为'go' } environment { // =========================================== - // 📝 项目配置 - 根据你的项目修改这些变量 + // 📝 项目配置 - 每个项目都需要修改这些变量 // =========================================== - PROJECT_NAME = 'golang-demo' // 🔧 修改为你的项目名 - DEPLOY_SERVER = '116.62.163.84' // 🔧 修改为你的服务器 - SSH_CREDENTIAL_ID = 'deploy-server-ssh-key' // 🔧 修改为你的SSH凭据ID + PROJECT_NAME = 'my-go-app' // 🔧 修改：项目名称 + DEPLOY_SERVER = '116.62.163.84' // 🔧 修改：部署服务器IP + SSH_CREDENTIAL_ID = 'deploy-server-ssh-key' // 🔧 修改：SSH凭据ID - // SonarQube配置 (可选) - SONAR_HOST_URL = 'http://116.62.163.84:15010' // 🔧 修改为你的SonarQube地址 - SONAR_PROJECT_KEY = "${PROJECT_NAME}" - SONAR_CREDENTIAL_ID = 'sonar-token' // 🔧 修改为你的SonarQube凭据ID + // SonarQube配置（可选，如果不使用可以注释掉） + SONAR_HOST_URL = 'http://116.62.163.84:15010' // 🔧 修改：SonarQube服务器地址 + SONAR_CREDENTIAL_ID = 'sonar-token' // 🔧 修改：SonarQube Token凭据ID + + // Docker镜像仓库配置（可选） + DOCKER_REGISTRY = '' // 🔧 修改：Docker仓库地址（留空使用本地） + DOCKER_CREDENTIAL_ID = '' // 🔧 修改：Docker仓库凭据ID // =========================================== - // 🔧 环境端口配置 + // 🔧 端口配置 - 根据你的环境修改 // =========================================== PROD_PORT = '15021' // 生产环境端口 STAGING_PORT = '15022' // 预发布环境端口 DEV_PORT = '15023' // 开发环境端口 + // 应用配置 + APP_PORT = '8080' // 应用内部端口（通常是8080） + // =========================================== // 🔧 自动化配置 - 通常不需要修改 // =========================================== @@ -80,8 +102,8 @@ pipeline { // 动态变量 IMAGE_NAME = "${PROJECT_NAME}" - IMAGE_TAG = "${BUILD_NUMBER}" - FULL_IMAGE_NAME = "${params.IMAGE_REGISTRY ? params.IMAGE_REGISTRY + '/' : ''}${IMAGE_NAME}:${IMAGE_TAG}" + IMAGE_TAG = "${params.CUSTOM_TAG ?: BUILD_NUMBER}" + FULL_IMAGE_NAME = "${DOCKER_REGISTRY ? DOCKER_REGISTRY + '/' : ''}${IMAGE_NAME}:${IMAGE_TAG}" } stages { @@ -89,7 +111,7 @@ pipeline { parallel { stage('检出代码') { steps { - echo "🔄 检出代码..." + echo "🔄 检出代码 - ${PROJECT_NAME}..." checkout scm script { @@ -99,7 +121,7 @@ pipeline { ).trim() env.GIT_BRANCH = sh( - script: "git rev-parse --abbrev-ref HEAD", + script: "git rev-parse --abbrev-ref HEAD || echo '${BRANCH_NAME}'", returnStdout: true ).trim() @@ -124,12 +146,16 @@ pipeline { case 'staging': env.DEPLOY_PORT = env.STAGING_PORT break - default: + case 'development': env.DEPLOY_PORT = env.DEV_PORT + break + case 'skip': + env.DEPLOY_PORT = 'none' + break } } - env.CONTAINER_NAME = "${PROJECT_NAME}-${DEPLOY_ENV}" + env.CONTAINER_NAME = "${PROJECT_NAME}-${env.DEPLOY_ENV}" } echo "📋 构建信息:" @@ -138,6 +164,7 @@ pipeline { echo " 提交: ${env.GIT_COMMIT_SHORT}" echo " 环境: ${env.DEPLOY_ENV}" echo " 端口: ${env.DEPLOY_PORT}" + echo " 镜像: ${FULL_IMAGE_NAME}" } } @@ -152,7 +179,7 @@ pipeline { go version echo "=== Go环境 ===" - go env GOROOT GOPATH GOPROXY GOSUMDB + go env GOROOT GOPATH GOPROXY GOSUMDB CGO_ENABLED GOOS GOARCH echo "=== Docker版本 ===" docker --version @@ -164,10 +191,14 @@ pipeline { echo "=== 检查Go项目结构 ===" if [ -f "go.mod" ]; then echo "✅ 发现go.mod文件" - cat go.mod | head -10 + head -10 go.mod else - echo "⚠️ 未发现go.mod文件，可能不是Go模块项目" + echo "⚠️ 未发现go.mod文件，请确保这是一个Go模块项目" + echo "建议运行: go mod init ${PROJECT_NAME}" fi + + echo "=== 检查SonarQube Scanner ===" + ls -la /var/jenkins_home/tools/hudson.plugins.sonar.SonarRunnerInstallation/ || echo "SonarQube Scanner未安装" ''' echo "✅ 环境检查完成" } @@ -188,6 +219,13 @@ pipeline { echo "整理依赖..." go mod tidy + echo "检查依赖漏洞..." + if command -v govulncheck >/dev/null 2>&1; then + govulncheck ./... || echo "⚠️ 发现安全漏洞，请检查" + else + echo "ℹ️ govulncheck未安装，跳过漏洞检查" + fi + echo "检查依赖更新..." go list -u -m all | head -20 || true @@ -217,9 +255,10 @@ pipeline { exit 1 fi - echo "检查import排序..." - if command -v goimports >/dev/null 2>&1; then - goimports -l . | head -10 + echo "检查Go语法..." + if ! go build -o /dev/null ./...; then + echo "❌ Go语法检查失败" + exit 1 fi echo "✅ 静态检查通过" @@ -227,26 +266,26 @@ pipeline { } } - stage('安全扫描') { - when { - not { params.SKIP_TESTS } - } + stage('代码规范') { steps { - echo '🔒 运行安全扫描...' + echo '📝 检查代码规范...' sh ''' - echo "检查已知漏洞..." - if command -v govulncheck >/dev/null 2>&1; then - govulncheck ./... || echo "⚠️ govulncheck未安装或发现问题" - else - echo "⚠️ govulncheck未安装，跳过漏洞检查" + echo "检查包导入顺序..." + if command -v goimports >/dev/null 2>&1; then + UNORGANIZED=$(goimports -l .) + if [ -n "$UNORGANIZED" ]; then + echo "⚠️ 以下文件导入顺序不规范：" + echo "$UNORGANIZED" + echo "建议运行: goimports -w ." + fi fi - echo "检查敏感信息..." - if command -v git-secrets >/dev/null 2>&1; then - git secrets --scan --recursive . || echo "⚠️ 发现敏感信息" + echo "检查代码复杂度..." + if command -v gocyclo >/dev/null 2>&1; then + gocyclo -over 15 . || echo "⚠️ 发现高复杂度函数" fi - echo "✅ 安全扫描完成" + echo "✅ 代码规范检查完成" ''' } } @@ -262,11 +301,11 @@ pipeline { steps { echo '🧪 运行单元测试...' sh ''' - echo "运行测试..." - mkdir -p test-results + echo "创建测试结果目录..." + mkdir -p test-results reports - # 运行测试并生成多种格式的报告 - go test -v -coverprofile=coverage.out -covermode=atomic \ + echo "运行测试..." + go test -v -coverprofile=coverage.out -covermode=atomic \\ -json ./... > test-results/test-report.json # 生成JUnit格式的测试报告（如果有go-junit-report） @@ -275,15 +314,23 @@ pipeline { fi echo "生成覆盖率报告..." - go tool cover -html=coverage.out -o coverage.html - go tool cover -func=coverage.out | tee coverage-summary.txt + go tool cover -html=coverage.out -o reports/coverage.html + go tool cover -func=coverage.out | tee reports/coverage-summary.txt # 提取覆盖率百分比 - COVERAGE=$(go tool cover -func=coverage.out | grep total | grep -oE '[0-9]+\.[0-9]+%') + COVERAGE=$(go tool cover -func=coverage.out | grep total | grep -oE '[0-9]+\\.[0-9]+%') echo "📊 总覆盖率: $COVERAGE" - echo "$COVERAGE" > coverage.txt + echo "$COVERAGE" > reports/coverage.txt - echo "✅ 单元测试完成" + # 检查覆盖率阈值（可选） + COVERAGE_NUM=$(echo $COVERAGE | sed 's/%//') + if [ "${COVERAGE_NUM%.*}" -lt 50 ]; then + echo "⚠️ 代码覆盖率低于50%: $COVERAGE" + # 可以选择是否让构建失败 + # exit 1 + fi + + echo "✅ 单元测试完成，覆盖率: $COVERAGE" ''' } post { @@ -295,20 +342,21 @@ pipeline { } // 发布覆盖率报告 - if (fileExists('coverage.html')) { + if (fileExists('reports/coverage.html')) { publishHTML([ allowMissing: false, alwaysLinkToLastBuild: true, keepAll: true, - reportDir: '.', + reportDir: 'reports', reportFiles: 'coverage.html', - reportName: 'Go Coverage Report', - reportTitles: '' + reportName: '📊 Go Coverage Report', + reportTitles: 'Go代码覆盖率报告' ]) + echo '✅ Go覆盖率报告已发布' } // 归档测试产物 - archiveArtifacts artifacts: 'coverage.out,coverage.txt,test-results/*', allowEmptyArchive: true + archiveArtifacts artifacts: 'coverage.out,reports/*,test-results/*', allowEmptyArchive: true } } } @@ -319,17 +367,21 @@ pipeline { echo '⚡ 运行性能测试...' sh ''' echo "运行基准测试..." - if go test -bench=. -benchmem ./... > benchmark.txt 2>&1; then + mkdir -p reports + + if go test -bench=. -benchmem ./... > reports/benchmark.txt 2>&1; then echo "✅ 基准测试完成" - cat benchmark.txt + echo "📊 性能测试结果：" + cat reports/benchmark.txt | head -20 else - echo "⚠️ 未发现基准测试或测试失败" + echo "ℹ️ 未发现基准测试或测试失败" + echo "建议添加基准测试函数，如: func BenchmarkMyFunction(b *testing.B)" fi ''' } post { always { - archiveArtifacts artifacts: 'benchmark.txt', allowEmptyArchive: true + archiveArtifacts artifacts: 'reports/benchmark.txt', allowEmptyArchive: true } } } @@ -346,46 +398,38 @@ pipeline { try { withCredentials([string(credentialsId: "${SONAR_CREDENTIAL_ID}", variable: 'SONAR_TOKEN')]) { withSonarQubeEnv('sonarQube') { - sh ''' - # 动态查找sonar-scanner - SCANNER_PATH="" - for path in \ - "$SONAR_SCANNER_HOME/bin/sonar-scanner" \ - "/var/jenkins_home/tools/hudson.plugins.sonar.SonarRunnerInstallation/sonarQube/bin/sonar-scanner" \ - "$(which sonar-scanner 2>/dev/null)"; do - if [ -f "$path" ]; then - SCANNER_PATH="$path" - break - fi - done + def scannerHome = tool name: 'sonarQube', type: 'hudson.plugins.sonar.SonarRunnerInstallation' + + sh """ + echo "=== SonarQube环境信息 ===" + echo "SONAR_HOST_URL: \$SONAR_HOST_URL" + echo "SONAR_SCANNER_HOME: ${scannerHome}" - if [ -z "$SCANNER_PATH" ]; then - echo "❌ 无法找到sonar-scanner" - exit 1 - fi + echo "✅ 使用Jenkins管理的SonarQube Scanner" - echo "✅ 使用sonar-scanner: $SCANNER_PATH" - - # 运行扫描 - "$SCANNER_PATH" \\ - -Dsonar.projectKey=${SONAR_PROJECT_KEY} \\ + # 运行SonarQube扫描 + ${scannerHome}/bin/sonar-scanner \\ + -Dsonar.projectKey=${PROJECT_NAME} \\ -Dsonar.projectName="${PROJECT_NAME}" \\ -Dsonar.projectVersion=${BUILD_NUMBER} \\ -Dsonar.sources=. \\ - -Dsonar.exclusions=**/*_test.go,**/vendor/**,**/*.mod,**/*.sum,**/test-results/** \\ + -Dsonar.exclusions=**/*_test.go,**/vendor/**,**/*.mod,**/*.sum,**/reports/**,**/test-results/** \\ -Dsonar.tests=. \\ -Dsonar.test.inclusions=**/*_test.go \\ -Dsonar.test.exclusions=**/vendor/** \\ -Dsonar.go.coverage.reportPaths=coverage.out \\ -Dsonar.sourceEncoding=UTF-8 - ''' + """ } } echo "✅ SonarQube扫描完成" } catch (Exception e) { echo "⚠️ SonarQube扫描失败: ${e.getMessage()}" if (env.DEPLOY_ENV == 'production') { - error("生产环境必须通过代码质量检查") + echo "❌ 生产环境必须通过代码质量检查" + throw e + } else { + echo "⚠️ 非生产环境，继续构建流程" } } } @@ -402,7 +446,12 @@ pipeline { # 设置构建信息 BUILD_TIME=$(date -u '+%Y-%m-%d_%H:%M:%S') - LDFLAGS="-w -s -X main.Version=${BUILD_NUMBER} -X main.GitCommit=${GIT_COMMIT_SHORT} -X main.BuildTime=${BUILD_TIME}" + LDFLAGS="-w -s" + LDFLAGS="$LDFLAGS -X main.Version=${BUILD_NUMBER}" + LDFLAGS="$LDFLAGS -X main.GitCommit=${GIT_COMMIT_SHORT}" + LDFLAGS="$LDFLAGS -X main.BuildTime=${BUILD_TIME}" + + echo "构建标志: $LDFLAGS" # 编译 CGO_ENABLED=${CGO_ENABLED} GOOS=${GOOS} GOARCH=${GOARCH} \\ @@ -410,12 +459,13 @@ pipeline { echo "验证二进制文件..." ls -lh ${PROJECT_NAME} - file ${PROJECT_NAME} + file ${PROJECT_NAME} || true # 尝试获取版本信息 - ./${PROJECT_NAME} --version 2>/dev/null || echo "应用不支持--version参数" + ./${PROJECT_NAME} --version 2>/dev/null || echo "ℹ️ 应用不支持--version参数" + ./${PROJECT_NAME} -h 2>/dev/null || echo "ℹ️ 应用不支持-h参数" - echo "✅ 编译完成" + echo "✅ 编译完成: ${PROJECT_NAME}" ''' } post { @@ -434,12 +484,17 @@ pipeline { #!/bin/bash set -e +# 部署配置 PROJECT_NAME="${PROJECT_NAME}" CONTAINER_NAME="${CONTAINER_NAME}" DEPLOY_PORT="${DEPLOY_PORT}" +APP_PORT="${APP_PORT}" IMAGE_TAG="${IMAGE_TAG}" +DEPLOY_ENV="${DEPLOY_ENV}" -echo "🚀 部署 $PROJECT_NAME 到 ${DEPLOY_ENV} 环境..." +echo "🚀 部署 $PROJECT_NAME 到 $DEPLOY_ENV 环境..." +echo "容器名称: $CONTAINER_NAME" +echo "端口映射: $DEPLOY_PORT:$APP_PORT" # 停止旧容器 echo "停止旧容器..." @@ -451,13 +506,19 @@ echo "启动新容器..." docker run -d \\ --name $CONTAINER_NAME \\ --restart unless-stopped \\ - -p $DEPLOY_PORT:8080 \\ + -p $DEPLOY_PORT:$APP_PORT \\ -e GIN_MODE=release \\ - -e DEPLOY_ENV=${DEPLOY_ENV} \\ + -e DEPLOY_ENV=$DEPLOY_ENV \\ + -e TZ=Asia/Shanghai \\ + --health-cmd="curl -f http://localhost:$APP_PORT/health || curl -f http://localhost:$APP_PORT/ping || exit 1" \\ + --health-interval=30s \\ + --health-timeout=3s \\ + --health-retries=3 \\ $PROJECT_NAME:$IMAGE_TAG echo "✅ 部署完成" -echo "🔗 访问地址: http://$(hostname -I | awk '{print $1}'):$DEPLOY_PORT" +echo "🔗 访问地址: http://$(hostname -I | awk '{print \\$1}'):$DEPLOY_PORT" +echo "🏥 健康检查: docker inspect --format='{{.State.Health.Status}}' $CONTAINER_NAME" EOF chmod +x deploy.sh @@ -473,7 +534,7 @@ EOF echo '🐳 构建Docker镜像...' script { // 检查是否需要重新构建 - def shouldBuild = params.FORCE_REBUILD + def shouldBuild = params.FORCE_REBUILD_IMAGE if (!shouldBuild) { def imageExists = sh( script: "docker images -q ${IMAGE_NAME}:${IMAGE_TAG}", @@ -488,12 +549,56 @@ EOF # 确保二进制文件存在 if [ ! -f "${PROJECT_NAME}" ]; then - echo "❌ 二进制文件不存在" + echo "❌ 二进制文件不存在: ${PROJECT_NAME}" exit 1 fi chmod +x ${PROJECT_NAME} + # 检查Dockerfile + if [ ! -f "Dockerfile" ]; then + echo "⚠️ 未找到Dockerfile，创建默认Dockerfile..." + cat > Dockerfile << 'DOCKERFILE_EOF' +FROM alpine:latest + +# 安装必要工具和设置时区 +RUN sed -i 's/dl-cdn.alpinelinux.org/mirrors.aliyun.com/g' /etc/apk/repositories && \\ + apk update && \\ + apk add --no-cache curl ca-certificates tzdata && \\ + rm -rf /var/cache/apk/* + +ENV TZ=Asia/Shanghai +RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone + +# 创建非root用户 +RUN addgroup -g 1000 appuser && adduser -u 1000 -G appuser -s /bin/sh -D appuser + +# 设置工作目录 +WORKDIR /app + +# 复制应用程序 +COPY ${PROJECT_NAME} . + +# 设置权限 +RUN mkdir -p /app/logs && \\ + chown -R appuser:appuser /app && \\ + chmod +x /app/${PROJECT_NAME} + +# 切换到非root用户 +USER appuser + +# 暴露端口 +EXPOSE ${APP_PORT} + +# 健康检查 +HEALTHCHECK --interval=30s --timeout=3s --start-period=30s --retries=3 \\ + CMD curl -f http://localhost:${APP_PORT}/health || curl -f http://localhost:${APP_PORT}/ping || exit 1 + +# 启动应用 +ENTRYPOINT ["./${PROJECT_NAME}"] +DOCKERFILE_EOF + fi + # 构建镜像 docker build \\ --build-arg PROJECT_NAME=${PROJECT_NAME} \\ @@ -513,16 +618,25 @@ EOF ''' // 推送到镜像仓库（如果配置了） - if (params.IMAGE_REGISTRY) { - sh ''' - echo "推送镜像到仓库..." - docker tag ${IMAGE_NAME}:${IMAGE_TAG} ${FULL_IMAGE_NAME} - docker push ${FULL_IMAGE_NAME} - echo "✅ 镜像推送完成" - ''' + if (env.DOCKER_REGISTRY && env.DOCKER_CREDENTIAL_ID) { + withCredentials([usernamePassword(credentialsId: env.DOCKER_CREDENTIAL_ID, usernameVariable: 'DOCKER_USER', passwordVariable: 'DOCKER_PASS')]) { + sh ''' + echo "登录Docker仓库..." + echo "$DOCKER_PASS" | docker login $DOCKER_REGISTRY -u "$DOCKER_USER" --password-stdin + + echo "推送镜像到仓库..." + docker tag ${IMAGE_NAME}:${IMAGE_TAG} ${FULL_IMAGE_NAME} + docker push ${FULL_IMAGE_NAME} + + docker tag ${IMAGE_NAME}:latest ${DOCKER_REGISTRY}/${IMAGE_NAME}:latest + docker push ${DOCKER_REGISTRY}/${IMAGE_NAME}:latest + + echo "✅ 镜像推送完成: ${FULL_IMAGE_NAME}" + ''' + } } } else { - echo "✅ 镜像已存在，跳过构建" + echo "✅ 镜像已存在，跳过构建: ${IMAGE_NAME}:${IMAGE_TAG}" } } } @@ -539,8 +653,9 @@ EOF sh """ echo "启动测试容器..." docker run -d --name ${testContainerName} \\ - -p ${testPort}:8080 \\ + -p ${testPort}:${APP_PORT} \\ -e GIN_MODE=test \\ + -e DEPLOY_ENV=test \\ ${IMAGE_NAME}:${IMAGE_TAG} echo "等待应用启动..." @@ -551,24 +666,33 @@ EOF docker logs ${testContainerName} echo "测试应用端点..." + SUCCESS=false for i in \$(seq 1 10); do echo "尝试连接 \$i/10..." if curl -f http://localhost:${testPort}/health; then - echo "✅ 健康检查通过" + echo "✅ 健康检查端点响应正常" + SUCCESS=true break elif curl -f http://localhost:${testPort}/ping; then - echo "✅ Ping检查通过" + echo "✅ Ping端点响应正常" + SUCCESS=true + break + elif curl -f http://localhost:${testPort}/; then + echo "✅ 根路径响应正常" + SUCCESS=true break else - if [ \$i -eq 10 ]; then - echo "❌ 镜像测试失败" - exit 1 - fi - echo "等待3秒后重试..." + echo "⚠️ 连接失败，等待3秒后重试..." sleep 3 fi done + if [ "\$SUCCESS" = "false" ]; then + echo "❌ 镜像测试失败，无法连接到应用" + docker logs ${testContainerName} + exit 1 + fi + echo "✅ 镜像测试通过" """ } finally { @@ -584,12 +708,11 @@ EOF stage('🚀 部署') { when { - anyOf { - branch 'main' - branch 'master' - branch 'develop' - branch 'staging' - expression { params.DEPLOY_ENV != 'auto' } + not { + anyOf { + expression { params.DEPLOY_ENV == 'skip' } + expression { env.DEPLOY_ENV == 'skip' } + } } } steps { @@ -623,6 +746,7 @@ EOF rm -f ${PROJECT_NAME}-${IMAGE_TAG}.tar deploy.sh echo "✅ 部署完成" + echo "🔗 应用地址: http://${DEPLOY_SERVER}:${DEPLOY_PORT}" EOF # 清理本地临时文件 @@ -635,36 +759,50 @@ EOF stage('🏥 健康检查') { when { - anyOf { - branch 'main' - branch 'master' - branch 'develop' - branch 'staging' - expression { params.DEPLOY_ENV != 'auto' } + not { + anyOf { + expression { params.DEPLOY_ENV == 'skip' } + expression { env.DEPLOY_ENV == 'skip' } + } } } steps { echo '🏥 执行应用健康检查...' script { + echo "等待应用启动..." sleep(time: 30, unit: 'SECONDS') def healthCheckPassed = false + def healthUrls = [ + "http://${DEPLOY_SERVER}:${env.DEPLOY_PORT}/health", + "http://${DEPLOY_SERVER}:${env.DEPLOY_PORT}/ping", + "http://${DEPLOY_SERVER}:${env.DEPLOY_PORT}/" + ] + for (int i = 1; i <= 5; i++) { - try { - def response = sh( - script: "curl -s -o /dev/null -w '%{http_code}' http://${DEPLOY_SERVER}:${env.DEPLOY_PORT}/health", - returnStdout: true - ).trim() - - if (response == "200") { - echo "✅ 第${i}次健康检查通过" - healthCheckPassed = true - break - } else { - echo "⚠️ 第${i}次健康检查失败，状态码: ${response}" + echo "第${i}次健康检查..." + + for (String url : healthUrls) { + try { + def response = sh( + script: "curl -s -o /dev/null -w '%{http_code}' '${url}'", + returnStdout: true + ).trim() + + if (response == "200") { + echo "✅ 健康检查通过: ${url} (${response})" + healthCheckPassed = true + break + } else { + echo "⚠️ ${url} 响应状态码: ${response}" + } + } catch (Exception e) { + echo "⚠️ ${url} 检查异常: ${e.getMessage()}" } - } catch (Exception e) { - echo "⚠️ 第${i}次健康检查异常: ${e.getMessage()}" + } + + if (healthCheckPassed) { + break } if (i < 5) { @@ -673,10 +811,19 @@ EOF } } - if (!healthCheckPassed && env.DEPLOY_ENV == 'production') { - error("❌ 生产环境健康检查失败，回滚部署") - } else if (!healthCheckPassed) { - echo "⚠️ 健康检查失败，但允许${env.DEPLOY_ENV}环境继续" + if (!healthCheckPassed) { + def errorMsg = "❌ 健康检查失败，应用可能未正常启动" + echo errorMsg + + if (env.DEPLOY_ENV == 'production') { + echo "🔄 生产环境健康检查失败，考虑回滚..." + // 这里可以添加自动回滚逻辑 + error(errorMsg) + } else { + echo "⚠️ 非生产环境，允许继续但需要人工检查" + } + } else { + echo "✅ 应用部署成功并通过健康检查" } } } @@ -690,8 +837,8 @@ EOF // 清理构建产物 sh """ - rm -f ${PROJECT_NAME} coverage.out coverage.html deploy.sh - rm -rf test-results/ + rm -f ${PROJECT_NAME} coverage.out deploy.sh + rm -rf test-results/ reports/ docker image prune -f || true docker builder prune -f || true """ @@ -705,6 +852,14 @@ EOF success { script { + def deployInfo = env.DEPLOY_ENV != 'skip' ? + "🔗 访问: http://${DEPLOY_SERVER}:${env.DEPLOY_PORT}" : + "📦 仅构建，未部署" + + def sonarInfo = params.SKIP_SONAR ? + "" : + "📊 SonarQube: ${SONAR_HOST_URL}/dashboard?id=${PROJECT_NAME}" + def message = """ 🎉 ${PROJECT_NAME} 构建成功！ @@ -714,15 +869,18 @@ EOF 📝 提交: ${env.GIT_COMMIT_SHORT ?: 'unknown'} 🌍 环境: ${env.DEPLOY_ENV} ⏱️ 耗时: ${currentBuild.durationString} -🔗 访问: http://${DEPLOY_SERVER}:${env.DEPLOY_PORT} -📊 报告: ${env.BUILD_URL} +🐳 镜像: ${FULL_IMAGE_NAME} +${deployInfo} +${sonarInfo} +📈 构建详情: ${env.BUILD_URL} """ echo message - // 发送通知 (可选) + // 发送通知（根据需要启用） // slackSend(color: 'good', message: message) // emailext(subject: "✅ ${PROJECT_NAME} 构建成功", body: message) + // dingTalk(robot: 'your-robot-id', message: message) } } @@ -738,7 +896,7 @@ EOF 🌍 环境: ${env.DEPLOY_ENV} ⏱️ 耗时: ${currentBuild.durationString} 🔗 日志: ${env.BUILD_URL}console -📧 修复后请重新构建 +🛠️ 修复后请重新构建 """ echo message @@ -766,4 +924,37 @@ EOF } } } -} \ No newline at end of file +} + +// ================================================================= +// 📖 使用文档： +// +// 1. 项目配置： +// - 修改 PROJECT_NAME 为你的项目名称 +// - 修改 DEPLOY_SERVER 为你的服务器IP +// - 配置端口映射和凭据ID +// +// 2. Jenkins要求： +// - Go工具：名称为'go' +// - SonarQube Server：名称为'sonarQube' +// - SonarQube Scanner：名称为'sonarQube' +// - SSH凭据：配置部署服务器的SSH Key +// +// 3. 项目要求： +// - 必须是Go模块项目（有go.mod文件） +// - 建议有健康检查端点：/health 或 /ping +// - 可选：添加基准测试函数 +// +// 4. 分支策略： +// - main/master → 生产环境 +// - staging/release → 预发布环境 +// - 其他分支 → 开发环境 +// +// 5. 手动参数： +// - DEPLOY_ENV：选择部署环境 +// - SKIP_TESTS：跳过测试（不推荐） +// - SKIP_SONAR：跳过代码扫描 +// - FORCE_REBUILD_IMAGE：强制重建镜像 +// - CUSTOM_TAG：自定义镜像标签 +// +// ================================================================= \ No newline at end of file