summaryrefslogtreecommitdiffhomepage
path: root/wgengine/watchdog_test.go
blob: a0ce9cf07965261113057b6ef565573f913e477f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
// Copyright (c) Tailscale Inc & contributors
// SPDX-License-Identifier: BSD-3-Clause

//go:build !js

package wgengine

import (
	"runtime"
	"sync"
	"testing"
	"time"

	"tailscale.com/health"
	"tailscale.com/util/eventbus/eventbustest"
	"tailscale.com/util/usermetric"
)

func TestWatchdog(t *testing.T) {
	t.Parallel()

	var maxWaitMultiple time.Duration = 1
	if runtime.GOOS == "darwin" {
		// Work around slow close syscalls on Big Sur with content filter Network Extensions installed.
		// See https://github.com/tailscale/tailscale/issues/1598.
		maxWaitMultiple = 15
	}

	t.Run("default-watchdog-does-not-fire", func(t *testing.T) {
		t.Parallel()
		bus := eventbustest.NewBus(t)
		ht := health.NewTracker(bus)
		reg := new(usermetric.Registry)
		e, err := NewFakeUserspaceEngine(t.Logf, 0, ht, reg, bus)
		if err != nil {
			t.Fatal(err)
		}

		e = NewWatchdog(e)
		e.(*watchdogEngine).maxWait = maxWaitMultiple * 150 * time.Millisecond
		e.(*watchdogEngine).logf = t.Logf
		e.(*watchdogEngine).fatalf = t.Fatalf

		e.RequestStatus()
		e.RequestStatus()
		e.RequestStatus()
		e.Close()
	})
}

func TestWatchdogMetrics(t *testing.T) {
	tests := []struct {
		name       string
		events     []watchdogEvent
		wantCounts map[watchdogEvent]int64
	}{
		{
			name:   "single-event-types",
			events: []watchdogEvent{RequestStatus, PeerForIPEvent, Ping},
			wantCounts: map[watchdogEvent]int64{
				RequestStatus:  1,
				PeerForIPEvent: 1,
				Ping:           1,
			},
		},
		{
			name:   "repeated-events",
			events: []watchdogEvent{RequestStatus, RequestStatus, Ping, RequestStatus},
			wantCounts: map[watchdogEvent]int64{
				RequestStatus: 3,
				Ping:          1,
			},
		},
	}

	// For swallowing fatalf calls and stack traces
	logf := func(format string, args ...any) {}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			clearMetrics(t)
			bus := eventbustest.NewBus(t)
			ht := health.NewTracker(bus)
			reg := new(usermetric.Registry)
			e, err := NewFakeUserspaceEngine(logf, 0, ht, reg, bus)
			if err != nil {
				t.Fatal(err)
			}
			e = NewWatchdog(e)
			w := e.(*watchdogEngine)
			w.maxWait = 1 * time.Microsecond
			w.logf = logf
			w.fatalf = logf

			var wg sync.WaitGroup
			wg.Add(len(tt.events))

			for _, ev := range tt.events {
				blocked := make(chan struct{})
				w.watchdog(ev, func() {
					defer wg.Done()
					<-blocked
				})
				close(blocked)
			}
			wg.Wait()

			// Check individual event counts
			for ev, want := range tt.wantCounts {
				m, ok := watchdogMetrics[ev]
				if !ok {
					t.Fatalf("no metric found for event %q", ev)
				}
				got := m.Value()
				if got != want {
					t.Errorf("got %d metric events for %q, want %d", got, ev, want)
				}
			}

			// Check total count for Any
			m, ok := watchdogMetrics[Any]
			if !ok {
				t.Fatalf("no Any metric found")
			}
			got := m.Value()
			if got != int64(len(tt.events)) {
				t.Errorf("got %d metric events for Any, want %d", got, len(tt.events))
			}
		})
	}
}

func clearMetrics(t *testing.T) {
	t.Helper()
	if watchdogMetrics == nil {
		return
	}
	for _, m := range watchdogMetrics {
		m.Set(0)
	}
}