Exercise11

bantinghy

已于 2023-07-04 11:50:19 修改

阅读量44

点赞数

分类专栏： CMake 文章标签： c++ linux 服务器

于 2023-07-04 09:22:00 首次发布

本文链接：https://blog.csdn.net/u011743621/article/details/131527838

版权

CMake 专栏收录该内容

18 篇文章 0 订阅

订阅专栏

该文章展示了如何使用CMake来管理项目的编译选项，包括创建接口库添加编译特性，处理不同编译器的警告级别，并通过configure_file生成配置头文件。同时，文章还详细介绍了如何设置和运行单元测试，以及如何将项目提交到CDashDashboard进行持续集成监控。

摘要由CSDN通过智能技术生成

Configure.h.in file

ubuntu@ubuntu:$ vim TutorialConfig.h.in 
ubuntu@ubuntu:$ cat TutorialConfig.h.in 
// the configured options and settings for Tutorial
// TODO : Define Tutorial_VERSION_MAJOR and Tutorial_VERSION_MINOR

#define Tutorial_VERSION_MAJOR @Tutorial_VERSION_MAJOR@
#define Tutorial_VERSION_MINOR @Tutorial_VERSION_MINOR@

#cmakedefine USE_MYMATH
ubuntu@ubuntu:$

Cxx file

ubuntu@ubuntu:$ vim tutorial.cxx 
ubuntu@ubuntu:$ cat tutorial.cxx 
// A simple program that computes the square root of a number
#include <cmath>
#include <iostream>
#include <string>

#include "TutorialConfig.h"
#ifdef USE_MYMATH
#include "MathFunctions.h"
#endif


int main(int argc, char* argv[])
{
  if (argc < 2) {
    //report version
    std::cout << argv[0] << " Version " << Tutorial_VERSION_MAJOR << "."
                         << Tutorial_VERSION_MINOR << std::endl;
    std::cout << "Usage: " << argv[0] << " number" << std::endl;
    return 1;
  }

  // convert input to double
  // std::stod是C++ 11标准函数
  const double inputValue = std::stod(argv[1]);

  // calculate square root
  const double outputValue = mysqrt(inputValue);
  std::cout << "The square root of " << inputValue << " is " << outputValue
            << std::endl;
  return 0;
}
ubuntu@ubuntu:$

Top CMake file

ubuntu@ubuntu:$ vim CMakeLists.txt 
ubuntu@ubuntu:$ cat CMakeLists.txt 

# TODO : Set the minimum required version of CMake to be 3.10

cmake_minimum_required(VERSION 3.10)

# TODO : Create a project named Tutorial and project version number 1.0

project(Tutorial VERSION 1.0)

# TODO : Replace the following code by:

# * Creating an interface library called tutorial_compiler_flags

#   Hint: use add_library() with the INTERFACE signature

# * Add compiler feature cxx_std_11 to tutorial_compiler_flags

#   Hint: Use target_compile_features()

# specify the C++ standard

# set(CMAKE_CXX_STANDARD 11)

# set(CMAKE_CXX_STANDARD_REQUIRED True)

add_library(tutorial_compiler_flags INTERFACE)
target_compile_features(tutorial_compiler_flags INTERFACE cxx_std_11)


# TODO : Create helper variables to determine which compiler we are using:

# * Create a new variable gcc_like_cxx that is true if we are using CXX and

#   any of the following compilers: ARMClang, AppleClang, Clang, GNU, LCC

# * Create a new variable msvc_cxx that is true if we are using CXX and MSVC

# Hint: Use set() and COMPILE_LANG_AND_ID

set(gcc_like_cxx "$<COMPILE_LANG_AND_ID:CXX,ARMClang,AppleClang,Clang,GNU,LCC>")
set(msvc_cxx "$<COMPILE_LANG_AND_ID:CXX,MSVC>")


# TODO : Add warning flag compile options to the interface library

# tutorial_compiler_flags.

# * For gcc_like_cxx, add flags -Wall;-Wextra;-Wshadow;-Wformat=2;-Wunused

# * For msvc_cxx, add flags -W3

# Hint: Use target_compile_options()

