Google Test参数化测试：如何在测试输出中获取正确行号？

问题背景 #

在使用Google Test进行参数化测试时，测试失败后输出的行号指向INSTANTIATE_TEST_SUITE_P的结束括号位置，而非具体测试用例的声明行。测试代码如下：

#include <gtest/gtest.h>

#include <string>

class TracedName {
public:
    TracedName(std::string name, std::string filename, int line):
        m_name(std::move(name)), m_filename(std::move(filename)), m_lineNumber(line)
    {
    }
    
    std::string_view operator()() const { return m_name; }
    
    ::testing::ScopedTrace trace() const
    {
        return {m_filename.c_str(), m_lineNumber, m_name.c_str()};
    }
    
private:
    std::string m_name;
    std::string m_filename;
    int m_lineNumber;
};

#define TRACED_NAME(name) TracedName(name, __FILE__, __LINE__)

struct TestInput {
    std::string value;
};

struct TestCase {
    TracedName name;
    TestInput input;
    bool expected;
};

class ParameterizedTestSuite : public ::testing::TestWithParam<TestCase> {};

TEST_P(ParameterizedTestSuite, Test) {
    const auto& param = GetParam();
    const auto trace = param.name.trace(); // 尝试让追踪指向测试用例
    EXPECT_EQ(param.input.value == "valid", param.expected);
}

INSTANTIATE_TEST_SUITE_P(
    MyTests,
    ParameterizedTestSuite,
    ::testing::Values(
        TestCase{
            .name = TRACED_NAME("ValidInput"),
            .input = {.value = "valid"},
            .expected = true,
        },
        TestCase{
            .name = TRACED_NAME("InvalidInput"), // 希望错误信息指向此行
            .input = {.value = "invalid"},
            .expected = true,  // 此处会失败
        }
    )
);

当前表现 #

测试失败时，输出的行号指向INSTANTIATE_TEST_SUITE_P的结束位置，而非TRACED_NAME("InvalidInput")所在的行号。该问题仅在14.42.34433版本MSVC Build Tools下出现，GCC环境无此异常。

期望表现 #

测试失败时，错误信息能直接显示对应测试用例声明的行号，便于快速定位问题。

解决方案 #

问题根源是MSVC对宏展开的处理方式，导致__LINE__被捕获为INSTANTIATE_TEST_SUITE_P宏展开后的结束行号。可通过以下两种方式修正：

方式一：用宏包裹测试用例初始化，确保行号正确捕获 #

修改测试用例结构和初始化方式，直接在宏中捕获当前行号，避免嵌套宏的上下文丢失：

#include <gtest/gtest.h>
#include <string>

struct TestInput {
    std::string value;
};

struct TestCase {
    std::string name;
    const char* filename;
    int line;
    TestInput input;
    bool expected;
};

// 用宏包裹测试用例初始化，确保__LINE__捕获当前行号
#define DEFINE_TEST_CASE(name_str, input_val, expected_val) \
    TestCase{name_str, __FILE__, __LINE__, {input_val}, expected_val}

class ParameterizedTestSuite : public ::testing::TestWithParam<TestCase> {};

TEST_P(ParameterizedTestSuite, Test) {
    const auto& param = GetParam();
    // 使用SCOPED_TRACE将测试用例的行号注入错误信息
    SCOPED_TRACE(::testing::Message() << param.filename << ":" << param.line << ": " << param.name);
    EXPECT_EQ(param.input.value == "valid", param.expected);
}

INSTANTIATE_TEST_SUITE_P(
    MyTests,
    ParameterizedTestSuite,
    ::testing::Values(
        DEFINE_TEST_CASE("ValidInput", "valid", true),
        DEFINE_TEST_CASE("InvalidInput", "invalid", true) // 此处__LINE__会正确捕获当前行号
    )
);

方式二：调整ScopedTrace的使用时机 #

保留原有的TracedName类，修改TEST_P中的ScopedTrace使用方式，确保其作用域覆盖断言逻辑，同时开放TracedName的文件和行号访问：

// 修改TracedName类，开放文件和行号的访问
class TracedName {
public:
    TracedName(std::string name, std::string filename, int line):
        m_name(std::move(name)), m_filename(std::move(filename)), m_lineNumber(line)
    {
    }
    
    std::string_view name() const { return m_name; }
    const std::string& filename() const { return m_filename; }
    int line() const { return m_lineNumber; }
    
private:
    std::string m_name;
    std::string m_filename;
    int m_lineNumber;
};

#define TRACED_NAME(name) TracedName(name, __FILE__, __LINE__)

// TEST_P中直接构造ScopedTrace，确保作用域覆盖断言
TEST_P(ParameterizedTestSuite, Test) {
    const auto& param = GetParam();
    const ::testing::ScopedTrace trace(
        param.name.filename().c_str(),
        param.name.line(),
        param.name.name().data()
    );
    EXPECT_EQ(param.input.value == "valid", param.expected);
}

这两种方式都能让MSVC正确捕获测试用例声明的行号，失败时错误信息会显示对应行号，实现快速定位。

内容的提问来源于stack exchange，提问作者Sergey Kolesnik