svnscha - development

C++: How to measure code coverage with lcov and GTest

2025-03-25T00:00:00+00:00

Why, You Ask?

Because you want to know which parts of your C++ code are actually being tested – not just assumed to be. Code coverage isn't about perfection, but about confidence. And with the right setup, you can easily visualize what's being tested and what's quietly collecting dust.

In this guide, we'll walk through:

Setting up lcov and GTest
Writing effective coverage-focused tests
Running the tests and generating reports
Interpreting results and achieving real insight
Automating it all via GitHub Actions

📦 Try It Yourself

Check out the working example repository here:

👉 github.com/svnscha/cpp-coverage-example

It contains:

A minimal MyQueue class
Unit tests using GTest
Full lcov and genhtml integration
A GitHub Actions workflow for automated code coverage with a threshold

1. Install Required Tools

Make sure your environment has:

lcov
A C++ compiler (GCC or Clang)
cmake, ninja
GTest (or install libgtest-dev on Ubuntu)

2. Build with Coverage Instrumentation

To generate coverage data, compile your code with:

--coverage: Coverage instrumentation
-g: Debug information
-O0: No optimization (to avoid inlining, etc.)

🛠 Minimal CMake Snippet

option(ENABLE_COVERAGE "Enable code coverage reporting" OFF)

