Jenkins除了有GUI界面,還提供了RestAPI的方式來方便用戶,使用代碼(Python、Java)控制Jenkins的工作流。
【本文要點(diǎn)】
- 使用python-jenkins庫和python3.6.3作為基礎(chǔ)糖儡。
- Jenkins被安裝在虛擬機(jī)上,開放部分Jenkins的“安全設(shè)置”怔匣。
- 設(shè)置Jenkins中當(dāng)前登錄用戶的API Token握联。
- 在Pycharm中寫一些簡(jiǎn)單的代碼來控制遠(yuǎn)程的Jenkins桦沉。
1.Python-Jenkins庫
1.1 What is python-jenkins?
Python Jenkins is a python wrapper for the Jenkins REST API which aims to provide a more conventionally pythonic way of controlling a Jenkins server. It provides a higher-level API containing a number of convenience functions.
1.2 Python-Jenkins能做什么?
Python-Jenkins可以做很多事情見圖1所示:
1.3 Python-Jenkins的安裝
如果你的Python環(huán)境中有pip管理工具,請(qǐng)使用pip進(jìn)行python-jenkins庫文件的安裝金闽,安裝命令如下所示纯露。【PS:建議python版本使用3.x】
#使用pip進(jìn)行python-jenkins庫的安裝
$ pip install python-jenkins
2.修改Jenkins的“安全設(shè)置”
筆者所用的Jenkins版本為2.89.3代芜,對(duì)于Jenkins2.x以上的版本埠褪,安全防護(hù)更加的嚴(yán)格。因此挤庇,我們需要降低一點(diǎn)Jenkins的安全防護(hù)級(jí)別钞速,將“安全矩陣”替換為“登錄用戶可以做任何事”。圖2和圖3為具體更改后的安全配置情況嫡秕。
修改完“全局安全配置”后渴语,請(qǐng)重啟您的Jenkins服務(wù)
[PS]重啟Jenkins服務(wù)可以采用在地址欄輸入“http://ip:port/restart”的方式。
3.Jenkins中設(shè)置當(dāng)前登錄用戶的 API Token
只有已登錄的用戶才能設(shè)置自己相對(duì)應(yīng)的API Token昆咽,API token是用戶登錄操作Jenkins的另外意義上的Password,可以將API Token 等價(jià)于Password驾凶。
3.1 啟用用戶所屬的API Token
當(dāng)你成功登錄進(jìn)Jenkins系統(tǒng),根據(jù)圖3所示的操作進(jìn)行Show API Token 的操作掷酗,你就會(huì)得到當(dāng)前用戶唯一的API Token调违,API Token的用法見本文第四節(jié)(編寫python控制jenkins的代碼)
3.2 修改用戶所屬的API Token
如果,你想修改你的API Token,請(qǐng)根據(jù)圖4所示進(jìn)行修改操作泻轰。
4.編寫python控制jenkins的代碼
下面是一個(gè)獲取Jenkins版本號(hào)的小Demo:
import jenkins
#遠(yuǎn)程Jenkins的地址
jenkins_server_url = 'http://192.168.1.13:8080'
#用戶名
user_id = 'admin'
#用戶的token值(每個(gè)user有對(duì)應(yīng)的token----如本文第3.1節(jié)所示)
api_token = 'ea8c65123036cf95cd038b1d8e5cc3c9'
#登錄密碼
#passwd = 'admin'
#server = jenkins.Jenkins(jenkins_server_url, username=user_id, password=passwd)
#使用 API_Token 進(jìn)行Jenkins登錄操作
server = jenkins.Jenkins(jenkins_server_url, username=user_id, password=api_token)
#使用get.version()方法獲取版本號(hào)
version = server.get_version()
print(version)
#server.build_job('oschina_selenium_docker')
圖5為Jenkins GUI上的版本號(hào)信息:
圖6為Python代碼執(zhí)行后獲取Jenkins版本號(hào)的結(jié)果:
筆者遇到的坑點(diǎn)與填坑
【坑點(diǎn)1】一定要修改Jenkins的“全局安全設(shè)置”技肩,不然代碼運(yùn)行時(shí)就會(huì)報(bào)錯(cuò)“jenkins.BadHTTPException: Error communicating with server[http://192.168.1.13:8080/]”。
【填坑1】要想解決坑點(diǎn)1糕殉,請(qǐng)具體本文【圖2圖3】進(jìn)行設(shè)置Jenkins的【全局安全配置】即可。
更多Python代碼方式操作Jenkins的事例代碼請(qǐng)?jiān)L問Pthon-Jenkins官方殖告。
本文END阿蝶,請(qǐng)換一種方式體驗(yàn)下Jenkins的不同玩法!