谷歌测试中跨多个文件的单独测试用例

Question

我是谷歌测试 C++ 框架的新手。它很容易使用，但我想知道如何将案例分成多个测试文件。最好的方法是什么？

直接包含 .cpp 文件是一个选项。使用标头似乎没有任何作用...

欢迎任何帮助

Answer 1

创建一个仅包含运行测试的主文件的文件。

// AllTests.cpp
#include "gtest/gtest.h"

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

然后将测试放入其他文件中。您可以在一个文件中放置任意数量的测试。为每个类或每个源文件创建一个文件可以很好地工作。

// SubtractTest.cpp
#include "subtract.h"
#include "gtest/gtest.h"

TEST(SubtractTest, SubtractTwoNumbers)
{
    EXPECT_EQ(5, subtract(6, 1));
}

这确实要求所有测试可以共享同一个 main。如果你必须在那里做一些特殊的事情，你将必须有多个构建目标。

Answer 2

不寻找学分或积分。我是 stackoverflow 的新手，没有资格添加评论。 @jkoendev 的答案尽管在技术上是正确的，但却做出了错误的陈述“我认为另一个答案中的主要缺失点是你需要 #include 测试文件。”不正确，您只需将所有 CPP 文件链接在一起即可。

例如，在 CMAKE 中，

add_executable(${PROJECT_NAME} 
    ${sources}
    ${headers})

带有

file(GLOB_RECURSE sources
    ${CMAKE_CURRENT_SOURCE_DIR}/*.cpp)

所有 cpp 文件的链接。
您不需要在主文件中包含任何测试文件。

Answer 3

我认为另一个答案中的主要缺失点是您需要 #include 测试文件。

这是我分割测试的方法：

1. 将测试放在 .h 文件中，可能带有标头保护，但如果您小心的话，则不需要。
2. 有一个如下定义的主程序，其中包括测试标头
3. 一个编译+链接主测试程序的 Makefile。

不要在所有文件中使用相同的名称两次进行测试！

// main_test.cc
#include <gtest/gtest.h>

#include "test_a.h"
#include "test_b.h"
#include "test_c.h"

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

使用 googletest 中的 Makefile 并添加规则：

#  compiles main test program
main_test.o : main_test.cc test_a.h test_b.h test_c.h $(GTEST_HEADERS)
    $(CXX) $(CPPFLAGS) $(CXXFLAGS) -c 
lt; -o $@
# links test program
main_test : main_test.o
    $(CXX) $(LDFLAGS) -L$(GTEST_LIB_DIR) $^ -lgtest_main -lpthread -o $@

我使用命名约定按字母顺序对测试进行排序：

// test_a.h
#include "some_class.h"

TEST(SomeClass, aName)
{
  library::SomeClass a("v", {5,4});
  EXPECT_EQ(a.name(), "v");
}

TEST(SomeClass, bSize)
{
  library::SomeClass a("v", {5,4});
  EXPECT_EQ(a.size(0), 5);
  EXPECT_EQ(a.size(1), 4);
}

然后您可以使用以下命令运行单独的测试

./main_test --gtest_filter=SomeClass.a*

Answer 4

我最近遇到了同样的问题。

我将 test_cases.o 和 main.o 归档到静态库 (test_main.a) 中，然后将它们与其他库链接到最终的可执行文件。

我注意到，如果我链接 test_main.a，它就找不到测试用例。

g++ -o test test_main.a -lgtest -lpthread -lXXX

但是，如果我单独链接对象，它就可以工作！

g++ -o test test_cases.o main.o -lgtest -lpthread -lXXX

我在这篇文章中找到了答案 为什么要创建.a来自 .o 的文件用于静态链接？

最后的链接步骤有一个重要的区别。您链接的任何目标文件都将包含在最终程序中。仅当库中的对象文件有助于解析其他对象文件中的任何未定义符号时，才会包含它们。如果不这样做，它们将不会链接到最终的可执行文件中。

我怀疑这与Google Test的设计有关。

RUN_ALL_TESTS() 宏动态运行测试类的所有实例，这意味着它在运行时期间获取测试用例。

因此，不需要链接测试类的实例，因此链接器不会链接 test_case.o。

Answer 5

要添加到 @jkoendev，您可以通过生成包含所有单元测试文件的单个文件来一次性包含所有头文件。如果您将单元测试文件隔离在 test_cases 目录下，则可以执行以下操作：

// CMakeLists.txt
file(GLOB_RECURSE headers
    ${CMAKE_CURRENT_SOURCE_DIR}/test_cases/*.h)

set(testcases testcases.hpp)
file(TOUCH ${testcases})
file(WRITE ${testcases} "")
foreach(file IN LISTS headers)
    file(APPEND ${testcases} "#include \"${file}\"\n")
endforeach()

然后只需将生成的文件包含在 main_test.cc 中

// main_test.cc
#include <gtest/gtest.h>

#include "testcases.hpp"
...

这当然会运行以下责任：保持 test_cases 干净并且没有冲突的文件，同时处理可能导致调试困难的自动生成的文件。

Answer 6

假设您有一个名为 MyProject 的项目。进一步假设在此项目中，您有两个要测试的不同文件 A.cpp 和 B.cpp（及其相应的标头 A.hpp 和 B.hpp）。

为了保持简洁，需要有两个单独的文件 A.cc 来测试 A.cpp 和 B.cc 来测试 B.cpp。

您需要设置 CMakeLists.txt（如下所示）才能将所有这些编译为单个测试可执行文件。然后，Google 测试将从该单个可执行文件中发现测试。

下面 CMakeLists.txt 代码片段中的注释将解释这一切是如何完成的：

#Create variables that reference all the files relevant to A
set(A_SOURCES A.cpp ATest.cc)
set(A_HEADERS A.hpp)

#Create variables that reference all the files relevant to B    
set(B_SOURCES B.cpp BTest.cc)
set(B_HEADERS B.hpp)

#Create the the single test executable MyProjectTests that will use
# all the files referenced from the variables above
add_executable(
  MyProjectTests ${A_SOURCES} ${A_HEADERS} ${B_SOURCES} ${B_HEADERS}
)

#Link google test libraries into that executable MyProjectTests
target_link_libraries(
  MyProjectTests
  GTest::gtest_main
)

include(GoogleTest)
#Tell gtest to look for tests in the MyProjectTests executable
gtest_discover_tests(MyProjectTests)

Answer 7

如果您使用的方法很简单：

1. 使用测试文件创建可执行文件
2. 链接 GoogleTest 和其他库等。
3. 包括任何目录
4. 在 CMakeLists.txt 中使用 gtest_discover_tests(//NameOfExecutable) 发现测试
5. 现在执行以下操作有了所有测试文件，你就完成了！在构建文件中运行 ctest，所有测试都应该运行。