C 語(yǔ)言的單元測(cè)試與代碼覆蓋率
[導(dǎo)讀]測(cè)試是軟件開(kāi)發(fā)過(guò)程中一個(gè)必須的環(huán)節(jié)，測(cè)試確保軟件的質(zhì)量符合預(yù)期。對(duì)于工程師自己來(lái)說(shuō)，單元測(cè)試也是提升自信心的一種方式。直接交付沒(méi)有經(jīng)過(guò)測(cè)試的代碼是不太好的，因?yàn)檫@很可能會(huì)浪費(fèi)整個(gè)團(tuán)隊(duì)的時(shí)間，在一些原本早期就可以發(fā)現(xiàn)的問(wèn)題上。而單元測(cè)試，就是發(fā)現(xiàn)問(wèn)題一個(gè)很重要的環(huán)節(jié)。本文以C語(yǔ)言為...
測(cè)試是軟件開(kāi)發(fā)過(guò)程中一個(gè)必須的環(huán)節(jié)，測(cè)試確保軟件的質(zhì)量符合預(yù)期。
對(duì)于工程師自己來(lái)說(shuō)，單元測(cè)試也是提升自信心的一種方式。直接交付沒(méi)有經(jīng)過(guò)測(cè)試的代碼是不太好的，因?yàn)檫@很可能會(huì)浪費(fèi)整個(gè)團(tuán)隊(duì)的時(shí)間，在一些原本早期就可以發(fā)現(xiàn)的問(wèn)題上。而單元測(cè)試，就是發(fā)現(xiàn)問(wèn)題一個(gè)很重要的環(huán)節(jié)。本文以C 語(yǔ)言為基礎(chǔ)，講解了如何進(jìn)行單元測(cè)試并生成測(cè)試報(bào)告。在工具上，我們會(huì)使用下面這些：
- GCC
- CMake
- Google Test
- gcov
- lcov
演示項(xiàng)目
為了方便本文的講解，我專門編寫(xiě)了一個(gè)演示項(xiàng)目作為代碼示例。演示項(xiàng)目的源碼可以在我的Github上獲取：paulQuei/gtest-and-coverage[1]。你可以通過(guò)下面幾條命令下載和運(yùn)行這個(gè)項(xiàng)目：git?clone?https://github.com/paulQuei/gtest-and-coverage.git
cd?gtest-and-coverage
./make_all.sh
要運(yùn)行這個(gè)項(xiàng)目，你的機(jī)器上必須先安裝好前面提到的工具。如果沒(méi)有，請(qǐng)閱讀下文以了解如何安裝它們。
如果你使用的是Mac系統(tǒng)，下文假設(shè)你的系統(tǒng)上已經(jīng)安裝了brew[2]包管理器。如果沒(méi)有，請(qǐng)通過(guò)下面這條命令安裝它：
/usr/bin/ruby?-e?"$(curl?-fsSL?https://raw.githubusercontent.com/Homebrew/install/master/install)"
項(xiàng)目結(jié)構(gòu)
演示項(xiàng)目的目錄結(jié)構(gòu)如下：.
├──?CMakeLists.txt
├──?googletest-release-1.8.1.zip
├──?include
│???└──?utility.h
├──?make_all.sh
├──?src
│???└──?utility.cpp
└──?test
????└──?unit_test.cpp
這里演示的內(nèi)容是：以測(cè)試一個(gè)我們要提供的軟件庫(kù)為例，講解如何對(duì)其進(jìn)行單元測(cè)試并生成測(cè)試報(bào)告。為了簡(jiǎn)單起見(jiàn)，這個(gè)軟件庫(kù)只有一個(gè)頭文件和一個(gè)實(shí)現(xiàn)文件。當(dāng)然，在實(shí)際上的項(xiàng)目中，一個(gè)軟件庫(kù)會(huì)通常包含更多的文件，不過(guò)這并不影響我們要說(shuō)明的問(wèn)題。演示項(xiàng)目中的文件說(shuō)明如下：
| 文件名稱 | 說(shuō)明 |
|---|---|
| make_all.sh | 入口文件，會(huì)執(zhí)行：編譯，測(cè)試和生成報(bào)告等所有工作 |
| CMakeLists.txt | 項(xiàng)目的編譯文件 |
| googletest-release-1.8.1.zip | google test源碼壓縮包 |
| utility.h | 待測(cè)試的軟件庫(kù)的頭文件 |
| utility.cpp | 待測(cè)試的軟件庫(kù)的實(shí)現(xiàn)文件 |
| unit_test.cpp | 對(duì)軟件庫(kù)進(jìn)行單元測(cè)試的代碼 |
測(cè)試環(huán)境
演示項(xiàng)目在如下的環(huán)境中測(cè)試過(guò)。- MacBook Pro
- 操作系統(tǒng)：macOS Mojave 10.14.1
- 編譯器：Apple LLVM version 10.0.0 （clang-1000.11.45.2）
- CMake：cmake version 3.12.1
- Google Test: 1.8.1
- lcov: lcov version 1.13
- Ubuntu
- 操作系統(tǒng)：Ubuntu 16.04.5 LTS
- 編譯器：gcc （Ubuntu 5.4.0-6ubuntu1~16.04.10） 5.4.0 20160609
- CMake：cmake version 3.5.1
- Google Test：1.8.1
- lcov：lcov version 1.12
關(guān)于CMake
為了簡(jiǎn)化編譯的過(guò)程，這里使用CMake作為編譯工具。關(guān)于CMake的更多內(nèi)容請(qǐng)參見(jiàn)請(qǐng)官網(wǎng)：https://cmake.org[3]。關(guān)于如何安裝CMake請(qǐng)參見(jiàn)這里：Installing CMake[4]。另外，你也可以通過(guò)一條簡(jiǎn)單的命令來(lái)安裝CMake：- Mac系統(tǒng)：
brew?install?cmake
- Ubuntu系統(tǒng)
sudo?apt?install?cmake
由于篇幅所限，這里不打算對(duì)CMake做過(guò)多講解，讀者可以訪問(wèn)其官網(wǎng)或者在網(wǎng)絡(luò)上搜尋其使用方法。這里僅僅對(duì)演示項(xiàng)目中用到的內(nèi)容做一下說(shuō)明。演示項(xiàng)目中的CMakeLists.txt內(nèi)容如下：cmake_minimum_required(VERSION?2.8.11)?①
project(utility)?②
set(CMAKE_CXX_STANDARD?11)?③
set(GTEST?googletest-release-1.8.1)?④
include_directories("./include"?"${GTEST}/googletest/include/")
link_directories("build/gtest/googlemock/gtest/")
SET(CMAKE_CXX_FLAGS??"${CMAKE_CXX_FLAGS}?--coverage")?⑤
add_library(${CMAKE_PROJECT_NAME}_lib?src/utility.cpp)?⑥
add_executable(unit_test?test/unit_test.cpp)?⑦
target_link_libraries(unit_test?${CMAKE_PROJECT_NAME}_lib?gtest?gtest_main?pthread)?⑧
以編號(hào)為序，這段代碼說(shuō)明如下：- 設(shè)置使用的CMake最低版本號(hào)為2.8.11。
- 指定項(xiàng)目的名稱為”utility”，項(xiàng)目名稱可以通過(guò)
${CMAKE_PROJECT_NAME}進(jìn)行引用。 - 指定使用C 11。
- 這里的三行是編譯google test，并將其頭文件路徑和編譯結(jié)果的庫(kù)文件路徑添加到環(huán)境中。因?yàn)楹竺嬖诰幾g單元測(cè)試代碼的時(shí)候需要用到。
- 添加
--coverage到編譯器flag中，這個(gè)參數(shù)是很重要的，因?yàn)檫@是生成代碼覆蓋率所必須的。關(guān)于該編譯參數(shù)的說(shuō)明見(jiàn)這里：Program Instrumentation Options[5]。 - 編譯我們的軟件庫(kù)，這里將生成
libutility_lib.a庫(kù)文件。 - 編譯單元測(cè)試的可執(zhí)行文件。
- 單元測(cè)試的可執(zhí)行文件需要鏈接我們開(kāi)發(fā)的軟件庫(kù)以及google test的庫(kù)。另外，google test依賴了pthread，所以這個(gè)庫(kù)也需要。
關(guān)于測(cè)試
軟件測(cè)試有很多種分類方式。從測(cè)試的級(jí)別來(lái)說(shuō)，可以大致分為：- 單元測(cè)試
- 集成測(cè)試
- 系統(tǒng)測(cè)試
關(guān)于xUnit
xUnit是幾種單元測(cè)試框架的總稱。最早源于Smalltalk的單元測(cè)試框架SUnit，它是由Kent Beck[7]開(kāi)發(fā)的。除此之外，還有針對(duì)Java語(yǔ)言的JUnit，針對(duì)R語(yǔ)言的RUnit。在本文中，我們使用Google開(kāi)發(fā)的xUnit框架：Google Test。Google Test介紹
Google Test的項(xiàng)目主頁(yè)在Github上：Github: Google Test[8]。實(shí)際上，這個(gè)項(xiàng)目中同時(shí)包含了GoogleTest和GoogleMock兩個(gè)工具，本文中我們只會(huì)講解第一個(gè)。Google Test支持的操作系統(tǒng)包含下面這些：- Linux
- Mac OS X
- Windows
- Cygwin
- MinGW
- Windows Mobile
- Symbian
- Chromium projects[9]
- LLVM[10]
- Protocol Buffers[11]
- OpenCV[12]
- tiny-dnn[13]
編譯Google Test
關(guān)于如何編譯Google Test請(qǐng)參見(jiàn)這里：Generic Build Instructions[14]。為了便于讀者使用，我們?cè)谘菔卷?xiàng)目中包含了Google Test 1.8.1的源碼壓縮包。并且在CMake文件中，同時(shí)包含了Google Test的編譯和使用配置工作。如果使用演示項(xiàng)目，讀者將不需要手動(dòng)處理Google Test的編譯和安裝工作。使用Google Test
演示項(xiàng)目代碼說(shuō)明
為了便于下文說(shuō)明，演示項(xiàng)目中包含了幾個(gè)簡(jiǎn)單的函數(shù)。可以從這里下載源碼以便查看其中的內(nèi)容：paulQuei/gtest-and-coverage[15]。演示項(xiàng)目中的軟件庫(kù)包含一個(gè)頭文件和一個(gè)實(shí)現(xiàn)文件。頭文件內(nèi)容如下：
//?utility.h
#ifndef?INCLUDE_UTILITY_
#define?INCLUDE_UTILITY_
enum?CalcType?{
????ADD,
????MINUS,
????MULTIPLE,
????DIVIDE
};
class?Utility?{
public:
????int?ArithmeticCalculation(CalcType?op,?int?a,?int?b);
????double?ArithmeticCalculation(CalcType?op,?double?a,?double?b);
????bool?IsLeapYear(int?year);
};
#endif
這個(gè)頭文件說(shuō)明如下：- 頭文件包含了三個(gè)函數(shù)，前兩個(gè)用來(lái)做
int和double類型的四則運(yùn)算。最后一個(gè)判斷輸入的年份是否是閏年。 - 當(dāng)然，在實(shí)際的工程中，前兩個(gè)函數(shù)合并實(shí)現(xiàn)為一個(gè)泛型函數(shù)更為合適。但這里之所以分成兩個(gè)，是為了查看代碼覆蓋率所用。
- 關(guān)于閏年說(shuō)明如下：
- 能被4整除但不能被100整除的年份為普通閏年。
- 能被100整除，也同時(shí)能被400整除的為世紀(jì)閏年。
- 其他都不是閏年。
- 例如：1997年不是閏年，2000年是閏年，2016年是閏年，2100不是閏年。
//?utility.cpp
#include?"utility.h"
#include?
#include?
using?namespace?std;
int?Utility::ArithmeticCalculation(CalcType?op,?int?a,?int?b)?{
????if?(op?==?ADD)?{
????????return?a? ?b;
????}?else?if?(op?==?MINUS)?{
????????return?a?-?b;
????}?else?if?(op?==?MULTIPLE)?{
????????return?a?*?b;
????}?else?{
????????if?(b?==?0)?{
????????????cout?<"CANNO?Divided?by?0"?<????????????return?std::numeric_limits::max();
????????}
????????return?a?/?b;
????}
}
double?Utility::ArithmeticCalculation(CalcType?op,?double?a,?double?b)?{
????if?(op?==?ADD)?{
????????return?a? ?b;
????}?else?if?(op?==?MINUS)?{
????????return?a?-?b;
????}?else?if?(op?==?MULTIPLE)?{
????????return?a?*?b;
????}?else?{
????????if?(b?==?0)?{
????????????cout?<"CANNO?Divided?by?0"?<????????????return?std::numeric_limits::max();
????????}
????????return?a?/?b;
????}
}
bool?Utility::IsLeapYear(int?year)?{
????if?(year?%?100?==?0? 
下載文檔
