apiservers: add synchronous shutdown mechanism on SIGTERM+INT
This commit is contained in:
@@ -22,9 +22,12 @@ import (
|
||||
"fmt"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
"github.com/stretchr/testify/assert"
|
||||
|
||||
"k8s.io/apimachinery/pkg/util/wait"
|
||||
)
|
||||
|
||||
type result struct {
|
||||
@@ -36,7 +39,7 @@ func testServer(n string) *Server {
|
||||
return &Server{
|
||||
SimpleUsage: n,
|
||||
Long: fmt.Sprintf("A simple server named %s", n),
|
||||
Run: func(s *Server, args []string) error {
|
||||
Run: func(s *Server, args []string, stopCh <-chan struct{}) error {
|
||||
s.hk.Printf("%s Run\n", s.Name())
|
||||
return nil
|
||||
},
|
||||
@@ -46,12 +49,47 @@ func testServerError(n string) *Server {
|
||||
return &Server{
|
||||
SimpleUsage: n,
|
||||
Long: fmt.Sprintf("A simple server named %s that returns an error", n),
|
||||
Run: func(s *Server, args []string) error {
|
||||
Run: func(s *Server, args []string, stopCh <-chan struct{}) error {
|
||||
s.hk.Printf("%s Run\n", s.Name())
|
||||
return errors.New("server returning error")
|
||||
},
|
||||
}
|
||||
}
|
||||
func testStopChRespectingServer(n string) *Server {
|
||||
return &Server{
|
||||
SimpleUsage: n,
|
||||
Long: fmt.Sprintf("A simple server named %s", n),
|
||||
Run: func(s *Server, args []string, stopCh <-chan struct{}) error {
|
||||
s.hk.Printf("%s Run\n", s.Name())
|
||||
<-stopCh
|
||||
return nil
|
||||
},
|
||||
RespectsStopCh: true,
|
||||
}
|
||||
}
|
||||
func testStopChIgnoringServer(n string) *Server {
|
||||
return &Server{
|
||||
SimpleUsage: n,
|
||||
Long: fmt.Sprintf("A simple server named %s", n),
|
||||
Run: func(s *Server, args []string, stopCh <-chan struct{}) error {
|
||||
<-wait.NeverStop // this leaks obviously, but we don't care about one go routine more or less in test
|
||||
return nil
|
||||
},
|
||||
RespectsStopCh: false,
|
||||
}
|
||||
}
|
||||
func testStopChRespectingServerWithError(n string) *Server {
|
||||
return &Server{
|
||||
SimpleUsage: n,
|
||||
Long: fmt.Sprintf("A simple server named %s", n),
|
||||
Run: func(s *Server, args []string, stopCh <-chan struct{}) error {
|
||||
s.hk.Printf("%s Run\n", s.Name())
|
||||
<-stopCh
|
||||
return errors.New("server returning error")
|
||||
},
|
||||
RespectsStopCh: true,
|
||||
}
|
||||
}
|
||||
|
||||
const defaultCobraMessage = "default message from cobra command"
|
||||
const defaultCobraSubMessage = "default sub-message from cobra command"
|
||||
@@ -91,7 +129,7 @@ func testCobraCommand(n string) *Server {
|
||||
s := &Server{
|
||||
SimpleUsage: n,
|
||||
Long: fmt.Sprintf("A server named %s which uses a cobra command", n),
|
||||
Run: func(s *Server, args []string) error {
|
||||
Run: func(s *Server, args []string, stopCh <-chan struct{}) error {
|
||||
cobraServer = s
|
||||
cmd.SetOutput(s.hk.Out())
|
||||
cmd.SetArgs(args)
|
||||
@@ -102,7 +140,7 @@ func testCobraCommand(n string) *Server {
|
||||
|
||||
return s
|
||||
}
|
||||
func runFull(t *testing.T, args string) *result {
|
||||
func runFull(t *testing.T, args string, stopCh <-chan struct{}) *result {
|
||||
buf := new(bytes.Buffer)
|
||||
hk := HyperKube{
|
||||
Name: "hyperkube",
|
||||
@@ -114,11 +152,14 @@ func runFull(t *testing.T, args string) *result {
|
||||
hk.AddServer(testServer("test2"))
|
||||
hk.AddServer(testServer("test3"))
|
||||
hk.AddServer(testServerError("test-error"))
|
||||
hk.AddServer(testStopChIgnoringServer("test-stop-ch-ignoring"))
|
||||
hk.AddServer(testStopChRespectingServer("test-stop-ch-respecting"))
|
||||
hk.AddServer(testStopChRespectingServerWithError("test-error-stop-ch-respecting"))
|
||||
hk.AddServer(testCobraCommand("test-cobra-command"))
|
||||
|
||||
a := strings.Split(args, " ")
|
||||
t.Logf("Running full with args: %q", a)
|
||||
err := hk.Run(a)
|
||||
err := hk.Run(a, stopCh)
|
||||
|
||||
r := &result{err, buf.String()}
|
||||
t.Logf("Result err: %v, output: %q", r.err, r.output)
|
||||
@@ -127,37 +168,37 @@ func runFull(t *testing.T, args string) *result {
|
||||
}
|
||||
|
||||
func TestRun(t *testing.T) {
|
||||
x := runFull(t, "hyperkube test1")
|
||||
x := runFull(t, "hyperkube test1", wait.NeverStop)
|
||||
assert.Contains(t, x.output, "test1 Run")
|
||||
assert.NoError(t, x.err)
|
||||
}
|
||||
|
||||
func TestLinkRun(t *testing.T) {
|
||||
x := runFull(t, "test1")
|
||||
x := runFull(t, "test1", wait.NeverStop)
|
||||
assert.Contains(t, x.output, "test1 Run")
|
||||
assert.NoError(t, x.err)
|
||||
}
|
||||
|
||||
func TestTopNoArgs(t *testing.T) {
|
||||
x := runFull(t, "hyperkube")
|
||||
x := runFull(t, "hyperkube", wait.NeverStop)
|
||||
assert.EqualError(t, x.err, "no server specified")
|
||||
}
|
||||
|
||||
func TestBadServer(t *testing.T) {
|
||||
x := runFull(t, "hyperkube bad-server")
|
||||
x := runFull(t, "hyperkube bad-server", wait.NeverStop)
|
||||
assert.EqualError(t, x.err, "Server not found: bad-server")
|
||||
assert.Contains(t, x.output, "Usage")
|
||||
}
|
||||
|
||||
func TestTopHelp(t *testing.T) {
|
||||
x := runFull(t, "hyperkube --help")
|
||||
x := runFull(t, "hyperkube --help", wait.NeverStop)
|
||||
assert.NoError(t, x.err)
|
||||
assert.Contains(t, x.output, "all-in-one")
|
||||
assert.Contains(t, x.output, "A simple server named test1")
|
||||
}
|
||||
|
||||
func TestTopFlags(t *testing.T) {
|
||||
x := runFull(t, "hyperkube --help test1")
|
||||
x := runFull(t, "hyperkube --help test1", wait.NeverStop)
|
||||
assert.NoError(t, x.err)
|
||||
assert.Contains(t, x.output, "all-in-one")
|
||||
assert.Contains(t, x.output, "A simple server named test1")
|
||||
@@ -165,14 +206,14 @@ func TestTopFlags(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestTopFlagsBad(t *testing.T) {
|
||||
x := runFull(t, "hyperkube --bad-flag")
|
||||
x := runFull(t, "hyperkube --bad-flag", wait.NeverStop)
|
||||
assert.EqualError(t, x.err, "unknown flag: --bad-flag")
|
||||
assert.Contains(t, x.output, "all-in-one")
|
||||
assert.Contains(t, x.output, "A simple server named test1")
|
||||
}
|
||||
|
||||
func TestServerHelp(t *testing.T) {
|
||||
x := runFull(t, "hyperkube test1 --help")
|
||||
x := runFull(t, "hyperkube test1 --help", wait.NeverStop)
|
||||
assert.NoError(t, x.err)
|
||||
assert.Contains(t, x.output, "A simple server named test1")
|
||||
assert.Contains(t, x.output, "-h, --help")
|
||||
@@ -181,7 +222,7 @@ func TestServerHelp(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestServerFlagsBad(t *testing.T) {
|
||||
x := runFull(t, "hyperkube test1 --bad-flag")
|
||||
x := runFull(t, "hyperkube test1 --bad-flag", wait.NeverStop)
|
||||
assert.EqualError(t, x.err, "unknown flag: --bad-flag")
|
||||
assert.Contains(t, x.output, "A simple server named test1")
|
||||
assert.Contains(t, x.output, "-h, --help")
|
||||
@@ -190,36 +231,91 @@ func TestServerFlagsBad(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestServerError(t *testing.T) {
|
||||
x := runFull(t, "hyperkube test-error")
|
||||
x := runFull(t, "hyperkube test-error", wait.NeverStop)
|
||||
assert.Contains(t, x.output, "test-error Run")
|
||||
assert.EqualError(t, x.err, "server returning error")
|
||||
}
|
||||
|
||||
func TestStopChIgnoringServer(t *testing.T) {
|
||||
stopCh := make(chan struct{})
|
||||
returnedCh := make(chan struct{})
|
||||
var x *result
|
||||
go func() {
|
||||
defer close(returnedCh)
|
||||
x = runFull(t, "hyperkube test-stop-ch-ignoring", stopCh)
|
||||
}()
|
||||
close(stopCh)
|
||||
select {
|
||||
case <-time.After(wait.ForeverTestTimeout):
|
||||
t.Fatalf("%q never returned after stopCh was closed", "hyperkube test-stop-ch-ignoring")
|
||||
case <-returnedCh:
|
||||
}
|
||||
// we cannot be sure that the server had a chance to output anything
|
||||
// assert.Contains(t, x.output, "test-error-stop-ch-ignoring Run")
|
||||
assert.EqualError(t, x.err, "interrupted")
|
||||
}
|
||||
|
||||
func TestStopChRespectingServer(t *testing.T) {
|
||||
stopCh := make(chan struct{})
|
||||
returnedCh := make(chan struct{})
|
||||
var x *result
|
||||
go func() {
|
||||
defer close(returnedCh)
|
||||
x = runFull(t, "hyperkube test-stop-ch-respecting", stopCh)
|
||||
}()
|
||||
close(stopCh)
|
||||
select {
|
||||
case <-time.After(wait.ForeverTestTimeout):
|
||||
t.Fatalf("%q never returned after stopCh was closed", "hyperkube test-stop-ch-respecting")
|
||||
case <-returnedCh:
|
||||
}
|
||||
assert.Contains(t, x.output, "test-stop-ch-respecting Run")
|
||||
assert.Nil(t, x.err)
|
||||
}
|
||||
|
||||
func TestStopChRespectingServerWithError(t *testing.T) {
|
||||
stopCh := make(chan struct{})
|
||||
returnedCh := make(chan struct{})
|
||||
var x *result
|
||||
go func() {
|
||||
defer close(returnedCh)
|
||||
x = runFull(t, "hyperkube test-error-stop-ch-respecting", stopCh)
|
||||
}()
|
||||
close(stopCh)
|
||||
select {
|
||||
case <-time.After(wait.ForeverTestTimeout):
|
||||
t.Fatalf("%q never returned after stopCh was closed", "hyperkube test-error-stop-ch-respecting")
|
||||
case <-returnedCh:
|
||||
}
|
||||
assert.Contains(t, x.output, "test-error-stop-ch-respecting Run")
|
||||
assert.EqualError(t, x.err, "server returning error")
|
||||
}
|
||||
|
||||
func TestCobraCommandHelp(t *testing.T) {
|
||||
x := runFull(t, "hyperkube test-cobra-command --help")
|
||||
x := runFull(t, "hyperkube test-cobra-command --help", wait.NeverStop)
|
||||
assert.NoError(t, x.err)
|
||||
assert.Contains(t, x.output, "A server named test-cobra-command which uses a cobra command")
|
||||
assert.Contains(t, x.output, cobraMessageDesc)
|
||||
}
|
||||
func TestCobraCommandDefaultMessage(t *testing.T) {
|
||||
x := runFull(t, "hyperkube test-cobra-command")
|
||||
x := runFull(t, "hyperkube test-cobra-command", wait.NeverStop)
|
||||
assert.Contains(t, x.output, fmt.Sprintf("msg: %s", defaultCobraMessage))
|
||||
}
|
||||
func TestCobraCommandMessage(t *testing.T) {
|
||||
x := runFull(t, "hyperkube test-cobra-command --msg foobar")
|
||||
x := runFull(t, "hyperkube test-cobra-command --msg foobar", wait.NeverStop)
|
||||
assert.Contains(t, x.output, "msg: foobar")
|
||||
}
|
||||
|
||||
func TestCobraSubCommandHelp(t *testing.T) {
|
||||
x := runFull(t, "hyperkube test-cobra-command subcommand --help")
|
||||
x := runFull(t, "hyperkube test-cobra-command subcommand --help", wait.NeverStop)
|
||||
assert.NoError(t, x.err)
|
||||
assert.Contains(t, x.output, cobraSubMessageDesc)
|
||||
}
|
||||
func TestCobraSubCommandDefaultMessage(t *testing.T) {
|
||||
x := runFull(t, "hyperkube test-cobra-command subcommand")
|
||||
x := runFull(t, "hyperkube test-cobra-command subcommand", wait.NeverStop)
|
||||
assert.Contains(t, x.output, fmt.Sprintf("submsg: %s", defaultCobraSubMessage))
|
||||
}
|
||||
func TestCobraSubCommandMessage(t *testing.T) {
|
||||
x := runFull(t, "hyperkube test-cobra-command subcommand --submsg foobar")
|
||||
x := runFull(t, "hyperkube test-cobra-command subcommand --submsg foobar", wait.NeverStop)
|
||||
assert.Contains(t, x.output, "submsg: foobar")
|
||||
}
|
||||
|
Reference in New Issue
Block a user