forked from DataDog/dd-trace-go
/
sqltest.go
221 lines (191 loc) · 5.81 KB
/
sqltest.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
// Unless explicitly stated otherwise all files in this repository are licensed
// under the Apache License Version 2.0.
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2016-2019 Datadog, Inc.
package sqltest // import "gopkg.in/DataDog/dd-trace-go.v1/contrib/internal/sqltest"
import (
"context"
"database/sql"
"fmt"
"log"
"testing"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/ext"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/mocktracer"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
"github.com/stretchr/testify/assert"
)
// Prepare sets up a table with the given name in both the MySQL and Postgres databases and returns
// a teardown function which will drop it.
func Prepare(tableName string) func() {
queryDrop := fmt.Sprintf("DROP TABLE IF EXISTS %s", tableName)
queryCreate := fmt.Sprintf("CREATE TABLE %s (id integer NOT NULL DEFAULT '0', name text)", tableName)
mysql, err := sql.Open("mysql", "test:test@tcp(127.0.0.1:3306)/test")
defer mysql.Close()
if err != nil {
log.Fatal(err)
}
mysql.Exec(queryDrop)
mysql.Exec(queryCreate)
postgres, err := sql.Open("postgres", "postgres://postgres:postgres@127.0.0.1:5432/postgres?sslmode=disable")
defer postgres.Close()
if err != nil {
log.Fatal(err)
}
postgres.Exec(queryDrop)
postgres.Exec(queryCreate)
return func() {
mysql.Exec(queryDrop)
postgres.Exec(queryDrop)
}
}
// RunAll applies a sequence of unit tests to check the correct tracing of sql features.
func RunAll(t *testing.T, cfg *Config) {
cfg.mockTracer = mocktracer.Start()
defer cfg.mockTracer.Stop()
for name, test := range map[string]func(*Config) func(*testing.T){
"Ping": testPing,
"Query": testQuery,
"Statement": testStatement,
"BeginRollback": testBeginRollback,
"Exec": testExec,
} {
t.Run(name, test(cfg))
}
}
func testPing(cfg *Config) func(*testing.T) {
return func(t *testing.T) {
cfg.mockTracer.Reset()
assert := assert.New(t)
err := cfg.DB.Ping()
assert.Nil(err)
spans := cfg.mockTracer.FinishedSpans()
assert.Len(spans, 1)
span := spans[0]
assert.Equal(cfg.ExpectName, span.OperationName())
for k, v := range cfg.ExpectTags {
assert.Equal(v, span.Tag(k), "Value mismatch on tag %s", k)
}
}
}
func testQuery(cfg *Config) func(*testing.T) {
query := fmt.Sprintf("SELECT id, name FROM %s LIMIT 5", cfg.TableName)
return func(t *testing.T) {
cfg.mockTracer.Reset()
assert := assert.New(t)
rows, err := cfg.DB.Query(query)
defer rows.Close()
assert.Nil(err)
spans := cfg.mockTracer.FinishedSpans()
assert.Len(spans, 1)
span := spans[0]
assert.Equal(cfg.ExpectName, span.OperationName())
for k, v := range cfg.ExpectTags {
assert.Equal(v, span.Tag(k), "Value mismatch on tag %s", k)
}
}
}
func testStatement(cfg *Config) func(*testing.T) {
query := "INSERT INTO %s(name) VALUES(%s)"
switch cfg.DriverName {
case "postgres":
query = fmt.Sprintf(query, cfg.TableName, "$1")
case "mysql":
query = fmt.Sprintf(query, cfg.TableName, "?")
}
return func(t *testing.T) {
cfg.mockTracer.Reset()
assert := assert.New(t)
stmt, err := cfg.DB.Prepare(query)
assert.Equal(nil, err)
spans := cfg.mockTracer.FinishedSpans()
assert.Len(spans, 1)
span := spans[0]
assert.Equal(cfg.ExpectName, span.OperationName())
for k, v := range cfg.ExpectTags {
assert.Equal(v, span.Tag(k), "Value mismatch on tag %s", k)
}
cfg.mockTracer.Reset()
_, err2 := stmt.Exec("New York")
assert.Equal(nil, err2)
spans = cfg.mockTracer.FinishedSpans()
assert.Len(spans, 1)
span = spans[0]
assert.Equal(cfg.ExpectName, span.OperationName())
for k, v := range cfg.ExpectTags {
assert.Equal(v, span.Tag(k), "Value mismatch on tag %s", k)
}
}
}
func testBeginRollback(cfg *Config) func(*testing.T) {
return func(t *testing.T) {
cfg.mockTracer.Reset()
assert := assert.New(t)
tx, err := cfg.DB.Begin()
assert.Equal(nil, err)
spans := cfg.mockTracer.FinishedSpans()
assert.Len(spans, 1)
span := spans[0]
assert.Equal(cfg.ExpectName, span.OperationName())
for k, v := range cfg.ExpectTags {
assert.Equal(v, span.Tag(k), "Value mismatch on tag %s", k)
}
cfg.mockTracer.Reset()
err = tx.Rollback()
assert.Equal(nil, err)
spans = cfg.mockTracer.FinishedSpans()
assert.Len(spans, 1)
span = spans[0]
assert.Equal(cfg.ExpectName, span.OperationName())
for k, v := range cfg.ExpectTags {
assert.Equal(v, span.Tag(k), "Value mismatch on tag %s", k)
}
}
}
func testExec(cfg *Config) func(*testing.T) {
return func(t *testing.T) {
assert := assert.New(t)
query := fmt.Sprintf("INSERT INTO %s(name) VALUES('New York')", cfg.TableName)
parent, ctx := tracer.StartSpanFromContext(context.Background(), "test.parent",
tracer.ServiceName("test"),
tracer.ResourceName("parent"),
)
cfg.mockTracer.Reset()
tx, err := cfg.DB.BeginTx(ctx, nil)
assert.Equal(nil, err)
_, err = tx.ExecContext(ctx, query)
assert.Equal(nil, err)
err = tx.Commit()
assert.Equal(nil, err)
parent.Finish() // flush children
spans := cfg.mockTracer.FinishedSpans()
assert.Len(spans, 4)
var span mocktracer.Span
for _, s := range spans {
if s.OperationName() == cfg.ExpectName && s.Tag(ext.ResourceName) == query {
span = s
}
}
assert.NotNil(span, "span not found")
for k, v := range cfg.ExpectTags {
assert.Equal(v, span.Tag(k), "Value mismatch on tag %s", k)
}
for _, s := range spans {
if s.OperationName() == cfg.ExpectName && s.Tag(ext.ResourceName) == "Commit" {
span = s
}
}
assert.NotNil(span, "span not found")
for k, v := range cfg.ExpectTags {
assert.Equal(v, span.Tag(k), "Value mismatch on tag %s", k)
}
}
}
// Config holds the test configuration.
type Config struct {
*sql.DB
mockTracer mocktracer.Tracer
DriverName string
TableName string
ExpectName string
ExpectTags map[string]interface{}
}