forked from etcd-io/etcd-operator
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add e2e tests for failpoint scenarios
- Loading branch information
Showing
5 changed files
with
488 additions
and
4 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| name: E2E Failpoint Tests | ||
|
|
||
| on: | ||
| push: | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| test-e2e: | ||
| name: Run on Ubuntu | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Clone the code | ||
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 | ||
|
|
||
| - name: Setup Go | ||
| uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a | ||
| with: | ||
| go-version-file: 'go.mod' | ||
|
|
||
| - name: Install the latest version of kind | ||
| run: | | ||
| curl -Lo ./kind https://kind.sigs.k8s.io/dl/latest/kind-linux-amd64 | ||
| chmod +x ./kind | ||
| sudo mv ./kind /usr/local/bin/kind | ||
| - name: Verify kind installation | ||
| run: kind version | ||
|
|
||
| - name: Create kind cluster | ||
| run: kind create cluster | ||
|
|
||
| - name: Running Test e2e | ||
| run: | | ||
| go mod tidy | ||
| make gofail-enable | ||
| make test-e2e-failpoint |
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,120 @@ | ||
| /* | ||
| Copyright 2024. | ||
| 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 e2e_failpoint | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "os/exec" | ||
| "testing" | ||
|
|
||
| . "github.com/onsi/ginkgo/v2" | ||
| . "github.com/onsi/gomega" | ||
|
|
||
| "go.etcd.io/etcd-operator/test/utils" | ||
| ) | ||
|
|
||
| var ( | ||
| // Optional Environment Variables: | ||
| // - PROMETHEUS_INSTALL_SKIP=true: Skips Prometheus Operator installation during test setup. | ||
| // - CERT_MANAGER_INSTALL_SKIP=true: Skips CertManager installation during test setup. | ||
| // These variables are useful if Prometheus or CertManager is already installed, avoiding | ||
| // re-installation and conflicts. | ||
| skipPrometheusInstall = os.Getenv("PROMETHEUS_INSTALL_SKIP") == "true" | ||
| skipCertManagerInstall = os.Getenv("CERT_MANAGER_INSTALL_SKIP") == "true" | ||
| // isPrometheusOperatorAlreadyInstalled will be set true when prometheus CRDs be found on the cluster | ||
| isPrometheusOperatorAlreadyInstalled = false | ||
| // isCertManagerAlreadyInstalled will be set true when CertManager CRDs be found on the cluster | ||
| isCertManagerAlreadyInstalled = false | ||
|
|
||
| // projectImage is the name of the image which will be build and loaded | ||
| // with the code source changes to be tested. | ||
| projectImage = "example.com/etcd-operator:v0.0.1" | ||
| ) | ||
|
|
||
| // TestE2E runs the end-to-end (e2e) test suite for the project. These tests execute in an isolated, | ||
| // temporary environment to validate project changes with the the purposed to be used in CI jobs. | ||
| // The default setup requires Kind, builds/loads the Manager Docker image locally, and installs | ||
| // CertManager and Prometheus. | ||
| func TestE2E(t *testing.T) { | ||
| RegisterFailHandler(Fail) | ||
| _, _ = fmt.Fprintf(GinkgoWriter, "Starting etcd-operator integration test suite\n") | ||
| RunSpecs(t, "e2e suite") | ||
| } | ||
|
|
||
| var _ = BeforeSuite(func() { | ||
| By("Ensure that Prometheus is enabled") | ||
| _ = utils.UncommentCode("config/default/kustomization.yaml", "#- ../prometheus", "#") | ||
|
|
||
| By("generating files") | ||
| cmd := exec.Command("make", "generate") | ||
| _, err := utils.Run(cmd) | ||
| ExpectWithOffset(1, err).NotTo(HaveOccurred(), "Failed to run make generate") | ||
|
|
||
| By("generating manifests") | ||
| cmd = exec.Command("make", "manifests") | ||
| _, err = utils.Run(cmd) | ||
| ExpectWithOffset(1, err).NotTo(HaveOccurred(), "Failed to run make manifests") | ||
|
|
||
| By("building the manager(Operator) image") | ||
| cmd = exec.Command("make", "docker-build", fmt.Sprintf("IMG=%s", projectImage)) | ||
| _, err = utils.Run(cmd) | ||
| ExpectWithOffset(1, err).NotTo(HaveOccurred(), "Failed to build the manager(Operator) image") | ||
|
|
||
| // TODO(user): If you want to change the e2e test vendor from Kind, ensure the image is | ||
| // built and available before running the tests. Also, remove the following block. | ||
| By("loading the manager(Operator) image on Kind") | ||
| err = utils.LoadImageToKindClusterWithName(projectImage) | ||
| ExpectWithOffset(1, err).NotTo(HaveOccurred(), "Failed to load the manager(Operator) image into Kind") | ||
|
|
||
| // The tests-e2e are intended to run on a temporary cluster that is created and destroyed for testing. | ||
| // To prevent errors when tests run in environments with Prometheus or CertManager already installed, | ||
| // we check for their presence before execution. | ||
| // Setup Prometheus and CertManager before the suite if not skipped and if not already installed | ||
| if !skipPrometheusInstall { | ||
| By("checking if prometheus is installed already") | ||
| isPrometheusOperatorAlreadyInstalled = utils.IsPrometheusCRDsInstalled() | ||
| if !isPrometheusOperatorAlreadyInstalled { | ||
| _, _ = fmt.Fprintf(GinkgoWriter, "Installing Prometheus Operator...\n") | ||
| Expect(utils.InstallPrometheusOperator()).To(Succeed(), "Failed to install Prometheus Operator") | ||
| } else { | ||
| _, _ = fmt.Fprintf(GinkgoWriter, "WARNING: Prometheus Operator is already installed. Skipping installation...\n") | ||
| } | ||
| } | ||
| if !skipCertManagerInstall { | ||
| By("checking if cert manager is installed already") | ||
| isCertManagerAlreadyInstalled = utils.IsCertManagerCRDsInstalled() | ||
| if !isCertManagerAlreadyInstalled { | ||
| _, _ = fmt.Fprintf(GinkgoWriter, "Installing CertManager...\n") | ||
| Expect(utils.InstallCertManager()).To(Succeed(), "Failed to install CertManager") | ||
| } else { | ||
| _, _ = fmt.Fprintf(GinkgoWriter, "WARNING: CertManager is already installed. Skipping installation...\n") | ||
| } | ||
| } | ||
| }) | ||
|
|
||
| var _ = AfterSuite(func() { | ||
| // Teardown Prometheus and CertManager after the suite if not skipped and if they were not already installed | ||
| if !skipPrometheusInstall && !isPrometheusOperatorAlreadyInstalled { | ||
| _, _ = fmt.Fprintf(GinkgoWriter, "Uninstalling Prometheus Operator...\n") | ||
| utils.UninstallPrometheusOperator() | ||
| } | ||
| if !skipCertManagerInstall && !isCertManagerAlreadyInstalled { | ||
| _, _ = fmt.Fprintf(GinkgoWriter, "Uninstalling CertManager...\n") | ||
| utils.UninstallCertManager() | ||
| } | ||
| }) |
Oops, something went wrong.