Book Image

CMake Best Practices

By : Dominik Berner, Mustafa Kemal Gilor
5 (2)
Book Image

CMake Best Practices

5 (2)
By: Dominik Berner, Mustafa Kemal Gilor

Overview of this book

CMake is a powerful tool used to perform a wide variety of tasks, so finding a good starting point for learning CMake is difficult. This book cuts to the core and covers the most common tasks that can be accomplished with CMake without taking an academic approach. While the CMake documentation is comprehensive, it is often hard to find good examples of how things fit together, especially since there are lots of dirty hacks and obsolete solutions available on the internet. This book focuses on helping you to tie things together and create clean and maintainable projects with CMake. You'll not only get to grips with the basics but also work through real-world examples of structuring large and complex maintainable projects and creating builds that run in any programming environment. You'll understand the steps to integrate and automate various tools for improving the overall software quality, such as testing frameworks, fuzzers, and automatic generation of documentation. And since writing code is only half of the work, the book also guides you in creating installers and packaging and distributing your software. All this is tailored to modern development workflows that make heavy use of CI/CD infrastructure. By the end of this CMake book, you'll be able to set up and maintain complex software projects using CMake in the best way possible.
Table of Contents (22 chapters)
Part 1: The Basics
Part 2: Practical CMake – Getting Your Hands Dirty with CMake
Part 3: Mastering the Details

Generating code coverage reports

Being aware of how much of your code is covered by tests is a great benefit and often gives a very good impression about how well-tested a given software is. It can also give hints to developers about the execution paths and edge cases that are not covered by tests.

There are a few tools that help you get code coverage in C++. Arguably, the most popular is Gcov from GNU. It's been around for years and works well with GCC and Clang. Although it does not work with Microsoft's Visual Studio, using Clang to build and run the software provides a viable alternative for Windows. Alternatively, the tool OpenCppCoverage can be used to get coverage data on Windows to build with MSVC.

The coverage information generated by Gcov can be collected in summarized reports with the Gcovr or LCOV tools.

Generating coverage reports using Clang or GCC

In this section, we will look at how to create such reports with Gcovr. Generating code coverage...