-
Notifications
You must be signed in to change notification settings - Fork 2
/
terminator_test.go
345 lines (281 loc) · 8.29 KB
/
terminator_test.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
package graterm
import (
"context"
"errors"
"github.com/stretchr/testify/require"
"log"
"os"
"os/signal"
"runtime"
"sync"
"syscall"
"testing"
"time"
)
func TestNewWithSignals(t *testing.T) {
rootCtx, cancel := context.WithCancel(context.Background())
defer cancel()
got, ctx := NewWithSignals(rootCtx, syscall.SIGINT, syscall.SIGTERM)
require.NotNil(t, got)
require.NotNil(t, ctx)
require.NotNil(t, got.hooksMx)
require.NotNil(t, got.hooks)
require.NotNil(t, got.wg)
require.NotNil(t, got.cancelFunc)
require.NotNil(t, got.log)
}
func TestTerminator_Register(t *testing.T) {
t.Parallel()
t.Run("add_only_one_hook_with_negative_timeout", func(t *testing.T) {
rootCtx, cancel := context.WithCancel(context.Background())
defer cancel()
terminator, ctx := NewWithSignals(rootCtx, syscall.SIGINT, syscall.SIGTERM)
require.NotNil(t, ctx)
terminator.WithOrder(777).Register(-1, func(_ context.Context) {}) // negative timeout
require.Equal(t, 1, len(terminator.hooks))
got, ok := terminator.hooks[Order(777)]
require.True(t, ok)
require.Equal(t, 1, len(got))
require.Equal(t, time.Minute, got[0].timeout)
})
t.Run("add_only_one_hook", func(t *testing.T) {
rootCtx, cancel := context.WithCancel(context.Background())
defer cancel()
terminator, ctx := NewWithSignals(rootCtx, syscall.SIGINT, syscall.SIGTERM)
require.NotNil(t, ctx)
terminator.WithOrder(1).
WithName("Hook").
Register(1*time.Second, func(_ context.Context) {})
require.Equal(t, 1, len(terminator.hooks))
got, ok := terminator.hooks[Order(1)]
require.True(t, ok)
require.Equal(t, 1, len(got))
})
t.Run("add_with_different_order", func(t *testing.T) {
rootCtx, cancel := context.WithCancel(context.Background())
defer cancel()
terminator, ctx := NewWithSignals(rootCtx, syscall.SIGINT, syscall.SIGTERM)
require.NotNil(t, ctx)
terminator.WithOrder(1).
WithName("Hook1").
Register(1*time.Second, func(_ context.Context) {})
terminator.WithOrder(2).
WithName("Hook2").
Register(1*time.Second, func(_ context.Context) {})
require.Equal(t, 2, len(terminator.hooks))
got, ok := terminator.hooks[Order(1)]
require.True(t, ok)
require.Equal(t, 1, len(got))
got2, ok2 := terminator.hooks[Order(2)]
require.True(t, ok2)
require.Equal(t, 1, len(got2))
})
t.Run("add_with_the_same_order", func(t *testing.T) {
rootCtx, cancel := context.WithCancel(context.Background())
defer cancel()
terminator, ctx := NewWithSignals(rootCtx, syscall.SIGINT, syscall.SIGTERM)
require.NotNil(t, ctx)
terminator.WithOrder(1).
WithName("Hook1").
Register(1*time.Second, func(_ context.Context) {})
terminator.WithOrder(1).
WithName("Hook2").
Register(1*time.Second, func(_ context.Context) {})
require.Equal(t, 1, len(terminator.hooks))
got, ok := terminator.hooks[Order(1)]
require.True(t, ok)
require.Equal(t, 2, len(got))
})
t.Run("panic_in_registered_hook", func(t *testing.T) {
rootCtx, cancel := context.WithCancel(context.Background())
defer cancel()
terminator, ctx := NewWithSignals(rootCtx, syscall.SIGINT, syscall.SIGTERM)
require.NotNil(t, ctx)
terminator.WithOrder(1).
WithName("Panicked Hook1").
Register(1*time.Second, func(_ context.Context) { panic(errors.New("panic in Hook1")) })
terminator.WithOrder(2).
WithName("Panicked Hook2").
Register(1*time.Second, func(_ context.Context) { panic(errors.New("panic in Hook2")) })
require.Equal(t, 2, len(terminator.hooks))
cancel()
gotErr := terminator.Wait(ctx, time.Minute) // some long period of time
require.NoError(t, gotErr)
})
}
func TestTerminator_waitShutdown(t *testing.T) {
t.Run("execution_waits_for_the_context_to_be_done_before_proceeding", func(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
terminator, ctx := NewWithSignals(ctx, syscall.SIGINT, syscall.SIGTERM)
require.NotNil(t, ctx)
i := 0
terminator.WithOrder(1).WithName("Hook").Register(time.Second, func(_ context.Context) { i = 1 })
terminator.wg.Add(1)
go terminator.waitShutdown(ctx)
runtime.Gosched()
require.Equal(t, 0, i)
cancel()
terminator.wg.Wait()
require.Equal(t, 1, i)
})
t.Run("hooks_are_executed_in_order", func(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
terminator, ctx := NewWithSignals(ctx, syscall.SIGINT, syscall.SIGTERM)
require.NotNil(t, ctx)
res := make([]int, 0, 4)
terminator.WithOrder(2).WithName("Hook1").Register(time.Second, func(_ context.Context) { res = append(res, 2) })
terminator.WithOrder(4).WithName("Hook2").Register(time.Second, func(_ context.Context) { res = append(res, 4) })
terminator.WithOrder(1).WithName("Hook3").Register(time.Second, func(_ context.Context) { res = append(res, 1) })
terminator.WithOrder(3).WithName("Hook4").Register(time.Second, func(_ context.Context) { res = append(res, 3) })
cancel()
terminator.wg.Add(1)
go terminator.waitShutdown(ctx)
terminator.wg.Wait()
require.Equal(t, []int{1, 2, 3, 4}, res)
})
t.Run("timeouted_hooks_are_ignored", func(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
terminator, ctx := NewWithSignals(ctx, syscall.SIGINT, syscall.SIGTERM)
require.NotNil(t, ctx)
t1Mx := sync.Mutex{}
t1 := 0
t2 := 0
goLeakWg := sync.WaitGroup{}
goLeakWg.Add(1)
terminator.WithOrder(1).WithName("Hook1").
Register(time.Nanosecond, func(_ context.Context) {
defer goLeakWg.Done()
time.Sleep(500 * time.Millisecond)
t1Mx.Lock()
defer t1Mx.Unlock()
t1 = 1
})
terminator.WithOrder(2).
WithName("Hook2").
Register(time.Second, func(_ context.Context) { t2 = 1 })
cancel()
terminator.wg.Add(1)
go terminator.waitShutdown(ctx)
terminator.wg.Wait()
t1Mx.Lock()
require.Equal(t, 0, t1)
require.Equal(t, 1, t2) // checking before Unlock to be sure that 2nd hook won't be just executed after unlocking
t1Mx.Unlock()
goLeakWg.Wait()
})
}
func TestTerminator_Wait(t *testing.T) {
tests := []struct {
name string
timeout time.Duration
wouldDone bool
wantErr bool
}{
{
name: "canceled",
wouldDone: true,
timeout: time.Minute,
wantErr: false,
},
{
name: "timeout",
wouldDone: false,
timeout: time.Millisecond,
wantErr: true,
},
}
for _, tt := range tests {
tt := tt
t.Run(tt.name, func(t *testing.T) {
rootCtx, cancel := context.WithCancel(context.Background())
defer cancel()
terminator, ctx := NewWithSignals(rootCtx, syscall.SIGINT, syscall.SIGTERM)
require.NotNil(t, ctx)
terminator.wg.Add(1)
done := make(chan struct{})
var waitErr error
go func() {
waitErr = terminator.Wait(ctx, tt.timeout)
close(done)
}()
cancel()
if tt.wouldDone {
terminator.wg.Done()
} else {
defer terminator.wg.Done()
}
select {
case <-time.After(time.Second):
t.Fatal("waiting group is done timed out")
case <-done:
}
if tt.wantErr {
require.Error(t, waitErr)
} else {
require.NoError(t, waitErr)
}
})
}
}
func Test_withSignals(t *testing.T) {
t.Run("termination_on_SIGHUP", func(t *testing.T) {
rootCtx, cancel := context.WithCancel(context.Background())
defer cancel()
chSignals := make(chan os.Signal, 1)
sig := syscall.SIGHUP
defer signal.Stop(chSignals)
gotCtx, gotCancelFunc := withSignals(rootCtx, chSignals, sig)
err := syscall.Kill(syscall.Getpid(), sig)
require.NoError(t, err)
require.NotNil(t, gotCtx)
require.NotNil(t, gotCancelFunc)
require.NoError(t, gotCtx.Err())
})
}
func TestTerminator_SetLogger(t *testing.T) {
type args struct {
log Logger
}
tests := []struct {
name string
args args
wantLog Logger
}{
{
name: "default_logger",
args: args{
log: log.Default(),
},
wantLog: log.Default(),
},
{
name: "private_noop_logger",
args: args{
log: log.Default(),
},
wantLog: log.Default(),
},
{
name: "nil_logger",
args: args{
log: nil,
},
wantLog: noopLogger{},
},
}
for _, tt := range tests {
tt := tt
t.Run(tt.name, func(t *testing.T) {
rootCtx, cancel := context.WithCancel(context.Background())
defer cancel()
got, ctx := NewWithSignals(rootCtx, os.Interrupt)
require.NotNil(t, got)
require.NotNil(t, ctx)
got.SetLogger(tt.args.log)
require.Equal(t, tt.wantLog, got.log)
})
}
}