Update your CRDs with confidence

Hello.

I would like to write about a release for crd-to-sample-yaml¹. It’s the release version v0.8.0².

This version brings with it a feature to test the validity of your CRD changes.

It means that if you change your CRD it will test if the changes do not break working samples of that version.

This is achieved by a helm unittest type of YAML based test scenarios and snapshot generation.

It looks something like this:

suite: test crd bootstrap
template: crd-bootstrap/crds/bootstrap_crd.yaml # should point to a CRD that is regularly updated like in a helm chart.
tests:
  - it: matches bootstrap crds correctly
    asserts:
      - matchSnapshot:
          # this will generate one snapshot / CRD version and match all of them to the right version of the CRD
          path: sample-tests/__snapshots__
      - matchSnapshot:
          path: sample-tests/__snapshots__
          # generates a yaml file
          minimal: true
  - it: matches some custom stuff
    asserts:
      - matchString:
          apiVersion: v1alpha1 # this will match this exact version only from the list of versions in the CRD
          kind: Bootstrap
          spec:
            source:
              url:
                url: https://github.com/Skarlso/test

It can be run by pointing cty at it with a command like cty test tests/crds.

More about this can be read on the project’s readme here³.

Enjoy, and I hope it’s helpful.

Thanks!

Update your CRDs with confidence#

Update your CRDs with confidence