恰逢項目初起之時，代碼基礎(chǔ)各部分都有待完善。第一天上項目發(fā)現(xiàn)前后端幾乎沒有測試皮钠，遂決定加個測試覆蓋率的限制。
前端
前端用的react, 測試用的jest赠法。Jest是Facebook的一個專門進(jìn)行Javascript單元測試的工具麦轰，適合React全家桶使用。因jest本身內(nèi)置代碼覆蓋率砖织，便新建了jest.config.json來實現(xiàn)統(tǒng)計前端測試覆蓋率的需求款侵。
{
"collectCoverage": true,
"coverageDirectory": "reports",
"collectCoverageFrom": [
"src/**/*.js",
"!**/node_modules/**"
],
"coverageReporters": [
"clover",
"html"
],
"coverageThreshold": {
"global": {
"branches": 80,
"functions": 80,
"lines": 80,
"statements": 80
}
},
"moduleFileExtensions": [
"js"
],
"modulePaths": [
"<rootDir>"
],
"testRegex": "(/__tests__/.*|\\.test)\\.js$"
}
- testRegex:
設(shè)置識別哪些文件是測試文件（正則形式），與testMatch互斥侧纯，不能同時寫 - moduleFileExtensions: 測試文件的類型
moduleFileExtensions: ['js','json','jsx','node'] - rootDir: 默認(rèn)值是當(dāng)前目錄
- collectCoverage: 默認(rèn)值false
- coverageDirectory: 輸出coverage report的目錄
- collectCoverageFrom: 可配置哪些文件需要收集覆蓋率新锈，哪些不需要
- coverageThreshold: 配置需要達(dá)到的測試覆蓋率的百分比
配置完jest.config.json之后，在package.json內(nèi)配置
"scripts": {
"test": "jest --config jest.config.json",
"prepush": "npm run lint && git secrets --scan -r && npm run test"
}
當(dāng)開發(fā)運行npm run test或git push時會運行測試以及統(tǒng)計測試覆蓋率眶熬。同時項目目錄reports/index.html可查看測試覆蓋率的report. 如果測試覆蓋率沒有達(dá)到配置的百分比妹笆，則push會失敗。
后端
后端用的java gradle娜氏，測試是junit拳缠。一開始想的比較多，老想著在prepush的時候進(jìn)行控制贸弥，在spike解決統(tǒng)計測試率的時候沒能正確的拆分task窟坐，導(dǎo)致花了比較長的時間去spike。后經(jīng)指點绵疲，重點去尋找統(tǒng)計java測試覆蓋率的方法哲鸳。發(fā)現(xiàn)jacoco可以實現(xiàn)并且滿足我的需求。
JaCoCo（Java Code Coverage）是一種分析單元測試覆蓋率的工具盔憨。很多第三方的工具提供了對Jacoco的集成帕胆，如Jenkins等。使用它可以給出代碼中哪些部分被單元測試測到般渡，哪些部分沒有沒測到懒豹，并且給出整個項目的單元測試覆蓋情況百分比芙盘。
統(tǒng)計測試覆蓋率
首先因使用的gradle，所以需要在build.gradle下面引入jacoco脸秽，并進(jìn)行一系列配置儒老。
apply plugin: 'jacoco'
jacocoTestReport {
reports {
xml.enabled false
html.enabled true
}
}
輕松配置完之后愉悅的運行./gradlew jacocoTestReport，完美的在build/jacoco/test/html/index.html看見了測試覆蓋率的report
提交记餐！
上jenkins一看 build掛了驮樊！
在運行TASK:test的時候報錯Caused by: java.lang.NoSuchFieldException: $jacocoAccess，但本地運行良好片酝。懷疑是jacoco根本沒被下載下來囚衔。尋覓許久，發(fā)現(xiàn)jacoco有個issue是跟jdk11不能友好合作雕沿。而我們恰好用的就是jdk11和jacoco0.7.练湿。https://github.com/vaskoz/core-java9-impatient/issues/11
jacoco已經(jīng)在0.8.2的版本中修復(fù)了這個問題：https://github.com/jacoco/jacoco/releases/tag/v0.8.2
所以在我們的build.gradle中需要配置jacoco的版本就能解決。修改后：
apply plugin: 'jacoco'
jacoco {
toolVersion = "0.8.2"
}
jacocoTestReport {
reports {
xml.enabled false
html.enabled true
}
}
集成jenkins
我想要在jenkins上也能看見測試覆蓋率的report审轮，所以需要修改jenkinsfile.
stage('build') {
agent {
docker {
image 'echohe/gradle'
args '-v $HOME/.gradle:/root/.gradle -e JAVA_TOOL_OPTIONS="-Dfile.encoding=UTF8"'
}
}
steps {
sh 'gradle build '
script {
echo "Stage test coverage report starting: ====="
try {
timeout(time:25, unit:'MINUTES') {
sh './gradlew jacocoTestReport'
}
} finally {
if (fileExists('./build/reports/jacoco/test/html/index.html')) {
echo '==== test coverage report exists, prepare to publish'
publishHTML(target: [
allowMissing: true,
alwaysLinkToLastBuild: false,
keepAll: false,
reportDir: 'build/reports/jacoco/test/html/',
reportFiles: 'index.html',
reportName: 'test coverage report',
reportTitles: 'test coverage report']
)
} else {
echo '==== test coverage report does NOT exists!!!'
}
echo "build state: ${currentBuild.result}"
sh 'rm -rf ./build/reports/jacoco'
}
}
}
}
這樣在jenkins的build stage就能生成測試覆蓋率的report肥哎，并且使用了publishHTML，就能在jenkins上出現(xiàn)測試覆蓋率的link疾渣，點擊之后會顯示./build/reports/jacoco/test/html/index.html的內(nèi)容篡诽。
