Writing Kuttl Scorecard Tests

This guide outlines the steps which can be followed to implement scorecard tests using the kuttl project and specifically the scorecard kuttl test image.

Defining kuttl Tests in Scorecard

Scorecard users can include kuttl tests within their operator bundles as follows:

.
├── manifests
│   ├── cache.example.com_memcacheds_crd.yaml
│   └── memcached-operator.clusterserviceversion.yaml
├── metadata
│   └── annotations.yaml
└── tests
    └── scorecard
        ├── config.yaml
        └── kuttl
            ├── kuttl-test.yaml
            └── list-pods
                ├── 00-assert.yaml
                └── 00-pod.yaml
            └── list-other
                ├── 00-assert.yaml
                └── 00-pod.yaml
  • bundle/ - Contains bundle manifests and metadata under test.
  • bundle/tests/scorecard/config.yaml - Configuration yaml to define and run scorecard tests.
  • tests/kuttl - Contains tests written for kuttl to execute
  • tests/kuttl/kuttl-test.yaml - Contains the kuttl configuration, it is here that you would add any kuttl specific configuration settings that you might require.
  • tests/kuttl/list-pods - Contains a kuttl test case
  • tests/kuttl/list-pods/00-assert.yaml - Contains a kuttl test case assert
  • tests/kuttl/list-pods/00-pod.yaml - Contains a kuttl test case step
  • tests/kuttl/list-other - Contains another kuttl test case

When the scorecard kuttl binary is executed, it will process all the test cases under the scorecard/kuttl directory within the bundle contents.

Configuring kuttl Tests in the Scorecard Configuration

In the scorecard configuration file, you might have the following definition of what the selector suite=kuttlsuite will translate to:

tests:
- name: "kuttltest1"
  image: quay.io/operator-framework/scorecard-test-kuttl:dev
  labels:
    suite: kuttlsuite
    test: kuttltest1
  description: an ISV custom test that does...

This test configuration will execute the scorecard-test-kuttl image which executes kuttl. The kuttl output is translated into scorecard compliant output which is displayed back to the end user along with any other test results.

With the above kuttl test configuration, you can execute that kuttl test using scorecard as follows:

operator-sdk alpha scorecard deploy/olm-catalog/memcached-operator --selector=suite=kuttlsuite 

Defining kuttl Specific Configuration Options

The kuttl configuration file is documented within the kuttl project.

An example of the kuttl configuration file is as follows:

apiVersion: kudo.dev/v1beta1
kind: TestSuite
parallel: 4
timeout: 120
startControlPlane: false

The important fields to note here are:

  • startControlPlane - Set to false since scorecard assumes it is running within a control plane already.

Other kuttl configurations settings are available for more advanced kuttl use cases. See kuttl configuration for more details on kuttl configuration.

kuttl Tests Explained

The kuttl test tool looks for tests to execute within the bundle following a naming convention as follows:

        └── kuttl
            ├── kuttl-test.yaml
            └── list-pods
                ├── 00-assert.yaml
                └── 00-pod.yaml
            └── list-other
                ├── 00-assert.yaml
                └── 00-pod.yaml

The important fields to note here are:

  • kuttl-test.yaml - The name required for your kuttl configuration file.
  • list-pods, list-other - The names given by you for these test cases.
  • 00-assert.yaml - The assert file is executed to test whether or not the test was successful, this assertion determines whether or not the test passed or failed.
  • 00-pod.yaml - The pod file is used to define what the test will create, in this case a pod will be created based on the manifest within 00-pod.yaml.

The number in front of the assert and pod manifests is used to determine the order in which kuttl will execute the files.

See kuttl tests for a detailed description of how kuttl tests are named and executed.

kuttl Test Privileges

The kuttl tests a user might write can vary widely in functionality and in particular require special Kubernetes RBAC priviledges outside of what your default service account might have. It is therefore very likely you will be required to run scorecard with a custom service account that holds the required RBAC permissions.

You can specify a custom service account in scorecard as follows:

operator-sdk alpha scorecard --service-account=mycustomsa

Also, you can set up a non-default namespace that your tests will be executed within using the following namespace flag:

operator-sdk alpha scorecard --namespace=mycustomns

If you do not specify either of these flags, the default namespace and service account will be used by the scorecard to run test pods.

It is worth noting that scorecard-test-kuttl specifies a namespace to the kubectl-kuttl command which causes kuttl to not create a namespace for each test. This might impact your kuttl tests in that you might need to perform resource cleanup in your tests instead of depending upon namespace deletion to perform that cleanup.