Introduce Helm Chart Test Framework Along With Basic Tests #9
Conversation
mkysel
changed the title
mkysel
force-pushed
the
mkysel/helm-tests
branch
from
b59665d
to
5b70659
Compare
| go-lint-fmt: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 |
There was a problem hiding this comment.
| - uses: actions/checkout@v2 | |
| - uses: actions/checkout@v4 |
| - name: Set up Go | ||
| uses: actions/setup-go@v2 | ||
| with: | ||
| go-version: 1.23 |
There was a problem hiding this comment.
In general, when it comes to maintaining versions in CI/CD I'd suggest using some kind of version control system.
For example this one https://github.com/smartcontractkit/tool-versions-to-env-action, which centralizes all the versions in a file .tool-versions in the root of the repository, with this format:
golang 1.22.9
golangci-lint 1.62.0
task 3.40.0
setup-go 5
Then, to call it from a workflow it would look like this:
- uses: smartcontractkit/tool-versions-to-env-action@aabd5efbaf28005284e846c5cf3a02f2cba2f4c2 # v1.0.8
id: tool-versions
- name: Setup go ${{ steps.tool-versions.outputs.golang_version }}
uses: actions/setup-go@${{ steps.tool-versions.outputs.setup-go_version }}
with:
go-version: ${{ steps.tool-versions.outputs.golang_version }}
| ) | ||
|
|
||
| func installDB(t *testing.T, options *helm.Options, helmChartReleaseName string) { | ||
| helm.Install(t, options, "oci://registry-1.docker.io/bitnamicharts/postgresql", helmChartReleaseName) |
There was a problem hiding this comment.
nit: probably out of the scope for this PR, but this could be moved to a const and potentially be overridden with a flag provided by the user. I'm thinking here about some admin that wants to customize the bitnami postgresql for example.
| func findXmtpContainer(pod *corev1.Pod) *corev1.Container { | ||
| // look for any container named "xmtp" that has logs | ||
| for _, container := range pod.Spec.Containers { | ||
| if (container.Name == "xmtpd") && doesContainerHaveLogs(&container, pod.Status.ContainerStatuses) { |
There was a problem hiding this comment.
nit: I usually default to create a const for every value like "xmtpd" subject to change at some point.
|
|
||
| AwaitNrReplicasReady(t, namespaceName, mlsDeployment, replicaCount) | ||
|
|
||
| return |
There was a problem hiding this comment.
nit: personally I'd adhere to the golang style guide and use naked returns in really small and simple funcs, where it's guaranteed to be readable. Obviously this is not an issue!
We had no tests of the Helm charts in the past. This fixes that.
The tests are based on
gruntwork-io/terratestwhich allow you to assert certain facts about the Kubernetes environment. The basic set of tests installs a chart using the minimal set of variables and asserts that the pods start succesfully.We now test MLS validation, payer service and the main sync+API service. I will make a follow-up PR that splits the sync service from the API service.
The majority of the code here is required to handle the weird Github actions environment that does not allow for easy log collection. The framework collects all relevant logs, dumps them to a file and collects all these files as a CI artefact.
Each test runs in its own namespace, so in theory, we could run them all in parallel. This also allows for easy cleanup for local testing as all you have to do is delete the namespace.
We can use this framework for much more complicated stuff if we felt like it. For now, it just ensures that the charts actually work.
Fixes #1