function(enable_coverage target)
    if(ENABLE_COVERAGE AND CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
        target_compile_options(${target} PRIVATE --coverage -O0 -g)
        target_link_options(${target} PRIVATE --coverage)
    endif()
endfunction()

enable_testing()

add_library(MyLibrary ...)
add_executable(MyTests ...)
target_link_libraries(MyTests PRIVATE MyLibrary GTest::gtest_main)

include(GTest)
gtest_discover_tests(MyTests)

enable_coverage(MyLibrary)
enable_coverage(MyTests)

3. Write Tests That Actually Trigger All Code Paths

Here’s a small utility class as an example:

class MyQueue
{
public:
    void Push(int val)
    { 
        _q.push(val); 
    }

    void Pop() 
    {
        if (_q.empty())
            return;
        _q.pop();
    }

    bool IsEmpty() const { return _q.empty(); }

private:
    std::queue<int> _q;
};

Now test both normal and edge cases:

TEST(MyQueueTest, PopWhenEmpty) {
    MyQueue q;
    q.Pop(); // Hit the early return
    EXPECT_TRUE(q.IsEmpty());
}

TEST(MyQueueTest, PushAndPop) {
    MyQueue q;
    q.Push(42);
    EXPECT_FALSE(q.IsEmpty());
    q.Pop();
    EXPECT_TRUE(q.IsEmpty());
}

4. Run Tests and Generate Coverage Report

cmake -B build -DENABLE_COVERAGE=ON -DCMAKE_BUILD_TYPE=Debug
cmake --build build
cd build
ctest --output-on-failure

Then generate the coverage report:

lcov --directory . --capture --output-file coverage.info --rc geninfo_auto_base=1 --ignore-errors mismatch
lcov --remove coverage.info '/usr/*' '*/tests/*' --output-file coverage.filtered.info
genhtml coverage.filtered.info --output-directory coverage-report

Open this in your browser:

build/coverage-report/index.html

Your browser does not support the video tag.

5. Automation

Now, having the coverage report in place is a great start. But it's not enough to just have the coverage report. You need to automate it so that every time you run your tests, you get a detailed report of what was covered and what wasn't.

To get started, you can setup a GitHub workflow with threshold tests, upload the reports or do post-processing on the report.

Either way, the key is to have a way to run tests and generate reports. Here's an example workflow:

Summary

Step	What You Did
1. Install	Set up `lcov`, gtest, gcc, and cmake
2. Build	Compiled with --coverage and no optimizations
3. Test	Hit both happy paths and edge cases
4. Report	Generated detailed HTML coverage report

Conclusion

Code coverage doesn't guarantee perfect tests, but it gives you visibility. When paired with thoughtful test cases (especially edge cases), it helps ensure your code behaves correctly - even when things go sideways.

Even small utility classes deserve this level of care.

And with lcov, you can turn "I think I tested this" into "Yes, this line has been executed 12 times during CI."

Simplify Visual Studio Installation

2024-02-12T00:00:00+00:00

Why, You Ask?

Every year, like clockwork, I find myself setting up my local dev environment from scratch. And every time, it's the same old song and dance: downloading, installing, configuring.

It's time-consuming and frustrating. I'm tired of it.

Can It Be Easier?

What if setting up a new machine, rolling it back, or tweaking it could be as simple as running a build on a server? What if I told you we could apply the same principles of automation to our local setups?

Let's Find A Solution

Creating a new development environment shouldn't be a chore. It should be quick, painless, and even a little bit fun. To turn this dream into reality, I need two things: the right software and the perfect setup. That's where winget and .vsconfig come in.

With a list of essential software and some PowerShell tricks, I began to make boring tasks automatic. I picked each program, from 7Zip to Visual Studio, for its important use. But the adventure of automating everything is a story for another time.

Streamlining Visual Studio Installation

My main event? Automating Visual Studio installation. Using winget, I can install Visual Studio with just a line:

winget install -e --id Microsoft.VisualStudio.2022.Enterprise --silent

But I didn't stop there. With the --override flag, I tailored the installation to include specific workloads, like this:

winget install -e --id Microsoft.VisualStudio.2022.Enterprise --silent --override "--wait --quiet --addProductLang En-us --config C:\vs2022.vsconfig"

This method sets up Visual Studio with the workload I need without having to manually select each package.

What's `.vsconfig`?

.vsconfig helps me easily replicate my development environment wherever I am. It's a JSON file that, with just a few clicks in the Visual Studio Installer, allows me to compress my environment workloads into a neat package. This approach is not only perfect for keeping build servers and personal development environments in sync with identical workloads, but it also simplifies sharing updates and changes with teammates.

Example: vs2022.vsconfig

{
  "version": "1.0",
  "components": [
    "Microsoft.VisualStudio.Component.Roslyn.Compiler",
    "Microsoft.Component.MSBuild",
    "Microsoft.VisualStudio.Component.Roslyn.LanguageServices",
    "Microsoft.VisualStudio.Component.SQL.LocalDB.Runtime",
    "Microsoft.VisualStudio.Component.CoreEditor",
    "Microsoft.VisualStudio.Workload.CoreEditor",
    "Microsoft.VisualStudio.Component.TypeScript.TSServer",
    "Microsoft.VisualStudio.ComponentGroup.WebToolsExtensions",
    "Microsoft.VisualStudio.Component.JavaScript.TypeScript",
    "Microsoft.VisualStudio.Component.TextTemplating",
    "Microsoft.VisualStudio.Component.NuGet",
    "Microsoft.VisualStudio.Component.IntelliTrace.FrontEnd",
    "Microsoft.VisualStudio.Component.Debugger.JustInTime",
    "Component.Microsoft.VisualStudio.LiveShare.2022",
    "Microsoft.VisualStudio.Component.IntelliCode",
    "Microsoft.VisualStudio.Component.ClassDesigner",
    "Microsoft.VisualStudio.Component.GraphDocument",
    "Microsoft.VisualStudio.Component.CodeMap",
    "Microsoft.VisualStudio.Component.VC.CoreIde",
    "Microsoft.VisualStudio.Component.VC.Tools.x86.x64",
    "Microsoft.VisualStudio.Component.Graphics.Tools",
    "Microsoft.VisualStudio.Component.VC.DiagnosticTools",
    "Microsoft.VisualStudio.Component.Windows11SDK.22621",
    "Microsoft.VisualStudio.Component.VC.ATL",
    "Microsoft.VisualStudio.Component.SecurityIssueAnalysis",
    "Microsoft.VisualStudio.ComponentGroup.ArchitectureTools.Native",
    "Microsoft.VisualStudio.Component.VC.Redist.14.Latest",
    "Microsoft.VisualStudio.ComponentGroup.NativeDesktop.Core",
    "Microsoft.VisualStudio.Component.Windows11Sdk.WindowsPerformanceToolkit",
    "Microsoft.VisualStudio.Component.CppBuildInsights",
    "Microsoft.VisualStudio.ComponentGroup.WebToolsExtensions.CMake",
    "Microsoft.VisualStudio.Component.VC.CMake.Project",
    "Microsoft.VisualStudio.Component.VC.TestAdapterForBoostTest",
    "Microsoft.VisualStudio.Component.VC.TestAdapterForGoogleTest",
    "Microsoft.VisualStudio.Component.VC.ASAN",
    "Microsoft.VisualStudio.Component.Vcpkg",
    "Microsoft.VisualStudio.Component.VC.Tools.ARM64EC",
    "Microsoft.VisualStudio.Workload.NativeDesktop",
    "Microsoft.VisualStudio.Component.VC.Runtimes.ARM64EC.Spectre"
  ]
}

You can create a .vsconfig file with these easy steps:

Launch the Visual Studio Installer and choose to modify your setup.
Hit More and then select the option to Export your settings into a .vsconfig file.

That's it!

Why Bother With All This?

I'm all about making life easier, not harder. Thanks to winget and Visual Studio's .vsconfig, what used to eat up a lot of time now takes no time at all.

Setting up a fresh development environment is now a piece of cake - and I mean the kind of delicious cake you can buy ready-made but tastes as good as anything you'd bake yourself. So here's to spending less time on setup and more on the fun stuff: coding.

svnscha - development

C++: How to measure code coverage with lcov and GTest

Why, You Ask?

📦 Try It Yourself

1. Install Required Tools

2. Build with Coverage Instrumentation

🛠 Minimal CMake Snippet

3. Write Tests That Actually Trigger All Code Paths

4. Run Tests and Generate Coverage Report

5. Automation

Summary

Conclusion

Simplify Visual Studio Installation

Why, You Ask?

Can It Be Easier?

Let's Find A Solution

Streamlining Visual Studio Installation

What's .vsconfig?

Why Bother With All This?

What's `.vsconfig`?