如何设计可维护的C++单元测试？

编写可维护的 c++++ 单元测试的关键实践包括：编写原子测试，一次只测试一个操作。对输入数据进行参数化，以减少重复编写代码。使用模拟对象替代外部依赖项。避免重复设置和拆除代码，使用 test_f 宏。编写干净的断言，使用清晰和简洁的消息。

如何设计可维护的 C++ 单元测试

当涉及到编写可维护的 C++ 单元测试时，遵循一些最佳实践至关重要。本文将介绍一些技巧和技术，以帮助您设计和编写易于维护的单元测试。

编写原子测试

单元测试应保持原子性，这意味着它们应测试一次操作或功能。避免编写测试多个操作或检查输出的同时进行多个断言的测试。这使得识别和调试失败变得更加容易。

TEST(MyClass, AddNumbers) {
  MyClass obj;
  ASSERT_EQ(obj.Add(1, 2), 3);
}

对输入数据进行参数化

对于需要执行多次相同操作但需要不同输入参数的测试，请考虑使用参数化测试。这有助于保持测试代码整洁并节省重复编写代码的时间。使用 GTest，可以使用 TEST_P(TestCaseName, TestName) 宏和 INSTANTIATE_TEST_SUITE_P 宏进行参数化。

立即学习“C++免费学习笔记（深入）”；

一览AI绘图

一览AI绘图是一览科技推出的AIGC作图工具，用AI灵感助力，轻松创作高品质图片

下载

class MyClassTest : public ::testing::TestWithParam> {};

INSTANTIATE_TEST_SUITE_P(Addition, MyClassTest,
                          ::testing::Values(std::make_tuple(1, 2, 3),
                                            std::make_tuple(3, 4, 7)));

TEST_P(MyClassTest, AddNumbers) {
  auto input = GetParam();
  ASSERT_EQ(MyClass().Add(std::get<0>(input), std::get<1>(input)),
            std::get<2>(input));
}

使用模拟对象

模拟对象允许您替代被测代码中的外部依赖项。这使您可以测试代码的特定部分，而无需依赖外部系统或库。使用 GMock，您可以轻松创建模拟对象并控制它们的函数调用。

class FileReaderMock : public FileReader {
 public:
  MOCK_METHOD(std::string, ReadFile, (const std::string& filename),
               (const, override));
};

TEST(MyClass, ProcessFile) {
  FileReaderMock file_reader_mock;
  ON_CALL(file_reader_mock, ReadFile("input.txt"))
      .WillByDefault(Return("Hello, world!"));
  MyClass obj(&file_reader_mock);
  ASSERT_EQ(obj.ProcessFile("input.txt"), "Hello, world!");
}

避免重复设置和拆除

单元测试设置和拆除代码可能会复杂且容易出错。通过使用 TEST_F 宏将测试函数与固定的安装程序和拆除程序分组，您可以消除此问题。

class MyClassTest : public ::testing::Test {
 protected:
  void SetUp() override { fixture_ = new MyFixture(); }
  void TearDown() override { delete fixture_; }
  MyFixture* fixture_;
};

TEST_F(MyClassTest, Test1) {
  // 使用 fixture_ 进行测试。
}

TEST_F(MyClassTest, Test2) {
  // 使用 fixture_ 进行测试。
}

编写干净的断言

断言是单元测试的关键部分。使用清晰简洁的消息编写断言，以帮助您快速识别和调试失败。使用 GTest，您可以使用 EXPECT_EQ、ASSERT_TRUE 等宏编写断言。

TEST(MyClass, AddNumbers) {
  MyClass obj;
  ASSERT_EQ(obj.Add(1, 2), 3, "Expected 3 but got something else");
}

实战案例

以下示例展示了如何设计和编写一个可维护的 C++ 单元测试：

#include 

class MyClass {
 public:
  int Add(int a, int b) { return a + b; }
};

TEST(MyClass, AddNumbers) {
  MyClass obj;
  ASSERT_EQ(obj.Add(1, 2), 3, "Expected 3 but got something else");
}

TEST_P(MyClassParamTest, AddNumbers) {
  auto input = GetParam();
  ASSERT_EQ(MyClass().Add(input.first, input.second), input.third,
            "Incorrect addition");
}
INSTANTIATE_TEST_SUITE_P(Addition, MyClassParamTest,
                          ::testing::Values(std::make_tuple(1, 2, 3),
                                            std::make_tuple(3, 4, 7)));

TEST_F(MyClassFixture, AddNumbersWithMock) {
  FileReaderMock file_reader_mock;
  ON_CALL(file_reader_mock, ReadFile("input.txt"))
      .WillByDefault(Return("Hello, world!"));
  MyClass obj(&file_reader_mock);
  ASSERT_EQ(obj.ProcessFile("input.txt"), "Hello, world!",
            "Incorrect output from ProcessFile");
}