Need references/documentation for unit testing

[kaushiksrinivas]

Hi

Looking for documentation/examples on unit testing the operator sdk project.
links referred in some of the bugs seems to be no more available
https://github.com/operator-framework/operator-sdk/blob/master/doc/user/unit-testing.md

Can anyone provide documentation link for unit testing and any example implementations ?
Thanks in advance
Kaushik.

[estroz]

We recommend following this kubebuilder testing guide, which we should link in documentation.

/kind documentation
/milestone v1.1.0

[camilamacedo86]

Hi @kaushiksrinivas,

However, the same doc that you are looking for is in : https://sdk.operatorframework.io/docs/golang/legacy/unit-testing/. Note that SDK is in a process to be integrated with KB which means that its project layouts will be aligned. More info : Integrating Kubebuilder and Operator SDK.

So, for the new layout test files for your controller are scaffold and then, you can follow up the docs suggested by @estroz as well.

[kaushiksrinivas]

Hi @camilamacedo86
"Note that SDK is in a process to be integrated with KB which means that its project layouts will be aligned."
Does this mean operator-sdk would get changed to align with kubebuilder ?

Currently if anyone is already using operator-sdk, what changes are expected ?
Thanks,
Kaushik

[camilamacedo86]

Hi @kaushiksrinivas,

Does this mean operator-sdk would get changed to align with kubebuilder?

Yes, for 1.0.0 the legacy layout will no longer be supported.

Currently if anyone is already using operator-sdk, what changes are expected?

You can check the migration guide to know how to upgrade your projects. See the PR #3543 for we shape it better. Note that in the first comment has a link where you can preview the doc.

See that Can anyone provide documentation link for unit testing and any example implementations ? which shows answered and we already started to discuss another topic. Ideally, we should have one question/bug/feature per issue. So, let's it open for we track the need to add the unit test doc. However, feel free to raise another issue as well

[camilamacedo86]

/reopen

[openshift-ci-robot]

@camilamacedo86: Reopened this issue.

Details

In response to this:

/reopen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[britoaldan]

hi @camilamacedo86, @estroz @joelanford
The above comments are a bit confusing,
Need clarifications for the below concerns,

Operator SDK includes an e2e testing framework that simplifies testing your operator against an actual cluster.
Kubebuilder includes an envtest package that allows operator developers to run simple tests with a standalone etcd and apiserver.
Reference: #1758

Does this mean that the e2e test framework of operator-sdk will be removed and no longer supported and one needs to follow the kube-builder way of testing ?

Does this mean https://sdk.operatorframework.io/docs/golang/legacy/unit-testing/. this is no longer valid with latest version(v0.19) of operator-sdk ?

[camilamacedo86]

Hi @britoaldan,

I flagged it to be discussed in the Bug Triage meeting. Please, feel free to attend.
We will update it after the meeting as well.