Add unit test for ListIPForwardRows

Signed-off-by: Quan Tian <[email protected]>
antrea-io · Sep 14, 2024 · 7ed92a0 · 7ed92a0
1 parent b96d22f
commit 7ed92a0
Show file tree

Hide file tree

Showing 2 changed files with 100 additions and 7 deletions.
diff --git a/pkg/agent/util/syscall/syscall_windows.go b/pkg/agent/util/syscall/syscall_windows.go
@@ -307,11 +307,14 @@ type NetIOInterface interface {
 }
 
 type netIO struct {
-	syscallN func(trap uintptr, args ...uintptr) (r1, r2 uintptr, err syscall.Errno)
+	syscallN            func(trap uintptr, args ...uintptr) (r1, r2 uintptr, err syscall.Errno)
+	getIPForwardTableFn func(family uint16, ipForwardTable **MibIPForwardTable) (errcode error)
 }
 
 func NewNetIO() NetIOInterface {
-	return &netIO{syscallN: syscall.SyscallN}
+	io := &netIO{syscallN: syscall.SyscallN}
+	io.getIPForwardTableFn = io.getIPForwardTable
+	return io
 }
 
 func (n *netIO) GetIPInterfaceEntry(ipInterfaceRow *MibIPInterfaceRow) (errcode error) {
@@ -361,7 +364,7 @@ func (n *netIO) getIPForwardTable(family uint16, ipForwardTable **MibIPForwardTa
 
 func (n *netIO) ListIPForwardRows(family uint16) ([]MibIPForwardRow, error) {
 	var table *MibIPForwardTable
-	err := n.getIPForwardTable(family, &table)
+	err := n.getIPForwardTableFn(family, &table)
 	if table != nil {
 		defer n.freeMibTable(unsafe.Pointer(table))
 	}

diff --git a/pkg/agent/util/syscall/syscall_windows_test.go b/pkg/agent/util/syscall/syscall_windows_test.go
@@ -19,8 +19,10 @@ import (
 	"os"
 	"syscall"
 	"testing"
+	"unsafe"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func TestRawSockAddrTranslation(t *testing.T) {
@@ -202,16 +204,104 @@ func TestIPForwardEntryOperations(t *testing.T) {
 	}
 }
 
-func TestListIPForwardRows(t *testing.T) {
+func TestListIPForwardRowsFailure(t *testing.T) {
 	wantErr := os.NewSyscallError("iphlpapi.GetIpForwardTable", syscall.Errno(22))
 	testNetIO := NewTestNetIO(22)
 	// Skipping no error case because converting uintptr back to Pointer is not valid in general.
-	gotRow, gotErr := testNetIO.ListIPForwardRows(AF_INET)
-	assert.Nil(t, gotRow)
+	gotRows, gotErr := testNetIO.ListIPForwardRows(AF_INET)
+	assert.Nil(t, gotRows)
 	assert.Equal(t, wantErr, gotErr)
 }
 
-func NewTestNetIO(wantR1 uintptr) NetIOInterface {
+func TestListIPForwardRowsSuccess(t *testing.T) {
+	// The table contains two rows. Its memory address will be assigned to ipForwardTable when getIPForwardTableFn is called.
+	table := struct {
+		NumEntries uint32
+		Table      [2]MibIPForwardRow
+	}{
+		NumEntries: 2,
+		Table: [2]MibIPForwardRow{
+			{
+				Luid:  10,
+				Index: 11,
+				DestinationPrefix: AddressPrefix{
+					Prefix: RawSockAddrInet{
+						Family: AF_INET,
+						data:   [26]byte{10, 10, 10, 0},
+					},
+					prefixLength: 24,
+				},
+				NextHop: RawSockAddrInet{
+					Family: AF_INET,
+					data:   [26]byte{11, 11, 11, 11},
+				},
+			},
+			{
+				Luid:  20,
+				Index: 21,
+				DestinationPrefix: AddressPrefix{
+					Prefix: RawSockAddrInet{
+						Family: AF_INET,
+						data:   [26]byte{20, 20, 20, 0},
+					},
+					prefixLength: 24,
+				},
+				NextHop: RawSockAddrInet{
+					Family: AF_INET,
+					data:   [26]byte{21, 21, 21, 21},
+				},
+			},
+		},
+	}
+	testNetIO := NewTestNetIO(0)
+	testNetIO.getIPForwardTableFn = func(family uint16, ipForwardTable **MibIPForwardTable) (errcode error) {
+		*ipForwardTable = (*MibIPForwardTable)(unsafe.Pointer(&table))
+		return nil
+	}
+
+	gotRows, gotErr := testNetIO.ListIPForwardRows(AF_INET)
+	require.Nil(t, gotErr)
+
+	// It verifies that the returned rows are independent copies, not referencing to the original table's memory, by
+	// asserting they retain the exact same content as the original table after it has been set.
+	table.Table[0] = MibIPForwardRow{}
+	table.Table[1] = MibIPForwardRow{}
+	expectedRows := []MibIPForwardRow{
+		{
+			Luid:  10,
+			Index: 11,
+			DestinationPrefix: AddressPrefix{
+				Prefix: RawSockAddrInet{
+					Family: AF_INET,
+					data:   [26]byte{10, 10, 10, 0},
+				},
+				prefixLength: 24,
+			},
+			NextHop: RawSockAddrInet{
+				Family: AF_INET,
+				data:   [26]byte{11, 11, 11, 11},
+			},
+		},
+		{
+			Luid:  20,
+			Index: 21,
+			DestinationPrefix: AddressPrefix{
+				Prefix: RawSockAddrInet{
+					Family: AF_INET,
+					data:   [26]byte{20, 20, 20, 0},
+				},
+				prefixLength: 24,
+			},
+			NextHop: RawSockAddrInet{
+				Family: AF_INET,
+				data:   [26]byte{21, 21, 21, 21},
+			},
+		},
+	}
+	assert.Equal(t, expectedRows, gotRows)
+}
+
+func NewTestNetIO(wantR1 uintptr) *netIO {
 	mockSyscallN := func(trap uintptr, args ...uintptr) (r1, r2 uintptr, err syscall.Errno) {
 		return wantR1, 0, 0
 	}