Skip to content

Commit 1a62a43

Browse files
authored
docs: add note about chainsaw (operator-framework#6675)
Signed-off-by: Charles-Edouard Brétéché <[email protected]>
1 parent 1fd7f4d commit 1a62a43

File tree

1 file changed

+4
-0
lines changed
  • website/content/en/docs/building-operators/golang

1 file changed

+4
-0
lines changed

website/content/en/docs/building-operators/golang/testing.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ used for testing projects built with SDK `1.0.0`:
4242

4343
Also, you can write tests for your operator in a declarative format using [kuttl][kuttl]. Via kuttl, you can define YAML manifests that specify the expected before and after states of a cluster when your operator is used. For more info see [Writing Kuttl Scorecard Tests][writing-kuttl-scorecard-tests].
4444

45+
An alternative and more modern solution to kuttl is [chainsaw][chainsaw]. Chainsaw offers more flexibility, a rich assertion model, and is actively maintained. Tests from kuttl can be automatically converted to chainsaw, see [Migration from KUTTL][from-kuttl-to-chainsaw].
46+
4547
To implement application-specific tests, the SDK's test harness, [scorecard][scorecard], provides the ability to ship custom code in container images as well, which can be referenced in the test suite. Because this test suite definition metadata travels with the Operator Bundle, it allows for functional testing of the Operator without the source code or the project layout being available. See [Writing Custom Scorecard Tests][writing-custom-scorecard-tests].
4648

4749
[envtest]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/envtest
@@ -59,3 +61,5 @@ To implement application-specific tests, the SDK's test harness, [scorecard][sco
5961
[go-legacy-shell]: https://github.com/operator-framework/operator-sdk/blob/v1.0.0/hack/tests/e2e-go.sh
6062
[helm-legacy-shell]: https://github.com/operator-framework/operator-sdk/blob/v1.0.0/hack/tests/e2e-helm.sh
6163
[ansible-legacy-shell]: https://github.com/operator-framework/operator-sdk/blob/v1.0.0/hack/tests/e2e-ansible.sh
64+
[chainsaw]: https://kyverno.github.io/chainsaw/latest/
65+
[from-kuttl-to-chainsaw]: https://kyverno.github.io/chainsaw/latest/more/kuttl-migration/

0 commit comments

Comments
 (0)