使用Jenkins Pipeline自動化構建發佈Java項目

簡介

Pipeline，簡而言之，就是一套運行於Jenkins上的工做流框架，將本來獨立運行於單個或者多個節點的任務鏈接起來，實現單個任務難以完成的複雜流程編排與可視化。

Pipeline是Jenkins2.X的最核心的特性，幫助Jenkins實現從CI到CD與DevOps的轉變。

一，建立pipeline項目

二，清除部分歷史構建

三，參數化構建

這裏使用三個參數，分別對應是否拉取代碼，項目名稱，以及發版選項

四，編寫pipeline腳本

選擇pipeline script

編寫pipeline腳本

def userMap
def proMap = ['api': 'test_api', 'report':'test_report', 'job': 'test_job']     //定義項目字典
def deployMap = ['test-pipeline': 'test-pro.sh']          //定義發版腳本
def predeployMap = ['test-pipeline': 'test-pre.sh']     //定義預發佈腳本
def rollbackMap = ['test-pipeline': 'test-pro-rollback.sh']     //定義回滾腳本
pipeline {
    agent any
    //parameters { string(defaultValue: '', name: 'PULL_FLAG', description: '請根據發佈類型進行選擇發佈：\n1，輸入-TESTING-發佈-最新代碼-到灰度\n2，輸入-LATEST-發佈-最新代碼-到生產\n3，輸入-版本號-發佈-制定版本-到生產 ' ) }
    stages {
        stage('Checkout') {
            when {
                                //判斷是否要拉取代碼
                environment name: 'PULL_FLAG', value: 'yes'
            }
            steps {
                echo "${PULL_FLAG}"
                                //拉取代碼
                checkout([$class: 'GitSCM', branches: [[name: '*/master']], doGenerateSubmoduleConfigurations: false, extensions: [[$class: 'CleanBeforeCheckout']], submoduleCfg: [], userRemoteConfigs: [[credentialsId: '797fddfc-d9d6-42a7-9a2b-38421a6963b0', url: 'git@git.test.com:test/test.git']]])
                echo 'Checkout'
            }
        }
        stage('Build') {
            when {
                environment name: 'PULL_FLAG', value: 'yes'
            }
            steps {
                echo 'Building'
                                // 使用maven進行構建
                sh 'mvn clean install -Dmaven.test.skip=true -Pprod'
            }
        }
        stage('Push package') {
            when {
                environment name: 'PULL_FLAG', value: 'yes'
            }
            steps {
                echo 'push package'
                                //上傳war包至跳板機
                sh 'sh /srv/shell/PAY_scp_pipe.sh '
            }
        }
        stage('Deploy/Rollback') {

            steps {
                                //定義發版密碼校驗，只有輸入口令正確，纔會發版到線上機器，密碼保存在環境變量中
                timeout(60) {
                    script {
                        userMap = input message: 'please input password', ok: 'ok', submitter: 'admin', parameters: [password(name:'password', defaultValue: '', description: '發佈代碼口令' )], submitterParameter: 'admin'

                        if (userMap['password'].toString() == PASSWORD) {
                            echo '密碼正確'
                            if (DEPLOY_FLAG == 'deploy') {
                                echo "發版"
                                sh "ssh test 'cd /data/faban && sh ${deployMap[env.JOB_NAME]} ${proMap[PROJECT]}'"
                            }else if (DEPLOY_FLAG == 'predeploy') {
                                echo '預發佈'
                                sh "ssh test 'cd /data/faban/pre-release && sh ${predeployMap[env.JOB_NAME]} ${proMap[PROJECT]}'"
                            }else if (DEPLOY_FLAG == 'rollback') {
                                echo '回滾'
                                sh "ssh test 'cd /data/faban && sh ${rollbackMap[env.JOB_NAME]} ${proMap[PROJECT]}'"
                            }
                        }else {
                            echo '密碼錯誤'
                            echo "${env.JOB_NAME}"
                        }
                    }
                }    
            }   
        }
    }
    post {
        always {
            echo 'This will always run'
                        //發版結束後刪除jenkins workspace下的臨時目錄
            deleteDir()
        }
        success {
            echo 'This task is successful!'
                        //記錄日誌信息
            sh """
                printf '%s %s %s %s %s  %s' `date +'%F %H:%M:%S'` "${env.JOB_NAME}" "${proMap[PROJECT]}" "${DEPLOY_FLAG}" "success!\n"  >> /srv/jk_logs/jk.log
            """     
        }
    }
}

五，用到的shell腳本

1， 上傳war包的腳本 /srv/shell/TEST_scp_pipe.sh

#!/bin/bash

scp -r /srv/jenkins/workspace/test/test/api/target/api.war test:/data/faban/server_war/risk_api.war
scp -r /srv/jenkins/workspace/test/test/report/target/report.war test:/data/faban/server_war/risk_report.war
scp -r /srv/jenkins/workspace/test/test/job/target/job.war test:/data/faban/server_war/risk_job.war

2， 發版腳本（跳板機）

#!/bin/bash
project="$1"
java_config=/data/faban/java_config
war_rebuild=/data/faban/war_rebuild

if [ $# -lt 1 ]; then
  echo "usage: $0 <project>"
  exit 1
fi

case "$project" in 
        test_api)
        tomcat=/opt/tomcat_api
        server="test"
    ;;
        test_report)
        tomcat=/opt/tomcat_report
        server="test"
    ;;
        test_job)
        tomcat=/opt/tomcat_job
        server="test"
    ;;

esac

rm -rf $war_rebuild/*
rsync -av /data/faban/server_war/$project.war /data/faban/war_rebuild
cd $war_rebuild

ssh $server "pkill -9 -f $tomcat"
ssh $server "rm -rf $tomcat/webapps/ROOT; mv $tomcat/webapps/ROOT.war $tomcat/webapps/ROOT.war.bak"
scp $project.war $server:$tomcat/webapps/ROOT.war
ssh $server "chown www.www $tomcat/webapps/ROOT.war"
ssh $server "su - www -c $tomcat/bin/startup.sh"

sleep 5

3， 回滾腳本（跳板機）

#!/bin/bash
project="$1"

if [ $# -lt 1 ]; then
  echo "usage: $0 <project>"
  exit 1
fi

case "$project" in 
        test_api)
        tomcat=/opt/tomcat_api
        server="test"
    ;;
        test_report)
        tomcat=/opt/tomcat_report
        server="test"
    ;;
        test_job)
        tomcat=/opt/tomcat_job
        server="test"
    ;;

esac

ssh $server "pkill -9 -f $tomcat"
ssh $server "rm -rf $tomcat/webapps/ROOT; mv $tomcat/webapps/ROOT.war.bak $tomcat/webapps/ROOT.war"
ssh $server "su - www -c $tomcat/bin/startup.sh"
sleep 5