Helm Unit Tests #29
Helm Unit Tests #29
Conversation
…seqr-helm into benb/barebones_unittests
| @@ -4,6 +4,9 @@ description: A Helm chart for deploying the hail backend of Seqr, an open source | |||
| sources: | |||
| - https://github.com/broadinstitute/seqr | |||
| - https://github.com/broadinstitute/seqr-helm | |||
| maintainers: | |||
There was a problem hiding this comment.
The chart linter not only requires the maintainers section, but requires that the name be discoverable on GitHub, e.g. https://github.com/seqr.
| @@ -52,7 +52,7 @@ initContainers: |- | |||
| {{ end }} | |||
| {{- range $path, $queries := $.Values.cachedReferenceDatasetQueries -}} | |||
| {{- range $query := $queries -}} | |||
| - name: sync-cached-reference-dataset-queries-{{ $path | replace "/" "-" | replace "_" "-" | lower}} | |||
| - name: sync-crdq-{{ $path | replace "/" "-" | replace "_" "-" | lower}}-{{ $query | replace "_" "-" | lower}} | |||
There was a problem hiding this comment.
Testing found a bug with this line... need to be < 63 chars and need to include "$query" in the resource name to avoid having multiple resources with the same name.
| @@ -103,13 +103,13 @@ environment: | |||
| ELASTICSEARCH_SERVICE_PORT: "9200" | |||
| # -- The URL protocol that seqr should use to connect to elasticsearch | |||
| ELASTICSEARCH_PROTOCOL: "http" | |||
| #ELASTICSEARCH_CA_PATH: "/elasticsearch-certs/ca.crt" | |||
| # ELASTICSEARCH_CA_PATH: "/elasticsearch-certs/ca.crt" | |||
There was a problem hiding this comment.
lint related changes.
| os.path.join(WORK_DIR, 'values.yaml') | ||
| ] | ||
|
|
||
| class TestSeqrChart(unittest.TestCase): |
There was a problem hiding this comment.
I made a little test harness that just sanity checks the helm install --dry-run with some values permutations.
The chart-testing tool doesn't have great support for overriding values, and I thought generating a full running set of kubernetes resources for different permutations of values was a little overkill to solve the problem we're having with having bad yaml whitespace.
helm install also gives us a little more validation than helm template as well, as you can see from the cronjob name correctly failing to render.
There was a problem hiding this comment.
Yeah, it's unfortunate that overriding is janky :/, but i think this is a reasonable solution.
If you're looking to validate templated output against the k8s API schema without running kubernetes, there is https://github.com/yannh/kubeconform, which can be helpful. Though, i have found cases with this over in clingen where we're outputting YAML that is API spec compliant, but won't result in a successful deploy, so having some kind of helm install in there somewhere is still good to have.
| @@ -0,0 +1,112 @@ | |||
| replicaCount: 4 | |||
There was a problem hiding this comment.
This is just a set of values that better reflects what we (or also a potential user of this chart) are using.
| kubectl create secret generic seqr-secrets --from-literal=django_key='securely-generated-key' | ||
|
|
||
| # The extra variable is to allow kubernetes to ping our postrgres running locally | ||
| ct install --charts charts/seqr --namespace default --helm-extra-set-args "--set=environment.POSTGRES_SERVICE_HOSTNAME=172.17.0.1" |
There was a problem hiding this comment.
This line basically validates that we can get a seqr service up and passing a health check with the default set of values provided for the seqr chart (so no redis, no ingress, etc). It's useful but limited.
Getting a similar test for hail-search is trickier because that service requires files during the init and at startup... getting that fixed seemed out of scope.
Adds some unit tests, a single "integration" test, and CI for the
seqr/hail-searchtemplating.