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