target_compile_options(tutorial_compiler_flags INTERFACE
            "$<${gcc_like_cxx}:-Wall;-Wextra;-Wshadow;-Wformat=2;-Wunused>"
            "$<${msvc_cxx}:-W3>"
            )

# TODO 7: With nested generator expressions, only use the flags for the

# build-tree

# Hint: Use BUILD_INTERFACE

target_compile_options(tutorial_compiler_flags INTERFACE
          "$<${gcc_like_cxx}:$<BUILD_INTERFACE:-Wall;-Wextra;-Wshadow;-Wformat=2;-Wunused>>"
           "$<${msvc_cxx}:$<BUILD_INTERFACE:-W3>>"
            )


# TODO : Create a variable MY_MATH using option and set default to ON

option(USE_MYMATH "Use tutorial provided math implementation" ON)


# TODO : Use configure_file to configure and copy TutorialConfig.h.in to

#         TutorialConfig.h

configure_file(TutorialConfig.h.in TutorialConfig.h)


# TODO : Use list() and APPEND to create a list of optional libraries

# called  EXTRA_LIBS and a list of optional include directories called

# EXTRA_INCLUDES. Add the MathFunctions library and source directory to

# the appropriate lists.

#

# Only call add_subdirectory and only add MathFunctions specific values

# to EXTRA_LIBS and EXTRA_INCLUDES if USE_MYMATH is true.

if(USE_MYMATH)
    add_subdirectory(MathFunctions)
    list(APPEND EXTRA_LIBS MathFunctions)
endif()



# TODO : Add an executable called Tutorial to the project

# Hint: Be sure to specify the source file as tutorial.cxx

add_executable(Tutorial tutorial.cxx)

# TODO : Use target_link_libraries to link the library to our executable

# Link to tutorial_compiler_flags

target_link_libraries(Tutorial PUBLIC ${EXTRA_LIBS} tutorial_compiler_flags)

# TODO : Use target_include_directories to include ${PROJECT_BINARY_DIR}

target_include_directories(Tutorial PUBLIC
                           ${PROJECT_BINARY_DIR}
                          )

# TODO : Install Tutorial in the bin directory

# Hint: Use the TARGETS and DESTINATION parameters

install(TARGETS Tutorial DESTINATION bin)

# TODO : Install Tutorial.h to the include directory

# Hint: Use the FILES and DESTINATION parameters

install(FILES "${PROJECT_BINARY_DIR}/TutorialConfig.h"
        DESTINATION include
        )

# TODO : Enable testing

# enable_testing()
include(CTest)

# TODO : Add a test called Runs which runs the following command:

# $ Tutorial 25

add_test(NAME Runs COMMAND Tutorial 4)

# TODO : Add a test called Usage which runs the following command:

# $ Tutorial

# Make sure the expected output is displayed.

# Hint: Use the PASS_REGULAR_EXPRESSION property with "Usage.*number"

add_test(NAME Usage COMMAND Tutorial)
set_tests_properties(Usage
                     PROPERTIES PASS_REGULAR_EXPRESSION "Usage:.*number"
                     )

# TODO : Add a test which runs the following command:

# $ Tutorial 4

# Make sure the result is correct.

# Hint: Use the PASS_REGULAR_EXPRESSION property with "4 is 2"

add_test(NAME StandardUse COMMAND Tutorial 4)
set_tests_properties(StandardUse
          PROPERTIES PASS_REGULAR_EXPRESSION "4 is 2"
          )

# TODO : Add more tests. Create a function called do_test to avoid copy +

# paste. Test the following values: 4, 9, 5, 7, 25, -25 and 0.00001.

function(do_test target arg result)
    add_test(NAME Comp${arg} COMMAND ${target} ${arg})
    set_tests_properties(Comp${arg}
                        PROPERTIES PASS_REGULAR_EXPRESSION ${result}
                        )
endfunction()

# do a bunch of result based tests

do_test(Tutorial 4 "4 is 2")
do_test(Tutorial 9 "9 is 3")
do_test(Tutorial 5 "5 is 2.236")
do_test(Tutorial 7 "7 is 2.645")
do_test(Tutorial 25 "25 is 5")
do_test(Tutorial -25 "-25 is (-nan|nan|0)")
do_test(Tutorial 0.0001 "0.0001 is 0.01")

