/* Copyright 2017 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 apps import ( "context" "encoding/json" "fmt" "io" "net" "net/http" "path/filepath" "sync" "time" "github.com/onsi/ginkgo/v2" "github.com/onsi/gomega" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/util/version" "k8s.io/apimachinery/pkg/util/wait" "k8s.io/kubernetes/test/e2e/framework" e2ekubectl "k8s.io/kubernetes/test/e2e/framework/kubectl" e2estatefulset "k8s.io/kubernetes/test/e2e/framework/statefulset" e2etestfiles "k8s.io/kubernetes/test/e2e/framework/testfiles" "k8s.io/kubernetes/test/e2e/upgrades" ) const manifestPath = "test/e2e/testing-manifests/statefulset/etcd" // EtcdUpgradeTest tests that etcd is writable before and after a cluster upgrade. type EtcdUpgradeTest struct { ip string successfulWrites int } // Name returns the tracking name of the test. func (EtcdUpgradeTest) Name() string { return "etcd-upgrade" } // Skip returns true when this test can be skipped. func (EtcdUpgradeTest) Skip(upgCtx upgrades.UpgradeContext) bool { minVersion := version.MustParseSemantic("1.6.0") for _, vCtx := range upgCtx.Versions { if vCtx.Version.LessThan(minVersion) { return true } } return false } func kubectlCreate(ns, file string) { data, err := e2etestfiles.Read(filepath.Join(manifestPath, file)) if err != nil { framework.Fail(err.Error()) } input := string(data) e2ekubectl.RunKubectlOrDieInput(ns, input, "create", "-f", "-") } // Setup creates etcd statefulset and then verifies that the etcd is writable. func (t *EtcdUpgradeTest) Setup(ctx context.Context, f *framework.Framework) { ns := f.Namespace.Name statefulsetPoll := 30 * time.Second statefulsetTimeout := 10 * time.Minute ginkgo.By("Creating a PDB") kubectlCreate(ns, "pdb.yaml") ginkgo.By("Creating an etcd StatefulSet") e2estatefulset.CreateStatefulSet(ctx, f.ClientSet, manifestPath, ns) ginkgo.By("Creating an etcd--test-server deployment") kubectlCreate(ns, "tester.yaml") ginkgo.By("Getting the ingress IPs from the services") err := wait.PollImmediateWithContext(ctx, statefulsetPoll, statefulsetTimeout, func(ctx context.Context) (bool, error) { if t.ip = t.getServiceIP(ctx, f, ns, "test-server"); t.ip == "" { return false, nil } if _, err := t.listUsers(); err != nil { framework.Logf("Service endpoint is up but isn't responding") return false, nil } return true, nil }) framework.ExpectNoError(err) framework.Logf("Service endpoint is up") ginkgo.By("Adding 2 dummy users") err = t.addUser("Alice") framework.ExpectNoError(err) err = t.addUser("Bob") framework.ExpectNoError(err) t.successfulWrites = 2 ginkgo.By("Verifying that the users exist") users, err := t.listUsers() framework.ExpectNoError(err) framework.ExpectEqual(len(users), 2) } func (t *EtcdUpgradeTest) listUsers() ([]string, error) { r, err := http.Get(fmt.Sprintf("http://%s/list", net.JoinHostPort(t.ip, "8080"))) if err != nil { return nil, err } defer r.Body.Close() if r.StatusCode != http.StatusOK { b, err := io.ReadAll(r.Body) if err != nil { return nil, err } return nil, fmt.Errorf(string(b)) } var names []string if err := json.NewDecoder(r.Body).Decode(&names); err != nil { return nil, err } return names, nil } func (t *EtcdUpgradeTest) addUser(name string) error { val := map[string][]string{"name": {name}} r, err := http.PostForm(fmt.Sprintf("http://%s/add", net.JoinHostPort(t.ip, "8080")), val) if err != nil { return err } defer r.Body.Close() if r.StatusCode != http.StatusOK { b, err := io.ReadAll(r.Body) if err != nil { return err } return fmt.Errorf(string(b)) } return nil } func (t *EtcdUpgradeTest) getServiceIP(ctx context.Context, f *framework.Framework, ns, svcName string) string { svc, err := f.ClientSet.CoreV1().Services(ns).Get(ctx, svcName, metav1.GetOptions{}) framework.ExpectNoError(err) ingress := svc.Status.LoadBalancer.Ingress if len(ingress) == 0 { return "" } return ingress[0].IP } // Test waits for upgrade to complete and verifies if etcd is writable. func (t *EtcdUpgradeTest) Test(ctx context.Context, f *framework.Framework, done <-chan struct{}, upgrade upgrades.UpgradeType) { ginkgo.By("Continuously polling the database during upgrade.") var ( success, failures, writeAttempts, lastUserCount int mu sync.Mutex errors = map[string]int{} ) // Write loop. go wait.Until(func() { writeAttempts++ if err := t.addUser(fmt.Sprintf("user-%d", writeAttempts)); err != nil { framework.Logf("Unable to add user: %v", err) mu.Lock() errors[err.Error()]++ mu.Unlock() return } t.successfulWrites++ }, 10*time.Millisecond, done) // Read loop. wait.Until(func() { users, err := t.listUsers() if err != nil { framework.Logf("Could not retrieve users: %v", err) failures++ mu.Lock() errors[err.Error()]++ mu.Unlock() return } success++ lastUserCount = len(users) }, 10*time.Millisecond, done) framework.Logf("got %d users; want >=%d", lastUserCount, t.successfulWrites) gomega.Expect(lastUserCount).To(gomega.BeNumerically(">=", t.successfulWrites), "lastUserCount is too small") ratio := float64(success) / float64(success+failures) framework.Logf("Successful gets %d/%d=%v", success, success+failures, ratio) ratio = float64(t.successfulWrites) / float64(writeAttempts) framework.Logf("Successful writes %d/%d=%v", t.successfulWrites, writeAttempts, ratio) framework.Logf("Errors: %v", errors) // TODO(maisem): tweak this value once we have a few test runs. gomega.Expect(ratio).To(gomega.BeNumerically(">", 0.75), "ratio too small") } // Teardown does one final check of the data's availability. func (t *EtcdUpgradeTest) Teardown(ctx context.Context, f *framework.Framework) { users, err := t.listUsers() framework.ExpectNoError(err) gomega.Expect(len(users)).To(gomega.BeNumerically(">=", t.successfulWrites), "len(users) is too small") }