-
Notifications
You must be signed in to change notification settings - Fork 1
/
ready.go
476 lines (415 loc) · 10.9 KB
/
ready.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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
package pm
import (
"context"
"database/sql"
"fmt"
"io"
"log"
"net"
"net/http"
"regexp"
"strings"
"time"
"github.com/creasty/defaults"
"github.com/go-resty/resty/v2"
mysqlDriver "github.com/go-sql-driver/mysql"
"github.com/pkg/errors"
"github.com/telnet2/pm/cmd"
"github.com/telnet2/pm/debug"
"go.mongodb.org/mongo-driver/mongo"
"go.mongodb.org/mongo-driver/mongo/options"
)
func init() {
// Suppress MySQL driver error
_ = mysqlDriver.SetLogger(log.New(io.Discard, "", 0))
}
var (
// type assertion
_ ReadyChecker = &DummyChecker{}
_ ReadyChecker = &LogChecker{}
_ ReadyChecker = &HttpChecker{}
_ ReadyChecker = &MySqlChecker{}
_ ReadyChecker = &MongoDbChecker{}
_ ReadyChecker = &ShellChecker{}
)
var (
_logReady = debug.NewDebugLogger("pm:ready")
)
// NewReadyChecker is a factory returning a concrete ReadyChecker
func NewReadyChecker(id string, spec *ReadySpec) ReadyChecker {
if spec == nil {
return &DummyChecker{}
}
if spec.StdoutLog != "" {
_logReady.Infof("[%s] create stdout log checker", id)
return &LogChecker{id: id, spec: spec}
}
if spec.Http != nil {
return &HttpChecker{id: id, spec: spec}
}
if spec.MySql != nil {
return &MySqlChecker{id: id, spec: spec}
}
if spec.MongoDb != nil {
return &MongoDbChecker{id: id, spec: spec}
}
if spec.Shell != nil {
return &ShellChecker{id: id, spec: spec}
}
if spec.Tcp != nil {
return &TcpChecker{id: id, spec: spec}
}
return &DummyChecker{}
}
// DummyChecker do nothing
type DummyChecker struct {
}
func (*DummyChecker) Init(context.Context, *Runnable) error {
return nil
}
func (*DummyChecker) WaitForReady(context.Context, *Runnable) error {
return nil
}
// ShellChecker is a a shell Script based ready checker.
// A shell command is executed periodically until it returns 0 exit code.
type ShellChecker struct {
id string
spec *ReadySpec
}
// Init is called before the runnable starts.
func (sc *ShellChecker) Init(ctx context.Context, r *Runnable) error {
return nil
}
// WaitForReady waits until a given runnable is ready.
func (rc *ShellChecker) WaitForReady(ctx context.Context, _ *Runnable) error {
spec := rc.spec.Shell
if spec.Interval.Duration == 0 {
spec.Interval.Duration = time.Second * 3
}
if rc.spec.Timeout.Duration == 0 {
rc.spec.Timeout.Duration = time.Minute
}
ctx, cancel := context.WithTimeout(ctx, rc.spec.Timeout.Duration)
tick := time.NewTicker(spec.Interval.Duration)
defer func() {
tick.Stop()
cancel()
}()
for {
exeCmd := cmd.NewCmd(fmt.Sprintf("%s.ready_check", rc.id), spec.Command)
_logReady.Printf("[%s]: %s", exeCmd.Name, spec.Command)
select {
case status := <-exeCmd.Start():
_logReady.Printf("[%s]: exit %d", exeCmd.Name, status.Exit)
if status.Error != nil {
_logReady.Printf("[%s]: error %v", exeCmd.Name, status.Error)
}
if status.Exit == 0 {
return nil
}
<-tick.C
case <-ctx.Done():
// timeout occurred
_logReady.Printf("[%s]: timeout", exeCmd.Name)
_ = exeCmd.Stop()
return errors.New("timeout error")
}
}
}
// Implements ReadyChecker
type LogChecker struct {
id string
spec *ReadySpec
logListener chan string
re *regexp.Regexp
}
// Init is called before the runnable starts.
func (rc *LogChecker) Init(ctx context.Context, r *Runnable) error {
re, err := regexp.Compile(rc.spec.StdoutLog)
if err != nil {
_logReady.Errorf("[%s] regex compile error: %s", rc.id, rc.spec.StdoutLog)
} else {
_logReady.Infof("[%s] regex compile ok: %s", rc.id, rc.spec.StdoutLog)
rc.re = re
}
if r.Cmd == nil || r.Cmd.StdoutPub == nil {
return errors.New("invalid runnable")
}
_logReady.Infof("subscribe stdout to %s", rc.id)
rc.logListener = r.Cmd.StdoutPub.Subscribe()
return nil
}
// WaitForReady waits until a given runnable is ready.
func (rc *LogChecker) WaitForReady(ctx context.Context, _ *Runnable) error {
for {
select {
case msg, ok := <-rc.logListener:
if msg != "" {
_logReady.Debugf("[%s|stdout] %s", rc.id, msg)
if rc.re == nil {
if strings.Contains(msg, rc.spec.StdoutLog) {
return nil
}
} else {
if rc.re.MatchString(msg) {
return nil
}
}
}
if !ok {
// the listener channel will be closed when the process exits.
return errors.Errorf("[%s] process exited", rc.id)
}
case <-ctx.Done():
return errors.New("timeout error")
}
}
}
type HttpChecker struct {
id string
spec *ReadySpec
}
// Init does nothing.
func (rc *HttpChecker) Init(ctx context.Context, _ *Runnable) error {
return nil
}
// WaitForReady makes an http call to the url and matches the response with the expectation.
func (rc *HttpChecker) WaitForReady(ctx context.Context, _ *Runnable) error {
spec := rc.spec.Http
if err := defaults.Set(spec); err != nil {
_logReady.Errorf("fail to set defaults: %v", err)
}
if spec.Interval == 0 {
spec.Interval = time.Second * 3
}
if rc.spec.Timeout.Duration == 0 {
rc.spec.Timeout.Duration = time.Minute
}
if spec.Expect == nil {
// expect 200 OK
spec.Expect = &HttpReadyExpect{Status: 200}
}
// compile expect.body regex
var re *regexp.Regexp
if spec.Expect.BodyRegex != "" {
var err error
re, err = regexp.Compile(spec.Expect.BodyRegex)
if err != nil {
_logReady.Errorf("[%s] fail to compile regex: %s", spec.Expect.BodyRegex)
}
}
ctx, cancel := context.WithTimeout(ctx, rc.spec.Timeout.Duration)
tick := time.NewTicker(spec.Interval)
defer func() {
cancel()
tick.Stop()
}()
cli := resty.New()
// No redirection but use the last response.
cli.SetRedirectPolicy(resty.RedirectPolicyFunc(
func(req *http.Request, via []*http.Request) error {
return http.ErrUseLastResponse
}))
var err error
for {
var res *resty.Response
expect := spec.Expect
// Set the context with timeout
res, err = cli.R().SetContext(ctx).Get(spec.URL)
// if there was no error in the connection, validate the response with the expectation.
if err == nil {
ok := true
if expect.Status != 0 {
if res.StatusCode() != expect.Status {
ok = false
err = errors.Errorf("[%s] status code mismatch %d != %d", rc.id, expect.Status, res.StatusCode())
}
}
if ok && re != nil {
ok = ok && re.Match(res.Body())
}
if ok {
// match header values
for k, v := range spec.Expect.Headers {
var matched bool
matched, err = regexp.MatchString(v, res.Header().Get(k))
if err == nil {
ok = ok && matched
if !matched {
err = errors.Errorf("[%s] header %s mismatch: %s != %s", rc.id, k, v, res.Header().Get(k))
}
} else {
_logReady.Errorf("[%s] http.expect.headers.%s regex error: v", k, v)
}
}
}
if ok {
return nil
}
}
select {
case <-tick.C:
// repeat
case <-ctx.Done():
return err
}
}
}
type TcpChecker struct {
id string
spec *ReadySpec
n int
}
func (c *TcpChecker) RetryCount() int {
return c.n
}
// Init is called before the runnable starts.
func (c *TcpChecker) Init(ctx context.Context, r *Runnable) error {
return nil
}
// WaitForReady waits until the port is open.
func (c *TcpChecker) WaitForReady(ctx context.Context, _ *Runnable) error {
spec := c.spec.Tcp
if spec.Interval.Duration == 0 {
spec.Interval.Duration = time.Second * 3
}
if c.spec.Timeout.Duration == 0 {
c.spec.Timeout.Duration = time.Minute
}
ctx, cancel := context.WithTimeout(ctx, c.spec.Timeout.Duration)
tick := time.NewTicker(spec.Interval.Duration)
defer func() {
cancel()
tick.Stop()
}()
for c.n = 0; ; c.n++ {
cli, err := net.DialTimeout("tcp", fmt.Sprintf("%s:%d", spec.Host, spec.Port), time.Second)
if err == nil {
_ = cli.Close()
return nil
}
select {
case <-tick.C:
// repeat
case <-ctx.Done():
return err
}
}
}
type MongoDbChecker struct {
id string
spec *ReadySpec
}
// Init does nothing.
func (rc *MongoDbChecker) Init(ctx context.Context, r *Runnable) error {
return nil
}
// WaitForReady makes an http call to the url and matches the response with the expectation.
func (rc *MongoDbChecker) WaitForReady(ctx context.Context, r *Runnable) error {
spec := rc.spec.MongoDb
if err := defaults.Set(spec); err != nil {
_logReady.Errorf("fail to set defaults: %v", err)
}
if spec.Interval == 0 {
spec.Interval = time.Second * 3
}
if rc.spec.Timeout.Duration == 0 {
rc.spec.Timeout.Duration = time.Minute
}
ctx, cancel := context.WithTimeout(ctx, rc.spec.Timeout.Duration)
tick := time.NewTicker(spec.Interval)
defer func() {
cancel()
tick.Stop()
}()
cliOpts := options.Client().ApplyURI(spec.URI)
var err error
for {
var mongoCli *mongo.Client
// mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]
mongoCli, err = mongo.Connect(ctx, cliOpts)
if err == nil {
if err = mongoCli.Ping(ctx, nil); err == nil {
_logReady.Printf("[mongo] ready: %s", spec.URI)
return nil
} else {
_logReady.Printf("[mongo] ping failed: %s error: %v", spec.URI, err)
}
} else {
_logReady.Printf("[mongo] connect failed: %s error: %v", spec.URI, err)
}
var cmdDone <-chan struct{}
if r != nil && r.Cmd != nil {
cmdDone = r.Cmd.Done()
}
select {
case <-tick.C:
// repeat
case <-cmdDone:
// if it is already shutdown
cmdStatus := r.Cmd.Status()
return fmt.Errorf("[%s] is already stopped: %d => %v", rc.id, cmdStatus.Exit, cmdStatus.Error)
case <-ctx.Done():
return err
}
}
}
type MySqlChecker struct {
id string
spec *ReadySpec
}
// Init does nothing.
func (rc *MySqlChecker) Init(ctx context.Context, r *Runnable) error {
return nil
}
// WaitForReady makes an http call to the url and matches the response with the expectation.
func (rc *MySqlChecker) WaitForReady(ctx context.Context, r *Runnable) error {
spec := rc.spec.MySql
if err := defaults.Set(spec); err != nil {
_logReady.Errorf("fail to set defaults: %v", err)
}
if spec.Interval == 0 {
spec.Interval = time.Second * 3
}
if rc.spec.Timeout.Duration == 0 {
rc.spec.Timeout.Duration = time.Minute
}
ctx, cancel := context.WithTimeout(ctx, rc.spec.Timeout.Duration)
tick := time.NewTicker(spec.Interval)
defer func() {
cancel()
tick.Stop()
}()
var err error
for {
var db *sql.DB
dsn := fmt.Sprintf("%s:%s@%s(%s)/%s?timeout=1s", spec.User, spec.Password, spec.Network, spec.Addr, spec.Database)
_logReady.Infof("[%s] checking mysql: %s", rc.id, dsn)
db, err = sql.Open("mysql", dsn)
if err == nil {
_, err = db.QueryContext(ctx, fmt.Sprintf("select 1 from %s", spec.Table))
if err == nil {
_logReady.Debugf("[%s] is ready", rc.id)
return nil
} else {
_logReady.Debugf("[%s] ready check error: %v", rc.id, err)
}
} else {
_logReady.Debugf("[%s] ready check error: %v", rc.id, err)
}
var cmdDone <-chan struct{}
if r != nil && r.Cmd != nil {
cmdDone = r.Cmd.Done()
}
select {
case <-tick.C:
// repeat
case <-cmdDone:
// if it is already shutdown
cmdStatus := r.Cmd.Status()
return fmt.Errorf("[%s] is already stopped: %d => %v", rc.id, cmdStatus.Exit, cmdStatus.Error)
case <-ctx.Done():
return err
}
}
}