一些googletest宏的覆盖率分析显示分布在多行时的覆盖率不完整 - 为什么?

时间:2017-04-19 12:10:55

标签: c++ macros code-coverage googletest gcov

我正在使用gcov / lcov进行googletest单元测试的覆盖率分析。

一个反复出现的问题是,当宏分布在多行时,覆盖率报告会显示某些googletest宏的测试代码中未覆盖的行。

我知道gov / lcov不能比单行准确,但我对我看到的行为感到困惑。有人可以解释一下吗?最小的例子:

#include <gtest/gtest.h>

TEST(coverage,incomplete)
{
  // Every second line in every invocation here will show up as uncovered:
  EXPECT_NO_THROW(40 +
                  2);
  EXPECT_NO_THROW(40 + 2
                  );
  EXPECT_NO_THROW(40 + 2)
    ;
}

TEST(coverage,complete)
{
  // This test does not show uncovered lines
  EXPECT_NO_THROW(40 + 2);
  EXPECT_EQ(40
            +
            2
            , // even though this is spread over several lines
            42
            )
    ;
}

如何进行覆盖率分析:

g++-4.8 -Igtest/googletest/include/ --coverage -o coverage_macropp coverage_macropp.cpp gtest/googletest/make/gtest_main.a -pthread
./coverage_macropp
lcov --capture --directory . --output-file coverage.info
genhtml --demangle-cpp coverage.info --output-directory coverage

然后,网络浏览器中的覆盖率分析将显示第7,9和11行:

      Line data    Source code

   1             : #include <gtest/gtest.h>
   2             : 
   3           5 : TEST(coverage,incomplete)
   4             : {
   5             :   // Every second line in every invocation here will show up as uncovered:
   6           1 :   EXPECT_NO_THROW(40 +
   7           0 :                   2);
   8           1 :   EXPECT_NO_THROW(40 + 2
   9           0 :                   );
  10           1 :   EXPECT_NO_THROW(40 + 2)
  11           0 :     ;
  12           1 : }
  13             : 
  14           5 : TEST(coverage,complete)
  15             : {
  16             :   // This test does not show uncovered lines
  17           1 :   EXPECT_NO_THROW(40 + 2);
  18           1 :   EXPECT_EQ(40
  19             :             +
  20             :             2
  21             :             , // even though this is spread over several lines
  22             :             42
  23             :             )
  24           1 :     ;
  25           4 : }

为什么呢?为什么EXPECT_EQ宏不受影响?

1 个答案:

答案 0 :(得分:2)

这是一项引人入胜的调查。看看这些宏,我已经学习了关于switch / case和goto的事情,我不知道是不可能的。

但是行为差异的原因来自if / else构造,它们的共同点是从不执行else分支,但是在编译器已经知道的情况下,这些分支将永远不会被执行。

首先,将宏分布在源代码中的多行中,预处理器产生(对于这个问题而言重要)编译器及其覆盖分析器的以下代码:

if (condition) statement1; else statement2


  ;

显然,覆盖率分析器gcov用孤独的分号作为代码行计算行,并认为它是在执行else分支的statement2时执行的。

现在,要重现覆盖率分析差异,如问题所示,请考虑此示例程序:

#include <stdio.h>
#include <time.h>

int main(int, char*[]) {
  const bool true_1 = true;
  const bool true_2 = time(NULL) != 0;

  if (true_1) 42; else printf("hello\n")
                    ;
  if (true_2) 42; else printf("hello\n")
                    ;
  return 0;
}

true_1true_2总是正确的(在我的生命中,如果我不弄乱计算机的时钟),但在true_1的情况下,编译器知道它,而对于true_2,它无法知道。 (是的,我可能会为true_2找到一个更安全的初始化程序。现在这样做。)

另请注意,if-branches中的语句不执行任何操作,但else-branches中的语句会产生副作用。

此程序的gcov / lcov覆盖率分析如下所示:

      Line data    Source code

   1             : #include <stdio.h>
   2             : #include <time.h>
   3             : 
   4           1 : int main(int, char*[]) {
   5           1 :   const bool true_1 = true;
   6           1 :   const bool true_2 = time(NULL) != 0;
   7             :   
   8             :   if (true_1) 42; else printf("hello\n")
   9             :                     ;
  10           1 :   if (true_2) 42; else printf("hello\n")
  11           0 :                     ;
  12           1 :   return 0;
  13             : }

因为编译器已经知道true_1为真,所以不考虑else分支,因此第9行,不考虑覆盖率分析。使用-O0进行编译时甚至是这样。

然而,此程序中的第11行被考虑用于覆盖率分析,因为true_2仅在运行时已知。

作为旁注:如果我在else分支中也使用了另一个伪语句,或者甚至是已知没有副作用的函数调用,例如sin(7)而不是printf(“hello”),那么这条线也不会计入gcov覆盖率分析。

到目前为止看来,如果在编译时尚未知道测试结果,那么对于完整的正式报道,我必须将googletest宏限制为单个源代码行。