Jenkins是基於Java開發的一種持續集成工具,用於監控持續重複的工作。能夠實現項目的自動構建、打包、測試、發佈、構建結果通知、代碼質量分析等等。jenkins官網地址爲:https://wiki.jenkins-ci.org/display/JENKINS/Home
Jenkins安裝文件下載
目前最新的版本是2.46.1版本
地址http://mirrors.jenkins-ci.org/下載適合的Jenkins版本。
Windows最新穩定版的Jenkins地址爲:http://mirrors.jenkins-ci.org/windows-stable/jenkins-2.46.1.zip
https://wiki.jenkins-ci.org/display/JENKINS/Installing+Jenkins+as+a+Windows+service
把Jenkins 2.46.1版解壓後,有兩種運行方式:
1. 運行 java -jar jenkins.war,採用內置jetty服務器。
2. 將下載的war包文件部署到 servlet 容器(比如tomcat),然後啓動容器(推薦這種方式)。
redhat系統下安裝流程:https://wiki.jenkins-ci.org/display/JENKINS/Installing+Jenkins+on+Red+Hat+distributions
Jenkins啓動後訪問 http://localhost:8989/jenkins (8989此端口可根據實際情況修改,tomcat默認的端口爲8080),可打開如下界面表示安裝成功
第一次登陸需要輸入管理員密碼,密碼在jenkins的安裝後的.jenkins\secrets\initialAdminPassword文件夾,輸入後點擊Continue按鈕,頁面會調轉到
此時創建一個管理員賬號和密碼以及電子郵箱地址,然後點擊Save and Finish進入,顯示下圖則表明jenkins啓動成功
主要系統配置:
系統管理-Global Tool Configuration
配置JDK
配置MAVEN
系統管理-系統設置
主目錄設置,可以默認,在windows下面是 C:\Users\用戶名\.jenkins,可手動設置到其他目錄,比如F:\.jenkins等
jenkins Location設置:建議修改爲IP加端口
在這兒還可以配置MAVEN和EMAIL、GitHub、SonarQube等,待具體使用時再詳細介紹。
新建一個項目JOB任務
本文以一個Maven結構的java web工程爲列:
點擊新建
輸入項目名
輸入Job名,然後選擇構建一個風格自由的軟件項目,以及其他一些參數信息注意:如果有多個項目,建議工作空間+項目名稱,例:C:\Users\admin\.jenkins\workspace\demo,demo爲項目名稱,也可取其它名稱,這樣會在工作空間下新建不同目錄,以便區分不同項目
原碼管理
在此我使用svn;填寫Repository URL及Credentials,及svn的地址及用戶信息,其中Credentials在首頁Credentials選項新建;
注意:如果是Maven項目,且有多個模塊,則Repository URL路徑指向所有項目的根地址
在首頁Credentials選項新建,輸入svn的賬號和密碼
構建觸發器:
Poll SCM:定時檢查源碼變更(根據SCM軟件的版本號),如果有更新就checkout最新code下來,然後執行構建動作。我的配置如下:
*/5 * * * * (每5分鐘檢查一次源碼變化)
Build periodically:週期進行項目構建(它不care源碼是否發生變化),我的配置如下:
0 2 * * * (每天2:00 必須build一次源碼)
注:Schedule的配置規則是有5個空格隔開的字符組成,從左到右分別代表:分 時 天 月 年。*代表所有,0 12,20 * * * 表示“在任何年任何月任何天的12和20點0分”進行構建。
項目構建:
maven version : 選之前錄入的maven;
Goals選項輸入打包編譯時要執行的命令,如:clean package/clean install;
POM選項選擇pom文件所在的相對位置,如果有多個Maven模塊,選擇父級的pom.xml;
保存,首頁左側 點擊 立即構建 選項即可構建項目了。
監控:
當任務一旦運行,您將會看到這個任務正在隊列中的儀表板和當前工作主頁上運行。這兩種顯示如下。
圖29 主頁監控(左),項目監控(右)
一旦構建完成後,完成後的任務將會有三個地方進行顯示。
你可以在Jenkins的控制面板上看到它,如下圖。
圖30 主頁項目界面
在上面展示的截圖中,您將注意到有兩個圖標描述當前作業的狀態。S欄目代表着“最新構建狀態”,W欄目代表着“構建穩定性”。Jenkins使用這兩個概念來介紹一個作業的總體狀況:
構建狀態:下圖中分級符號概述了一個Job新近一次構建會產生的四種可能的狀態:
Successful:完成構建,且被認爲是穩定的。
Unstable:完成構建,但被認爲不穩定。
Failed:構建失敗。
Disabled:構建已禁用。
圖31 構建狀態界面
構建穩定性: 當一個Job中構建已完成並生成了一個未發佈的目標構件,如果您準備評估此次構建的穩定性,Jenkins會基於一些後處理器任務爲構建發佈一個穩健指數 (從0-100 ),這些任務一般以插件的方式實現。它們可能包括單元測試(JUnit)、覆蓋率(Cobertura )和靜態代碼分析(FindBugs)。分數越高,表明構建越穩定。下圖中分級符號概述了穩定性的評分範圍。任何構建作業的狀態(總分100)低於80分就是不穩定的。
圖32 構建穩定性界面
你也可以在當前Job主界面上看到它,如下圖左下部分
圖33 項目主界面
當前作業主頁上還包含了一些有趣的條目。左側欄的鏈接主要控制Job的配置、刪除作業、構建作業。右邊部分的鏈接指向最新的項目報告和構件。
通過點擊構建歷史(Build History)中某個具體的構建鏈接,您就能跳轉到Jenkins爲這個構建實例而創建的構建主頁上。如下圖
圖34 構建歷史界面
如果你想通過視圖輸出界面來監控當前任務的進展情況。你可以單擊Console Output(控制檯輸出)。如果工作已完成,這將顯示構建腳本產生的靜態輸出;如果作業仍然在運行中,Jenkins將不斷刷新網頁的內容,以便您可以看到它運行時的輸出。如下圖:
圖35 控制檯輸出界面
查看構建日誌:
日誌信息:
構建成功!!!如報一下錯誤:
解決方案:
(a)修改pom.xml文件
<build>
<finalName>demo</finalName>
</build>
添加<defaultGoal>install</defaultGoal>
即:
<build>
<defaultGoal>install</defaultGoal>
<finalName>demo</finalName>
</build>
(b)指定默認Goals
clean install -Dmaven.test.skip=true #加入了跳過測試的代碼
重新構建。
部署項目:
構建後操作:
配置後保存,重新構建,其中demo是我web項目的名稱,此處的http://localhost:8081,是部署demo項目的服務器和端口
WAR/EAR files:target\demo.war,是構建後生成的war包,正常情況下打包成功後就會部署到tomcat下webapps目錄下,如
果構建成功,但沒有自動部署,修改WAR/EAR files:**/*.war試試。
構建成功後,即可登錄項目驗證:
到此Jenkins部署就完成了!!!!!!!!!!!!!!
Jenkins自動部署配置
jenkins自動Deploy插件安裝
要實現jenkins的自動部署,首先是要下載 Deploy to Container Plugin 插件(這個是支持將代碼部署到tomcat容器的)
找到:插件管理 在“可選插件”界面
安裝完之後,如果勾選了:安裝完成後重啓jenkins 那麼會重啓jenkins。
Tomcat服務器賬號配置
另外還需要在被髮布那臺Tomcat設置相應的管理員賬號和密碼:
在tomcat的安裝路徑conf\tomcat-users.xml文件夾下新增
- <role rolename="manager"/>
- <role rolename="manager-script"/>
- <role rolename="manager-gui"/>
- <role rolename="manager-jmx"/>
- <role rolename="manager-status"/>
- <user username="admin" password="admin" roles="manager,manager-gui,manager-script,manager-jmx,manager-status"/>
然後重啓Tomcat,在jenkins的任務“增加構建後操作步驟”中選擇“DePloy War/ear to container”,然後新增對應目標tomcat服務器的連接URL,登錄名,密碼,發佈的war/ear包的原路徑和tomcat的webapps下面的工程報名(原war包名和部署後的工程名可不一致,比如之前是target目錄下的demo.war文件,部署後可改名爲demo2)
圖28 遠程部署配置界面
WAR/EAR files:war文件的存放位置,如:target/test.war 注意:相對路徑,target前是沒有/的。
Context path:訪問時需要輸入的內容,如ofCard訪問時如下:http://192.168.x.x:8080/ofCard/如果爲空,默認是war包的名字。
Container:選擇你的web容器,如tomca 6.x
Manager user name:填入tomcat-users.xml配置的username內容
Manager password:填入tomcat-users.xml配置的password內容
Tomcat URL:填入http://192.168.x.x:8080/
Deploy on failure:構建失敗依然部署,一般不選擇
注意:雖然這種部署方法可能會導致tomcat加載時出現卡死的現象。但是也是最簡單的部署方式。如果卡死了重啓下就好了,將tomcat的java內存參數調高可以解決這個問題。
Jenkins郵件配置
一、Jenkins內置默認的郵件通知配置
1、全局配置
點擊左邊的“系統管理”菜單,選擇右邊的“系統設置”
在系統設置中找到Jenkins Locaction項填入Jenkins URL和系統管理員郵件地址,系統管理員郵件地址一定要配置,否則發不了郵件通知。因爲郵件通知都是由系統管理員的郵箱發出來的。
找到郵件通知項,填入SMTP服務器信息及用戶名、密碼等認證信息。(此處使用SMTP用戶名和密碼需要特別注意的是如果是QQ和163等郵箱配置試密碼不是郵件用戶名的密碼,而是郵箱客戶端授權碼!!!網易郵箱客戶端授權碼設置鏈接) 配好以後勾選“通過發送測試郵件測試配置”
填入接收測試郵件的地址,點擊“Test configuration”。如果配置正確就會在下面顯示Email was successfully sent
在測試接收郵箱就會收到由Jenkins系統管理員的郵箱發出來的一封測試郵件。說明郵箱通知確實已經配置正確並能夠正常收發Jenkins的通知郵件了。有網友說如果配的發送郵箱是某個郵件服務商的比如163的郵件,接收郵箱也得要配相同郵件服務商163的纔可以收到郵件,經過測試沒有這種限制,只要是能夠收發郵件隨便配哪個郵件服務商126、163、QQ、189甚至公司郵件等的都可以收。
2、項目配置
郵件通知的全局設置配好以後就可以在具體的項目中應用發送郵件通知了。
在項目的設置中找到“增加構建後的操作步驟”,選擇“E-mail Notifacation”通過E-mail通知。
在Recipients中填入郵件通知接收者中,如果有多個接收者用空格分隔,可以發送郵件通知給多個相關的接收人。
如果配置沒有問題,在構建出問題的時候都會有郵件通知到郵件通知接收者。
二、Email Extension Plugin插件配置郵件通知
1、全局配置
同樣在點擊左邊的“系統管理”菜單,選擇右邊的“系統設置”,找到Extend E-mail Notification進行全局配置。
同樣填好SMTP Server的信息。點擊“高級”進行SMTP鑑權的配置,配置發郵件人的用戶名、密碼等信息。
默認收件人填需要發送郵件通知的人,如有多個用空格分隔
點擊最右下角的"Default Triggers ..."按鈕設置默認的觸發郵件通知的事件。
根據實際情況勾選需要觸發郵件通知的事件。
保存全局的配置信息後到項目中進行項目的配置。
2、項目配置
進入到具體的項目配置界面點擊“配置”,在配置界面點擊“增加構建後操作步驟”,選擇“Editable Email Notification”
在設置中保存默認就可以了。
可以在“Advanced Settings”中針對該項目進行個性化的配置。
可以針對該項目定義該項目通知的收件人列表、主題、內容、附件等。
設置完後點擊保存。就可以去驗證是否可以郵件通知了。
通過測試工程構建後,Jenkins配置的郵件通接收人可以正常收到構建信息的郵件通知。
到這裏Jenkins配置郵件通知全部完成了。
======================================
郵件通知配置相關的全局屬性詳解
1. Override Global Settings:如果不選,該插件將使用默認的E-mail Notification通知選項。反之,您可以通過指定不同於( 默認選項)的設置來進行覆蓋。
2. Default Content Type:指定構建後發送郵件內容的類型,有Text和HTML兩種.
3. Use List-ID Email Header:爲所有的郵件設置一個List-ID的郵件信頭
4. Add 'Precedence: bulk' Email Header:設置優先級
5. Default Recipients:自定義默認電子郵件收件人列表。如果沒有被項目配置覆蓋
,該插件會使用這個列表。您可以在項目配置使用$ DEFAULT_RECIPIENTS參數包括此默認列表,以及添加新的地址在項目級別。添加抄送:cc:電子郵件地址例如,CC:[email protected]6. Reply To List:回覆列表, A comma separated list of e-mail addresses to use in the Reply-To header of the email. This value will be available as $DEFAULT_REPLYTO in the project configuration.
7. Emergency reroute:如果這個字段不爲空,所有的電子郵件將被單獨發送到該地址(或地址列表)。
8. Excluded Committers:防止郵件被郵件系統認爲是垃圾郵件,郵件列表應該沒有擴展的賬戶名(如:@domain.com),並且使用逗號分隔
9. Default Subject:自定義郵件通知的默認主題名稱。該選項能在郵件的主題字段中替換一些參數,這樣你就可以在構建中包含指定的輸出信息。
10. Maximum Attachment Size:郵件最大附件大小。
11. Default Content:自定義郵件通知的默認內容主體。該選項能在郵件的內容中替換一些參數,這樣你就可以在構建中包含指定的輸出信息。
12. Default Pre-send Script:默認發送前執行的腳本(注:grooy腳本,這是我在某篇文章上看到的,不一定準確)。
13. Enable Debug Mode:啓用插件的調試模式。這將增加額外的日誌輸出,構建日誌以及Jenkins的日誌。在調試時是有用的,但不能用於生產。
14. Enable Security:啓用時,會禁用發送腳本的能力,直接進入Jenkins實例。如果用戶試圖訪問Jenkins管理對象實例,將拋出一個安全異常。
15. Content Token Reference:郵件中可以使用的變量,所有的變量都是可選的。
全局郵件變量
email-ext插件允許使用變量來動態插入數據到郵件的主題和內容主體中。變量是一個以$(美元符號)開始,並以空格結束的字符串。當一個郵件觸發時,主題和內容主體字段的所有變量都會通過真實的值動態地替換。同樣,變量中的“值”能包含其它的變量,都將被替換成真實的內容。
比如,項目配置頁的默認主題和內容分別對應的是全局配置頁面的DEFAULT_SUBJECT和DEFAULT_CONTENT,因此它會自動地使用全局的配置。同理,觸發器中的Subject和Content分別對應的是項目配置頁面的DEFAULT_SUBJECT和DEFAULT_CONTENT,所以它也會自動地使用項目的配置。由於變量中的“值”能包含其它的變量,所以就能爲變量快速地創建不同的切入點:全局級別(所有項目),專屬級別(單一項目),觸發器級別(構建結果)。
如果你要查看所有可用的變量,你可以點擊配置頁的Content Token Reference的問號獲取詳細的信息。
所有的變量都是可選的,每個變量可以如下表示,字符串類型使用name=“value”,而布爾型和數字型使用name=value。如果{和}標記裏面沒有變量,則不會被解析。示例:$TOKEN,${TOKEN},${TOKEN,count=100},${ENV,var=”PATH”}
提示:用英文逗號分隔變量的參數。
常用的屬性如下:
${FILE,path="PATH"} 包括指定文件(路徑)的含量相對於工作空間根目錄。
path文件路徑,注意:是工作區目錄的相對路徑。
${BUILD_NUMBER} 顯示當前構建的編號。
${JOB_DESCRIPTION} 顯示項目描述。
${SVN_REVISION} 顯示svn版本號。還支持Subversion插件出口的SVN_REVISION_n版本。
${CAUSE} 顯示誰、通過什麼渠道觸發這次構建。
${CHANGES } -顯示上一次構建之後的變化。
showPaths 如果爲 true,顯示提交修改後的地址。默認false。
showDependencies 如果爲true,顯示項目構建依賴。默認爲false
format 遍歷提交信息,一個包含%X的字符串,其中%a表示作者,%d表示日期,%m表示消息,%p表示路徑,%r表示版本。注意,並不是所有的版本系統都支持%d和%r。如果指定showPaths將被忽略。默認“[%a] %m\\n”。
pathFormat 一個包含“%p”的字符串,用來標示怎麼打印路徑。
${BUILD_ID}顯示當前構建生成的ID。
${PROJECT_NAME} 顯示項目的全名。
${PROJECT_DISPLAY_NAME} 顯示項目的顯示名稱。
${SCRIPT} 從一個腳本生成自定義消息內容。自定義腳本應該放在"$JENKINS_HOME/email-templates"。當使用自定義腳本時會默認搜索$JENKINS_HOME/email-templatesdirectory目錄。其他的目錄將不會被搜索。
script 當其使用的時候,僅僅只有最後一個值會被腳本使用(不能同時使用script和template)。
template常規的simpletemplateengine格式模板。
${JENKINS_URL} 顯示Jenkins服務器的url地址(你可以再系統配置頁更改)。
${BUILD_LOG_MULTILINE_REGEX}按正則表達式匹配並顯示構建日誌。
regex java.util.regex.Pattern 生成正則表達式匹配的構建日誌。無默認值,可爲空。
maxMatches 匹配的最大數量。如果爲0,將匹配所有。默認爲0。
showTruncatedLines 如果爲true,包含[...truncated ### lines...]行。默認爲true。
substText 如果非空,就把這部分文字(而不是整行)插入該郵件。默認爲空。
escapeHtml 如果爲true,格式化HTML。默認爲false。
matchedSegmentHtmlStyle 如果非空,輸出HTML。匹配的行數將變爲<b style=”your-style-value”> html escaped matched line </b>格式。默認爲空。
${BUILD_LOG} 顯示最終構建日誌。
maxLines 日誌最多顯示的行數,默認250行。
escapeHtml 如果爲true,格式化HTML。默認false。
${PROJECT_URL} 顯示項目的URL地址。
${BUILD_STATUS} -顯示當前構建的狀態(失敗、成功等等)
${BUILD_URL} -顯示當前構建的URL地址。
${CHANGES_SINCE_LAST_SUCCESS} -顯示上一次成功構建之後的變化。
reverse在頂部標示新近的構建。默認false。
format遍歷構建信息,一個包含%X的字符串,其中%c爲所有的改變,%n爲構建編號。默認”Changes for Build #%n\n%c\n”。
showPaths,changesFormat,pathFormat分別定義如${CHANGES}的showPaths、format和pathFormat參數。
${CHANGES_SINCE_LAST_UNSTABLE} -顯示顯示上一次不穩固或者成功的構建之後的變化。
reverse在頂部標示新近的構建。默認false
format遍歷構建信息,一個包含%X的字符串,其中%c爲所有的改變,%n爲構建編號。默認”Changes for Build #%n\n%c\n”。
showPaths,changesFormat,pathFormat分別定義如${CHANGES}的showPaths、format和pathFormat參數。
${ENV} –顯示一個環境變量。
var– 顯示該環境變量的名稱。如果爲空,顯示所有,默認爲空。
${FAILED_TESTS} -如果有失敗的測試,顯示這些失敗的單元測試信息。
${JENKINS_URL} -顯示Jenkins服務器的地址。(你能在“系統配置”頁改變它)。
${HUDSON_URL} -不推薦,請使用$JENKINS_URL
${PROJECT_URL} -顯示項目的URL。
${SVN_REVISION} -顯示SVN的版本號。
${JELLY_SCRIPT} -從一個Jelly腳本模板中自定義消息內容。有兩種模板可供配置:HTML和TEXT。你可以在$JENKINS_HOME/email-templates下自定義替換它。當使用自動義模板時,”template”參數的名稱不包含“.jelly”。
template模板名稱,默認”html”。
${TEST_COUNTS} -顯示測試的數量。
var– 默認“total”。
total -所有測試的數量。
fail -失敗測試的數量。
skip -跳過測試的數量。
Jenkins釘釘配置