client_linux_test.go

//go:build linux
// +build linux

package ipvs

import (
	"io"
	"net"
	"net/netip"
	"os"
	"testing"
	"unicode"

	"github.com/cloudflare/ipvs/internal/cipvs"
	"github.com/cloudflare/ipvs/netmask"
	"github.com/google/go-cmp/cmp"
	"github.com/mdlayher/genetlink"
	"github.com/mdlayher/genetlink/genltest"
	"github.com/mdlayher/netlink"
	"github.com/mdlayher/netlink/nltest"
	"gotest.tools/v3/assert"
	"pgregory.net/rapid"
)

const familyID = 0x24

func TestServices_IsNotExist(t *testing.T) {
	fn := func(gerq genetlink.Message, _ netlink.Message) ([]genetlink.Message, error) {
		return nil, io.EOF
	}
	client := testClient(t, genltest.CheckRequest(familyID, cipvs.CmdGetService, netlink.Request|netlink.Dump, fn))
	defer client.Close()

	if _, err := client.Services(); !os.IsNotExist(err) {
		t.Fatalf("expected to not exists, but got: %v", err)
	}
}

func TestServices(t *testing.T) {
	tests := map[string]struct {
		msgs     []genetlink.Message
		services []Service
	}{
		"single": {
			msgs: []genetlink.Message{
				{
					Data: nltest.MustMarshalAttributes([]netlink.Attribute{
						{
							Type: cipvs.CmdAttrService,
							Data: nltest.MustMarshalAttributes([]netlink.Attribute{
								{
									Type: cipvs.SvcAttrAf,
									Data: []byte{0x02, 0x00},
								},
								{
									Type: cipvs.SvcAttrProtocol,
									Data: []byte{0x06, 0x00},
								},
								{
									Type: cipvs.SvcAttrAddr,
									Data: []byte{0x7F, 0, 0x01, 0x01, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
								},
								{
									Type: cipvs.SvcAttrPort,
									Data: []byte{0x00, 0x50},
								},
								{
									Type: cipvs.SvcAttrSchedName,
									Data: []byte("wlc"),
								},
								{
									Type: cipvs.SvcAttrTimeout,
									Data: []byte{0x68, 0x01, 0x00, 0x00},
								},
								{
									Type: cipvs.SvcAttrNetmask,
									Data: []byte{0xFF, 0xFF, 0xFF, 0xFE},
								},
								{
									Type: cipvs.SvcAttrFlags,
									Data: []byte{0, 0, 0, 0, 0, 0, 0, 0},
								},
							}),
						},
					}),
				},
			},
			services: []Service{
				{
					Family:    INET,
					Protocol:  TCP,
					Address:   netip.MustParseAddr("127.0.1.1"),
					Port:      80,
					Scheduler: "wlc",
					Timeout:   360,
					Netmask:   netmask.MaskFrom(31, 32),
				},
			},
		},
		"single-ipv6": {
			msgs: []genetlink.Message{
				{
					Data: nltest.MustMarshalAttributes([]netlink.Attribute{
						{
							Type: cipvs.CmdAttrService,
							Data: nltest.MustMarshalAttributes([]netlink.Attribute{
								{
									Type: cipvs.SvcAttrAf,
									Data: []byte{0x0A, 0x00},
								},

								{
									Type: cipvs.SvcAttrProtocol,
									Data: []byte{0x06, 0x00},
								},
								{
									Type: cipvs.SvcAttrAddr,
									Data: []byte{0xFF, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
								},
								{
									Type: cipvs.SvcAttrPort,
									Data: []byte{0x00, 0x50},
								},
								{
									Type: cipvs.SvcAttrSchedName,
									Data: []byte("wlc"),
								},
								{
									Type: cipvs.SvcAttrTimeout,
									Data: []byte{0x68, 0x01, 0x00, 0x00},
								},
								{
									Type: cipvs.SvcAttrNetmask,
									Data: []byte{0x80, 0x00, 0x00, 0x00},
								},
								{
									Type: cipvs.SvcAttrFlags,
									Data: []byte{0, 0, 0, 0, 0, 0, 0, 0},
								},
							}),
						},
					}),
				},
			},
			services: []Service{
				{
					Family:    INET6,
					Protocol:  TCP,
					Address:   netip.MustParseAddr("ff00::"),
					Port:      80,
					Scheduler: "wlc",
					Timeout:   360,
					Netmask:   netmask.MaskFrom(128, 128),
				},
			},
		},
		"multiple": {
			msgs: []genetlink.Message{
				{
					Data: nltest.MustMarshalAttributes([]netlink.Attribute{
						{
							Type: cipvs.CmdAttrService,
							Data: nltest.MustMarshalAttributes([]netlink.Attribute{
								{
									Type: cipvs.SvcAttrAf,
									Data: []byte{0x02, 0x00},
								},
								{
									Type: cipvs.SvcAttrProtocol,
									Data: []byte{0x06, 0x00},
								},
								{
									Type: cipvs.SvcAttrAddr,
									Data: []byte{0x7F, 0, 0x01, 0x01, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
								},
								{
									Type: cipvs.SvcAttrPort,
									Data: []byte{0x00, 0x50},
								},
								{
									Type: cipvs.SvcAttrSchedName,
									Data: []byte("wlc"),
								},
								{
									Type: cipvs.SvcAttrTimeout,
									Data: []byte{0x68, 0x01, 0x00, 0x00},
								},
								{
									Type: cipvs.SvcAttrNetmask,
									Data: []byte{0xFF, 0xFF, 0xFF, 0xFE},
								},
								{
									Type: cipvs.SvcAttrFlags,
									Data: []byte{0, 0, 0, 0, 0, 0, 0, 0},
								},
							}),
						},
					}),
				},
				{
					Data: nltest.MustMarshalAttributes([]netlink.Attribute{
						{
							Type: cipvs.CmdAttrService,
							Data: nltest.MustMarshalAttributes([]netlink.Attribute{
								{
									Type: cipvs.SvcAttrAf,
									Data: []byte{0x0A, 0x00},
								},
								{
									Type: cipvs.SvcAttrProtocol,
									Data: []byte{0x06, 0x00},
								},
								{
									Type: cipvs.SvcAttrAddr,
									Data: []byte{0xFF, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
								},
								{
									Type: cipvs.SvcAttrPort,
									Data: []byte{0x00, 0x50},
								},
								{
									Type: cipvs.SvcAttrSchedName,
									Data: []byte("wlc"),
								},
								{
									Type: cipvs.SvcAttrTimeout,
									Data: []byte{0x68, 0x01, 0x00, 0x00},
								},
								{
									Type: cipvs.SvcAttrNetmask,
									Data: []byte{0x80, 0x00, 0x00, 0x00},
								},
								{
									Type: cipvs.SvcAttrFlags,
									Data: []byte{0, 0, 0, 0, 0, 0, 0, 0},
								},
							}),
						},
					}),
				},
			},
			services: []Service{
				{
					Family:    INET,
					Protocol:  TCP,
					Address:   netip.MustParseAddr("127.0.1.1"),
					Port:      80,
					Scheduler: "wlc",
					Timeout:   360,
					Netmask:   netmask.MaskFrom(31, 32),
				},
				{
					Family:    INET6,
					Protocol:  TCP,
					Address:   netip.MustParseAddr("ff00::"),
					Port:      80,
					Scheduler: "wlc",
					Timeout:   360,
					Netmask:   netmask.MaskFrom(128, 128),
				},
			},
		},
	}

	for name, tt := range tests {
		tt := tt
		t.Run(name, func(t *testing.T) {
			fn := func(gerq genetlink.Message, _ netlink.Message) ([]genetlink.Message, error) {
				return tt.msgs, nil
			}
			client := testClient(t, genltest.CheckRequest(familyID, cipvs.CmdGetService, netlink.Request|netlink.Dump, fn))

			defer client.Close()

			se, err := client.Services()
			assert.NilError(t, err)

			services := []Service{}
			for _, svc := range se {
				services = append(services, svc.Service)
			}

			assert.DeepEqual(t, services, tt.services, cmp.Comparer(NetipAddrCompare))
		})
	}
}

func TestService_PackUnpack(t *testing.T) {
	rapid.Check(t, func(t *rapid.T) {
		svc := rapid.Custom[Service](func(t *rapid.T) Service {
			family := rapid.SampledFrom([]AddressFamily{INET, INET6}).Draw(t, "Family")
			var addr netip.Addr
			var mask netmask.Mask

			switch family {
			case INET:
				addr, _ = netip.AddrFromSlice(rapid.SliceOfN(rapid.Byte(), net.IPv4len, net.IPv4len).Draw(t, "Address"))
				mask = netmask.MaskFrom(rapid.IntRange(0, 32).Draw(t, "ones"), 32)
			case INET6:
				addr, _ = netip.AddrFromSlice(rapid.SliceOfN(rapid.Byte(), net.IPv6len, net.IPv6len).Draw(t, "Address"))
				mask = netmask.MaskFrom(rapid.IntRange(0, 128).Draw(t, "ones"), 128)
			}

			return Service{
				Address:   addr,
				Netmask:   mask,
				Scheduler: rapid.StringOf(rapid.RuneFrom(nil, unicode.Letter, unicode.Number)).Draw(t, "Scheduler"),
				Timeout:   rapid.Uint32().Draw(t, "Timeout"),
				Flags:     Flags(rapid.Uint32().Draw(t, "Flags")),
				Port:      rapid.Uint16().Draw(t, "Port"),
				Family:    family,
				Protocol:  Protocol(rapid.Uint16().Draw(t, "Protocol")),
			}
		}).Draw(t, "svc")

		ae := netlink.NewAttributeEncoder()
		ae.Do(cipvs.CmdAttrService, packService(svc))
		p, err := ae.Encode()

		assert.NilError(t, err)

		ad, err := netlink.NewAttributeDecoder(p)
		assert.NilError(t, err)

		var out ServiceExtended
		for ad.Next() {
			if ad.Type() == cipvs.CmdAttrService {
				ad.Do(unpackService(&out))
			}
		}

		assert.NilError(t, ad.Err())
		assert.DeepEqual(t, out.Service, svc, cmp.Comparer(NetipAddrCompare))
	})
}

func TestDestinations_Pack(t *testing.T) {
	type testCase struct {
		name        string
		destination Destination
		expected    genetlink.Message
	}

	run := func(t *testing.T, tc testCase) {
		fn := func(gerq genetlink.Message, _ netlink.Message) ([]genetlink.Message, error) {
			assert.DeepEqual(t, gerq, tc.expected)
			return []genetlink.Message{{}}, nil
		}

		client := testClient(t, genltest.CheckRequest(familyID, cipvs.CmdNewDest, netlink.Request|netlink.Acknowledge, fn))
		defer client.Close()

		err := client.CreateDestination(Service{
			Address:   netip.MustParseAddr("127.0.1.1"),
			Netmask:   netmask.MaskFrom(31, 32),
			Scheduler: "wlc",
			Timeout:   300,
			Flags:     ServicePersistent,
			Port:      8080,
			Family:    INET,
			Protocol:  TCP,
		}, tc.destination)
		assert.NilError(t, err)
	}

	svcAttr := netlink.Attribute{
		Type: cipvs.CmdAttrService,
		Data: nltest.MustMarshalAttributes([]netlink.Attribute{
			{
				Type: cipvs.SvcAttrAf,
				Data: []byte{0x02, 0x00},
			},
			{
				Type: cipvs.SvcAttrSchedName,
				Data: []byte{'w', 'l', 'c', 0x00},
			},
			{
				Type: cipvs.SvcAttrFlags,
				Data: []byte{0x01, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0xFF},
			},
			{
				Type: cipvs.SvcAttrTimeout,
				Data: []byte{0x2C, 0x01, 0x00, 0x00},
			},
			{
				Type: cipvs.SvcAttrNetmask,
				Data: []byte{0xFF, 0xFF, 0xFF, 0xFE},
			},
			{
				Type: cipvs.SvcAttrProtocol,
				Data: []byte{0x06, 0x00},
			},
			{
				Type: cipvs.SvcAttrAddr,
				Data: []byte{
					0x7F, 0x00, 0x01, 0x01,
				},
			},
			{
				Type: cipvs.SvcAttrPort,
				Data: []byte{
					0x1F, 0x90,
				},
			},
		}),
	}

	testCases := []testCase{
		{
			name: "direct destination",
			destination: Destination{
				Address:   netip.MustParseAddr("127.0.1.1"),
				FwdMethod: DirectRoute,
				Weight:    1,
				Port:      80,
				Family:    INET,
			},
			expected: genetlink.Message{
				Header: genetlink.Header{
					Command: cipvs.CmdNewDest,
					Version: 1,
				},
				Data: nltest.MustMarshalAttributes([]netlink.Attribute{
					svcAttr,
					{
						Type: cipvs.CmdAttrDest,
						Data: nltest.MustMarshalAttributes([]netlink.Attribute{
							{
								Type: cipvs.DestAttrAddrFamily,
								Data: []byte{0x02, 0x00},
							},
							{
								Type: cipvs.DestAttrAddr,
								Data: []byte{
									0x7F, 0x00, 0x01, 0x01,
								},
							},
							{
								Type: cipvs.DestAttrPort,
								Data: []byte{0x00, 0x50},
							},
							{
								Type: cipvs.DestAttrFwdMethod,
								Data: []byte{0x03, 0x00, 0x00, 0x00},
							},
							{
								Type: cipvs.DestAttrWeight,
								Data: []byte{0x01, 0x00, 0x00, 0x00},
							},
							{
								Type: cipvs.DestAttrUThresh,
								Data: []byte{0x00, 0x00, 0x00, 0x00},
							},
							{
								Type: cipvs.DestAttrLThresh,
								Data: []byte{0x00, 0x00, 0x00, 0x00},
							},
							{
								Type: cipvs.DestAttrTunType,
								Data: []byte{0x00},
							},
							{
								Type: cipvs.DestAttrTunPort,
								Data: []byte{0x00, 0x00},
							},
							{
								Type: cipvs.DestAttrTunFlags,
								Data: []byte{0x00, 0x00},
							},
						}),
					},
				}),
			},
		},
		{
			name: "direct IPv6 destination",
			destination: Destination{
				Address:   netip.MustParseAddr("2004:db8::3"),
				FwdMethod: DirectRoute,
				Weight:    1,
				Port:      80,
				Family:    INET6,
			},
			expected: genetlink.Message{
				Header: genetlink.Header{
					Command: cipvs.CmdNewDest,
					Version: 1,
				},
				Data: nltest.MustMarshalAttributes([]netlink.Attribute{
					svcAttr,
					{
						Type: cipvs.CmdAttrDest,
						Data: nltest.MustMarshalAttributes([]netlink.Attribute{
							{
								Type: cipvs.DestAttrAddrFamily,
								Data: []byte{0x0A, 0x00},
							},
							{
								Type: cipvs.DestAttrAddr,
								Data: []byte{
									0x20, 0x04, 0x0D, 0xB8, 0x00, 0x00, 0x00, 0x00,
									0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03,
								},
							},
							{
								Type: cipvs.DestAttrPort,
								Data: []byte{0x00, 0x50},
							},
							{
								Type: cipvs.DestAttrFwdMethod,
								Data: []byte{0x03, 0x00, 0x00, 0x00},
							},
							{
								Type: cipvs.DestAttrWeight,
								Data: []byte{0x01, 0x00, 0x00, 0x00},
							},
							{
								Type: cipvs.DestAttrUThresh,
								Data: []byte{0x00, 0x00, 0x00, 0x00},
							},
							{
								Type: cipvs.DestAttrLThresh,
								Data: []byte{0x00, 0x00, 0x00, 0x00},
							},
							{
								Type: cipvs.DestAttrTunType,
								Data: []byte{0x00},
							},
							{
								Type: cipvs.DestAttrTunPort,
								Data: []byte{0x00, 0x00},
							},
							{
								Type: cipvs.DestAttrTunFlags,
								Data: []byte{0x00, 0x00},
							},
						}),
					},
				}),
			},
		},
		{
			name: "GUE tunnel destination",
			destination: Destination{
				Address:     netip.MustParseAddr("127.0.1.1"),
				FwdMethod:   Tunnel,
				Weight:      1,
				Port:        80,
				Family:      INET,
				TunnelType:  GUE,
				TunnelPort:  5580,
				TunnelFlags: TunnelEncapRemoteChecksum,
			},
			expected: genetlink.Message{
				Header: genetlink.Header{

					Command: cipvs.CmdNewDest,
					Version: 1,
				},
				Data: nltest.MustMarshalAttributes([]netlink.Attribute{
					svcAttr,
					{
						Type: cipvs.CmdAttrDest,
						Data: nltest.MustMarshalAttributes([]netlink.Attribute{
							{
								Type: cipvs.DestAttrAddrFamily,
								Data: []byte{0x02, 0x00},
							},
							{
								Type: cipvs.DestAttrAddr,
								Data: []byte{
									0x7F, 0x00, 0x01, 0x01,
								},
							},
							{
								Type: cipvs.DestAttrPort,
								Data: []byte{0x00, 0x50},
							},
							{
								Type: cipvs.DestAttrFwdMethod,
								Data: []byte{0x02, 0x00, 0x00, 0x00},
							},
							{
								Type: cipvs.DestAttrWeight,
								Data: []byte{0x01, 0x00, 0x00, 0x00},
							},
							{
								Type: cipvs.DestAttrUThresh,
								Data: []byte{0x00, 0x00, 0x00, 0x00},
							},
							{
								Type: cipvs.DestAttrLThresh,
								Data: []byte{0x00, 0x00, 0x00, 0x00},
							},
							{
								Type: cipvs.DestAttrTunType,
								Data: []byte{0x01},
							},
							{
								Type: cipvs.DestAttrTunPort,
								Data: []byte{0x15, 0xCC},
							},
							{
								Type: cipvs.DestAttrTunFlags,
								Data: []byte{0x02, 0x00},
							},
						}),
					},
				}),
			},
		},
	}

	for _, tc := range testCases {
		tc := tc
		t.Run(tc.name, func(t *testing.T) {
			run(t, tc)
		})
	}
}

func TestDestinations_Unpack(t *testing.T) {
	type testCase struct {
		name     string
		msgs     []genetlink.Message
		expected []Destination
	}

	run := func(t *testing.T, tc testCase) {
		fn := func(_ genetlink.Message, _ netlink.Message) ([]genetlink.Message, error) {
			return tc.msgs, nil
		}

		client := testClient(t, genltest.CheckRequest(familyID, cipvs.CmdGetDest, netlink.Request|netlink.Dump, fn))
		defer client.Close()

		result, err := client.Destinations(Service{
			Family: INET,
		})
		assert.NilError(t, err)

		dests := make([]Destination, 0, len(result))
		for _, dest := range result {
			dests = append(dests, dest.Destination)
		}

		assert.DeepEqual(t, dests, tc.expected, cmp.Comparer(NetipAddrCompare))
	}

	testCases := []testCase{
		{
			name: "single direct",
			msgs: []genetlink.Message{
				{
					Data: nltest.MustMarshalAttributes([]netlink.Attribute{
						{
							Type: cipvs.CmdAttrDest,
							Data: nltest.MustMarshalAttributes([]netlink.Attribute{
								{
									Type: cipvs.DestAttrAddr,
									Data: []byte{0x7F, 0, 0x01, 0x01, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
								},
								{
									Type: cipvs.DestAttrFwdMethod,
									Data: []byte{0x03, 0x00, 0x00, 0x00},
								},
								{
									Type: cipvs.DestAttrWeight,
									Data: []byte{0x01, 0x00, 0x00, 0x00},
								},
								{
									Type: cipvs.DestAttrPort,
									Data: []byte{0x00, 0x50},
								},
								{
									Type: cipvs.DestAttrAddrFamily,
									Data: []byte{0x02, 0x00},
								},
							}),
						},
					}),
				},
			},
			expected: []Destination{
				{
					Address:   netip.MustParseAddr("127.0.1.1"),
					FwdMethod: DirectRoute,
					Weight:    1,
					Port:      80,
					Family:    INET,
				},
			},
		},
		{
			name: "direct no address family",
			msgs: []genetlink.Message{
				{
					Data: nltest.MustMarshalAttributes([]netlink.Attribute{
						{
							Type: cipvs.CmdAttrDest,
							Data: nltest.MustMarshalAttributes([]netlink.Attribute{
								{
									Type: cipvs.DestAttrAddr,
									Data: []byte{0x7F, 0, 0x01, 0x01, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
								},
								{
									Type: cipvs.DestAttrFwdMethod,
									Data: []byte{0x03, 0x00, 0x00, 0x00},
								},
								{
									Type: cipvs.DestAttrWeight,
									Data: []byte{0x01, 0x00, 0x00, 0x00},
								},
								{
									Type: cipvs.DestAttrPort,
									Data: []byte{0x00, 0x50},
								},
							}),
						},
					}),
				},
			},
			expected: []Destination{
				{
					Address:   netip.MustParseAddr("127.0.1.1"),
					FwdMethod: DirectRoute,
					Weight:    1,
					Port:      80,
					Family:    INET,
				},
			},
		},
		{
			name: "single GUE tunnel",
			msgs: []genetlink.Message{
				{
					Data: nltest.MustMarshalAttributes([]netlink.Attribute{
						{
							Type: cipvs.CmdAttrDest,
							Data: nltest.MustMarshalAttributes([]netlink.Attribute{
								{
									Type: cipvs.DestAttrAddr,
									Data: []byte{0x7F, 0, 0x01, 0x01, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
								},
								{
									Type: cipvs.DestAttrFwdMethod,
									Data: []byte{0x02, 0x00, 0x00, 0x00},
								},
								{
									Type: cipvs.DestAttrWeight,
									Data: []byte{0x01, 0x00, 0x00, 0x00},
								},
								{
									Type: cipvs.DestAttrPort,
									Data: []byte{0x00, 0x50},
								},
								{
									Type: cipvs.DestAttrAddrFamily,
									Data: []byte{0x02, 0x00},
								},
								{
									Type: cipvs.DestAttrTunType,
									Data: []byte{0x01},
								},
								{
									Type: cipvs.DestAttrTunPort,
									Data: []byte{0x15, 0xB3},
								},
								{
									Type: cipvs.DestAttrTunFlags,
									Data: []byte{0x02, 0x00},
								},
							}),
						},
					}),
				},
			},
			expected: []Destination{
				{
					Address:     netip.MustParseAddr("127.0.1.1"),
					FwdMethod:   Tunnel,
					Weight:      1,
					Port:        80,
					Family:      INET,
					TunnelType:  GUE,
					TunnelPort:  5555,
					TunnelFlags: TunnelEncapRemoteChecksum,
				},
			},
		},
	}

	for _, tc := range testCases {
		tc := tc
		t.Run(tc.name, func(t *testing.T) {
			run(t, tc)
		})
	}
}

func testClient(t *testing.T, fn genltest.Func) *client {
	t.Helper()

	family := genetlink.Family{
		ID:      familyID,
		Version: cipvs.GenlVersion,
		Name:    cipvs.GenlName,
	}

	conn := genltest.Dial(genltest.ServeFamily(family, fn))
	client, err := initClient(conn)
	if err != nil {
		t.Fatalf("failed to open client: %v", err)
	}

	return client
}

func NetipAddrCompare(x, y netip.Addr) bool {
	return x == y
}