Enhance E2E Test Scaffold with Optional Prometheus and Cert-Manager Installation

[camilamacedo86]

What do you want to happen?

Projects are scaffolded with e2e tests, which by default, should be executed in a specific environment. The common practice is to spin up an environment, run the tests, and then tear down the environment to ensure the tests are executed in isolation.

However, some users might prefer to run these tests in an environment where Prometheus and Cert-Manager are already installed, or in cases where their project does not require these tools. Users should still be able to customize their scaffold as needed. (Motivation: #3971)

To facilitate this, we can add a logic that uses an environment variable to skip the installation of these tools, such as INSTALL_PROMETHEUS_E2E_TEST=false.

The changes should be made in the following section of the code:

kubebuilder/testdata/project-v4/test/e2e/e2e_test.go

Lines 32 to 43 in 94d8fce

	var _ = Describe("controller", Ordered, func() {
	BeforeAll(func() {
	By("installing prometheus operator")
	Expect(utils.InstallPrometheusOperator()).To(Succeed())
	By("installing the cert-manager")
	Expect(utils.InstallCertManager()).To(Succeed())
	By("creating manager namespace")
	cmd := exec.Command("kubectl", "create", "ns", namespace)
	_, _ = utils.Run(cmd)
	})

Additionally, we have a practice of adding TODO(user): comments. We must ensure that this code includes comments explaining how the tests should be used and describing the ability to disable the installation of Prometheus and Cert-Manager in the e2e tests.

Extra Labels

No response

[TAM360]

@camilamacedo86 I would also like to work on this as it is linked with the other task too.

[TAM360]

/assign

[camilamacedo86]

Hi @TAM360

After look it again, I think a good idea here would do as we do in all other places instead of complex envvar settings.

                 // TODO(user): If you enable the metrics endpoint and want to use metrics to validate your solution,
                 // make sure to uncomment this line to install the Prometheus operator.
                 // By("installing prometheus operator") 
 		// Expect(utils.InstallPrometheusOperator()).To(Succeed()) 
  
                 // TODO(user): If you are using webhooks or just enabled cert-manager in the scaffold
                 // make sure to uncomment this line to install the Cert-Manager operator.
 		By("installing the cert-manager") 
 		Expect(utils.InstallCertManager()).To(Succeed()) 

In this way, if someone run make test-e2e in an env that they should not and has those solutions already the tests will not re-install things. (problem faced #3971)

We need to do the same in the step that uninstall the solutions installed here.

[TAM360]

@camilamacedo86 so by default the steps to install, and delete Prometheus, and Cert Manager would be commented in a new project, and if anyone who wants to use it would have un-comment the relevant lines first?

[camilamacedo86]

@camilamacedo86 so by default the steps to install, and delete Prometheus, and Cert Manager would be commented in a new project, and if anyone who wants to use it would have un-comment the relevant lines first?

Honest, I do not know how much value comment it will bring or if it will bring more pain
E2e tests should be executed against isolated envs. so, if they either install the solution in a cluster where it should not be done will cause problems.
(people should not run e2e-tests on envs that are not specific for it, if someone want to run against to an specific env where has pormetheus and cert-manager already, then they should customize the tests and etc accordingly, and the best approach is spinning up an new env and kill it at the end)

Note that if someone scaffold webhooks then need install cert-manager
Also, we would need to uncomment either our tests: https://github.com/kubernetes-sigs/kubebuilder/blob/master/.github/workflows/test-sample-go.yml

In this way, wdyt about we try to do first: #4088
Then, we revisit this one again to see if still fit and if it would make sense.

[camilamacedo86]

Hi @TAM360

Furthermore, users need to customize the implementation according to their needs.
But, lets think here what we can do to help out.