Chart Test

Chart Test

chart包含了很多一起工作的Kubernetes资源和组件。作为一个chart作者，你可能想写一些测试验证chart安装时是否按照预期工作。这些测试同时可以帮助chart用户理解你的chart在做什么。

test 在helm chart中放在 templates/目录，并且是一个指定了容器和给定命令的任务。如果测试通过，容器应该成功退出 (exit 0) 任务的定义必须包含helm测试钩子的注释：helm.sh/hook: test。

注意Helm v3中，任务定义需要包含helm的测试钩子注释之一：helm.sh/hook: test-success 或者 helm.sh/hook: test-failure。 helm.sh/hook: test-success 仍然向后兼容，也可以是 helm.sh/hook: test。

示例测试以下内容：

验证你values.yaml文件中的配置可以正确注入。
- 确保你的用户名和密码是对的
- 确保不正确的用户名和密码不会工作
判断你的服务只启动的并且正确地负载均衡
等等。

你可以在Helm的一个版本中运行预定义的测试，执行 helm test <RELEASE_NAME>。对于chart用户来说，这是验证chart发布（或应用）可以正常运行的很好的方式。

Example Test

helm create命令会自动创建一些目录和文件。要尝试helm的测试功能，需要先创建一个helm chart示例。

$ helm create demo

然后就可以看到示例demo的目录结构如下：

demo/
  Chart.yaml
  values.yaml
  charts/
  templates/
  templates/tests/test-connection.yaml

在demo/templates/tests/test-connection.yaml中，可以试试看到的测试功能，测试pod定义如下：

apiVersion: v1
kind: Pod
metadata:
  name: "{{ include "demo.fullname" . }}-test-connection"
  labels:
    {{- include "demo.labels" . | nindent 4 }}
  annotations:
    "helm.sh/hook": test
spec:
  containers:
    - name: wget
      image: busybox
      command: ['wget']
      args: ['{{ include "demo.fullname" . }}:{{ .Values.service.port }}']
  restartPolicy: Never

运行一个发布版本测试套件的步骤

首先，安装chart到你的集群中创建一个版本。需要等待所有的pod变成active的状态；如果安装之后立即执行test，可能会出现相应的失败，你不得不再执行一次test。

$ helm install demo demo --namespace default
$ helm test demo
NAME: demo
LAST DEPLOYED: Mon Feb 14 20:03:16 2022
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE:     demo-test-connection
Last Started:   Mon Feb 14 20:35:19 2022
Last Completed: Mon Feb 14 20:35:23 2022
Phase:          Succeeded
[...]

注意

你可以在单个yaml文件中定义尽可能多的测试或者分布在templates/目录中的多个yaml文件中。
为了更好地隔离，欢迎你将测试套件嵌套放在tests/目录中，类似<chart-name>/templates/tests/。
一个test就是一个 Helm 钩子，所以类似于 helm.sh/hook-weight和helm.sh/hook-delete-policy的注释可以用于测试资源。