Files
kubernetes/test/integration/scheduler/serving/endpoints_test.go
2024-12-19 19:52:46 -08:00

272 lines
8.1 KiB
Go

/*
Copyright 2024 The Kubernetes 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 serving
import (
"crypto/tls"
"crypto/x509"
"fmt"
"io"
"net/http"
"os"
"path"
"regexp"
"strings"
"testing"
utilfeature "k8s.io/apiserver/pkg/util/feature"
featuregatetesting "k8s.io/component-base/featuregate/testing"
"k8s.io/component-base/zpages/features"
"k8s.io/klog/v2/ktesting"
kubeapiservertesting "k8s.io/kubernetes/cmd/kube-apiserver/app/testing"
kubeschedulertesting "k8s.io/kubernetes/cmd/kube-scheduler/app/testing"
"k8s.io/kubernetes/test/integration/framework"
)
func TestEndpointHandlers(t *testing.T) {
featuregatetesting.SetFeatureGateDuringTest(t, utilfeature.DefaultFeatureGate, features.ComponentFlagz, true)
server, configStr, _, err := startTestAPIServer(t)
if err != nil {
t.Fatalf("Failed to start kube-apiserver server: %v", err)
}
defer server.TearDownFn()
apiserverConfig, err := os.CreateTemp("", "kubeconfig")
if err != nil {
t.Fatalf("Failed to create config file: %v", err)
}
defer func() {
_ = os.Remove(apiserverConfig.Name())
}()
if _, err = apiserverConfig.WriteString(configStr); err != nil {
t.Fatalf("Failed to write config file: %v", err)
}
brokenConfigStr := strings.ReplaceAll(configStr, "127.0.0.1", "127.0.0.2")
brokenConfig, err := os.CreateTemp("", "kubeconfig")
if err != nil {
t.Fatalf("Failed to create config file: %v", err)
}
if _, err := brokenConfig.WriteString(brokenConfigStr); err != nil {
t.Fatalf("Failed to write config file: %v", err)
}
defer func() {
_ = os.Remove(brokenConfig.Name())
}()
tests := []struct {
name string
path string
useBrokenConfig bool
requestHeader map[string]string
wantResponseCode int
wantResponseBodyRegx string
}{
{
name: "/healthz",
path: "/healthz",
useBrokenConfig: false,
wantResponseCode: http.StatusOK,
},
{
name: "/livez",
path: "/livez",
useBrokenConfig: false,
wantResponseCode: http.StatusOK,
},
{
name: "/livez with ping check",
path: "/livez/ping",
useBrokenConfig: false,
wantResponseCode: http.StatusOK,
},
{
name: "/readyz",
path: "/readyz",
useBrokenConfig: false,
wantResponseCode: http.StatusOK,
},
{
name: "/readyz with sched-handler-sync",
path: "/readyz/sched-handler-sync",
useBrokenConfig: false,
wantResponseCode: http.StatusOK,
},
{
name: "/readyz with shutdown",
path: "/readyz/shutdown",
useBrokenConfig: false,
wantResponseCode: http.StatusOK,
},
{
name: "/readyz with broken apiserver",
path: "/readyz",
useBrokenConfig: true,
wantResponseCode: http.StatusInternalServerError,
},
{
name: "/flagz",
path: "/flagz",
requestHeader: map[string]string{"Accept": "text/plain"},
wantResponseCode: http.StatusOK,
wantResponseBodyRegx: `^\n` +
`kube-scheduler flags\n` +
`Warning: This endpoint is not meant to be machine parseable, ` +
`has no formatting compatibility guarantees and is for debugging purposes only.`,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
tt := tt
_, ctx := ktesting.NewTestContext(t)
configFile := apiserverConfig.Name()
if tt.useBrokenConfig {
configFile = brokenConfig.Name()
}
result, err := kubeschedulertesting.StartTestServer(
ctx,
[]string{"--kubeconfig", configFile, "--leader-elect=false", "--authorization-always-allow-paths", tt.path})
if err != nil {
t.Fatalf("Failed to start kube-scheduler server: %v", err)
}
if result.TearDownFn != nil {
defer result.TearDownFn()
}
client, base, err := clientAndURLFromTestServer(result)
if err != nil {
t.Fatalf("Failed to get client from test server: %v", err)
}
req, err := http.NewRequest("GET", base+tt.path, nil)
if err != nil {
t.Fatalf("failed to request: %v", err)
}
if tt.requestHeader != nil {
for k, v := range tt.requestHeader {
req.Header.Set(k, v)
}
}
r, err := client.Do(req)
if err != nil {
t.Fatalf("failed to GET %s from component: %v", tt.path, err)
}
body, err := io.ReadAll(r.Body)
if err != nil {
t.Fatalf("failed to read response body: %v", err)
}
if err = r.Body.Close(); err != nil {
t.Fatalf("failed to close response body: %v", err)
}
if got, expected := r.StatusCode, tt.wantResponseCode; got != expected {
t.Fatalf("expected http %d at %s of component, got: %d %q", expected, tt.path, got, string(body))
}
if tt.wantResponseBodyRegx != "" {
matched, err := regexp.MatchString(tt.wantResponseBodyRegx, string(body))
if err != nil {
t.Fatalf("failed to compile regex: %v", err)
}
if !matched {
t.Fatalf("response body does not match regex.\nExpected:\n%s\n\nGot:\n%s", tt.wantResponseBodyRegx, string(body))
}
}
})
}
}
// TODO: Make this a util function once there is a unified way to start a testing apiserver so that we can reuse it.
func startTestAPIServer(t *testing.T) (server *kubeapiservertesting.TestServer, apiserverConfig, token string, err error) {
// Insulate this test from picking up in-cluster config when run inside a pod
// We can't assume we have permissions to write to /var/run/secrets/... from a unit test to mock in-cluster config for testing
originalHost := os.Getenv("KUBERNETES_SERVICE_HOST")
if len(originalHost) > 0 {
if err = os.Setenv("KUBERNETES_SERVICE_HOST", ""); err != nil {
return
}
defer func() {
err = os.Setenv("KUBERNETES_SERVICE_HOST", originalHost)
}()
}
// authenticate to apiserver via bearer token
token = "flwqkenfjasasdfmwerasd" // Fake token for testing.
var tokenFile *os.File
tokenFile, err = os.CreateTemp("", "kubeconfig")
if err != nil {
return
}
if _, err = tokenFile.WriteString(fmt.Sprintf(`%s,system:kube-scheduler,system:kube-scheduler,""`, token)); err != nil {
return
}
if err = tokenFile.Close(); err != nil {
return
}
// start apiserver
server = kubeapiservertesting.StartTestServerOrDie(t, nil, []string{
"--token-auth-file", tokenFile.Name(),
"--authorization-mode", "AlwaysAllow",
}, framework.SharedEtcd())
apiserverConfig = fmt.Sprintf(`
apiVersion: v1
kind: Config
clusters:
- cluster:
server: %s
certificate-authority: %s
name: integration
contexts:
- context:
cluster: integration
user: kube-scheduler
name: default-context
current-context: default-context
users:
- name: kube-scheduler
user:
token: %s
`, server.ClientConfig.Host, server.ServerOpts.SecureServing.ServerCert.CertKey.CertFile, token)
return server, apiserverConfig, token, nil
}
func clientAndURLFromTestServer(s kubeschedulertesting.TestServer) (*http.Client, string, error) {
secureInfo := s.Config.SecureServing
secureOptions := s.Options.SecureServing
url := fmt.Sprintf("https://%s", secureInfo.Listener.Addr().String())
url = strings.ReplaceAll(url, "[::]", "127.0.0.1") // switch to IPv4 because the self-signed cert does not support [::]
// read self-signed server cert disk
pool := x509.NewCertPool()
serverCertPath := path.Join(secureOptions.ServerCert.CertDirectory, secureOptions.ServerCert.PairName+".crt")
serverCert, err := os.ReadFile(serverCertPath)
if err != nil {
return nil, "", fmt.Errorf("Failed to read component server cert %q: %w", serverCertPath, err)
}
pool.AppendCertsFromPEM(serverCert)
tr := &http.Transport{
TLSClientConfig: &tls.Config{
RootCAs: pool,
},
}
client := &http.Client{Transport: tr}
return client, url, nil
}