ubuntu@ubuntu:$

CTestConfig.cmake file

ubuntu@ubuntu:$ ls -tlr
total 24
-rw-r--r-- 1 ubuntu ubuntu  904 Oct 12 22:26 tutorial.cxx
-rw-r--r-- 1 ubuntu ubuntu  188 Oct 12 22:26 TutorialConfig.h.in
-rw-r--r-- 1 ubuntu ubuntu  245 Oct 12 22:26 CTestConfig.cmake
drwxr-xr-x 2 ubuntu ubuntu 4096 Oct 19 15:19 MathFunctions
-rw-r--r-- 1 ubuntu ubuntu 2329 Oct 19 15:20 CMakeLists.txt
ubuntu@ubuntu:$ vim CTestConfig.cmake 
ubuntu@ubuntu:$ cat CTestConfig.cmake 
set(CTEST_PROJECT_NAME "CMakeTutorial")
set(CTEST_NIGHTLY_START_TIME "00:00:00 EST")

set(CTEST_DROP_METHOD "http")
set(CTEST_DROP_SITE "my.cdash.org")
set(CTEST_DROP_LOCATION "/submit.php?project=CMakeTutorial")
set(CTEST_DROP_SITE_CDASH TRUE)
ubuntu@ubuntu:$

MathFunctions directory

ubuntu@ubuntu:$ ls -tlr
total 24
-rw-r--r-- 1 ubuntu ubuntu  904 Oct 12 22:26 tutorial.cxx
-rw-r--r-- 1 ubuntu ubuntu  188 Oct 12 22:26 TutorialConfig.h.in
-rw-r--r-- 1 ubuntu ubuntu  245 Oct 12 22:26 CTestConfig.cmake
drwxr-xr-x 2 ubuntu ubuntu 4096 Oct 19 15:19 MathFunctions
-rw-r--r-- 1 ubuntu ubuntu 2329 Oct 19 15:20 CMakeLists.txt
ubuntu@ubuntu:$

MathFunctions Cxx file

ubuntu@ubuntu:$ vim mysqrt.cxx 
ubuntu@ubuntu:$ cat mysqrt.cxx 
#include <iostream>

// a hack square root calculation using simple operations
double mysqrt(double x)
{
  if (x <= 0) {
    return 0;
  }

  double result = x;

  // do ten iterations
  for (int i = 0; i < 10; ++i) {
    if (result <= 0) {
      result = 0.1;
    }
    double delta = x - (result * result);
    result = result + 0.5 * delta / result;
    std::cout << "Computing sqrt of " << x << " to be " << result << std::endl;
  }
  return result;
}
ubuntu@ubuntu:$

MathFunctions header file

ubuntu@ubuntu:$ vim MathFunctions.h 
ubuntu@ubuntu:$ cat MathFunctions.h 
#ifndef __MATHFUNCTION___H__H
#define __MATHFUNCTION___H__H

double mysqrt(double x);

#endif
ubuntu@ubuntu:$

MathFunctions CMake file

ubuntu@ubuntu:$ vim CMakeLists.txt 
ubuntu@ubuntu:$ cat CMakeLists.txt 

# TODO : Add a library called MathFunctions

# Hint: You will need the add_library command

add_library(MathFunctions mysqrt.cxx)

# TODO : State that anybody linking to MathFunctions needs to include the

# current source directory, while MathFunctions itself doesn't.

# Hint: Use target_include_directories with the INTERFACE keyword

target_include_directories(MathFunctions
                  INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}
                          )
                          

 # TODO : Link to tutorial_compiler_flags

target_link_libraries(MathFunctions tutorial_compiler_flags)

# TODO : Create a variable called installable_libs that is a list of all

# libraries we want to install (e.g. MathFunctions and tutorial_compiler_flags)

# Then install the installable libraries to the lib folder.

# Hint: Use the TARGETS and DESTINATION parameters

set(installable_libs MathFunctions tutorial_compiler_flags)
install(TARGETS ${installable_libs} DESTINATION lib)

# TODO : Install the library headers to the include folder.

# Hint: Use the FILES and DESTINATION parameters

install(FILES MathFunctions.h DESTINATION include)

构建cmake/ctest dashboard工程

