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
|
// Copyright 2022 The OpenZipkin 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 grpc_test
import (
"context"
"github.com/onsi/ginkgo/v2"
"github.com/onsi/gomega"
"google.golang.org/grpc"
"google.golang.org/grpc/metadata"
"github.com/openzipkin/zipkin-go"
"github.com/openzipkin/zipkin-go/model"
"github.com/openzipkin/zipkin-go/propagation/b3"
service "github.com/openzipkin/zipkin-go/proto/testing"
"github.com/openzipkin/zipkin-go/reporter"
)
var _ = ginkgo.Describe("gRPC Server", func() {
var (
conn *grpc.ClientConn
client service.HelloServiceClient
)
ginkgo.BeforeEach(func() {
serverIDGenerator.reset()
serverReporter.Flush()
})
ginkgo.AfterEach(func() {
_ = conn.Close()
})
ginkgo.Context("with defaults", func() {
ginkgo.BeforeEach(func() {
var err error
conn, err = grpc.Dial(serverAddr, grpc.WithInsecure())
gomega.Expect(err).ToNot(gomega.HaveOccurred())
client = service.NewHelloServiceClient(conn)
})
ginkgo.It("creates a span and context", func() {
resp, err := client.Hello(context.Background(), &service.HelloRequest{Payload: "Hello"})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
var spans []model.SpanModel
gomega.Eventually(func() []model.SpanModel {
spans = serverReporter.Flush()
return spans
}).Should(gomega.HaveLen(1))
span := spans[0]
gomega.Expect(span.Kind).To(gomega.Equal(model.Server))
// Set to local host for tests, might be IPv4 or IPv6 not worth checking the actual address.
gomega.Expect(span.RemoteEndpoint.Empty()).To(gomega.BeFalse())
gomega.Expect(span.Name).To(gomega.Equal("zipkin.testing.HelloService.Hello"))
gomega.Expect(span.Tags).To(gomega.BeEmpty())
spanCtx := resp.GetSpanContext()
gomega.Expect(spanCtx).To(gomega.HaveLen(2))
gomega.Expect(spanCtx).To(gomega.HaveKeyWithValue(b3.TraceID, "0000000001000000"))
gomega.Expect(spanCtx).To(gomega.HaveKeyWithValue(b3.SpanID, "0000000001000000"))
})
ginkgo.It("propagates parent", func() {
// Manually create a client context
tracer, err := zipkin.NewTracer(
reporter.NewNoopReporter(),
zipkin.WithIDGenerator(newSequentialIDGenerator(1)))
gomega.Expect(tracer, err).ToNot(gomega.BeNil(), "failed to create Zipkin tracer")
testSpan := tracer.StartSpan("test")
md := metadata.New(nil)
_ = b3.InjectGRPC(&md)(testSpan.Context())
ctx := metadata.NewOutgoingContext(context.Background(), md)
resp, err := client.Hello(ctx, &service.HelloRequest{Payload: "Hello"})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
var spans []model.SpanModel
gomega.Eventually(func() []model.SpanModel {
spans = serverReporter.Flush()
return spans
}).Should(gomega.HaveLen(1))
span := spans[0]
gomega.Expect(span.Kind).To(gomega.Equal(model.Server))
gomega.Expect(span.RemoteEndpoint.Empty()).To(gomega.BeFalse())
gomega.Expect(span.Name).To(gomega.Equal("zipkin.testing.HelloService.Hello"))
gomega.Expect(span.Tags).To(gomega.BeEmpty())
spanCtx := resp.GetSpanContext()
gomega.Expect(spanCtx).To(gomega.HaveLen(3))
gomega.Expect(spanCtx).To(gomega.HaveKeyWithValue(b3.SpanID, "0000000001000000"))
gomega.Expect(spanCtx).To(gomega.HaveKeyWithValue(b3.TraceID, "0000000000000001"))
gomega.Expect(spanCtx).To(gomega.HaveKeyWithValue(b3.ParentSpanID, "0000000000000001"))
})
ginkgo.It("tags with error code", func() {
_, err := client.Hello(context.Background(), &service.HelloRequest{Payload: "fail"})
gomega.Expect(err).To(gomega.HaveOccurred())
var spans []model.SpanModel
gomega.Eventually(func() []model.SpanModel {
spans = serverReporter.Flush()
return spans
}).Should(gomega.HaveLen(1))
gomega.Expect(spans[0].Tags).To(gomega.HaveLen(2))
gomega.Expect(spans[0].Tags).To(gomega.HaveKeyWithValue("grpc.status_code", "ABORTED"))
gomega.Expect(spans[0].Tags).To(gomega.HaveKeyWithValue(string(zipkin.TagError), "ABORTED"))
})
})
ginkgo.Context("with joined spans and server tags", func() {
ginkgo.BeforeEach(func() {
var err error
conn, err = grpc.Dial(customServerAddr, grpc.WithInsecure())
gomega.Expect(err).ToNot(gomega.HaveOccurred())
client = service.NewHelloServiceClient(conn)
})
ginkgo.It("has server tags", func() {
resp, err := client.Hello(context.Background(), &service.HelloRequest{Payload: "Hello"})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
var spans []model.SpanModel
gomega.Eventually(func() []model.SpanModel {
spans = serverReporter.Flush()
return spans
}).Should(gomega.HaveLen(1))
span := spans[0]
gomega.Expect(span.RemoteEndpoint.Empty()).To(gomega.BeFalse())
gomega.Expect(span.Tags).To(gomega.HaveLen(1))
gomega.Expect(span.Tags).To(gomega.HaveKeyWithValue("default", "tag"))
spanCtx := resp.GetSpanContext()
gomega.Expect(spanCtx).To(gomega.HaveLen(2))
gomega.Expect(spanCtx).To(gomega.HaveKeyWithValue(b3.TraceID, "0000000001000000"))
gomega.Expect(spanCtx).To(gomega.HaveKeyWithValue(b3.SpanID, "0000000001000000"))
})
ginkgo.It("joins with caller", func() {
// Manually create a client context
tracer, err := zipkin.NewTracer(
reporter.NewNoopReporter(),
zipkin.WithIDGenerator(newSequentialIDGenerator(1)))
gomega.Expect(tracer, err).ToNot(gomega.BeNil(), "failed to create Zipkin tracer")
testSpan := tracer.StartSpan("test")
md := metadata.New(nil)
_ = b3.InjectGRPC(&md)(testSpan.Context())
ctx := metadata.NewOutgoingContext(context.Background(), md)
var resp *service.HelloResponse
resp, err = client.Hello(ctx, &service.HelloRequest{Payload: "Hello"})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
spanCtx := resp.GetSpanContext()
gomega.Expect(spanCtx).To(gomega.HaveLen(2))
gomega.Expect(spanCtx).To(gomega.HaveKeyWithValue(b3.TraceID, "0000000000000001"))
gomega.Expect(spanCtx).To(gomega.HaveKeyWithValue(b3.SpanID, "0000000000000001"))
})
})
})
|
