-
Notifications
You must be signed in to change notification settings - Fork 782
/
exec.go
220 lines (171 loc) · 4.91 KB
/
exec.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
package config
import (
"fmt"
"os"
"syscall"
"time"
)
const (
// DefaultExecKillSignal is the default signal to send to the process to
// tell it to gracefully terminate.
DefaultExecKillSignal = syscall.SIGINT
// DefaultExecKillTimeout is the maximum amount of time to wait for the
// process to gracefully terminate before force-killing it.
DefaultExecKillTimeout = 30 * time.Second
// DefaultExecTimeout is the default amount of time to wait for a
// command to exit. By default, this is disabled, which means the command
// is allowed to run for an infinite amount of time.
DefaultExecTimeout = 0 * time.Second
)
// DefaultExecReloadSignal is the default signal to send to the process to
// tell it to reload its configuration.
var DefaultExecReloadSignal = (os.Signal)(nil)
// ExecConfig is used to configure the application when it runs in
// exec/supervise mode.
type ExecConfig struct {
// Command is the command to execute and watch as a child process.
Command commandList `mapstructure:"command"`
// Enabled controls if this exec is enabled.
Enabled *bool `mapstructure:"enabled"`
// EnvConfig is the environmental customizations.
Env *EnvConfig `mapstructure:"env"`
// KillSignal is the signal to send to the command to kill it gracefully.
KillSignal *os.Signal `mapstructure:"kill_signal"`
// KillTimeout is the amount of time to give the process to cleanup before
// hard-killing it.
KillTimeout *time.Duration `mapstructure:"kill_timeout"`
// ReloadSignal is the signal to send to the child process when a template
// changes. This tells the child process that templates have
ReloadSignal *os.Signal `mapstructure:"reload_signal"`
// Splay is the maximum amount of random time to wait to signal or kill the
// process. By default this is disabled, but it can be set to low values to
// reduce the "thundering herd" problem where all tasks are restarted at once.
Splay *time.Duration `mapstructure:"splay"`
// Timeout is the maximum amount of time to wait for a command to complete.
// By default, this is 0, which means "wait forever".
Timeout *time.Duration `mapstructure:"timeout"`
}
// commandList is a []string with a common method for testing for content
type commandList []string
func (c commandList) Empty() bool {
return len(c) == 0 || c[0] == ""
}
// DefaultExecConfig returns a configuration that is populated with the
// default values.
func DefaultExecConfig() *ExecConfig {
return &ExecConfig{
Env: DefaultEnvConfig(),
}
}
// Copy returns a deep copy of this configuration.
func (c *ExecConfig) Copy() *ExecConfig {
if c == nil {
return nil
}
var o ExecConfig
o.Command = c.Command
o.Enabled = c.Enabled
if c.Env != nil {
o.Env = c.Env.Copy()
}
o.KillSignal = c.KillSignal
o.KillTimeout = c.KillTimeout
o.ReloadSignal = c.ReloadSignal
o.Splay = c.Splay
o.Timeout = c.Timeout
return &o
}
// Merge combines all values in this configuration with the values in the other
// configuration, with values in the other configuration taking precedence.
// Maps and slices are merged, most other values are overwritten. Complex
// structs define their own merge functionality.
func (c *ExecConfig) Merge(o *ExecConfig) *ExecConfig {
if c == nil {
if o == nil {
return nil
}
return o.Copy()
}
if o == nil {
return c.Copy()
}
r := c.Copy()
if o.Command != nil {
r.Command = o.Command
}
if o.Enabled != nil {
r.Enabled = o.Enabled
}
if o.Env != nil {
r.Env = r.Env.Merge(o.Env)
}
if o.KillSignal != nil {
r.KillSignal = o.KillSignal
}
if o.KillTimeout != nil {
r.KillTimeout = o.KillTimeout
}
if o.ReloadSignal != nil {
r.ReloadSignal = o.ReloadSignal
}
if o.Splay != nil {
r.Splay = o.Splay
}
if o.Timeout != nil {
r.Timeout = o.Timeout
}
return r
}
// Finalize ensures there no nil pointers.
func (c *ExecConfig) Finalize() {
if c.Enabled == nil {
c.Enabled = Bool(!c.Command.Empty())
}
if c.Command == nil {
c.Command = []string{}
}
if c.Env == nil {
c.Env = DefaultEnvConfig()
}
c.Env.Finalize()
if c.KillSignal == nil {
c.KillSignal = Signal(DefaultExecKillSignal)
}
if c.KillTimeout == nil {
c.KillTimeout = TimeDuration(DefaultExecKillTimeout)
}
if c.ReloadSignal == nil {
c.ReloadSignal = Signal(DefaultExecReloadSignal)
}
if c.Splay == nil {
c.Splay = TimeDuration(0 * time.Second)
}
if c.Timeout == nil {
c.Timeout = TimeDuration(DefaultExecTimeout)
}
}
// GoString defines the printable version of this struct.
func (c *ExecConfig) GoString() string {
if c == nil {
return "(*ExecConfig)(nil)"
}
return fmt.Sprintf("&ExecConfig{"+
"Command:%s, "+
"Enabled:%s, "+
"Env:%#v, "+
"KillSignal:%s, "+
"KillTimeout:%s, "+
"ReloadSignal:%s, "+
"Splay:%s, "+
"Timeout:%s"+
"}",
c.Command,
BoolGoString(c.Enabled),
c.Env,
SignalGoString(c.KillSignal),
TimeDurationGoString(c.KillTimeout),
SignalGoString(c.ReloadSignal),
TimeDurationGoString(c.Splay),
TimeDurationGoString(c.Timeout),
)
}