summaryrefslogtreecommitdiffhomepage
path: root/pkg/tcpip/testutil
diff options
context:
space:
mode:
Diffstat (limited to 'pkg/tcpip/testutil')
-rw-r--r--pkg/tcpip/testutil/BUILD21
-rw-r--r--pkg/tcpip/testutil/testutil.go190
-rw-r--r--pkg/tcpip/testutil/testutil_test.go103
-rw-r--r--pkg/tcpip/testutil/testutil_unsafe.go26
4 files changed, 0 insertions, 340 deletions
diff --git a/pkg/tcpip/testutil/BUILD b/pkg/tcpip/testutil/BUILD
deleted file mode 100644
index 02ee86ff1..000000000
--- a/pkg/tcpip/testutil/BUILD
+++ /dev/null
@@ -1,21 +0,0 @@
-load("//tools:defs.bzl", "go_library", "go_test")
-
-package(licenses = ["notice"])
-
-go_library(
- name = "testutil",
- testonly = True,
- srcs = [
- "testutil.go",
- "testutil_unsafe.go",
- ],
- visibility = ["//visibility:public"],
- deps = ["//pkg/tcpip"],
-)
-
-go_test(
- name = "testutil_test",
- srcs = ["testutil_test.go"],
- library = ":testutil",
- deps = ["//pkg/tcpip"],
-)
diff --git a/pkg/tcpip/testutil/testutil.go b/pkg/tcpip/testutil/testutil.go
deleted file mode 100644
index 903fe250d..000000000
--- a/pkg/tcpip/testutil/testutil.go
+++ /dev/null
@@ -1,190 +0,0 @@
-// Copyright 2021 The gVisor Authors.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-// Package testutil provides helper functions for netstack unit tests.
-package testutil
-
-import (
- "fmt"
- "net"
- "reflect"
- "strings"
-
- "gvisor.dev/gvisor/pkg/tcpip"
-)
-
-// MustParse4 parses an IPv4 string (e.g. "192.168.1.1") into a tcpip.Address.
-// Passing an IPv4-mapped IPv6 address will yield only the 4 IPv4 bytes.
-func MustParse4(addr string) tcpip.Address {
- ip := net.ParseIP(addr).To4()
- if ip == nil {
- panic(fmt.Sprintf("Parse4 expects IPv4 addresses, but was passed %q", addr))
- }
- return tcpip.Address(ip)
-}
-
-// MustParse6 parses an IPv6 string (e.g. "fe80::1") into a tcpip.Address. Passing
-// an IPv4 address will yield an IPv4-mapped IPv6 address.
-func MustParse6(addr string) tcpip.Address {
- ip := net.ParseIP(addr).To16()
- if ip == nil {
- panic(fmt.Sprintf("Parse6 was passed malformed address %q", addr))
- }
- return tcpip.Address(ip)
-}
-
-func checkFieldCounts(ref, multi reflect.Value) error {
- refTypeName := ref.Type().Name()
- multiTypeName := multi.Type().Name()
- refNumField := ref.NumField()
- multiNumField := multi.NumField()
-
- if refNumField != multiNumField {
- return fmt.Errorf("type %s has an incorrect number of fields: got = %d, want = %d (same as type %s)", multiTypeName, multiNumField, refNumField, refTypeName)
- }
-
- return nil
-}
-
-func validateField(ref reflect.Value, refName string, m tcpip.MultiCounterStat, multiName string) error {
- s, ok := ref.Addr().Interface().(**tcpip.StatCounter)
- if !ok {
- return fmt.Errorf("expected ref type's to be *StatCounter, but its type is %s", ref.Type().Elem().Name())
- }
-
- // The field names are expected to match (case insensitive).
- if !strings.EqualFold(refName, multiName) {
- return fmt.Errorf("wrong field name: got = %s, want = %s", multiName, refName)
- }
-
- base := (*s).Value()
- m.Increment()
- if (*s).Value() != base+1 {
- return fmt.Errorf("updates to the '%s MultiCounterStat' counters are not reflected in the '%s CounterStat'", multiName, refName)
- }
-
- return nil
-}
-
-func validateIntegralMapField(ref reflect.Value, refName string, m tcpip.MultiIntegralStatCounterMap, multiName string) error {
- // The field names are expected to match (case insensitive).
- if !strings.EqualFold(refName, multiName) {
- return fmt.Errorf("wrong field name: got = %s, want = %s", multiName, refName)
- }
- s, ok := ref.Addr().Interface().(**tcpip.IntegralStatCounterMap)
- if !ok {
- return fmt.Errorf("field is not an IntegralStatCounterMap")
- }
-
- const key = 42
-
- getValue := func() uint64 {
- counter, ok := (*s).Get(key)
- if !ok {
- return 0
- }
- return counter.Value()
- }
-
- before := getValue()
-
- m.Increment(key)
-
- after := getValue()
-
- if after != before+1 {
- return fmt.Errorf("updates to the '%s MultiCounterStat' counters are not reflected in the '%s CounterStat'", multiName, refName)
- }
-
- return nil
-}
-
-func validateMultiCounterStats(multi reflect.Value, counters []reflect.Value) (foundMultiCounterStat, foundMultiIntegralStatCounterMap bool, err error) {
- for _, c := range counters {
- if err := checkFieldCounts(c, multi); err != nil {
- return false, false, err
- }
- }
-
- for i := 0; i < multi.NumField(); i++ {
- multiName := multi.Type().Field(i).Name
- multiUnsafe := unsafeExposeUnexportedFields(multi.Field(i))
-
- switch m := multiUnsafe.Addr().Interface().(type) {
- case *tcpip.MultiCounterStat:
- foundMultiCounterStat = true
- for _, c := range counters {
- if err := validateField(unsafeExposeUnexportedFields(c.Field(i)), c.Type().Field(i).Name, *m, multiName); err != nil {
- return false, false, err
- }
- }
- case *tcpip.MultiIntegralStatCounterMap:
- foundMultiIntegralStatCounterMap = true
- for _, c := range counters {
- if err := validateIntegralMapField(unsafeExposeUnexportedFields(c.Field(i)), c.Type().Field(i).Name, *m, multiName); err != nil {
- return false, false, err
- }
- }
- default:
- var countersNextField []reflect.Value
- for _, c := range counters {
- countersNextField = append(countersNextField, c.Field(i))
- }
- innerFoundMultiCounterStat, innerFoundMultiIntegralStatCounterMap, err := validateMultiCounterStats(multi.Field(i), countersNextField)
- if err != nil {
- return false, false, err
- }
- foundMultiCounterStat = foundMultiCounterStat || innerFoundMultiCounterStat
- foundMultiIntegralStatCounterMap = foundMultiIntegralStatCounterMap || innerFoundMultiIntegralStatCounterMap
- }
- }
-
- return foundMultiCounterStat, foundMultiIntegralStatCounterMap, nil
-}
-
-// ValidateMultiCounterStatsOptions holds options used when validating multi
-// counter stat structs.
-type ValidateMultiCounterStatsOptions struct {
- ExpectMultiCounterStat bool
- ExpectMultiIntegralStatCounterMap bool
-}
-
-// ValidateMultiCounterStats verifies that every counter stored in multi is
-// correctly tracking its counterpart in the given counters.
-func ValidateMultiCounterStats(multi reflect.Value, counters []reflect.Value, options ValidateMultiCounterStatsOptions) error {
- foundMultiCounterStat, foundMultiIntegralStatCounterMap, err := validateMultiCounterStats(multi, counters)
- if err != nil {
- return err
- }
- if foundMultiCounterStat != options.ExpectMultiCounterStat {
- return fmt.Errorf("got %T presence: %t, want: %t", (*tcpip.MultiCounterStat)(nil), foundMultiCounterStat, options.ExpectMultiCounterStat)
- }
- if foundMultiIntegralStatCounterMap != options.ExpectMultiIntegralStatCounterMap {
- return fmt.Errorf("got %T presence: %t, want: %t", (*tcpip.MultiIntegralStatCounterMap)(nil), foundMultiIntegralStatCounterMap, options.ExpectMultiIntegralStatCounterMap)
- }
-
- return nil
-}
-
-// MustParseLink parses a Link string into a tcpip.LinkAddress, panicking on
-// error.
-//
-// The string must be in the format aa:bb:cc:dd:ee:ff or aa-bb-cc-dd-ee-ff.
-func MustParseLink(addr string) tcpip.LinkAddress {
- parsed, err := tcpip.ParseMACAddress(addr)
- if err != nil {
- panic(fmt.Sprintf("tcpip.ParseMACAddress(%s): %s", addr, err))
- }
- return parsed
-}
diff --git a/pkg/tcpip/testutil/testutil_test.go b/pkg/tcpip/testutil/testutil_test.go
deleted file mode 100644
index 6aad9585d..000000000
--- a/pkg/tcpip/testutil/testutil_test.go
+++ /dev/null
@@ -1,103 +0,0 @@
-// Copyright 2021 The gVisor Authors.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-package testutil
-
-import (
- "testing"
-
- "gvisor.dev/gvisor/pkg/tcpip"
-)
-
-// Who tests the testutils?
-
-func TestMustParse4(t *testing.T) {
- tcs := []struct {
- str string
- addr tcpip.Address
- shouldPanic bool
- }{
- {
- str: "127.0.0.1",
- addr: "\x7f\x00\x00\x01",
- }, {
- str: "",
- shouldPanic: true,
- }, {
- str: "fe80::1",
- shouldPanic: true,
- }, {
- // In an ideal world this panics too, but net.IP
- // doesn't distinguish between IPv4 and IPv4-mapped
- // addresses.
- str: "::ffff:0.0.0.1",
- addr: "\x00\x00\x00\x01",
- },
- }
-
- for _, tc := range tcs {
- t.Run(tc.str, func(t *testing.T) {
- if tc.shouldPanic {
- defer func() {
- if r := recover(); r == nil {
- t.Errorf("panic expected, but did not occur")
- }
- }()
- }
- if got := MustParse4(tc.str); got != tc.addr {
- t.Errorf("got MustParse4(%s) = %s, want = %s", tc.str, got, tc.addr)
- }
- })
- }
-}
-
-func TestMustParse6(t *testing.T) {
- tcs := []struct {
- str string
- addr tcpip.Address
- shouldPanic bool
- }{
- {
- // In an ideal world this panics too, but net.IP
- // doesn't distinguish between IPv4 and IPv4-mapped
- // addresses.
- str: "127.0.0.1",
- addr: "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xff\xff\x7f\x00\x00\x01",
- }, {
- str: "",
- shouldPanic: true,
- }, {
- str: "fe80::1",
- addr: "\xfe\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01",
- }, {
- str: "::ffff:0.0.0.1",
- addr: "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xff\xff\x00\x00\x00\x01",
- },
- }
-
- for _, tc := range tcs {
- t.Run(tc.str, func(t *testing.T) {
- if tc.shouldPanic {
- defer func() {
- if r := recover(); r == nil {
- t.Errorf("panic expected, but did not occur")
- }
- }()
- }
- if got := MustParse6(tc.str); got != tc.addr {
- t.Errorf("got MustParse6(%s) = %s, want = %s", tc.str, got, tc.addr)
- }
- })
- }
-}
diff --git a/pkg/tcpip/testutil/testutil_unsafe.go b/pkg/tcpip/testutil/testutil_unsafe.go
deleted file mode 100644
index 5ff764800..000000000
--- a/pkg/tcpip/testutil/testutil_unsafe.go
+++ /dev/null
@@ -1,26 +0,0 @@
-// Copyright 2020 The gVisor Authors.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-package testutil
-
-import (
- "reflect"
- "unsafe"
-)
-
-// unsafeExposeUnexportedFields takes a Value and returns a version of it in
-// which even unexported fields can be read and written.
-func unsafeExposeUnexportedFields(a reflect.Value) reflect.Value {
- return reflect.NewAt(a.Type(), unsafe.Pointer(a.UnsafeAddr())).Elem()
-}