C++ on Mark 的滿紙方糖言

Envoy 的 Integration Test(组件整合测试)

labile.zhu@gmail.com (Mark Zhu) — Sat, 10 Aug 2024 03:12:15 +0800

Envoy 成功原因之一是有严格的项目质量流程控制。如要实现一个新特性或扩展，必须编写组件整合测试用例。本文以 transport_sockets.tcp_stats 扩展的测试实现为例，说明 Envoy 的 integration test 架构。

Integration test 设计

用 Draw.io 打开

Envoy 的单元测试套路

labile.zhu@gmail.com (Mark Zhu) — Wed, 07 Aug 2024 03:12:15 +0800

Envoy 的单元测试套路

以下假设已经读过：

Testing Envoy with Bazel

GoogleTest Primer

被测试对象

/source/extensions/transport_sockets/tcp_stats/tcp_stats.h

class TcpStatsSocket : public TransportSockets::PassthroughSocket,
                       Logger::Loggable<Logger::Id::connection> {



  Network::TransportSocketCallbacks* callbacks_{};

/source/extensions/transport_sockets/tcp_stats/tcp_stats.cc

46: void TcpStatsSocket::onConnected() {
47:   if (config_->update_period_.has_value()) {
48:     timer_ = callbacks_->connection().dispatcher().createTimer([this]() {
49:       recordStats();
50:       timer_->enableTimer(config_->update_period_.value());
51:     });
52:     timer_->enableTimer(config_->update_period_.value());
53:   }
54: 
55:   transport_socket_->onConnected();
56: }


void TcpStatsSocket::setTransportSocketCallbacks(Network::TransportSocketCallbacks& callbacks) {
  callbacks_ = &callbacks;
  transport_socket_->setTransportSocketCallbacks(callbacks);
}

77: absl::optional<struct tcp_info> TcpStatsSocket::querySocketInfo() {
78:   struct tcp_info info;
79:   memset(&info, 0, sizeof(info));
80:   socklen_t optlen = sizeof(info);
81:   const auto result = callbacks_->ioHandle().getOption(IPPROTO_TCP, TCP_INFO, &info, &optlen); // <-----
82:   if (result.return_value_ != 0) {
83:     ENVOY_LOG(debug, "Failed getsockopt(IPPROTO_TCP, TCP_INFO): rc {} errno {} optlen {}",
84:               result.return_value_, result.errno_, optlen);
85:     return absl::nullopt;
86:   } else {
87:     return info;
88:   }
89: }

Mocks

EXPECT_CALL
EXPECT_CALL(`*`mock_object`*`,`*`method_name`*`(`*`matchers...`*`))
Creates an expectation that the method method_name of the object mock_object is called with arguments that match the given matchers matchers.... EXPECT_CALL must precede any code that exercises the mock object.

C++ 项目构建工具 Bazel 学习笔记

labile.zhu@gmail.com (Mark Zhu) — Sun, 30 Jun 2024 03:12:15 +0800

Bazel 概念与对象

用 Draw.io 打开 bazel-overview.drawio.svg

用 Draw.io 打开 bazel-concept.drawio.svg

用 Draw.io 打开 bazel-external-dep.drawio.svg

CPP use cases

Adding include paths

https://bazel.build/tutorials/cpp-use-cases#add-include-paths

Sometimes you cannot (or do not want to) root include paths at the workspace root. Existing libraries might already have an include directory that doesn’t match its path in your workspace. For example, suppose you have the following directory structure: