File size: 4,575 Bytes
e36aeda
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
// Copyright 2025 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package trace_test

import (
	"bytes"
	inttrace "internal/trace"
	"internal/trace/testtrace"
	"io"
	"runtime"
	"runtime/trace"
	"slices"
	"testing"
)

func TestSubscribers(t *testing.T) {
	validate := func(t *testing.T, source string, tr []byte) {
		t.Log("validating", source)
		defer func() {
			if t.Failed() {
				testtrace.Dump(t, "TestSubscribers."+source, tr, *dumpTraces)
			}
		}()

		// Prepare to read the trace snapshot.
		r, err := inttrace.NewReader(bytes.NewReader(tr))
		if err != nil {
			t.Errorf("unexpected error creating trace reader for %s: %v", source, err)
			return
		}

		v := testtrace.NewValidator()
		// These platforms can't guarantee a monotonically increasing clock reading in a short trace.
		if runtime.GOOS == "windows" || runtime.GOARCH == "wasm" {
			v.SkipClockSnapshotChecks()
		}
		// Make sure there are Sync events: at the start and end.
		var syncs []int
		evs := 0
		for {
			ev, err := r.ReadEvent()
			if err == io.EOF {
				break
			}
			if err != nil {
				t.Errorf("unexpected error reading trace for %s: %v", source, err)
				break
			}
			if err := v.Event(ev); err != nil {
				t.Errorf("event validation failed: %s", err)
				break
			}
			if ev.Kind() == inttrace.EventSync {
				syncs = append(syncs, evs)
			}
			evs++
		}
		if !t.Failed() {
			ends := []int{syncs[0], syncs[len(syncs)-1]}
			if wantEnds := []int{0, evs - 1}; !slices.Equal(wantEnds, ends) {
				t.Errorf("expected a sync event at each end of the trace, found sync events at %d instead of %d for %s",
					ends, wantEnds, source)
			}
		}
	}

	validateTraces := func(t *testing.T, trace, frTrace *bytes.Buffer) {
		validate(t, "tracer", trace.Bytes())
		validate(t, "flightRecorder", frTrace.Bytes())
	}
	startFlightRecorder := func(t *testing.T) *trace.FlightRecorder {
		fr := trace.NewFlightRecorder(trace.FlightRecorderConfig{})
		if err := fr.Start(); err != nil {
			t.Fatalf("unexpected error creating flight recorder: %v", err)
		}
		return fr
	}
	startTrace := func(t *testing.T, w io.Writer) {
		if err := trace.Start(w); err != nil {
			t.Fatalf("unexpected error starting flight recorder: %v", err)
		}
	}
	stopFlightRecorder := func(t *testing.T, fr *trace.FlightRecorder, w io.Writer) {
		if _, err := fr.WriteTo(w); err != nil {
			t.Fatalf("unexpected error writing trace from flight recorder: %v", err)
		}
		fr.Stop()
	}
	stopTrace := func() {
		trace.Stop()
	}
	t.Run("start(flight)_start(trace)_stop(trace)_stop(flight)", func(t *testing.T) {
		if trace.IsEnabled() {
			t.Skip("skipping because trace is already enabled")
		}
		frBuf := new(bytes.Buffer)
		tBuf := new(bytes.Buffer)
		fr := startFlightRecorder(t)
		defer fr.Stop()
		startTrace(t, tBuf)
		defer trace.Stop()
		stopTrace()
		stopFlightRecorder(t, fr, frBuf)
		validateTraces(t, tBuf, frBuf)
	})
	t.Run("start(trace)_start(flight)_stop(trace)_stop(flight)", func(t *testing.T) {
		if trace.IsEnabled() {
			t.Skip("skipping because trace is already enabled")
		}
		frBuf := new(bytes.Buffer)
		tBuf := new(bytes.Buffer)
		startTrace(t, tBuf)
		defer trace.Stop()
		fr := startFlightRecorder(t)
		defer fr.Stop()
		stopTrace()
		stopFlightRecorder(t, fr, frBuf)
		validateTraces(t, tBuf, frBuf)
	})
	t.Run("start(flight)_stop(flight)_start(trace)_stop(trace)", func(t *testing.T) {
		if trace.IsEnabled() {
			t.Skip("skipping because trace is already enabled")
		}
		frBuf := new(bytes.Buffer)
		tBuf := new(bytes.Buffer)
		fr := startFlightRecorder(t)
		defer fr.Stop()
		stopFlightRecorder(t, fr, frBuf)
		startTrace(t, tBuf)
		defer trace.Stop()
		stopTrace()
		validateTraces(t, tBuf, frBuf)
	})
	t.Run("start(flight)_stop(flight)_start(trace)_stop(trace)", func(t *testing.T) {
		if trace.IsEnabled() {
			t.Skip("skipping because trace is already enabled")
		}
		frBuf := new(bytes.Buffer)
		tBuf := new(bytes.Buffer)
		fr := startFlightRecorder(t)
		defer fr.Stop()
		stopFlightRecorder(t, fr, frBuf)
		startTrace(t, tBuf)
		defer trace.Stop()
		stopTrace()
		validateTraces(t, tBuf, frBuf)
	})
	t.Run("start(flight)_start(trace)_stop(flight)_stop(trace)", func(t *testing.T) {
		if trace.IsEnabled() {
			t.Skip("skipping because trace is already enabled")
		}
		frBuf := new(bytes.Buffer)
		tBuf := new(bytes.Buffer)
		fr := startFlightRecorder(t)
		defer fr.Stop()
		startTrace(t, tBuf)
		defer trace.Stop()
		stopFlightRecorder(t, fr, frBuf)
		stopTrace()
		validateTraces(t, tBuf, frBuf)
	})
}