前言
blog傳送門(mén)
項(xiàng)目中使用jenkins挺久了蚯根，每次發(fā)布測(cè)試環(huán)境代碼都需要手動(dòng)去jenkins上發(fā)布受扳，特別麻煩，想到兩種解決方案沪哺，一種是通過(guò)CI/CD持續(xù)集成忧饭，一種是通過(guò)jenkins API調(diào)用配制好的job。
- 第一種方案需要觸發(fā)，還要推送代碼到指定分支羡儿，不能完美解決目前的痛點(diǎn)。
- 第二種方案靈活配置是钥，手動(dòng)觸發(fā)掠归，在需要的時(shí)候構(gòu)建缅叠，可以解決目前的痛點(diǎn)。
本文就講解如何通過(guò)API完成測(cè)試環(huán)境的構(gòu)建工作虏冻，生產(chǎn)環(huán)境不推薦這樣做肤粱，生產(chǎn)環(huán)境一般都有嚴(yán)格的上線流程和權(quán)限控制。
image.png
一厨相、構(gòu)建腳本
- 首先我們?cè)陧?xiàng)目中新建(若沒(méi)有)
build文件夾领曼，新建jenkins.js存放我們的腳本 - 安裝Jenkins ->
npm install --save-dev jenkins - 示例代碼如下
- 把腳本添加到
package.json的script中，新增"deploy:jen": "node ./build/jenkins" - 我們運(yùn)行
npm run deploy:jen
const Jenkins = require('jenkins')
// 分支名
const branchName = 'test'
// 項(xiàng)目名
const jobName = 'example'
// 授權(quán)信息
const auth = {
username: 'username',
// 推薦使用jenkins token蛮穿，在個(gè)人設(shè)置中生成
password: 'password'
}
const jenkins = new Jenkins({
// https://用戶名:密碼/token@jenkins地址
baseUrl: `https://${auth.username}:${auth.password}@jenkins.xxx.com`,
})
async function triggerBuild() {
try {
const result = await jenkins.job.build({
name: jobName,
// jenkins中需要的參數(shù)庶骄，若無(wú)則為空
parameters: {
branch: branchName,
merge: true
},
token: auth.password
})
console.log('開(kāi)始構(gòu)建...', result)
} catch (error) {
console.error('error: ', error);
}
}
triggerBuild()
此時(shí)我們已經(jīng)可以觸發(fā)構(gòu)建流程，但是不夠完美践磅，發(fā)布分支需要我們寫(xiě)死单刁，且我們并不知道構(gòu)建進(jìn)度，所以我們需要借助child_process查看分支和jenkins.build.logStream實(shí)時(shí)查看構(gòu)建進(jìn)度
二音诈、動(dòng)態(tài)配置分支名&輸出進(jìn)度
在第一步的基礎(chǔ)上幻碱，我們進(jìn)行完善
const Jenkins = require('jenkins')
const { exec } = require('child_process');
// 分支名初始化
const branchName = 'test'
// jenkins的job名
const jobName = 'example'
// 授權(quán)信息
const auth = {
username: 'username',
password: 'password'
}
const jenkins = new Jenkins({
// https://用戶名:密碼/token@jenkins地址
baseUrl: `https://${auth.username}:${auth.password}@jenkins.xxx.com`,
})
getGitBranch()
.then(res => {
branchName = res
triggerBuild()
})
// 獲取當(dāng)前分支
function getGitBranch() {
return new Promise((resolve, reject) => {
exec('git rev-parse --abbrev-ref HEAD', (error, stdout, stderr) => {
if (error) {
console.error(`exec error: ${error}`)
reject()
return;
}
resolve(stdout.trim())
})
})
}
// 觸發(fā)構(gòu)建
async function triggerBuild() {
try {
const result = await jenkins.job.build({
name: jobName,
// jenkins中需要的參數(shù)，若無(wú)則為空
parameters: {
branch: branchName,
merge: true
},
token: auth.token
})
console.log('準(zhǔn)備構(gòu)建...', result)
waitOnQueue(result)
} catch (error) {
console.error('error: ', error);
}
}
// 輪訓(xùn)查看當(dāng)前構(gòu)建狀態(tài)
async function waitOnQueue(id) {
const result = await jenkins.queue.item(id)
if (result.executable) {
console.log('開(kāi)始構(gòu)建: ', jobName);
setTimeout(() => {
logBuild(result.executable.number)
}, 500);
} else if (result.cancelled) {
console.log('構(gòu)建已取消')
} else {
setTimeout(() => {
waitOnQueue(id)
}, 500);
}
}
// 輸出編譯結(jié)果
function logBuild(id) {
console.log('構(gòu)建中...', id)
const log = jenkins.build.logStream(jobName, id);
log.on("data", (text) => {
process.stdout.write(text);
});
log.on("error", (err) => {
console.log("error", err);
});
log.on("end", () => {
console.log("success: 構(gòu)建完成.");
});
}
此時(shí)细溅，我們已經(jīng)完善了我們的發(fā)布腳本褥傍，但是項(xiàng)目中會(huì)有多個(gè)開(kāi)發(fā)需要使用此腳本，認(rèn)證信息如果可以動(dòng)態(tài)配置喇聊，那就更好了恍风。我們可以通過(guò)node腳本或者shell完成這一想法。
三誓篱、編寫(xiě)shell腳本完成用戶賬號(hào)信息配置
build文件中新增jenkins-init.sh文件朋贬，參考第四步-
文件內(nèi)腳本需要完成三個(gè)個(gè)操作
- 允許用戶輸入賬號(hào)信息
- 內(nèi)置默認(rèn)賬號(hào)配置
- 存入賬號(hào)信息到j(luò)son中
在
package.json的script中新增"init:jen": "sh ./build/jenkins-init.sh"修改
jenkins.js腳本，讀取配置賬號(hào)信息shell腳本會(huì)自動(dòng)在build文件夾下生成一個(gè)token.json的文件窜骄，可以把這個(gè)文件加入到.gitignore里面锦募，不需要提交到遠(yuǎn)端
image.png
四、完整版
jenkins-init
#!/usr/bin/env sh
set -e
ACCOUNT=""
TOKEN=""
read -p "初始化本地jenkins配置, 是否使用默認(rèn)配置 ? (y/n)" -n 1 -r
if [[ $REPLY =~ ^[Yy]$ ]]
then
echo ""
ACCOUNT="username"
TOKEN="password|token"
else
echo ""
echo "jenkins賬號(hào):"
# 20s超時(shí)自動(dòng)斷
read -t 20 ACCOUNT
echo "jenkins密碼(token):"
read -t 20 TOKEN
fi
# 存入配置文件
echo '{"account": "'$ACCOUNT'", "token": "'$TOKEN'"}' > ./build/token.json
echo "jenkins配置初始化完成"
jenkins.js
const Jenkins = require('jenkins')
const fs = require('fs')
const path = require('path')
const { exec } = require('child_process');
const auth = {}
const jobName = 'example'
let jenkins
let branchName = 'test'
getGitBranch()
.then(res => {
branchName = res
initJenkins()
})
function initJenkins() {
try {
const data = fs.readFileSync(path.join(__dirname, './', 'token.json'), 'utf8')
Object.assign(auth, JSON.parse(data))
jenkins = new Jenkins({
baseUrl: `https://${auth.account}:${auth.token}@jenkins.xxx.com`,
})
triggerBuild()
} catch (error) {
console.error('配置文件未找到邻遏，請(qǐng)先運(yùn)行npm run init:jen 生成配置文件')
}
}
function getGitBranch() {
return new Promise((resolve, reject) => {
exec('git rev-parse --abbrev-ref HEAD', (error, stdout, stderr) => {
if (error) {
console.error(`exec error: ${error}`)
reject()
return;
}
resolve(stdout.trim())
})
})
}
async function triggerBuild() {
try {
const result = await jenkins.job.build({
name: jobName,
// jenkins中需要的參數(shù)糠亩，若無(wú)則為空
parameters: {
branch: branchName,
merge: true
},
token: auth.token
})
console.log('準(zhǔn)備構(gòu)建...', result)
waitOnQueue(result)
} catch (error) {
console.error('error: ', error);
}
}
async function waitOnQueue(id) {
const result = await jenkins.queue.item(id)
if (result.executable) {
console.log('開(kāi)始構(gòu)建: ', jobName);
setTimeout(() => {
logBuild(result.executable.number)
}, 500);
} else if (result.cancelled) {
console.log('構(gòu)建已取消')
} else {
setTimeout(() => {
waitOnQueue(id)
}, 500);
}
}
function logBuild(id) {
console.log('構(gòu)建中...', id)
const log = jenkins.build.logStream(jobName, id);
log.on("data", (text) => {
process.stdout.write(text);
});
log.on("error", (err) => {
console.log("error", err);
});
log.on("end", () => {
console.log("success: 構(gòu)建完成.");
});
}
image.png
開(kāi)發(fā)拉取代碼后，首次需要運(yùn)行npm run init:jen生成配置文件准验，之后每次發(fā)布測(cè)試環(huán)境可以運(yùn)行npm run deploy:jen觸發(fā)構(gòu)建赎线，若需要合并test分支，則可以在jenkins中配置自動(dòng)合并糊饱。
至此垂寥，我們實(shí)現(xiàn)了可自由配置賬號(hào)信息，手動(dòng)觸發(fā)jenkins構(gòu)建，并且查看構(gòu)建進(jìn)度的腳本滞项。
