Writing Kuttl Scorecard Tests

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

    • - 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/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.

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

    2. - tests:
    3.   - image: quay.io/operator-framework/scorecard-test-kuttl:dev
    4.     labels:
    5.       suite: kuttlsuite
    6.       test: kuttltest1

    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:

    The kuttl configuration file is documented within the kuttl project.

    1. kind: TestSuite
    2. parallel: 4
    4. 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 for more details on kuttl configuration.

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

    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

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

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

      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.

      Also of note is that in our example kuttl configuration file, we add the suppressLog: events setting which means that kuttl will not log kubernetes events and thereby means you do not have to provide RBAC access for reading kubernetes events to the service account used to run kuttl tests.