cmake使用教程（三）-安裝、測試、系統自檢

【cmake系列使用教程】

cmake使用教程（一）-起步

cmake使用教程（二）-添加庫

cmake使用教程（三）-安裝、測試、系統自檢

cmake使用教程（四）-文件生成器

cmake使用教程（五）-cpack生成安裝包

cmake使用教程（六）-蛋疼的語法

cmake使用教程（七）-流程和循環

cmake使用教程（八）-macro和function

這個系列的文章翻譯自官方cmake教程：cmake tutorial。

示例程序地址：github.com/rangaofei/t…

不會僅僅停留在官方教程。本人做爲一個安卓開發者，實在是沒有linux c程序開發經驗，望大佬們海涵。教程是在macos下完成，大部分linux我也測試過，有特殊說明的我會標註出來。本教程基於cmake-3.10.2，同時認爲你已經安裝好cmake。

本節將爲咱們的項目添加安裝規則和測試支持。此處僅講解教程中添加的一些規則，後續有詳細章節講解定製本身的安裝規則。只適用於macos和linux。

設置安裝規則

安裝規則至關簡單。對於mathfunction庫，咱們設添加了這個庫，經過將如下兩行添加到mathfunction的CMakeLists.txt中來安裝頭文件和靜態庫:

install (TARGETS MathFunctions DESTINATION bin)
install (FILES MathFunctions.h DESTINATION include)
複製代碼

而後根目錄下的CMakeLusts.txt文件中添加以下行,用來安裝可執行文件和配置文件：

# add the install targets
install (TARGETS Tutorial DESTINATION bin)
install (FILES "${PROJECT_BINARY_DIR}/TutorialConfig.h"        
         DESTINATION include)
複製代碼

注意上邊install的第一個參數和第三個參數。

TARGETS包含六種形式：ARCHIVE, LIBRARY, RUNTIME, OBJECTS, FRAMEWORK, BUNDLE。注意Mathfunction安裝的是LIBRARY，而根目錄下的可執行文件是RUNTIME類型。

FILE 將給定的文件複製到指定目錄。若是沒有給定權限參數，則由該表單安裝的文件默認爲OWNER_WRITE、OWNER_READ、GROUP_READ和WORLD_READ。

TARGETS和FILE可指定爲相對目錄和絕對目錄。

DESTINATION在這裏是一個相對路徑，取默認值。在unix系統中指向 /usr/local 在windows上c:/Program Files/${PROJECT_NAME}。

也能夠經過設置CMAKE_INSTALL_PREFIX這個變量來設置安裝的路徑，那麼安裝位置不指向/usr/local，而指向你所指定的目錄。

cmake .
make
makeinstall
複製代碼

執行完畢後即安裝了軟件。

示例中指向的安裝地址以下表所示:

文件/庫	安裝位置
MathFunctions	/usr/local/bin/
MathFunctions.h	/usr/local/include/
Tutorial	/usr/local/bin/
TutorialConfig.h	/usr/local/include

添加測試

添加測試也很是簡單，在根目錄下的CMakeLists.txt文件最後添加以下代碼來測試輸入參數後產生的結果是否正確。

include(CTest)

# does the application run
add_test (TutorialRuns Tutorial 25)
# does it sqrt of 25
add_test (TutorialComp25 Tutorial 25)
set_tests_properties (TutorialComp25 PROPERTIES PASS_REGULAR_EXPRESSION "25 is 5")
# does it handle negative numbers
add_test (TutorialNegative Tutorial -25)
set_tests_properties (TutorialNegative PROPERTIES PASS_REGULAR_EXPRESSION "-25 is 0")
# does it handle small numbers
add_test (TutorialSmall Tutorial 0.0001)
set_tests_properties (TutorialSmall PROPERTIES PASS_REGULAR_EXPRESSION "0.0001 is 0.01")
# does the usage message work?
add_test (TutorialUsage Tutorial)
set_tests_properties (TutorialUsage PROPERTIES PASS_REGULAR_EXPRESSION "Usage:.*number")
複製代碼

構建項目完成後，能夠運行ctest命令行工具來運行測試。第一個測試只是驗證應用程序是否正常運行，沒有發生崩潰，而且返回值是0。這是CTest測試的基本形式。接下來的幾個測試都使用PASS_REGULAR_EXPRESSION測試屬性來驗證測試的輸出是否包含特定的字符串。

若是您想要添加許多測試來測試不一樣的輸入值，您能夠考慮建立以下的宏(至關於函數):

#define a macro to simplify adding tests, then use it
macro (do_test arg result)
  add_test (TutorialComp${arg} Tutorial ${arg})
  set_tests_properties (TutorialComp${arg}
    PROPERTIES PASS_REGULAR_EXPRESSION ${result})
endmacro (do_test)
 
# do a bunch of result based tests
do_test (25 "25 is 5")
do_test (-25 "-25 is 0")
複製代碼

構建項目後執行ctest可獲得以下結果：

 ~/Desktop/Tutorial/Step3/build/ ctest
Test project /Users/saka/Desktop/Tutorial/Step3/build
    Start 1: TutorialRuns
1/5 Test #1: TutorialRuns ..................... Passed 0.00 sec
    Start 2: TutorialComp25
2/5 Test #2: TutorialComp25 ................... Passed 0.01 sec
    Start 3: TutorialNegative
3/5 Test #3: TutorialNegative ................. Passed 0.00 sec
    Start 4: TutorialSmall
4/5 Test #4: TutorialSmall .................... Passed 0.00 sec
    Start 5: TutorialUsage
5/5 Test #5: TutorialUsage .................... Passed 0.00 sec

100% tests passed, 0 tests failed out of 5

Total Test time (real) =   0.03 sec
複製代碼

能夠看到，測試所有經過。

添加系統自檢

有時候咱們可能會爲多種平臺開發程序，而有的平臺包含某個庫，有的平臺不包含這個庫，那麼咱們就能夠經過系統自檢來判斷是使用平臺系統提供的庫仍是本身編寫的庫。

下邊咱們將添加一些依賴於目標平臺是否具備log和exp函數的代碼。固然，幾乎每一個平臺都有這些功能，但本教程假設它們不太常見。若是平臺有log庫，那麼咱們將使用它來計算平方根，而不適用mysqrt中的函數。

首先使用CheckFunctionExists.cmake宏來測試這些函數的是否存在。在頂級CMakeLists.txt文件中編寫代碼以下:

# does this system provide the log and exp functions?
include (CheckFunctionExists)
check_function_exists (log HAVE_LOG)
check_function_exists (exp HAVE_EXP)
複製代碼

而後在TutorialConfig.h.in中添加使用上邊定義的變量的代碼：

// does the platform provide exp and log functions?
#cmakedefine HAVE_LOG
#cmakedefine HAVE_EXP
複製代碼

有一點須要注意：log和exp的測試代碼必定要在TutorialConfig.h的configure_file命令以前。configure.file命令會當即使用CMake中的當前設置配置文件。最後，在mysqrt函數中，咱們能夠提供一個基於log和exp的替代實現，若是它們在系統上可用如下代碼可用:

// if we have both log and exp then use them
#if defined (HAVE_LOG) && defined (HAVE_EXP)
  result = exp(log(x)*0.5);
#else // otherwise use an iterative approach
  ...
複製代碼