1. 程式人生 > >Jenkins中整合Gcov程式碼覆蓋率報告

Jenkins中整合Gcov程式碼覆蓋率報告

最近終於把gcov程式碼覆蓋報告整合到jenkins中了,總算是完成工作,寫篇部落格總結下。

我循序漸進地用了三個工具:gcov, lcov, gcovr

這三個工具原理(其實gcovr依賴於GNU的gcov的)都是收集你程式run之後所產生的*.gcda檔案,總的來說,我個人覺得比較喜歡lcov,應為lcov的報告讀起來很不錯,可惜它不能整合到Jenkins。。。

從頭說起。。。

一開始我用的是GNU tool gcov,網上學習了下gcov,生成了xx.cpp.gcov報告,然後就可以查看了,gcov給我的感覺是比較基礎,最大的缺點是不能統計所有程式碼的覆蓋資訊(我是用cmake,有可能我的CMakeLists.txt中有好多target,比如,我寫了個CMakeLists.txt,這個檔案中產生2個目標,一個叫hello_world,一個叫goodbye_world,這個hello_world裡有2個原始檔,然後這個goodbye_world裡假設也有兩個檔案,但是我想檢視總的程式碼覆蓋情況,也就是兩個目標run之後4個原始檔的程式碼覆蓋情況

),而且生成的報告不是那麼human-readable。

隨後,又開始研究,找到了一個叫lcov前端工具,將lcov和genhtml連起來用確實生成的HTML報告讀起來很棒,行覆蓋率、分支什麼的都有,而且又能收集多個目標執行後的程式碼覆蓋率,但是lcov生成的報告不能被Jenkins追蹤,也沒有覆蓋率趨勢。

於是,又再次研究,用Google搜到篇老外的文章,http://www.semipol.de/archives/320,裡面講了用gcovr可以生成xml檔案,這個xml檔案是可以被Cobertura讀取解析,而這個Cobertura是Jenkins的一個現有java統計覆蓋率的外掛,這下就找到方向了!

有了方向,我就開始做了,首先:在Jenkins上找到了Cobertura這個外掛並安裝,然後,配置下你的編譯,我是直接執行了shell指令碼,就是Jenkins的構建的Execute shell,比如,sh mybuild.sh,緊接著,在你的Jenkins工程中增加post-build action,見下圖,讓這個外掛去讀這個coverage.xml檔案,接下來就是怎麼生成這個coverage.xml檔案了。

隨後,我在網上下了個gcovr,是用gcovr -x -r "source_dir" --output "output_dir/coverage.xml"生成了上面外掛需要的coverage.xml檔案,你可以把它寫到上面的mybuild.sh中,其實mybuild.sh肯定還有其他shell命令,比如先執行你的程式,進入目錄什麼的。

ok,如果編譯沒什麼錯誤的話,最後你就能在Jenkins中看到gcov的報告了。

 至此,Jenkins整合Gcov報告就結束了,如果你用的是cmake的話,我強烈推薦下老外寫的CMake指令碼,這些指令碼很強大,可以整合到你的CMakeLists.txt中,使你不需要去寫gcovr -x -r "source_dir".....這些命令了,因為老外直接寫好了,額,open source就是強大啊!

Cmake coverage 指令碼:https://code.cor-lab.de/projects/rsc/repository/revisions/master/entry/cmake/Modules/EnableCoverageReport.cmake

相關解析指令碼: https://code.cor-lab.de/projects/rsc/repository/revisions/master/entry/cmake/Modules/ParseArguments.cmake

找lcov指令碼: https://code.cor-lab.de/projects/rsc/repository/revisions/master/entry/cmake/Modules/FindLcov.cmake

找gcovr指令碼:https://code.cor-lab.de/projects/rsc/repository/revisions/master/entry/cmake/Modules/Findgcovr.cmake

gcovr下載地址:https://pypi.python.org/pypi/gcovr/   解壓後,使用scripts/gcovr就可以了

下載完上述4個指令碼和gcovr工具後,你就可以在你的CMakelists.txt中加入了,具體我不解釋了,自行檢視,下面示範怎麼使用:


set(CMAKE_MODULE_PATH "helloworld/cmake/modules" ${CMAKE_MODULE_PATH})  #我把這些指令碼放到cmake/modlues目錄下

include(ConfigureCodeCoverage)

if(CODE_COVERAGE)
ENABLE_COVERAGE_REPORT(FILTER "/usr/include/*;/usr/lib/*")
endif(CODE_COVERAGE)

編譯:

先執行 cmake --build . --use-stderr

然後執行 cmake --build . --use-stderr -- target Coverage

執行完畢後,你就可以看到locv和gcovr生成的報告了,因為老外已經講lcov,gcovr整合進EnableCoverageReport.cmake這個指令碼中了。

一些連結:

Gcovr user guide: http://gcovr.com/guide.html#gettingStarted