-
Notifications
You must be signed in to change notification settings - Fork 379
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use a ten second timeout for join requests
This prevents k0s from hanging on idle network connections, such as random glitches, badly behaving load balancers, and so on. Add a context to the JoinClient methods and call them with a context that times out after 10 seconds when joining a controller. This has the side effect that joining will also be interruptible by SIGTERM and Ctrl+C. Signed-off-by: Tom Wieczorek <twieczorek@mirantis.com>
- Loading branch information
Showing
4 changed files
with
157 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| /* | ||
| Copyright 2024 k0s authors | ||
| 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, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package token_test | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "net" | ||
| "net/http" | ||
| "net/url" | ||
| "testing" | ||
|
|
||
| "github.com/k0sproject/k0s/pkg/token" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestJoinClient_Cancellation(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| for _, test := range []struct { | ||
| name string | ||
| funcUnderTest func(context.Context, *token.JoinClient) error | ||
| }{ | ||
| {"GetCA", func(ctx context.Context, c *token.JoinClient) error { | ||
| _, err := c.GetCA(ctx) | ||
| return err | ||
| }}, | ||
| {"JoinEtcd", func(ctx context.Context, c *token.JoinClient) error { | ||
| _, err := c.JoinEtcd(ctx, "") | ||
| return err | ||
| }}, | ||
| } { | ||
| test := test | ||
| t.Run(test.name, func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| clientContext, cancelClientContext := context.WithCancelCause(context.Background()) | ||
| joinURL := startFakeJoinServer(t, func(_ http.ResponseWriter, req *http.Request) { | ||
| cancelClientContext(assert.AnError) // cancel the client's context | ||
| <-req.Context().Done() // block forever | ||
| }) | ||
|
|
||
| kubeconfig, err := token.GenerateKubeconfig(joinURL.String(), nil, "", "") | ||
| require.NoError(t, err) | ||
| tok, err := token.JoinEncode(bytes.NewReader(kubeconfig)) | ||
| require.NoError(t, err) | ||
|
|
||
| underTest, err := token.JoinClientFromToken(tok) | ||
| require.NoError(t, err) | ||
|
|
||
| err = test.funcUnderTest(clientContext, underTest) | ||
| assert.ErrorIs(t, err, context.Canceled, "Expected the call to be cancelled") | ||
| assert.Same(t, context.Cause(clientContext), assert.AnError, "Didn't receive an HTTP request") | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func startFakeJoinServer(t *testing.T, handler func(http.ResponseWriter, *http.Request)) *url.URL { | ||
| requestCtx, cancelRequests := context.WithCancel(context.Background()) | ||
|
|
||
| listener, err := net.Listen("tcp", "localhost:0") | ||
| if err != nil { | ||
| require.NoError(t, err) | ||
| } | ||
|
|
||
| server := &http.Server{ | ||
| Addr: listener.Addr().String(), | ||
| Handler: http.HandlerFunc(handler), | ||
| BaseContext: func(net.Listener) context.Context { return requestCtx }, | ||
| } | ||
|
|
||
| serverError := make(chan error) | ||
| go func() { defer close(serverError); serverError <- server.Serve(listener) }() | ||
|
|
||
| t.Cleanup(func() { | ||
| cancelRequests() | ||
| if !assert.NoError(t, server.Shutdown(context.Background()), "Couldn't shutdown HTTP server") { | ||
| return | ||
| } | ||
| assert.ErrorIs(t, <-serverError, http.ErrServerClosed, "HTTP server terminated unexpectedly") | ||
| }) | ||
|
|
||
| return &url.URL{Scheme: "http", Host: server.Addr} | ||
| } |