forked from FerretDB/FerretDB
-
Notifications
You must be signed in to change notification settings - Fork 0
/
listener.go
262 lines (212 loc) · 7.93 KB
/
listener.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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
// Copyright 2021 FerretDB Inc.
//
// 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 setup
import (
"context"
"errors"
"net/url"
"os"
"path/filepath"
"github.com/stretchr/testify/require"
"go.opentelemetry.io/otel"
"go.uber.org/zap"
"github.com/FerretDB/FerretDB/internal/clientconn"
"github.com/FerretDB/FerretDB/internal/handler/registry"
"github.com/FerretDB/FerretDB/internal/util/observability"
"github.com/FerretDB/FerretDB/internal/util/state"
"github.com/FerretDB/FerretDB/internal/util/testutil"
"github.com/FerretDB/FerretDB/internal/util/testutil/testtb"
)
// unixSocketPath returns temporary Unix domain socket path for that test.
func unixSocketPath(tb testtb.TB) string {
tb.Helper()
// do not use tb.TempDir() because generated path is too long on macOS
f, err := os.CreateTemp("", "ferretdb-*.sock")
require.NoError(tb, err)
// remove file so listener could create it (and remove it itself on stop)
err = f.Close()
require.NoError(tb, err)
err = os.Remove(f.Name())
require.NoError(tb, err)
return f.Name()
}
// listenerMongoDBURI builds MongoDB URI for in-process FerretDB.
func listenerMongoDBURI(tb testtb.TB, hostPort, unixSocketPath string, tlsAndAuth bool) string {
tb.Helper()
var host string
if hostPort != "" {
require.Empty(tb, unixSocketPath, "both hostPort and unixSocketPath are set")
host = hostPort
} else {
host = unixSocketPath
}
var user *url.Userinfo
var q url.Values
if tlsAndAuth {
require.Empty(tb, unixSocketPath, "unixSocketPath cannot be used with TLS")
certsRoot := filepath.Join(Dir(tb), "..", "..", "build", "certs")
// we don't separate TLS and auth just for simplicity of our test configurations
q = url.Values{
"tls": []string{"true"},
"tlsCertificateKeyFile": []string{filepath.Join(certsRoot, "client.pem")},
"tlsCaFile": []string{filepath.Join(certsRoot, "rootCA-cert.pem")},
"authMechanism": []string{"PLAIN"},
}
user = url.UserPassword("username", "password")
}
// TODO https://github.com/FerretDB/FerretDB/issues/1507
u := &url.URL{
Scheme: "mongodb",
Host: host,
Path: "/",
User: user,
RawQuery: q.Encode(),
}
return u.String()
}
// setupListener starts in-process FerretDB server that runs until ctx is canceled.
// It returns basic MongoDB URI for that listener.
func setupListener(tb testtb.TB, ctx context.Context, logger *zap.Logger) string {
tb.Helper()
_, span := otel.Tracer("").Start(ctx, "setupListener")
defer span.End()
defer observability.FuncCall(ctx)()
require.Empty(tb, *targetURLF, "-target-url must be empty for in-process FerretDB")
var handler string
switch *targetBackendF {
case "ferretdb-postgresql":
require.NotEmpty(tb, *postgreSQLURLF, "-postgresql-url must be set for %q", *targetBackendF)
require.Empty(tb, *sqliteURLF, "-sqlite-url must be empty for %q", *targetBackendF)
require.Empty(tb, *mysqlURLF, "-mysql-url must be empty for %q", *targetBackendF)
require.Empty(tb, *hanaURLF, "-hana-url must be empty for %q", *targetBackendF)
handler = "postgresql"
case "ferretdb-sqlite":
require.Empty(tb, *postgreSQLURLF, "-postgresql-url must be empty for %q", *targetBackendF)
require.NotEmpty(tb, *sqliteURLF, "-sqlite-url must be set for %q", *targetBackendF)
require.Empty(tb, *mysqlURLF, "-mysql-url must be empty for %q", *targetBackendF)
require.Empty(tb, *hanaURLF, "-hana-url must be empty for %q", *targetBackendF)
handler = "sqlite"
case "ferretdb-mysql":
require.Empty(tb, *postgreSQLURLF, "-postgresql-url must be empty for %q", *targetBackendF)
require.Empty(tb, *sqliteURLF, "-sqlite-url must be empty for %q", *targetBackendF)
require.NotEmpty(tb, *mysqlURLF, "-mysql-url must be empty for %q", *targetBackendF)
require.Empty(tb, *hanaURLF, "-hana-url must be set for %q", *targetBackendF)
handler = "mysql"
case "ferretdb-hana":
require.Empty(tb, *postgreSQLURLF, "-postgresql-url must be empty for %q", *targetBackendF)
require.Empty(tb, *sqliteURLF, "-sqlite-url must be empty for %q", *targetBackendF)
require.Empty(tb, *mysqlURLF, "-mysql-url must be empty for %q", *targetBackendF)
require.NotEmpty(tb, *hanaURLF, "-hana-url must be set for %q", *targetBackendF)
handler = "hana"
case "mongodb":
tb.Fatal("can't start in-process MongoDB")
default:
// that should be caught by Startup function
panic("not reached")
}
// use per-test PostgreSQL database to prevent handler's/backend's metadata registry
// read schemas owned by concurrent tests
postgreSQLURLF := *postgreSQLURLF
if postgreSQLURLF != "" {
postgreSQLURLF = testutil.TestPostgreSQLURI(tb, ctx, postgreSQLURLF)
}
// use per-test directory to prevent handler's/backend's metadata registry
// read databases owned by concurrent tests
sqliteURL := *sqliteURLF
if sqliteURL != "" {
sqliteURL = testutil.TestSQLiteURI(tb, sqliteURL)
}
// user per-test MySQL database to prevent handler's/backend's metadata registry
// read databases owned by concurrent tests
mysqlURL := *mysqlURLF
if mysqlURL != "" {
mysqlURL = testutil.TestMySQLURI(tb, ctx, mysqlURL)
}
sp, err := state.NewProvider("")
require.NoError(tb, err)
handlerOpts := ®istry.NewHandlerOpts{
Logger: logger,
ConnMetrics: listenerMetrics.ConnMetrics,
StateProvider: sp,
PostgreSQLURL: postgreSQLURLF,
SQLiteURL: sqliteURL,
MySQLURL: mysqlURL,
HANAURL: *hanaURLF,
TestOpts: registry.TestOpts{
DisablePushdown: *disablePushdownF,
CappedCleanupPercentage: 20,
CappedCleanupInterval: 0,
EnableNewAuth: true,
BatchSize: *batchSizeF,
},
}
h, closeBackend, err := registry.NewHandler(handler, handlerOpts)
require.NoError(tb, err)
tb.Cleanup(closeBackend)
listenerOpts := clientconn.NewListenerOpts{
ProxyAddr: *targetProxyAddrF,
Mode: clientconn.NormalMode,
Metrics: listenerMetrics,
Handler: h,
Logger: logger,
TestRecordsDir: filepath.Join(Dir(tb), "..", "..", "tmp", "records"),
}
if *targetProxyAddrF != "" {
listenerOpts.Mode = clientconn.DiffNormalMode
}
if *targetTLSF && *targetUnixSocketF {
tb.Fatal("Both -target-tls and -target-unix-socket are set.")
}
switch {
case *targetTLSF:
certsRoot := filepath.Join(Dir(tb), "..", "..", "build", "certs")
listenerOpts.TLS = "127.0.0.1:0"
listenerOpts.TLSCertFile = filepath.Join(certsRoot, "server-cert.pem")
listenerOpts.TLSKeyFile = filepath.Join(certsRoot, "server-key.pem")
listenerOpts.TLSCAFile = filepath.Join(certsRoot, "rootCA-cert.pem")
case *targetUnixSocketF:
listenerOpts.Unix = unixSocketPath(tb)
default:
listenerOpts.TCP = "127.0.0.1:0"
}
l := clientconn.NewListener(&listenerOpts)
runDone := make(chan struct{})
go func() {
defer close(runDone)
err := l.Run(ctx)
if err == nil || errors.Is(err, context.Canceled) {
logger.Info("Listener stopped without error")
} else {
logger.Error("Listener stopped", zap.Error(err))
}
}()
// ensure that all listener's and handler's logs are written before test ends
tb.Cleanup(func() {
<-runDone
})
var hostPort, unixSocketPath string
var tlsAndAuth bool
switch {
case *targetTLSF:
hostPort = l.TLSAddr().String()
tlsAndAuth = true
case *targetUnixSocketF:
unixSocketPath = l.UnixAddr().String()
default:
hostPort = l.TCPAddr().String()
}
uri := listenerMongoDBURI(tb, hostPort, unixSocketPath, tlsAndAuth)
logger.Info("Listener started", zap.String("handler", handler), zap.String("uri", uri))
return uri
}