Merge pull request #2602 from chinaran/fix/suite-test-global-cfg

k8s-ci-robot · web-flow · commit 10ce817f7f39 · 2022-04-07T05:45:58.000-07:00
🐛 fix: suite test using global cfg and update docs
diff --git a/docs/book/src/cronjob-tutorial/testdata/project/api/v1/webhook_suite_test.go b/docs/book/src/cronjob-tutorial/testdata/project/api/v1/webhook_suite_test.go
@@ -71,7 +71,9 @@ var _ = BeforeSuite(func() {
 		},
 	}
 
-	cfg, err := testEnv.Start()
+	var err error
+	// cfg is defined in this file globally.
+	cfg, err = testEnv.Start()
 	Expect(err).NotTo(HaveOccurred())
 	Expect(cfg).NotTo(BeNil())
 
diff --git a/docs/book/src/cronjob-tutorial/testdata/project/controllers/suite_test.go b/docs/book/src/cronjob-tutorial/testdata/project/controllers/suite_test.go
@@ -87,7 +87,9 @@ var _ = BeforeSuite(func() {
 	/*
 		Then, we start the envtest cluster.
 	*/
-	cfg, err := testEnv.Start()
+	var err error
+	// cfg is defined in this file globally.
+	cfg, err = testEnv.Start()
 	Expect(err).NotTo(HaveOccurred())
 	Expect(cfg).NotTo(BeNil())
 
diff --git a/docs/book/src/multiversion-tutorial/testdata/project/api/v1/webhook_suite_test.go b/docs/book/src/multiversion-tutorial/testdata/project/api/v1/webhook_suite_test.go
@@ -71,7 +71,9 @@ var _ = BeforeSuite(func() {
 		},
 	}
 
-	cfg, err := testEnv.Start()
+	var err error
+	// cfg is defined in this file globally.
+	cfg, err = testEnv.Start()
 	Expect(err).NotTo(HaveOccurred())
 	Expect(cfg).NotTo(BeNil())
 
diff --git a/docs/book/src/multiversion-tutorial/testdata/project/api/v2/webhook_suite_test.go b/docs/book/src/multiversion-tutorial/testdata/project/api/v2/webhook_suite_test.go
@@ -71,7 +71,9 @@ var _ = BeforeSuite(func() {
 		},
 	}
 
-	cfg, err := testEnv.Start()
+	var err error
+	// cfg is defined in this file globally.
+	cfg, err = testEnv.Start()
 	Expect(err).NotTo(HaveOccurred())
 	Expect(cfg).NotTo(BeNil())
 
diff --git a/docs/book/src/multiversion-tutorial/testdata/project/controllers/suite_test.go b/docs/book/src/multiversion-tutorial/testdata/project/controllers/suite_test.go
@@ -58,7 +58,9 @@ var _ = BeforeSuite(func() {
 		ErrorIfCRDPathMissing: true,
 	}
 
-	cfg, err := testEnv.Start()
+	var err error
+	// cfg is defined in this file globally.
+	cfg, err = testEnv.Start()
 	Expect(err).NotTo(HaveOccurred())
 	Expect(cfg).NotTo(BeNil())
 
diff --git a/pkg/plugins/golang/v3/scaffolds/internal/templates/api/webhook_suitetest.go b/pkg/plugins/golang/v3/scaffolds/internal/templates/api/webhook_suitetest.go
@@ -188,7 +188,9 @@ var _ = BeforeSuite(func() {
 		},
 	}
 
-	cfg, err := testEnv.Start()
+	var err error
+	// cfg is defined in this file globally.
+	cfg, err = testEnv.Start()
 	Expect(err).NotTo(HaveOccurred())
 	Expect(cfg).NotTo(BeNil())
 
diff --git a/testdata/project-v3-config/api/v1/webhook_suite_test.go b/testdata/project-v3-config/api/v1/webhook_suite_test.go
@@ -71,7 +71,9 @@ var _ = BeforeSuite(func() {
 		},
 	}
 
-	cfg, err := testEnv.Start()
+	var err error
+	// cfg is defined in this file globally.
+	cfg, err = testEnv.Start()
 	Expect(err).NotTo(HaveOccurred())
 	Expect(cfg).NotTo(BeNil())
 
diff --git a/testdata/project-v3-multigroup/apis/crew/v1/webhook_suite_test.go b/testdata/project-v3-multigroup/apis/crew/v1/webhook_suite_test.go
@@ -71,7 +71,9 @@ var _ = BeforeSuite(func() {
 		},
 	}
 
-	cfg, err := testEnv.Start()
+	var err error
+	// cfg is defined in this file globally.
+	cfg, err = testEnv.Start()
 	Expect(err).NotTo(HaveOccurred())
 	Expect(cfg).NotTo(BeNil())
 
diff --git a/testdata/project-v3-multigroup/apis/ship/v1/webhook_suite_test.go b/testdata/project-v3-multigroup/apis/ship/v1/webhook_suite_test.go
@@ -71,7 +71,9 @@ var _ = BeforeSuite(func() {
 		},
 	}
 
-	cfg, err := testEnv.Start()
+	var err error
+	// cfg is defined in this file globally.
+	cfg, err = testEnv.Start()
 	Expect(err).NotTo(HaveOccurred())
 	Expect(cfg).NotTo(BeNil())
 
diff --git a/testdata/project-v3-multigroup/apis/ship/v2alpha1/webhook_suite_test.go b/testdata/project-v3-multigroup/apis/ship/v2alpha1/webhook_suite_test.go
@@ -71,7 +71,9 @@ var _ = BeforeSuite(func() {
 		},
 	}
 
-	cfg, err := testEnv.Start()
+	var err error
+	// cfg is defined in this file globally.
+	cfg, err = testEnv.Start()
 	Expect(err).NotTo(HaveOccurred())
 	Expect(cfg).NotTo(BeNil())
 
diff --git a/testdata/project-v3-multigroup/apis/v1/webhook_suite_test.go b/testdata/project-v3-multigroup/apis/v1/webhook_suite_test.go
@@ -71,7 +71,9 @@ var _ = BeforeSuite(func() {
 		},
 	}
 
-	cfg, err := testEnv.Start()
+	var err error
+	// cfg is defined in this file globally.
+	cfg, err = testEnv.Start()
 	Expect(err).NotTo(HaveOccurred())
 	Expect(cfg).NotTo(BeNil())
 
diff --git a/testdata/project-v3-v1beta1/api/v1/webhook_suite_test.go b/testdata/project-v3-v1beta1/api/v1/webhook_suite_test.go
@@ -71,7 +71,9 @@ var _ = BeforeSuite(func() {
 		},
 	}
 
-	cfg, err := testEnv.Start()
+	var err error
+	// cfg is defined in this file globally.
+	cfg, err = testEnv.Start()
 	Expect(err).NotTo(HaveOccurred())
 	Expect(cfg).NotTo(BeNil())
 
diff --git a/testdata/project-v3/api/v1/webhook_suite_test.go b/testdata/project-v3/api/v1/webhook_suite_test.go
@@ -71,7 +71,9 @@ var _ = BeforeSuite(func() {
 		},
 	}
 
-	cfg, err := testEnv.Start()
+	var err error
+	// cfg is defined in this file globally.
+	cfg, err = testEnv.Start()
 	Expect(err).NotTo(HaveOccurred())
 	Expect(cfg).NotTo(BeNil())
 

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,9 @@ var _ = BeforeSuite(func() {`
`71`	`71`	`},`
`72`	`72`	`}`
`73`	`73`
`74`		`- cfg, err := testEnv.Start()`
	`74`	`+ var err error`
	`75`	`+ // cfg is defined in this file globally.`
	`76`	`+ cfg, err = testEnv.Start()`
`75`	`77`	`Expect(err).NotTo(HaveOccurred())`
`76`	`78`	`Expect(cfg).NotTo(BeNil())`
`77`	`79`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,9 @@ var _ = BeforeSuite(func() {`
`58`	`58`	`ErrorIfCRDPathMissing: true,`
`59`	`59`	`}`
`60`	`60`
`61`		`- cfg, err := testEnv.Start()`
	`61`	`+ var err error`
	`62`	`+ // cfg is defined in this file globally.`
	`63`	`+ cfg, err = testEnv.Start()`
`62`	`64`	`Expect(err).NotTo(HaveOccurred())`
`63`	`65`	`Expect(cfg).NotTo(BeNil())`
`64`	`66`
Original file line number	Diff line number	Diff line change
`@@ -188,7 +188,9 @@ var _ = BeforeSuite(func() {`
`188`	`188`	`},`
`189`	`189`	`}`
`190`	`190`
`191`		`- cfg, err := testEnv.Start()`
	`191`	`+ var err error`
	`192`	`+ // cfg is defined in this file globally.`
	`193`	`+ cfg, err = testEnv.Start()`
`192`	`194`	`Expect(err).NotTo(HaveOccurred())`
`193`	`195`	`Expect(cfg).NotTo(BeNil())`
`194`	`196`