ubuntu@ubuntu:$ cd exercise11_build/
ubuntu@ubuntu:$ cmake -DUSE_MYMATH=ON ..
-- The C compiler identification is GNU 7.5.0
-- The CXX compiler identification is GNU 7.5.0
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Configuring done
-- Generating done
-- Build files have been written to: /home/ubuntu/study/cmake-learning/cmake-3.25.0-rc1-tutorial-source/Step6/exercise11_build
ubuntu@ubuntu:$ cmake --build .
[ 25%] Building CXX object MathFunctions/CMakeFiles/MathFunctions.dir/mysqrt.cxx.o
[ 50%] Linking CXX static library libMathFunctions.a
[ 50%] Built target MathFunctions
[ 75%] Building CXX object CMakeFiles/Tutorial.dir/tutorial.cxx.o
[100%] Linking CXX executable Tutorial
[100%] Built target Tutorial
ubuntu@ubuntu:$ ctest  -D Experimental
   Site: ubuntu
   Build name: Linux-c++
Create new tag: 20221019-0851 - Experimental
Configure project
   Each . represents 1024 bytes of output
    . Size of output: 0K
Build project
   Each symbol represents 1024 bytes of output.
   '!' represents an error and '*' a warning.
    . Size of output: 0K
   0 Compiler errors
   0 Compiler warnings
Test project /home/ubuntu/study/cmake-learning/cmake-3.25.0-rc1-tutorial-source/Step6/exercise11_build
    Start 1: Runs
1/9 Test #1: Runs .............................   Passed    0.01 sec
    Start 2: Usage
2/9 Test #2: Usage ............................   Passed    0.00 sec
    Start 3: Comp4
3/9 Test #3: Comp4 ............................   Passed    0.00 sec
    Start 4: Comp9
4/9 Test #4: Comp9 ............................   Passed    0.00 sec
    Start 5: Comp5
5/9 Test #5: Comp5 ............................   Passed    0.00 sec
    Start 6: Comp7
6/9 Test #6: Comp7 ............................   Passed    0.00 sec
    Start 7: Comp25
7/9 Test #7: Comp25 ...........................   Passed    0.00 sec
    Start 8: Comp-25
8/9 Test #8: Comp-25 ..........................   Passed    0.00 sec
    Start 9: Comp0.0001
9/9 Test #9: Comp0.0001 .......................   Passed    0.00 sec

100% tests passed, 0 tests failed out of 9

Total Test time (real) =   0.04 sec
Performing coverage
 Cannot find any coverage files. Ignoring Coverage request.
Submit files
   SubmitURL: http://my.cdash.org/submit.php?project=CMakeTutorial
   Uploaded: /home/ubuntu/study/cmake-learning/cmake-3.25.0-rc1-tutorial-source/Step6/exercise11_build/Testing/20221019-0851/Configure.xml
   Uploaded: /home/ubuntu/study/cmake-learning/cmake-3.25.0-rc1-tutorial-source/Step6/exercise11_build/Testing/20221019-0851/Build.xml
   Uploaded: /home/ubuntu/study/cmake-learning/cmake-3.25.0-rc1-tutorial-source/Step6/exercise11_build/Testing/20221019-0851/Test.xml
   Uploaded: /home/ubuntu/study/cmake-learning/cmake-3.25.0-rc1-tutorial-source/Step6/exercise11_build/Testing/20221019-0851/Done.xml
   Submission successful
