.NETCore下CI/CD之自動化測試

• 2019 年 10 月 30 日
• 筆記

前言

為了呼應《中國.NET開發者峰會2019上海站》，作為演講嘉賓，我希望和各位同行建立更多的互動，為此，我特地將部分演講內容，整理成文章先行發布。本文從零開始，一步一步的引導，從安裝JDK/Tomcat/jenkins 到建立第一個 CI/CD 項目，確保按照本文指引，能快速的在 CentOS 下，將 .NET Core 通過 jenkins 進行持續集成/持續部署，通過 jenkins，實現集成測試自動化，最終達到，快速構建項目，執行單元測試，生成測試報告，發送測試報告等工作，讓測試工作伴隨著 CI/CD 的持續進行而不斷的對輸出進行測試和校正，真正實現讓本地單元測試在 CI/CD 中發揮其巨大的威力。

大會詳情介紹請看文章末尾介紹。

安裝JDK

首先安裝Java環境，在Centos7上，搜索倉庫內的包包

yum search java | grep --color OpenJDK

可以看到一堆顏色鮮艷的Java包包，接下來執行安裝openjdk

yum install java-1.8.0-openjdk java-1.8.0-openjdk-devel

安裝完成後，執行命令

java -version  # 輸出 OpenJDK 64-Bit Server VM (build 25.222-b10, mixed mode) 表示安裝成功

安裝 Tomcat

安裝Tomcat的話，直接下載Tomcat的zip包，下載地址：http://mirrors.tuna.tsinghua.edu.cn/apache/tomcat/tomcat-9/v9.0.27/bin/apache-tomcat-9.0.27.tar.gz 到官網下載是個好習慣，認準這隻貓；然後上傳到伺服器，解壓
比如我目前上傳到目錄： /usr/local/，執行解壓命令，然後刪除壓縮包

tar -zxf apache-tomcat-9.0.27.tar.gz tomcat  rm -f apache-tomcat-9.0.27.tar.gz

實際上，按照一般情況下，直接執行下面的命令可以直接運行 Tomcat

/usr/local/tomcat/bin/startup.sh

但是作為測試要盡量貼近實際環境的極客追求來說，我們要把 Tomcat 作為系統服務，在系統開關機的時候隨系統啟動，那麼就需要多做點小工作，不需要擔心，下面的工作一共就花了2分鐘左右

首先，我們需要指定 Tomcat.PID 進程文件，進入 /usr/local/tomcat/bin，編輯文件

vi /usr/local/tomcat/bin/setenv.sh  // 輸入  CATALINA_PID="$CATALINA_BASE/tomcat.pid"  JAVA_OPTS="-server -XX:MetaspaceSize=256M -XX:MaxMetaspaceSize=1024m -Xms512M -Xmx1024M -XX:MaxNewSize=256m"  // 保存，退出編輯

增加 tomcat 賬戶並賦予許可權

getent group tomcat || groupadd -r tomcat  getent passwd tomcat || useradd -r -d /opt -s /bin/nologin -g tomcat tomcat  chown -R tomcat:tomcat /usr/local/tomcat

防止Jeknins報錯，先打個預防針，創建 .jenkins 目錄

mkdir /opt/.jenkins  chown -R tomcat:tomcat /opt/.jenkins

編寫系統服務文件

進入目錄 cd /usr/lib/systemd/system,執行 ls -l，可以看到很多服務文件，然後我們直接執行下面的命令新建並編輯文件 tomcat.service

vi tomcat.service

tomcat.service 輸入以下內容

[Unit]  Description=tomcat  After=syslog.target network.target remote-fs.target nss-lookup.target    [Service]  Type=forking  Environment = "JAVA_HOME=/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.222.b10-1.el7_7.x86_64"  PIDFile=/usr/local/tomcat/tomcat.pid  ExecStart=/usr/local/tomcat/bin/startup.sh  ExecStop=/usr/local/tomcat/bin/shutdown.sh  ExecReload=/bin/kill -s HUP $MAINPID  PrivateTmp=true  User=tomcat  Group=tomcat    [Install]  WantedBy=multi-user.target    // 保存，退出

系統服務文件創建完成，輸入命令3連

systemctl enable tomcat.service  systemctl start tomcat.service  system status tomcat.service

如果以上的命令沒有報錯，那麼恭喜你，你已經成功部署了 Tomcat 服務，接下來就是部署 jenkins 到 Tomcat

部署並運行jenkins

下載 jenkins 的war 包包，地址：https://jenkins.io/zh/download/ ，由於我們使用 Tomcat 託管，直接選擇 Generic Java package（.war）下載即可

下載完成，直接將該 jenkins.war 包上傳到 Tomcat 伺服器目錄 /usr/local/tomcat/webapps/ 下,這個時候你應該喝杯咖啡；稍等一會，Tomcat 馬上就把 jenkins 做好了，大概在1分鐘後，訪問 jenkins 站點的地址

http://172.16.1.202:8080/jenkins

在 CentOS上，正常情況下，你是無法訪問該地址的，需要打開 Tomcat 這隻貓貓的偵聽埠：8080，執行下面的命令，完成防火牆的設置

firewall-cmd --zone=public --add-port=8080/tcp --permanent  firewall-cmd reload

再次訪問 jenkins 的地址，你應該看到下面這個介面：

首次訪問，按照提示，直接複製密碼 cat /opt/.jenkins/secrets/initialAdminPassword 到輸入框中進入 jenkins，稍後還需要創建用戶，一併設置完成即可

等待 jenkins 初始化完成，可選擇安裝推薦的插件

請耐心等待插件安裝完成….

