GoogleTest 开源项目入门指南

GoogleTest 开源项目入门指南

googletest项目地址:https://gitcode.com/gh_mirrors/goo/googletest

目录结构及介绍

在 GoogleTest 的根目录下，你会找到以下主要的子目录：

• include: 包含了所有的头文件，这里是核心库部分。

  • gtest: 主要测试框架的头文件。
  • gtest_prod: 生产环境使用的测试宏定义。
  • gmock: 虚拟对象（Mock Objects）相关的头文件。

• googlemock: 这是 Google Mock 框架的代码所在位置，用来构建 mock 对象用于单元测试。

• googletest: 这是 Google Test 框架的核心代码所在位置。

• scripts: 常见脚本工具，如自动化构建工具等。

• tests: 单元测试代码位于此目录下。

• cmake: 包含了 CMake 配置文件以及用于构建系统的 CMakeLists.txt 文件。

此外，你还会发现一些重要的文件：

• .gitignore: 定义哪些文件或目录应该被 Git 忽略。
• LICENSE: 许可证信息。
• README.md: 项目简介、功能描述、如何使用等信息。
• CONTRIBUTING.md: 如何贡献代码到该项目。

启动文件介绍

对于大多数用户而言，启动文件主要是通过集成开发环境 (IDE)，或者编译命令来调用的测试二进制文件。但在 GoogleTest 内部，通常以以下方式组织：

• main.cpp 或类似名称的文件：这是测试程序的主要入口点，在这里进行测试初始化，并调用 RUN_ALL_TESTS() 函数运行所有注册的测试。

示例中的主函数结构如下所示：

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

在这个主函数中，

• ::testing::InitGoogleTest(&argc, argv); 被用来解析命令行参数并设置 GoogleTest 的标志。
• RUN_ALL_TESTS(); 则负责执行所有的测试案例。

如果不想每次编写测试时都重写 main() 函数，可以将你的测试工程链接到 gtest_main 库，这样就不必每次都写 main() 函数。

配置文件介绍

GoogleTest 使用不同类型的配置文件取决于其构建系统。以下是两种常见的构建配置形式：

CMake

当你使用 CMake 构建系统时，CMakeLists.txt 是主要的配置文件。在此文件内，你需要添加以下内容来链接 GoogleTest：

find_package(GTest REQUIRED)
include_directories(${GTEST_INCLUDE_DIRS})
add_executable(your_test_file_name ${SOURCE_FILES})
target_link_libraries(your_test_file_name ${GTEST_BOTH_LIBRARIES})

以上片段假设你已经在项目中找到了 GoogleTest 并将其标记为必需项 (REQUIRED)。

然后，指定要包括的目录，声明测试目标，并最终链接相应的 GoogleTest 库。

Bazel

如果你选择使用 Bazel 构建工具，那么配置文件将是 BUILD 文件，其中包含关于如何构建项目的规则。一个简单的 BUILD 文件可能会包含如下内容：

cc_test(
   name = "your_test",
   srcs = glob(["src/*.cc"]),
   deps = [
       "//third_party/googletest/gtest",
       "//path/to/your/test/files"
   ],
)

上面的配置指定了测试规则 (cc_test) 和所需的源码文件。deps 属性列出了依赖的库，这里包括 GoogleTest 的路径以及你的测试文件路径。

总之，无论采用哪种构建工具，重要的是确保正确地配置了 GoogleTest，使其能够被测试程序顺利链接和运行。

googletest项目地址:https://gitcode.com/gh_mirrors/goo/googletest