ubuntu@ubuntu:$ ls -trl
total 92
-rw-r--r--  1 ubuntu ubuntu   137 Oct 19 16:50 TutorialConfig.h
-rw-r--r--  1 ubuntu ubuntu  2686 Oct 19 16:50 DartConfiguration.tcl
-rw-rw-r--  1 ubuntu ubuntu 16635 Oct 19 16:50 CMakeCache.txt
-rw-rw-r--  1 ubuntu ubuntu  4770 Oct 19 16:50 CTestTestfile.cmake
-rw-rw-r--  1 ubuntu ubuntu  3064 Oct 19 16:50 cmake_install.cmake
-rwxrwxr-x  1 ubuntu ubuntu 15008 Oct 19 16:50 Tutorial
drwxrwxr-x  4 ubuntu ubuntu  4096 Oct 19 16:51 Testing
-rw-rw-r--  1 ubuntu ubuntu 22595 Oct 19 16:51 Makefile
drwxrwxr-x  3 ubuntu ubuntu  4096 Oct 19 16:51 MathFunctions
drwxrwxr-x 34 ubuntu ubuntu  4096 Oct 19 16:51 CMakeFiles
ubuntu@ubuntu:$ cd Testing/
ubuntu@ubuntu:$ ls -tlr
total 12
-rw-rw-r-- 1 ubuntu ubuntu   40 Oct 19 16:51 TAG
drwxrwxr-x 2 ubuntu ubuntu 4096 Oct 19 16:51 20221019-0851
drwxrwxr-x 2 ubuntu ubuntu 4096 Oct 19 16:51 Temporary
ubuntu@ubuntu:$ cd 20221019-0851/
ubuntu@ubuntu:$ ls -tlr
total 28
-rw-rw-r-- 1 ubuntu ubuntu  1294 Oct 19 16:51 Configure.xml
-rw-rw-r-- 1 ubuntu ubuntu  1045 Oct 19 16:51 Build.xml
-rw-rw-r-- 1 ubuntu ubuntu 13249 Oct 19 16:51 Test.xml
-rw-rw-r-- 1 ubuntu ubuntu   107 Oct 19 16:51 Done.xml
ubuntu@ubuntu:$

通浏览器访问Dashboard

访问网址为https://my.cdash.org/index.php?project=CMakeTutorial.

运行可执行文件

ubuntu@ubuntu:$ ls -tlr
total 92
-rw-r--r--  1 ubuntu ubuntu   137 Oct 19 16:50 TutorialConfig.h
-rw-r--r--  1 ubuntu ubuntu  2686 Oct 19 16:50 DartConfiguration.tcl
-rw-rw-r--  1 ubuntu ubuntu 16635 Oct 19 16:50 CMakeCache.txt
-rw-rw-r--  1 ubuntu ubuntu  4770 Oct 19 16:50 CTestTestfile.cmake
-rw-rw-r--  1 ubuntu ubuntu  3064 Oct 19 16:50 cmake_install.cmake
-rwxrwxr-x  1 ubuntu ubuntu 15008 Oct 19 16:50 Tutorial
drwxrwxr-x  4 ubuntu ubuntu  4096 Oct 19 16:51 Testing
-rw-rw-r--  1 ubuntu ubuntu 22595 Oct 19 16:51 Makefile
drwxrwxr-x  3 ubuntu ubuntu  4096 Oct 19 16:51 MathFunctions
drwxrwxr-x 34 ubuntu ubuntu  4096 Oct 19 16:51 CMakeFiles
ubuntu@ubuntu:$  ./Tutorial 4294967296
Computing sqrt of 4.29497e+09 to be 2.14748e+09
Computing sqrt of 4.29497e+09 to be 1.07374e+09
Computing sqrt of 4.29497e+09 to be 5.36871e+08
Computing sqrt of 4.29497e+09 to be 2.68435e+08
Computing sqrt of 4.29497e+09 to be 1.34218e+08
Computing sqrt of 4.29497e+09 to be 6.71089e+07
Computing sqrt of 4.29497e+09 to be 3.35545e+07
Computing sqrt of 4.29497e+09 to be 1.67773e+07
Computing sqrt of 4.29497e+09 to be 8.38878e+06
Computing sqrt of 4.29497e+09 to be 4.19465e+06
The square root of 4.29497e+09 is 4.19465e+06
ubuntu@ubuntu:$ ./Tutorial 10
Computing sqrt of 10 to be 5.5
Computing sqrt of 10 to be 3.65909
Computing sqrt of 10 to be 3.19601
Computing sqrt of 10 to be 3.16246
Computing sqrt of 10 to be 3.16228
Computing sqrt of 10 to be 3.16228
Computing sqrt of 10 to be 3.16228
Computing sqrt of 10 to be 3.16228
Computing sqrt of 10 to be 3.16228
Computing sqrt of 10 to be 3.16228
The square root of 10 is 3.16228
ubuntu@ubuntu:$ ./Tutorial 
./Tutorial Version 1.0
Usage: ./Tutorial number
ubuntu@ubuntu:$