TheArchive/tailscale
1
0
Fork 0
mirror of https://github.com/tailscale/tailscale.git synced 2025-04-29 12:11:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

net/portmapper: fix test flakes from logging after test done

Browse Source 
Fixes #15794

Change-Id: Ic22aa99acb10fdb6dc5f0b6482e722e48237703c
Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
This commit is contained in:
Brad Fitzpatrick 2025-04-25 14:56:18 -07:00 committed by Brad Fitzpatrick
parent 66371f392a
commit 189e03e741
5 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
net/portmapper/igd_test.go
View File

@ -18,8 +18,10 @@ import (
"tailscale.com/net/netaddr" "tailscale.com/net/netaddr"
"tailscale.com/net/netmon" "tailscale.com/net/netmon"
"tailscale.com/syncs" "tailscale.com/syncs"
"tailscale.com/tstest"
"tailscale.com/types/logger" "tailscale.com/types/logger"
"tailscale.com/util/eventbus" "tailscale.com/util/eventbus"
"tailscale.com/util/testenv"
) )
// TestIGD is an IGD (Internet Gateway Device) for testing. It supports fake // TestIGD is an IGD (Internet Gateway Device) for testing. It supports fake
@ -64,7 +66,8 @@ type igdCounters struct {
invalidPCPMapPkt int32 invalidPCPMapPkt int32
} }
func NewTestIGD(logf logger.Logf, t TestIGDOptions) (*TestIGD, error) { func NewTestIGD(tb testenv.TB, t TestIGDOptions) (*TestIGD, error) {
logf := tstest.WhileTestRunningLogger(tb)
d := &TestIGD{ d := &TestIGD{
doPMP: t.PMP, doPMP: t.PMP,
doPCP: t.PCP, doPCP: t.PCP,
@ -265,7 +268,7 @@ func (d *TestIGD) handlePCPQuery(pkt []byte, src netip.AddrPort) {
func newTestClient(t *testing.T, igd *TestIGD, bus *eventbus.Bus) *Client { func newTestClient(t *testing.T, igd *TestIGD, bus *eventbus.Bus) *Client {
var c *Client var c *Client
c = NewClient(Config{ c = NewClient(Config{
Logf: t.Logf, Logf: tstest.WhileTestRunningLogger(t),
NetMon: netmon.NewStatic(), NetMon: netmon.NewStatic(),
ControlKnobs: new(controlknobs.Knobs), ControlKnobs: new(controlknobs.Knobs),
EventBus: bus, EventBus: bus,

6
net/portmapper/portmapper_test.go
View File

@ -61,7 +61,7 @@ func TestClientProbeThenMap(t *testing.T) {
} }
func TestProbeIntegration(t *testing.T) { func TestProbeIntegration(t *testing.T) {
igd, err := NewTestIGD(t.Logf, TestIGDOptions{PMP: true, PCP: true, UPnP: true}) igd, err := NewTestIGD(t, TestIGDOptions{PMP: true, PCP: true, UPnP: true})
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
@ -95,7 +95,7 @@ func TestProbeIntegration(t *testing.T) {
} }
func TestPCPIntegration(t *testing.T) { func TestPCPIntegration(t *testing.T) {
igd, err := NewTestIGD(t.Logf, TestIGDOptions{PMP: false, PCP: true, UPnP: false}) igd, err := NewTestIGD(t, TestIGDOptions{PMP: false, PCP: true, UPnP: false})
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
@ -137,7 +137,7 @@ func TestGetUPnPErrorsMetric(t *testing.T) {
} }
func TestUpdateEvent(t *testing.T) { func TestUpdateEvent(t *testing.T) {
igd, err := NewTestIGD(t.Logf, TestIGDOptions{PCP: true}) igd, err := NewTestIGD(t, TestIGDOptions{PCP: true})
if err != nil { if err != nil {
t.Fatalf("Create test gateway: %v", err) t.Fatalf("Create test gateway: %v", err)
} }

2
net/portmapper/select_test.go
View File

@ -28,7 +28,7 @@ func TestSelectBestService(t *testing.T) {
} }
// Run a fake IGD server to respond to UPnP requests. // Run a fake IGD server to respond to UPnP requests.
igd, err := NewTestIGD(t.Logf, TestIGDOptions{UPnP: true}) igd, err := NewTestIGD(t, TestIGDOptions{UPnP: true})
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }

12
net/portmapper/upnp_test.go
View File

@ -533,7 +533,7 @@ func TestGetUPnPClient(t *testing.T) {
} }
func TestGetUPnPPortMapping(t *testing.T) { func TestGetUPnPPortMapping(t *testing.T) {
igd, err := NewTestIGD(t.Logf, TestIGDOptions{UPnP: true}) igd, err := NewTestIGD(t, TestIGDOptions{UPnP: true})
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
@ -672,7 +672,7 @@ func TestGetUPnPPortMapping_LeaseDuration(t *testing.T) {
"DeletePortMapping": "", // Do nothing for test "DeletePortMapping": "", // Do nothing for test
} }
igd, err := NewTestIGD(t.Logf, TestIGDOptions{UPnP: true}) igd, err := NewTestIGD(t, TestIGDOptions{UPnP: true})
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
@ -722,7 +722,7 @@ func TestGetUPnPPortMapping_LeaseDuration(t *testing.T) {
// //
// See https://github.com/tailscale/tailscale/issues/10911 // See https://github.com/tailscale/tailscale/issues/10911
func TestGetUPnPPortMapping_NoValidServices(t *testing.T) { func TestGetUPnPPortMapping_NoValidServices(t *testing.T) {
igd, err := NewTestIGD(t.Logf, TestIGDOptions{UPnP: true}) igd, err := NewTestIGD(t, TestIGDOptions{UPnP: true})
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
@ -753,7 +753,7 @@ func TestGetUPnPPortMapping_NoValidServices(t *testing.T) {
// Tests the legacy behaviour with the pre-UPnP standard portmapping service. // Tests the legacy behaviour with the pre-UPnP standard portmapping service.
func TestGetUPnPPortMapping_Legacy(t *testing.T) { func TestGetUPnPPortMapping_Legacy(t *testing.T) {
igd, err := NewTestIGD(t.Logf, TestIGDOptions{UPnP: true}) igd, err := NewTestIGD(t, TestIGDOptions{UPnP: true})
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
@ -796,7 +796,7 @@ func TestGetUPnPPortMapping_Legacy(t *testing.T) {
} }
func TestGetUPnPPortMappingNoResponses(t *testing.T) { func TestGetUPnPPortMappingNoResponses(t *testing.T) {
igd, err := NewTestIGD(t.Logf, TestIGDOptions{UPnP: true}) igd, err := NewTestIGD(t, TestIGDOptions{UPnP: true})
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
@ -912,7 +912,7 @@ func TestGetUPnPPortMapping_Invalid(t *testing.T) {
"127.0.0.1", "127.0.0.1",
} { } {
t.Run(responseAddr, func(t *testing.T) { t.Run(responseAddr, func(t *testing.T) {
igd, err := NewTestIGD(t.Logf, TestIGDOptions{UPnP: true}) igd, err := NewTestIGD(t, TestIGDOptions{UPnP: true})
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }

3
tstest/log.go
View File

@ -13,6 +13,7 @@ import (
"go4.org/mem" "go4.org/mem"
"tailscale.com/types/logger" "tailscale.com/types/logger"
"tailscale.com/util/testenv"
) )
type testLogWriter struct { type testLogWriter struct {
@ -149,7 +150,7 @@ func (ml *MemLogger) String() string {
// WhileTestRunningLogger returns a logger.Logf that logs to t.Logf until the // WhileTestRunningLogger returns a logger.Logf that logs to t.Logf until the
// test finishes, at which point it no longer logs anything. // test finishes, at which point it no longer logs anything.
func WhileTestRunningLogger(t testing.TB) logger.Logf { func WhileTestRunningLogger(t testenv.TB) logger.Logf {
var ( var (
mu sync.RWMutex mu sync.RWMutex
done bool done bool