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
|
// Copyright 2020 PingCAP, 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,
// See the License for the specific language governing permissions and
// limitations under the License.
package module
import (
"bytes"
"context"
"fmt"
"time"
"github.com/pingcap/errors"
"github.com/pingcap/tiup/pkg/cluster/ctxt"
"github.com/pingcap/tiup/pkg/cluster/executor"
"github.com/pingcap/tiup/pkg/utils"
"go.uber.org/zap"
)
// WaitForConfig is the configurations of WaitFor module.
type WaitForConfig struct {
Port int // Port number to poll.
Sleep time.Duration // Duration to sleep between checks, default 1 second.
// Choices:
// started
// stopped
// When checking a port started will ensure the port is open, stopped will check that it is closed
State string
Timeout time.Duration // Maximum duration to wait for.
}
// WaitFor is the module used to wait for some condition.
type WaitFor struct {
c WaitForConfig
}
// NewWaitFor create a WaitFor instance.
func NewWaitFor(c WaitForConfig) *WaitFor {
if c.Sleep == 0 {
c.Sleep = time.Second
}
if c.Timeout == 0 {
c.Timeout = time.Second * 60
}
if c.State == "" {
c.State = "started"
}
w := &WaitFor{
c: c,
}
return w
}
// Execute the module return nil if successfully wait for the event.
func (w *WaitFor) Execute(ctx context.Context, e ctxt.Executor) (err error) {
pattern := fmt.Appendf(nil, ":%d ", w.c.Port)
retryOpt := utils.RetryOption{
Delay: w.c.Sleep,
Timeout: w.c.Timeout,
}
if err := utils.Retry(func() error {
// only listing TCP ports
stdout, _, err := executor.UnwarpCheckPointExecutor(e).Execute(ctx, "ss -ltn", false)
if err == nil {
switch w.c.State {
case "started":
if bytes.Contains(stdout, pattern) {
return nil
}
case "stopped":
if !bytes.Contains(stdout, pattern) {
return nil
}
}
return errors.New("still waiting for port state to be satisfied")
}
return err
}, retryOpt); err != nil {
zap.L().Debug("retry error", zap.Error(err))
return errors.Errorf("timed out waiting for port %d to be %s after %s", w.c.Port, w.c.State, w.c.Timeout)
}
return nil
}
|
