Merge pull request #5269 from BadisLaffet1/docs/fix-writing-tests-duplicate-collapse

📖 (docs): Fix duplicate content and collapse markers in writing tests tutorial

Author: k8s-ci-robot

docs/book/src/cronjob-tutorial/testdata/project/internal/controller/cronjob_controller_test.go

@@ -208,8 +208,6 @@ var _ = Describe("CronJob controller", func() {
 
 })
 
-// +kubebuilder:docs-gen:collapse=Remaining code from cronjob_controller_test.go
-
 /*
 	After writing all this code, you can run `go test ./...` in your `controllers/` directory again to run your new test!
 */

docs/book/src/cronjob-tutorial/testdata/project/internal/controller/suite_test.go

@@ -170,8 +170,6 @@ var _ = AfterSuite(func() {
 	Expect(err).NotTo(HaveOccurred())
 })
 
-// +kubebuilder:docs-gen:collapse=Remaining code from suite_test.go
-
 /*
 Now that you have your controller running on a test cluster and a client ready to perform operations on your CronJob, we can start writing integration tests!
 */

docs/book/src/cronjob-tutorial/writing-tests.md

@@ -9,31 +9,6 @@ The basic approach is that, in your generated `suite_test.go` file, you will use
 
 If you want to tinker with how your envtest cluster is configured, see section [Configuring envtest for integration tests](../reference/envtest.md) as well as the [`envtest docs`](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/envtest?tab=doc).
 
-## Test Environment Setup
-
-{{#literatego ../cronjob-tutorial/testdata/project/internal/controller/suite_test.go}}
-
-## Testing your Controller's Behavior
-
-{{#literatego ../cronjob-tutorial/testdata/project/internal/controller/cronjob_controller_test.go}}
-
-This Status update example above demonstrates a general testing strategy for a custom Kind with downstream objects. By this point, you hopefully have learned the following methods for testing your controller behavior:
-
-* Setting up your controller to run on an envtest cluster
-* Writing stubs for creating test objects
-* Isolating changes to an object to test specific controller behavior
-
-# Writing controller tests
-
-Testing Kubernetes controllers is a big subject, and the boilerplate testing
-files generated for you by kubebuilder are fairly minimal.
-
-To walk you through integration testing patterns for Kubebuilder-generated controllers, we will revisit the CronJob we built in our first tutorial and write a simple test for it.
-
-The basic approach is that, in your generated `suite_test.go` file, you will use envtest to create a local Kubernetes API server, instantiate and run your controllers, and then write additional `*_test.go` files to test it using [Ginkgo](http://onsi.github.io/ginkgo).
-
-If you want to tinker with how your envtest cluster is configured, see section [Configuring envtest for integration tests](../reference/envtest.md) as well as the [`envtest docs`](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/envtest?tab=doc).
-
 <aside class="note">
 <h1>Other Examples</h1>
 

docs/book/src/multiversion-tutorial/testdata/project/internal/controller/cronjob_controller_test.go

@@ -208,8 +208,6 @@ var _ = Describe("CronJob controller", func() {
 
 })
 
-// +kubebuilder:docs-gen:collapse=Remaining code from cronjob_controller_test.go
-
 /*
 	After writing all this code, you can run `go test ./...` in your `controllers/` directory again to run your new test!
 */

docs/book/src/multiversion-tutorial/testdata/project/internal/controller/suite_test.go

@@ -170,8 +170,6 @@ var _ = AfterSuite(func() {
 	Expect(err).NotTo(HaveOccurred())
 })
 
-// +kubebuilder:docs-gen:collapse=Remaining code from suite_test.go
-
 /*
 Now that you have your controller running on a test cluster and a client ready to perform operations on your CronJob, we can start writing integration tests!
 */

hack/docs/internal/cronjob-tutorial/writing_tests_controller.go

@@ -226,7 +226,6 @@ var _ = Describe("CronJob controller", func() {
 	})
 
 })
-// +kubebuilder:docs-gen:collapse=Remaining code from cronjob_controller_test.go
 
 /*
 	After writing all this code, you can run` + " `" + `go test ./...` + "`" + ` in your` + " `" + `controllers/` + "`" + ` directory again to run your new test!

hack/docs/internal/cronjob-tutorial/writing_tests_env.go

@@ -120,7 +120,6 @@ var _ = AfterSuite(func() {
 	err := testEnv.Stop()
 	Expect(err).NotTo(HaveOccurred())
 })
-// +kubebuilder:docs-gen:collapse=Remaining code from suite_test.go
 
 /*
 Now that you have your controller running on a test cluster and a client ready to perform operations on your CronJob, we can start writing integration tests!