設置帳號密碼

Jenkins已就緒

安裝 .NET Core 環境

相信來到這個環節，大家都鬆了一口氣，畢竟安裝 sdk/runtime 這種事情，微軟已經幫我們把腳本寫好了，直接 copy 使用即可。訪問 https://dotnet.microsoft.com/download/linux-package-manager/centos7/sdk-current

sudo rpm -Uvh https://packages.microsoft.com/config/centos/7/packages-microsoft-prod.rpm    // 本文演示還是使用 2.2  sudo yum install dotnet-sdk-2.2

安裝完成，按照國際慣例，輸入 dotnet –version，輸出版本號即為安裝成功

創建一個.NET Core 的解決方案，包含單元測試

一個相對標準的解決方案結構如下，解決方案中必須包含 src/test 兩個基礎項目，表示該項目有單元測試，沒有單元測試的項目是不完整的，這應當成為一種良好的編程規範。項目建立完成，我們本地執行單元測試看看結果。

dotnet test

其中，Ron.XUnitTest 項目使用了託管測試主機的方式運行單元測試，默認的測試結果文件是 .trx 格式，在 jenkins 上執行發送測試報告的時候， jenkins 將無法解析，為了使用測試結果文件，我們還必須引用另外一個 nuget 包:XunitXml.TestLogger，該組件賦予我們將 dotnet test 的結果文件轉換為 xUnitXml 文件的能力。

控制台輸出結果如下：

一共有12項測試，其中全部通過。本地測試已經通過。接下來我們就開始使用 jenkins 構建 .NET Core 程式。

jenkins配置郵件通知

為了實現發送測試報告的功能，我們需要在 jenkins 中配置郵件伺服器，點擊 Manage Jenkins -> Configure System -> Email notification

配置系統管理員郵件地址

配置 Smtp 伺服器

創建第一個 CI/CD 項目

創建任務

點擊 「開始創建一個新任務」，輸入任務名稱，選擇自由風格的項目，點擊確定，然後馬上就進入了任務詳細配置的介面。

源碼管理，選擇 git

由於我的測試項目託管在 GitHub 上，所以我填入 GitHub 的項目地址：https://github.com/lianggx/RonTest.git，身份驗證，我選擇添加一個認證資訊。

編寫構建腳本

接下來，直接拉到底部，在構建選項這裡選擇「增加構建步驟」，選擇 「執行 shell」。輸入構建腳本。

echo '==============準備開始構建=================='  pwd    cd src/Ron.Blogs  sudo dotnet restore  sudo dotnet build  sudo dotnet publish --framework netcoreapp2.2 -o /data/sites/RonTest    echo '==============構建完成=================='

編寫測試腳本

再次增加一個構建步驟，「執行 shell」。輸入腳本

sudo dotnet test test/Ron.XUnitTest/Ron.XUnitTest.csproj --logger:"xunit;LogFileName=TestResult.xml"

這裡有一個細節，就是在執行命令的時候帶了一個參數 –logger:"xunit;LogFileName=TestResult.xml"，表示輸出測試結果為 xunit 格式的 xml 文件，該文件將在下面的測試報告環節使用。

演示到了這裡，有點走不下去，因為我們要解析測試報告，但是這個時候我們需要去安裝一個插件，否則無法解析

安裝 jenkins 必須插件

返回 jenkins 首頁，依次點擊 Manage Jenkins -> Manage Plugins -> Available（可選插件），搜索 TestComplete xUnit ，勾選，選擇直接安裝即可。

發送測試報告配置

安裝完成後，再次進入任務配置頁，添加構建後操作，選擇：Publish xUnit test result report，Report Type 選擇 xUnit.NET-v2(default)，Pattern 輸入測試報告生成的路徑：

test/Ron.XUnitTest/TestResults/TestResults.xml

配置郵件接收人

繼續添加構建後操作步驟 E-mail notification

保存配置，立即構建！

構建成功，獲得報表

收到郵件通知

一個小細節

由於我是從安裝 CentOS 開始做起，在開始構建的時候還有一個錯誤，就是報：sudo: no tty present and no askpass program specified，如果有碰到的同學，請勿驚慌，編輯下面的文件可解決問題

vi /etc/sudoers    // 定位到文件末尾，增加兩個用戶的配置，保存即可  jenkins ALL = NOPASSWD:ALL  tomcat ALL = NOPASSWD:ALL  

結束語

本文詳細介紹了從零開始，如何利用 jenkins 對 .NET Core 項目進行 CI/CD 下的集成自動化測試，對於即將開展或者已經開展 CI/CD 化的項目具有一定的參考意義，篇幅較長，由於篇幅較長，難免有所疏漏，歡迎指正。
文章參考：https://www.cnblogs.com/ieinstein/p/7096650.html

中國.NET開發者峰會2019上海站

作為《中國.NET開發者峰會2019上海站》的演講嘉賓，我分享的主題《建立TDD的高效開發模型》，裡面會提到本文的內容，由於本文篇幅較長，所以先放本節內容，在會上我也會做詳細的介紹，歡迎大家到上海現場交流。進入現場的方式請訪問下方的二維碼，獲取大會行程介紹，也請掃描下方的二維碼獲取。

大會資訊

2019年11月9日 09:00-18：00
大會地址：（上海楊浦）佳木斯路777號上海中谷小南國花園酒店
門票優惠：每張門票299， 購買團體票（大於10張）享受整單8折優惠，請通過郵箱聯繫主辦方 [email protected]

報名方式

活動行：https://www.huodongxing.com/event/4514005355700

百格活動：https://www.bagevent.com/event/6069892

演講嘉賓介紹