前言

測試是軟件開發(fā)過程中一個必須的環(huán)節(jié)，測試確保軟件的質(zhì)量符合預(yù)期。

對于工程師自己來說，單元測試也是提升自信心的一種方式。

直接交付沒有經(jīng)過測試的代碼是不太好的，因為這很可能會浪費整個團隊的時間，在一些原本早期就可以發(fā)現(xiàn)的問題上。而單元測試，就是發(fā)現(xiàn)問題一個很重要的環(huán)節(jié)。

本文以C 語言為基礎(chǔ)，講解如何進行單元測試并生成測試報告。

在工具上，我們會使用下面這些：

• GCC
• CMake
• Google Test
• gcov
• lcov

演示項目

為了方便本文的講解，我專門編寫了一個演示項目作為代碼示例。

演示項目的源碼可以在我的Github上獲?。?span>paulQuei/gtest-and-coverage^[1]。

你可以通過下面幾條命令下載和運行這個項目：

git?clone?https://github.com/paulQuei/gtest-and-coverage.git
cd?gtest-and-coverage
./make_all.sh


要運行這個項目，你的機器上必須先安裝好前面提到的工具。如果沒有，請閱讀下文以了解如何安裝它們。

如果你使用的是Mac系統(tǒng)，下文假設(shè)你的系統(tǒng)上已經(jīng)安裝了brew^[2]包管理器。如果沒有，請通過下面這條命令安裝它：

/usr/bin/ruby?-e?"$(curl?-fsSL?https://raw.githubusercontent.com/Homebrew/install/master/install)"


項目結(jié)構(gòu)

演示項目的目錄結(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)容是：以測試一個我們要提供的軟件庫為例，講解如何對其進行單元測試并生成測試報告。

為了簡單起見，這個軟件庫只有一個頭文件和一個實現(xiàn)文件。

當(dāng)然，在實際上的項目中，一個軟件庫會通常包含更多的文件，不過這并不影響我們要說明的問題。

演示項目中的文件說明如下：

文件名稱	說明
make_all.sh	入口文件，會執(zhí)行：編譯，測試和生成報告等所有工作
CMakeLists.txt	項目的編譯文件
googletest-release-1.8.1.zip	google test源碼壓縮包
utility.h	待測試的軟件庫的頭文件
utility.cpp	待測試的軟件庫的實現(xiàn)文件
unit_test.cpp	對軟件庫進行單元測試的代碼

測試環(huán)境

演示項目在如下的環(huán)境中測試過。

• 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

為了簡化編譯的過程，這里使用CMake作為編譯工具。關(guān)于CMake的更多內(nèi)容請參見請官網(wǎng)：https://cmake.org^[3]。

關(guān)于如何安裝CMake請參見這里：Installing CMake^[4]。

另外，你也可以通過一條簡單的命令來安裝CMake：

• Mac系統(tǒng)：

brew?install?cmake


• Ubuntu系統(tǒng)

sudo?apt?install?cmake
由于篇幅所限，這里不打算對CMake做過多講解，讀者可以訪問其官網(wǎng)或者在網(wǎng)絡(luò)上搜尋其使用方法。

這里僅僅對演示項目中用到的內(nèi)容做一下說明。演示項目中的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)?⑧
以編號為序，這段代碼說明如下：

1. 設(shè)置使用的CMake最低版本號為2.8.11。
2. 指定項目的名稱為”utility”，項目名稱可以通過${CMAKE_PROJECT_NAME}進行引用。
3. 指定使用C 11。
4. 這里的三行是編譯google test，并將其頭文件路徑和編譯結(jié)果的庫文件路徑添加到環(huán)境中。因為后面在編譯單元測試代碼的時候需要用到。
5. 添加--coverage到編譯器flag中，這個參數(shù)是很重要的，因為這是生成代碼覆蓋率所必須的。關(guān)于該編譯參數(shù)的說明見這里：Program Instrumentation Options^[5]。
6. 編譯我們的軟件庫，這里將生成libutility_lib.a庫文件。
7. 編譯單元測試的可執(zhí)行文件。
8. 單元測試的可執(zhí)行文件需要鏈接我們開發(fā)的軟件庫以及google test的庫。另外，google test依賴了pthread，所以這個庫也需要。

關(guān)于測試

軟件測試有很多種分類方式。從測試的級別來說，可以大致分為：

• 單元測試
• 集成測試
• 系統(tǒng)測試

這其中，單元測試是最局部和具體的。它通常需要對代碼中的每一個類和函數(shù)進行測試。

單元測試通常由開發(fā)者完成，需要針對代碼邏輯進行測試。所以它是一種白盒測試^[6]。

關(guān)于xUnit

xUnit是幾種單元測試框架的總稱。最早源于Smalltalk的單元測試框架SUnit，它是由Kent Beck^[7]開發(fā)的。

除此之外，還有針對Java語言的JUnit，針對R語言的RUnit。

在本文中，我們使用Google開發(fā)的xUnit框架：Google Test。

Google Test介紹

Google Test的項目主頁在Github上：Github: Google Test^[8]。

實際上，這個項目中同時包含了GoogleTest和GoogleMock兩個工具，本文中我們只會講解第一個。

Google Test支持的操作系統(tǒng)包含下面這些：

• Linux
• Mac OS X
• Windows
• Cygwin
• MinGW
• Windows Mobile
• Symbian

目前有很多的項目都使用了Google Test，例如下面這些：

• Chromium projects^[9]
• LLVM^[10]
• Protocol Buffers^[11]
• OpenCV^[12]
• tiny-dnn^[13]

編譯Google Test

關(guān)于如何編譯Google Test請參見這里：Generic Build Instructions^[14]。

為了便于讀者使用，我們在演示項目中包含了Google Test 1.8.1的源碼壓縮包。并且在CMake文件中，同時包含了Google Test的編譯和使用配置工作。

如果使用演示項目，讀者將不需要手動處理Google Test的編譯和安裝工作。

使用Google Test

演示項目代碼說明

為了便于下文說明，演示項目中包含了幾個簡單的函數(shù)。

可以從這里下載源碼以便查看其中的內(nèi)容：paulQuei/gtest-and-coverage^[15]。

演示項目中的軟件庫包含一個頭文件和一個實現(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
這個頭文件說明如下：

• 頭文件包含了三個函數(shù)，前兩個用來做int和double類型的四則運算。最后一個判斷輸入的年份是否是閏年。

• 當(dāng)然，在實際的工程中，前兩個函數(shù)合并實現(xiàn)為一個泛型函數(shù)更為合適。但這里之所以分成兩個，是為了查看代碼覆蓋率所用。

• 關(guān)于
  閏年
  說明如下：

• 能被4整除但不能被100整除的年份為普通閏年。
• 能被100整除，也同時能被400整除的為世紀(jì)閏年。
• 其他都不是閏年。
• 例如：1997年不是閏年，2000年是閏年，2016年是閏年，2100不是閏年。

這三個函數(shù)的實現(xiàn)也不復(fù)雜：

//?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?