如何为包含main()函数的C++文件添加GoogleTest测试框架？

问题背景 #

我是C测试领域的初学者，这是我的首个测试项目。我已编写一段C代码，需要使用GoogleTest添加测试用例，但原代码包含main()函数，还有输入读取、计算、输出打印的功能，不清楚怎么适配GoogleTest的测试流程。原代码如下：

#include<bits/stdlib.h>
using namespace std;

//fn definitions and declarations 

read_input(){
    //reads input from the user
}
calculate(){
    //processes the input and does calculations
}
print_output(){
    //prints the output
}
    
int main()
{
    read_input();
    calculate();
    print_putput();
  return 0;
}

解决方案 #

核心思路是分离可测试的业务逻辑，让函数独立于main()，同时针对输入输出函数做模拟测试，具体步骤如下：

1. 重构原代码，解耦测试逻辑

首先修正原代码的语法错误（比如#include拼写、print_putput笔误、函数缺少返回类型），并将可测试函数的声明抽到头文件，实现和main()分离：

• 创建头文件my_program.h，声明所有需要测试的函数：

#ifndef MY_PROGRAM_H
#define MY_PROGRAM_H

#include <iostream>
using namespace std;

// 建议：尽量避免全局变量，改为函数传参，这里先兼容原结构
extern int global_input;
extern int global_result;

void read_input();
int calculate();
void print_output(int result);

#endif

• 修改原cpp文件（命名为my_program.cpp），实现函数并保留main()：

#include "my_program.h"
#include <cstdlib> // 替换错误的bits/stdlib.h

int global_input;
int global_result;

void read_input() {
    cin >> global_input;
}

int calculate() {
    // 示例计算逻辑，根据你的实际需求替换
    return global_input * 2;
}

void print_output(int result) {
    cout << result << endl;
}

int main() {
    read_input();
    global_result = calculate();
    print_output(global_result);
    return 0;
}

2. 编写GoogleTest测试用例

创建测试文件my_program_test.cpp，针对每个函数编写测试：

#include <gtest/gtest.h>
#include "my_program.h"
#include <sstream>
#include <iostream>

// 测试核心计算逻辑（最容易测试的部分）
TEST(CalculateTest, BasicCalculations) {
    global_input = 5;
    EXPECT_EQ(calculate(), 10);

    global_input = 0;
    EXPECT_EQ(calculate(), 0);

    global_input = -3;
    EXPECT_EQ(calculate(), -6);
}

// 测试输入读取：重定向cin模拟用户输入
TEST(ReadInputTest, ReadsCorrectValue) {
    string mock_input = "7\n";
    istringstream input_stream(mock_input);
    // 替换cin的缓冲区为模拟输入
    cin.rdbuf(input_stream.rdbuf());

    read_input();
    EXPECT_EQ(global_input, 7);
}

// 测试输出打印：重定向cout捕获输出内容
TEST(PrintOutputTest, PrintsCorrectResult) {
    ostringstream output_stream;
    // 替换cout的缓冲区为捕获流
    cout.rdbuf(output_stream.rdbuf());

    print_output(15);
    EXPECT_EQ(output_stream.str(), "15\n");
}

// GoogleTest的入口函数，也可以使用gtest_main库的默认main
int main(int argc, char **argv) {
    testing::InitGoogleTest(&argc, argv);
    return RUN_ALL_TESTS();
}

3. 编译与运行测试

用g++编译时，需要链接GoogleTest库：

# 编译测试程序
g++ my_program.cpp my_program_test.cpp -o my_test -lgtest -lgtest_main -pthread

# 运行测试
./my_test

4. 优化建议（重要）

• 移除全局变量：全局变量会导致测试用例之间的状态污染，建议重构函数为传参形式，让逻辑更纯粹：

// 重构后的函数（无全局变量）
int read_input() {
    int num;
    cin >> num;
    return num;
}

int calculate(int input) {
    return input * 2;
}

void print_output(int result) {
    cout << result << endl;
}

// 对应的测试用例更简洁
TEST(CalculateTest, BasicCalculations) {
    EXPECT_EQ(calculate(5), 10);
    EXPECT_EQ(calculate(0), 0);
    EXPECT_EQ(calculate(-3), -6);
}

• 编译时隔离main()：如果不想让测试程序包含原main()，可以用预编译宏控制：
  在my_program.cpp中修改main()：

#ifndef TEST_BUILD
int main() {
    // 原main代码
}
#endif

编译测试时添加-DTEST_BUILD宏：

g++ -DTEST_BUILD my_program.cpp my_program_test.cpp -o my_test -lgtest -lgtest_main -pthread

内容的提问来源于stack exchange，提问作者Amritanshu SINGH