gcov 覆盖范围仅限于最小 g++ 中的测试文件项目

Question

未能获得覆盖范围 with-cmake 我设置建立一个简约的项目，看看我是否能以这种方式获得报道。 它源自 using-gtest-without-cmake

它有一个 src 文件夹，其中包含头文件和源文件。 QuickMaths.hpp ：

#include <cstdint>

using size_t = std::size_t;

size_t
multiply(size_t a, size_t b);

inline size_t
add(size_t a, size_t b)
{
  return a + b;
}

class QuickMaths
{
public:
  size_t operator*() const;
  friend QuickMaths operator+(QuickMaths const&, QuickMaths const&);

  QuickMaths(size_t x);

private:
  size_t x;
};

QuickMaths.cpp：

#include "QuickMaths.hpp"

size_t
multiply(size_t a, size_t b)
{
  return a * b;
}

size_t
QuickMaths::operator*() const
{
  return x;
}

QuickMaths::QuickMaths(size_t x)
  : x(x)
{}

QuickMaths
operator+(QuickMaths const& a, QuickMaths const& b)
{
  return a.x + b.x;
}

以及一个测试文件夹 QuickMaths.cpp ：

#include <gtest/gtest.h>

#include <QuickMaths.hpp>

TEST(AddTest, shouldAdd)
{
  EXPECT_EQ(add(1UL, 1UL), 2UL);
}

TEST(MultiplyTest, shouldMultiply)
{
  EXPECT_EQ(multiply(2UL, 4UL), 8UL);
}

TEST(QuickMathTest, haveValue)
{
  auto v = QuickMaths{ 4UL };
  EXPECT_EQ(*v, 4UL);
}

和 main.cpp ：

#include <gtest/gtest.h>

int
main(int argc, char** argv)
{
  testing::InitGoogleTest(&argc, argv);

  return RUN_ALL_TESTS();
}

• 我创建一个 build 文件夹并 cd 进入其中，然后使用 g++ --coverage -O0 ../src/ 进行编译QuickMaths.cpp ../test/*.cpp -I../src/ -pthread -lgtest -lgtest_main -lgcov
• 我运行 ./a.out =>输出显示测试正在运行并通过

最后我运行 gcovr -r ../ . 并获得以下输出：

------------------------------------------------------------------------------
                           GCC Code Coverage Report
Directory: ../
------------------------------------------------------------------------------
File                                       Lines    Exec  Cover   Missing
------------------------------------------------------------------------------
src/QuickMaths.hpp                             2       0     0%   9,11
test/QuickMaths.cpp                            7       0     0%   5,7,10,12,15,17-18
test/main.cpp                                  3       3   100%   
------------------------------------------------------------------------------
TOTAL                                         12       3    25%
------------------------------------------------------------------------------

因此可以看出，位于 main 中的 gtest 设置正在被拾取，但测试用例本身并且 src 目录中的代码在执行时不会被拾取。

Answer 1

发生此错误的原因是您链接多个同名文件。

该问题有两个线索：

1. 运行测试时，您将看到如下警告：

   libgcov 分析错误：已编辑/a-QuickMaths.gcda：使用不同的时间戳覆盖现有的配置文件数据
   

2. 覆盖率报告列出了三个文件：

   • src/QuickMaths.hpp
   • 测试/QuickMaths.cpp
   • test/main.cpp

   但是有一个文件完全丢失：

   • src/QuickMaths.cpp

发生了什么？

• 当您的测试关闭时，原始覆盖率数据将由测试进程写入 .gcda 文件中。这些文件的名称取决于编译单元。

• 查看您的构建目录，我们会看到以下数据 (.gcda) 和注释 (.gcno) 文件：

  构建
  |-- a-QuickMaths.gcda
  |--a-QuickMaths.gcno
  |-- a-main.gcda
  |-- a-main.gcno
  `--a.out
  

• 您总共向编译命令提供了三个文件

  • 您的命令是g++ ... ../src/QuickMaths.cpp ../test/*.cpp ...。
  • 这三个文件是 src/QuickMaths.cpp、test/QuickMaths.cpp、test/main.cpp

• 自动生成的名称编译单元似乎只考虑输入文件的基本名称，而忽略目录。由于两个文件具有相同的基本名称，因此编译单元 a-QuickMaths 使用相同的名称。

• 由于编译单元存在名称冲突，因此覆盖率数据文件名也存在冲突。

• 结果是损坏的覆盖数据。

解决方案是单独编译每个编译单元，然后再链接它们。您必须为每个编译单元指定一个不同的名称，可能使用多个子目录。例如：

set -euo pipefail

# compile foo/bar.cpp -> build/foo/bar.o
for source in src/*.cpp test/*.cpp; do
  mkdir -p build/"$(dirname "$source")"
  cd build
  g++ --coverage -O0 -pthread -I../src -c -o "${source%.cpp}".o ../"${source}"
  cd -
done

# link the tests
cd build;
g++ --coverage -pthread -o testcase src/*.o test/*.o -lgtest
cd -

# run the test
cd build
./testcase
cd -

tree build  # show directory structure

# run gcovr
cd build
gcovr -r ..
cd -

在此示例中，构建目录将如下所示：

build
|-- src
|   |-- QuickMaths.gcda
|   |-- QuickMaths.gcno
|   `-- QuickMaths.o
|-- test
|   |-- QuickMaths.gcda
|   |-- QuickMaths.gcno
|   |-- QuickMaths.o
|   |-- main.gcda
|   |-- main.gcno
|   `-- main.o
`-- testcase

覆盖率报告符合预期：

------------------------------------------------------------------------------
                           GCC Code Coverage Report
Directory: ..
------------------------------------------------------------------------------
File                                       Lines    Exec  Cover   Missing
------------------------------------------------------------------------------
src/QuickMaths.cpp                             9       7    77%   20,22
src/QuickMaths.hpp                             2       2   100%   
test/QuickMaths.cpp                           10      10   100%   
test/main.cpp                                  3       3   100%   
------------------------------------------------------------------------------
TOTAL                                         24      22    91%
------------------------------------------------------------------------------

附加说明：

• 您提供 main() 但也链接 -lgtest_main< /代码>。这是不必要的。
• --coverage 标志已包含 -lgcov。