/
tracing_test.go
224 lines (169 loc) · 7.12 KB
/
tracing_test.go
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
package opencensus_test
import (
"context"
"testing"
"github.com/ThreeDotsLabs/watermill"
"github.com/ThreeDotsLabs/watermill/message"
"github.com/ThreeDotsLabs/watermill/pubsub/gochannel"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.opencensus.io/trace"
opencensus "github.com/czeslavo/watermill-opencensus"
)
func TestTracingMiddleware(t *testing.T) {
msg := message.NewMessage(watermill.NewULID(), nil)
ctx, parentSpan := trace.StartSpan(context.Background(), "parent")
msg.SetContext(ctx)
tracingMiddleware := opencensus.TracingMiddleware(func(m *message.Message) ([]*message.Message, error) {
spanCtx := trace.FromContext(m.Context())
require.NotNil(t, spanCtx)
require.Equal(t, parentSpan.SpanContext().TraceID, spanCtx.SpanContext().TraceID, "span context should have the same trace id as the parent's one")
require.NotEqual(t, parentSpan.SpanContext().SpanID, spanCtx.SpanContext().SpanID, "span context should have different span id than parent")
return []*message.Message{sampleMsg()}, nil
})
producedMsgs, err := tracingMiddleware(msg)
require.NoError(t, err)
require.NotEmpty(t, producedMsgs)
for _, producedMsg := range producedMsgs {
spanContext, ok := opencensus.GetSpanContext(producedMsg)
require.True(t, ok)
assert.Equal(t, parentSpan.SpanContext().TraceID, spanContext.TraceID, "produced msg should have same trace id as the parent's one")
assert.NotEqual(t, parentSpan.SpanContext().SpanID, spanContext.SpanID, "produced msg should have span ID different than parent")
}
}
func TestTracingMiddleware_no_parent_span(t *testing.T) {
tracingMiddleware := opencensus.TracingMiddleware(func(m *message.Message) ([]*message.Message, error) {
require.NotNil(t, trace.FromContext(m.Context()), "new span context should be propagated when there's no parent")
return nil, nil
})
msg := message.NewMessage(watermill.NewULID(), nil)
_, err := tracingMiddleware(msg)
require.NoError(t, err)
}
func sampleMsg() *message.Message {
return message.NewMessage(watermill.NewULID(), nil)
}
func TestPublisherDecorator_propagate_span_context(t *testing.T) {
logger := watermill.NewStdLogger(true, false)
pubsub := gochannel.NewGoChannel(gochannel.Config{}, logger)
publisher := opencensus.PublisherDecorator(pubsub, logger)
msgCh, err := pubsub.Subscribe(context.Background(), "topic")
require.NoError(t, err)
msg := message.NewMessage(watermill.NewULID(), nil)
// create a span and set the message's context to the span's one
ctx, _ := trace.StartSpan(context.Background(), "span_name")
msg.SetContext(ctx)
err = publisher.Publish("topic", msg)
require.NoError(t, err)
// wait for the message with propagated span context
receivedMsg := <-msgCh
defer receivedMsg.Ack()
sc, ok := opencensus.GetSpanContext(receivedMsg)
require.True(t, ok)
require.NotNil(t, sc)
}
func TestTracingMiddleware_message_received_event_added(t *testing.T) {
exporter := registerTestExporter()
tracingMiddleware := opencensus.TracingMiddleware(func(m *message.Message) ([]*message.Message, error) {
require.NotNil(t, trace.FromContext(m.Context()), "new span context should be propagated when there's no parent")
return nil, nil
})
msgPayload := message.Payload("PAYLOAD")
msg := message.NewMessage(watermill.NewULID(), msgPayload)
msg.Metadata.Set("opencensus_event_id", "100")
_, err := tracingMiddleware(msg)
require.NoError(t, err)
require.Len(t, exporter.collected, 1)
spanData := exporter.collected[0]
require.Len(t, spanData.MessageEvents, 1)
messageEvent := exporter.collected[0].MessageEvents[0]
require.Equal(t, int64(100), messageEvent.MessageID)
require.Equal(t, trace.MessageEventTypeRecv, messageEvent.EventType)
require.Equal(t, int64(len(msgPayload)), messageEvent.UncompressedByteSize)
require.Equal(t, int64(0), messageEvent.CompressedByteSize)
}
func TestTracingMiddleware_payload_attribute(t *testing.T) {
exporter := registerTestExporter()
tracingMiddleware := opencensus.TracingMiddleware(func(m *message.Message) ([]*message.Message, error) {
require.NotNil(t, trace.FromContext(m.Context()), "new span context should be propagated when there's no parent")
return nil, nil
})
msgPayload := message.Payload("PAYLOAD")
msg := message.NewMessage(watermill.NewULID(), msgPayload)
msg.Metadata.Set("opencensus_event_id", "100")
_, err := tracingMiddleware(msg)
require.NoError(t, err)
require.Len(t, exporter.collected, 1)
spanData := exporter.collected[0]
require.Equal(t, "PAYLOAD", spanData.Attributes["event_payload"])
}
func TestPublisherDecorator_no_span_context_in_msg(t *testing.T) {
logger := watermill.NewStdLogger(true, false)
pubsub := gochannel.NewGoChannel(gochannel.Config{}, logger)
publisher := opencensus.PublisherDecorator(pubsub, logger)
msgCh, err := pubsub.Subscribe(context.Background(), "topic")
require.NoError(t, err)
msg := message.NewMessage(watermill.NewULID(), nil)
err = publisher.Publish("topic", msg)
require.NoError(t, err)
receivedMsg := <-msgCh
defer receivedMsg.Ack()
_, ok := opencensus.GetSpanContext(receivedMsg)
require.False(t, ok)
}
func TestPublisherDecorator_message_sent_event_added(t *testing.T) {
exporter := registerTestExporter()
logger := watermill.NewStdLogger(true, false)
pubsub := gochannel.NewGoChannel(gochannel.Config{}, logger)
publisher := opencensus.PublisherDecorator(pubsub, logger)
msgPayload := message.Payload("PAYLOAD")
msg := message.NewMessage(watermill.NewULID(), msgPayload)
ctx, span := trace.StartSpan(context.Background(), "testSpan")
msg.SetContext(ctx)
err := publisher.Publish("topic", msg)
require.NoError(t, err)
span.End()
require.Len(t, exporter.collected, 1)
spanData := exporter.collected[0]
require.Len(t, spanData.MessageEvents, 1)
messageEvent := exporter.collected[0].MessageEvents[0]
require.NotEqual(t, 0, messageEvent.MessageID)
require.Equal(t, trace.MessageEventTypeSent, messageEvent.EventType)
require.Equal(t, int64(len(msgPayload)), messageEvent.UncompressedByteSize)
require.Equal(t, int64(0), messageEvent.CompressedByteSize)
}
func TestPublisherDecorator_payload_attribute(t *testing.T) {
exporter := registerTestExporter()
logger := watermill.NewStdLogger(true, false)
pubsub := gochannel.NewGoChannel(gochannel.Config{}, logger)
publisher := opencensus.PublisherDecorator(pubsub, logger)
msgPayload := message.Payload("PAYLOAD")
msg := message.NewMessage(watermill.NewULID(), msgPayload)
ctx, span := trace.StartSpan(context.Background(), "testSpan")
msg.SetContext(ctx)
err := publisher.Publish("topic", msg)
require.NoError(t, err)
span.End()
require.Len(t, exporter.collected, 1)
spanData := exporter.collected[0]
require.Equal(t, "PAYLOAD", spanData.Attributes["event_payload"])
}
type exporterMock struct {
collected []*trace.SpanData
}
func newExporterMock() *exporterMock {
return &exporterMock{
collected: make([]*trace.SpanData, 0),
}
}
func (t *exporterMock) ExportSpan(s *trace.SpanData) {
t.collected = append(t.collected, s)
}
func registerTestExporter() *exporterMock {
exporter := newExporterMock()
trace.RegisterExporter(exporter)
trace.ApplyConfig(trace.Config{
DefaultSampler: trace.ProbabilitySampler(1.0),
})
return exporter
}