Golang基于Linux命名空间构建复杂网络拓扑的测试工具插件Gont的使用

Go分布式应用测试框架

Gont是一个Go包，用于支持网络和分布式应用程序的开发。它可以使用Linux网络命名空间在单台机器(VM、云或本地)上构建虚拟网络，模拟交换机、路由器、NAT和端点。此外，它还提供了用于跟踪和调试分布式应用程序的工具。

Gont深受Mininet的启发。它允许用户在Go代码中构建虚拟网络拓扑。在底层，网络是使用Linux虚拟桥和网络命名空间构建的。

Gont需要Linux系统和NET_ADMIN能力(或root访问权限)。

功能特性

• 各种常见网络节点：
  • 标准主机
  • 第3层路由器
  • 第2层交换机
  • 第3层NAT路由器
  • 到主机网络的第3层NAT
• 测试节点的主机名解析(/etc/hosts覆盖)
• 在测试节点的网络命名空间中执行子进程、Go代码和函数
• 同时设置多个隔离网络
• 适合Go单元测试
• 可以在GitHub的runner上运行
• 完整的IPv6支持
• 通过Netem和TBF排队规则实现每链路网络仿真和带宽限制
• 使用现有网络命名空间作为节点
• 配置每主机nftables防火墙规则
• 内置Ping和Traceroute诊断工具
• 内置数据包跟踪功能，支持PCAPng输出
• 分布式事件跟踪
• 内置Delve调试器

示例代码

以下是一个使用Gont构建简单网络拓扑的完整示例：

package main

import (
	"context"
	"log"
	"os"
	"os/signal"
	"syscall"

	"github.com/cunicu/gont/v2"
)

func main() {
	// 创建一个新的网络
	n, err := gont.NewNetwork("example")
	if err != nil {
		log.Fatalf("Failed to create network: %v", err)
	}
	defer n.Close()

	// 添加一个交换机
	sw, err := n.AddSwitch("sw")
	if err != nil {
		log.Fatalf("Failed to add switch: %v", err)
	}

	// 添加两个主机
	h1, err := n.AddHost("h1")
	if err != nil {
		log.Fatalf("Failed to add host h1: %v", err)
	}

	h2, err := n.AddHost("h2")
	if err != nil {
		log.Fatalf("Failed to add host h2: %v", err)
	}

	// 将主机连接到交换机
	if _, err := n.AddLink(
		gont.NewInterface("eth0", h1),
		gont.NewInterface("eth0", sw),
	); err != nil {
		log.Fatalf("Failed to connect h1 to switch: %v", err)
	}

	if _, err := n.AddLink(
		gont.NewInterface("eth0", h2),
		gont.NewInterface("eth1", sw),
	); err != nil {
		log.Fatalf("Failed to connect h2 to switch: %v", err)
	}

	// 设置IP地址
	h1.SetAddress("10.0.0.1/24")
	h2.SetAddress("10.0.0.2/24")

	// 在h1上ping h2
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()

	// 捕获中断信号以优雅地关闭
	sig := make(chan os.Signal, 1)
	signal.Notify(sig, syscall.SIGINT, syscall.SIGTERM)
	go func() {
		<-sig
		cancel()
	}()

	// 在h1上执行ping命令
	if err := h1.Run(ctx, "ping", "-c", "4", "10.0.0.2"); err != nil {
		log.Printf("Ping failed: %v", err)
	}
}

更复杂的网络拓扑示例

下面是一个更复杂的示例，展示如何构建包含路由器和多个子网的网络：

package main

import (
	"context"
	"log"
	"os"
	"os/signal"
	"syscall"

	"github.com/cunicu/gont/v2"
)

func main() {
	// 创建网络
	n, err := gont.NewNetwork("multi-subnet")
	if err != nil {
		log.Fatal(err)
	}
	defer n.Close()

	// 添加路由器
	r, err := n.AddRouter("r")
	if err != nil {
		log.Fatal(err)
	}

	// 添加两个交换机(代表两个子网)
	sw1, err := n.AddSwitch("sw1")
	if err != nil {
		log.Fatal(err)
	}

	sw2, err := n.AddSwitch("sw2")
	if err != nil {
		log.Fatal(err)
	}

	// 连接路由器到两个交换机
	if _, err := n.AddLink(
		gont.NewInterface("eth0", r, gont.AddressIP("10.0.1.1/24")),
		gont.NewInterface("eth0", sw1),
	); err != nil {
		log.Fatal(err)
	}

	if _, err := n.AddLink(
		gont.NewInterface("eth1", r, gont.AddressIP("10.0.2.1/24")),
		gont.NewInterface("eth0", sw2),
	); err != nil {
		log.Fatal(err)
	}

	// 在每个子网中添加主机
	h1, err := n.AddHost("h1",
		gont.AddressIP("10.0.1.10/24"),
		gont.GatewayIP("10.0.1.1"),
	)
	if err != nil {
		log.Fatal(err)
	}

	h2, err := n.AddHost("h2",
		gont.AddressIP("10.0.1.11/24"),
		gont.GatewayIP("10.0.1.1"),
	)
	if err != nil {
		log.Fatal(err)
	}

	h3, err := n.AddHost("h3",
		gont.AddressIP("10.0.2.10/24"),
		gont.GatewayIP("10.0.2.1"),
	)
	if err != nil {
		log.Fatal(err)
	}

	// 连接主机到交换机
	if _, err := n.AddLink(
		gont.NewInterface("eth0", h1),
		gont.NewInterface("eth1", sw1),
	); err != nil {
		log.Fatal(err)
	}

	if _, err := n.AddLink(
		gont.NewInterface("eth0", h2),
		gont.NewInterface("eth2", sw1),
	); err != nil {
		log.Fatal(err)
	}

	if _, err := n.AddLink(
		gont.NewInterface("eth0", h3),
		gont.NewInterface("eth1", sw2),
	); err != nil {
		log.Fatal(err)
	}

	// 设置上下文以处理中断信号
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()

	sig := make(chan os.Signal, 1)
	signal.Notify(sig, syscall.SIGINT, syscall.SIGTERM)
	go func() {
		<-sig
		cancel()
	}()

	// 测试跨子网通信
	log.Println("Testing connectivity between h1 (10.0.1.10) and h3 (10.0.2.10)...")
	if err := h1.Run(ctx, "ping", "-c", "4", "10.0.2.10"); err != nil {
		log.Printf("Ping from h1 to h3 failed: %v", err)
	} else {
		log.Println("Ping successful!")
	}
}

许可证

Gont使用Apache 2.0许可证。

• SPDX-FileCopyrightText: 2023 Steffen Vogel post@steffenvogel.de
• SPDX-License-Identifier: Apache-2.0