|
| 1 | +/* |
| 2 | +Copyright 2024 The Kubernetes Authors. |
| 3 | +
|
| 4 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +you may not use this file except in compliance with the License. |
| 6 | +You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | +Unless required by applicable law or agreed to in writing, software |
| 11 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +See the License for the specific language governing permissions and |
| 14 | +limitations under the License. |
| 15 | +*/ |
| 16 | + |
| 17 | +package serving |
| 18 | + |
| 19 | +import ( |
| 20 | + "crypto/tls" |
| 21 | + "crypto/x509" |
| 22 | + "fmt" |
| 23 | + "io" |
| 24 | + "net/http" |
| 25 | + "os" |
| 26 | + "path" |
| 27 | + "strings" |
| 28 | + "testing" |
| 29 | + |
| 30 | + "k8s.io/klog/v2/ktesting" |
| 31 | + kubeapiservertesting "k8s.io/kubernetes/cmd/kube-apiserver/app/testing" |
| 32 | + kubeschedulertesting "k8s.io/kubernetes/cmd/kube-scheduler/app/testing" |
| 33 | + "k8s.io/kubernetes/test/integration/framework" |
| 34 | +) |
| 35 | + |
| 36 | +func TestHealthEndpoints(t *testing.T) { |
| 37 | + server, configStr, _, err := startTestAPIServer(t) |
| 38 | + if err != nil { |
| 39 | + t.Fatalf("Failed to start kube-apiserver server: %v", err) |
| 40 | + } |
| 41 | + defer server.TearDownFn() |
| 42 | + |
| 43 | + apiserverConfig, err := os.CreateTemp("", "kubeconfig") |
| 44 | + if err != nil { |
| 45 | + t.Fatalf("Failed to create config file: %v", err) |
| 46 | + } |
| 47 | + defer func() { |
| 48 | + _ = os.Remove(apiserverConfig.Name()) |
| 49 | + }() |
| 50 | + if _, err = apiserverConfig.WriteString(configStr); err != nil { |
| 51 | + t.Fatalf("Failed to write config file: %v", err) |
| 52 | + } |
| 53 | + |
| 54 | + brokenConfigStr := strings.ReplaceAll(configStr, "127.0.0.1", "127.0.0.2") |
| 55 | + brokenConfig, err := os.CreateTemp("", "kubeconfig") |
| 56 | + if err != nil { |
| 57 | + t.Fatalf("Failed to create config file: %v", err) |
| 58 | + } |
| 59 | + if _, err := brokenConfig.WriteString(brokenConfigStr); err != nil { |
| 60 | + t.Fatalf("Failed to write config file: %v", err) |
| 61 | + } |
| 62 | + defer func() { |
| 63 | + _ = os.Remove(brokenConfig.Name()) |
| 64 | + }() |
| 65 | + |
| 66 | + tests := []struct { |
| 67 | + name string |
| 68 | + path string |
| 69 | + useBrokenConfig bool |
| 70 | + wantResponseCode int |
| 71 | + }{ |
| 72 | + { |
| 73 | + "/healthz", |
| 74 | + "/healthz", |
| 75 | + false, |
| 76 | + http.StatusOK, |
| 77 | + }, |
| 78 | + { |
| 79 | + "/livez", |
| 80 | + "/livez", |
| 81 | + false, |
| 82 | + http.StatusOK, |
| 83 | + }, |
| 84 | + { |
| 85 | + "/livez with ping check", |
| 86 | + "/livez/ping", |
| 87 | + false, |
| 88 | + http.StatusOK, |
| 89 | + }, |
| 90 | + { |
| 91 | + "/readyz", |
| 92 | + "/readyz", |
| 93 | + false, |
| 94 | + http.StatusOK, |
| 95 | + }, |
| 96 | + { |
| 97 | + "/readyz with sched-handler-sync", |
| 98 | + "/readyz/sched-handler-sync", |
| 99 | + false, |
| 100 | + http.StatusOK, |
| 101 | + }, |
| 102 | + { |
| 103 | + "/readyz with shutdown", |
| 104 | + "/readyz/shutdown", |
| 105 | + false, |
| 106 | + http.StatusOK, |
| 107 | + }, |
| 108 | + { |
| 109 | + "/readyz with broken apiserver", |
| 110 | + "/readyz", |
| 111 | + true, |
| 112 | + http.StatusInternalServerError, |
| 113 | + }, |
| 114 | + } |
| 115 | + |
| 116 | + for _, tt := range tests { |
| 117 | + t.Run(tt.name, func(t *testing.T) { |
| 118 | + tt := tt |
| 119 | + _, ctx := ktesting.NewTestContext(t) |
| 120 | + |
| 121 | + configFile := apiserverConfig.Name() |
| 122 | + if tt.useBrokenConfig { |
| 123 | + configFile = brokenConfig.Name() |
| 124 | + } |
| 125 | + result, err := kubeschedulertesting.StartTestServer( |
| 126 | + ctx, |
| 127 | + []string{"--kubeconfig", configFile, "--leader-elect=false", "--authorization-always-allow-paths", tt.path}) |
| 128 | + |
| 129 | + if err != nil { |
| 130 | + t.Fatalf("Failed to start kube-scheduler server: %v", err) |
| 131 | + } |
| 132 | + if result.TearDownFn != nil { |
| 133 | + defer result.TearDownFn() |
| 134 | + } |
| 135 | + |
| 136 | + client, base, err := clientAndURLFromTestServer(result) |
| 137 | + if err != nil { |
| 138 | + t.Fatalf("Failed to get client from test server: %v", err) |
| 139 | + } |
| 140 | + req, err := http.NewRequest("GET", base+tt.path, nil) |
| 141 | + if err != nil { |
| 142 | + t.Fatalf("failed to request: %v", err) |
| 143 | + } |
| 144 | + r, err := client.Do(req) |
| 145 | + if err != nil { |
| 146 | + t.Fatalf("failed to GET %s from component: %v", tt.path, err) |
| 147 | + } |
| 148 | + |
| 149 | + body, err := io.ReadAll(r.Body) |
| 150 | + if err != nil { |
| 151 | + t.Fatalf("failed to read response body: %v", err) |
| 152 | + } |
| 153 | + if err = r.Body.Close(); err != nil { |
| 154 | + t.Fatalf("failed to close response body: %v", err) |
| 155 | + } |
| 156 | + if got, expected := r.StatusCode, tt.wantResponseCode; got != expected { |
| 157 | + t.Fatalf("expected http %d at %s of component, got: %d %q", expected, tt.path, got, string(body)) |
| 158 | + } |
| 159 | + }) |
| 160 | + } |
| 161 | +} |
| 162 | + |
| 163 | +// TODO: Make this a util function once there is a unified way to start a testing apiserver so that we can reuse it. |
| 164 | +func startTestAPIServer(t *testing.T) (server *kubeapiservertesting.TestServer, apiserverConfig, token string, err error) { |
| 165 | + // Insulate this test from picking up in-cluster config when run inside a pod |
| 166 | + // We can't assume we have permissions to write to /var/run/secrets/... from a unit test to mock in-cluster config for testing |
| 167 | + originalHost := os.Getenv("KUBERNETES_SERVICE_HOST") |
| 168 | + if len(originalHost) > 0 { |
| 169 | + if err = os.Setenv("KUBERNETES_SERVICE_HOST", ""); err != nil { |
| 170 | + return |
| 171 | + } |
| 172 | + defer func() { |
| 173 | + err = os.Setenv("KUBERNETES_SERVICE_HOST", originalHost) |
| 174 | + }() |
| 175 | + } |
| 176 | + |
| 177 | + // authenticate to apiserver via bearer token |
| 178 | + token = "flwqkenfjasasdfmwerasd" // Fake token for testing. |
| 179 | + var tokenFile *os.File |
| 180 | + tokenFile, err = os.CreateTemp("", "kubeconfig") |
| 181 | + if err != nil { |
| 182 | + return |
| 183 | + } |
| 184 | + if _, err = tokenFile.WriteString(fmt.Sprintf(`%s,system:kube-scheduler,system:kube-scheduler,""`, token)); err != nil { |
| 185 | + return |
| 186 | + } |
| 187 | + if err = tokenFile.Close(); err != nil { |
| 188 | + return |
| 189 | + } |
| 190 | + |
| 191 | + // start apiserver |
| 192 | + server = kubeapiservertesting.StartTestServerOrDie(t, nil, []string{ |
| 193 | + "--token-auth-file", tokenFile.Name(), |
| 194 | + "--authorization-mode", "AlwaysAllow", |
| 195 | + }, framework.SharedEtcd()) |
| 196 | + |
| 197 | + apiserverConfig = fmt.Sprintf(` |
| 198 | +apiVersion: v1 |
| 199 | +kind: Config |
| 200 | +clusters: |
| 201 | +- cluster: |
| 202 | + server: %s |
| 203 | + certificate-authority: %s |
| 204 | + name: integration |
| 205 | +contexts: |
| 206 | +- context: |
| 207 | + cluster: integration |
| 208 | + user: kube-scheduler |
| 209 | + name: default-context |
| 210 | +current-context: default-context |
| 211 | +users: |
| 212 | +- name: kube-scheduler |
| 213 | + user: |
| 214 | + token: %s |
| 215 | +`, server.ClientConfig.Host, server.ServerOpts.SecureServing.ServerCert.CertKey.CertFile, token) |
| 216 | + return server, apiserverConfig, token, nil |
| 217 | +} |
| 218 | + |
| 219 | +func clientAndURLFromTestServer(s kubeschedulertesting.TestServer) (*http.Client, string, error) { |
| 220 | + secureInfo := s.Config.SecureServing |
| 221 | + secureOptions := s.Options.SecureServing |
| 222 | + url := fmt.Sprintf("https://%s", secureInfo.Listener.Addr().String()) |
| 223 | + url = strings.ReplaceAll(url, "[::]", "127.0.0.1") // switch to IPv4 because the self-signed cert does not support [::] |
| 224 | + |
| 225 | + // read self-signed server cert disk |
| 226 | + pool := x509.NewCertPool() |
| 227 | + serverCertPath := path.Join(secureOptions.ServerCert.CertDirectory, secureOptions.ServerCert.PairName+".crt") |
| 228 | + serverCert, err := os.ReadFile(serverCertPath) |
| 229 | + if err != nil { |
| 230 | + return nil, "", fmt.Errorf("Failed to read component server cert %q: %w", serverCertPath, err) |
| 231 | + } |
| 232 | + pool.AppendCertsFromPEM(serverCert) |
| 233 | + tr := &http.Transport{ |
| 234 | + TLSClientConfig: &tls.Config{ |
| 235 | + RootCAs: pool, |
| 236 | + }, |
| 237 | + } |
| 238 | + client := &http.Client{Transport: tr} |
| 239 | + return client, url, nil |
| 240 | +} |
0 commit comments