From f5d9660bf42d9961b575e34ec36c03a64edab59c Mon Sep 17 00:00:00 2001 From: Camila Macedo <7708031+camilamacedo86@users.noreply.github.com> Date: Wed, 1 Jan 2025 08:33:50 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=8C=B1=20e2e=20tests=20improve=20assertio?= =?UTF-8?q?ns=20by=20simplify=20style=20of=20checks=20(#4456)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit e2e tests improve assertions by simplify style of checks --- .../src/plugins/extending/testing-plugins.md | 6 +++--- test/e2e/alphagenerate/generate_test.go | 2 +- test/e2e/deployimage/generate_test.go | 6 +++--- test/e2e/grafana/generate_test.go | 12 ++++++------ test/e2e/v4/generate_test.go | 16 ++++++++-------- 5 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/book/src/plugins/extending/testing-plugins.md b/docs/book/src/plugins/extending/testing-plugins.md index 45b2d22e97e..6482bcdc5ed 100644 --- a/docs/book/src/plugins/extending/testing-plugins.md +++ b/docs/book/src/plugins/extending/testing-plugins.md @@ -55,7 +55,7 @@ Here’s a general workflow to create a sample project using the `go/v4` plugin "--domain", kbc.Domain, "--fetch-deps=false", ) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to initialize a project") ``` - **To define API:** @@ -70,7 +70,7 @@ Here’s a general workflow to create a sample project using the `go/v4` plugin "--controller", "--make=false", ) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to create an API") ``` - **To scaffold webhook configurations:** @@ -83,7 +83,7 @@ Here’s a general workflow to create a sample project using the `go/v4` plugin "--defaulting", "--programmatic-validation", ) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to create an webhook") ``` [cert-manager-install]: https://pkg.go.dev/sigs.k8s.io/kubebuilder/v4/test/e2e/utils#TestContext.InstallCertManager diff --git a/test/e2e/alphagenerate/generate_test.go b/test/e2e/alphagenerate/generate_test.go index 99ed8bc26e1..0e631f0ea25 100644 --- a/test/e2e/alphagenerate/generate_test.go +++ b/test/e2e/alphagenerate/generate_test.go @@ -182,7 +182,7 @@ func generateProject(kbc *utils.TestContext) { "--external-api-path=github.com/cert-manager/cert-manager/pkg/apis/certmanager/v1", "--external-api-domain=cert-manager.io", ) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to scaffold API with external API") } func regenerateProject(kbc *utils.TestContext, projectOutputDir string) { diff --git a/test/e2e/deployimage/generate_test.go b/test/e2e/deployimage/generate_test.go index 3af5680b764..b3d5be9ec4e 100644 --- a/test/e2e/deployimage/generate_test.go +++ b/test/e2e/deployimage/generate_test.go @@ -51,7 +51,7 @@ func creatingAPI(kbc *utils.TestContext) { "--make=false", "--manifests=false", ) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to create API definition") } func creatingAPIWithOptions(kbc *utils.TestContext) { @@ -69,7 +69,7 @@ func creatingAPIWithOptions(kbc *utils.TestContext) { "--make=false", "--manifests=false", ) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to create API definition with deploy-image/v1-alpha") } func initTheProject(kbc *utils.TestContext) { @@ -79,5 +79,5 @@ func initTheProject(kbc *utils.TestContext) { "--project-version", "3", "--domain", kbc.Domain, ) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to initialize project") } diff --git a/test/e2e/grafana/generate_test.go b/test/e2e/grafana/generate_test.go index 39ee429c1ac..ad1af8377bd 100644 --- a/test/e2e/grafana/generate_test.go +++ b/test/e2e/grafana/generate_test.go @@ -60,7 +60,7 @@ func GenerateProject(kbc *utils.TestContext) { err = kbc.Init( "--plugins", "grafana.kubebuilder.io/v1-alpha", ) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to initialize project") By("verifying the initial template content and updating for real custom metrics") ExpectWithOffset(1, pluginutil.ReplaceInFile( @@ -83,17 +83,17 @@ customMetrics: err = kbc.Edit( "--plugins", "grafana.kubebuilder.io/v1-alpha", ) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to edit base of the project") fileContainsExpr, err := pluginutil.HasFileContentWith( filepath.Join(kbc.Dir, "grafana", "custom-metrics", "custom-metrics-dashboard.json"), `sum(rate(foo_bar{job=\"$job\", namespace=\"$namespace\"}[5m])) by (instance, pod)`) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) - ExpectWithOffset(1, fileContainsExpr).To(BeTrue()) + Expect(err).NotTo(HaveOccurred(), "Failed to edit sum rate for custom metrics") + Expect(fileContainsExpr).To(BeTrue()) fileContainsExpr, err = pluginutil.HasFileContentWith( filepath.Join(kbc.Dir, "grafana", "custom-metrics", "custom-metrics-dashboard.json"), `histogram_quantile(0.90, sum by(instance, le) (rate(foo_bar{job=\"$job\", namespace=\"$namespace\"}[5m])))`) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) - ExpectWithOffset(1, fileContainsExpr).To(BeTrue()) + Expect(err).NotTo(HaveOccurred(), "Failed to edit histogram_quantile for custom metrics") + Expect(fileContainsExpr).To(BeTrue()) } diff --git a/test/e2e/v4/generate_test.go b/test/e2e/v4/generate_test.go index 2cc62bd3601..bfe2c0740a4 100644 --- a/test/e2e/v4/generate_test.go +++ b/test/e2e/v4/generate_test.go @@ -47,14 +47,14 @@ func GenerateV4(kbc *utils.TestContext) { "--programmatic-validation", "--make=false", ) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to scaffolding mutating webhook") By("implementing the mutating and validating webhooks") webhookFilePath := filepath.Join( kbc.Dir, "internal/webhook", kbc.Version, fmt.Sprintf("%s_webhook.go", strings.ToLower(kbc.Kind))) err = utils.ImplementWebhooks(webhookFilePath, strings.ToLower(kbc.Kind)) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to implement webhooks") scaffoldConversionWebhook(kbc) @@ -95,14 +95,14 @@ func GenerateV4WithoutMetrics(kbc *utils.TestContext) { "--programmatic-validation", "--make=false", ) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to scaffolding mutating webhook") By("implementing the mutating and validating webhooks") webhookFilePath := filepath.Join( kbc.Dir, "internal/webhook", kbc.Version, fmt.Sprintf("%s_webhook.go", strings.ToLower(kbc.Kind))) err = utils.ImplementWebhooks(webhookFilePath, strings.ToLower(kbc.Kind)) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to implement webhooks") scaffoldConversionWebhook(kbc) @@ -158,14 +158,14 @@ func GenerateV4WithNetworkPolicies(kbc *utils.TestContext) { "--programmatic-validation", "--make=false", ) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to scaffolding mutating webhook") By("implementing the mutating and validating webhooks") webhookFilePath := filepath.Join( kbc.Dir, "internal/webhook", kbc.Version, fmt.Sprintf("%s_webhook.go", strings.ToLower(kbc.Kind))) err = utils.ImplementWebhooks(webhookFilePath, strings.ToLower(kbc.Kind)) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to implement webhooks") scaffoldConversionWebhook(kbc) @@ -222,7 +222,7 @@ func creatingAPI(kbc *utils.TestContext) { "--controller", "--make=false", ) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to create API") By("implementing the API") ExpectWithOffset(1, pluginutil.InsertCode( @@ -241,7 +241,7 @@ func initingTheProject(kbc *utils.TestContext) { "--project-version", "3", "--domain", kbc.Domain, ) - ExpectWithOffset(1, err).NotTo(HaveOccurred()) + Expect(err).NotTo(HaveOccurred(), "Failed to initialize project") } const metricsTarget = `- path: manager_metrics_patch.yaml