Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ENGINES1031 and version 2021.1

...

  • The <CPPTEST_INSTALL_DIR>/integration/cmake/cpptest-coverage.cmake extension – The C/C++test extension file for CMake you need to add to your CMakeFiles.txt build file.
  • The CPPTEST_COVERAGE=ON and CPPTEST_HOME=<CPPTEST_INSTALL_DIR> options – The options provided by the extension for activating the extension when building the application with CMake.
  • The cpptest_coverage_report target for Make – The target provided by the extension for enabling Make to generate generating the coverage report using the .clog file as an input.

...

  1. Copy <CPPTEST_INSTALL_DIR>/integration/cmake/cpptest-coverage.cmake to your CMake project.

  2. Review the coverage configuration details in the cpptest-coverage.cmake file and update the options if needed.  At a minimum, you must ensure that the compiler configuration specified with the CPPTEST_COMPILER_ID option matches your compiler. See Customizing the Coverage Extension for CMake for available options.

  3. Include the cpptest-coverage.cmake extension to your main CMakeLists.txt build file. The extension must precede all build target definitions to ensure that the compiler/linker command lines are automatically modified.

  4. Activate the extension with the CPPTEST_COVERAGE and CPPTEST_HOME options when configuring and building your CMake project:

    Code Block
    languagetext
    > cmake -DCPPTEST_COVERAGE=ON -DCPPTEST_HOME=<CPPTEST_INSTALL_DIR> ..

    By default, C/C++test's coverage data files will be created in <CMAKE_BINARY_DIR>/cpptest-coverage/<CMAKE_PROJECT_NAME>/.cpptest.

  5. Run your application or execute your functional or unit tests.
    By default, the C/C++test coverage log file (.clog) will be created in <CMAKE_BINARY_DIR>/cpptest-coverage/<CMAKE_PROJECT_NAME>/<CMAKE_PROJECT_NAME>.clog.

  6. Run Make with the cpptest_coverage_report helper target to generate the coverage report:

    Code Block
    languagetext
    > make cpptest_coverage_report

    The coverage report will be generated in the following location: <CMAKE_BINARY_DIR>/cpptest-coverage/<CMAKE_PROJECT_NAME>/reports.

    We recommend generating the coverage report using the Make cpptest_coverage_report target. Alternatively, you can use cpptestcli with the Coverage test configuration and the .clog file as an input:

    Code Block
    languagetext
    > cd <CMAKE_BINARY_DIR>/cpptest-coverage/<CMAKE_PROJECT_NAME>
    > cpptestcli -config "builtin://Coverage" -input <CMAKE_PROJECT_NAME>.clog

...

Option NameDescriptionDefault
CPPTEST_COMPILER_ID

Specifies the compiler configuration that matches your compiler.

gcc_9-64
 CPPTEST_COVERAGE_TYPE_FLAGS Specifies the coverage type. See Command Line Reference for cpptestcc for available options.-optimized-line-coverage
CPPTEST_COVERAGE_WORKSPACESpecifies the path to the workspace for the coverage tool where C/C++test's coverage data files are stored by default.<CMAKE_BINARY_DIR>/cpptest-coverage/<CMAKE_PROJECT_NAME>
CPPTEST_COVERAGE_LOG_FILE

Specifies the name and location of the C/C++test coverage log file (.clog).

Important: You must ensure the coverage log directory exists before running the instrumented application.

<CPPTEST_COVERAGE_WORKSPACE>/<CMAKE_PROJECT_NAME>.clog
CPPTEST_CPPTESTCC_OPTSSpecifies the options for the cpptestcc coverage tool.

...