Chart 测试

一个 chart 包含许多一起工作的 Kubernetes 资源和组件。作为 chart 作者，可能需要编写一些测试来验证 chart 在安装时是否按预期工作。这些测试还有助于 chart 消费者了解 chart 应该做什么。

测试 在 Helm chart 中的 templates / 目录，是一个 pod 定义，指定一个给定的命令来运行容器。容器应该成功退出（exit 0），测试被认为是成功的。该 pod 定义必须包含 helm 测试 hook 注释之一：helm.sh/hook: test-success 或 helm.sh/hook: test-failure。

示例测试：

  • 验证来自 values.yaml 文件的配置是否正确注入。
  • 确保用户名和密码正常工作
  • 确保不正确的用户名和密码不起作用
  • 断言服务已启动并正确进行负载平衡
  • 等等

可以使用该 helm test 命令在 release 中运行 Helm 中的预定义测试。对于 chart 使用者来说，这是一种很好的方式来检查他们发布的 chart（或应用程序）是否按预期工作。

Helm 测试 hook 的分解

在 Helm 中，有两个测试 hook：test-success 和 test-failure.

test-success 表示测试 pod 应该成功完成。换句话说，容器中的容器应该 exit 0. test-failure 是一种断言测试容器不能成功完成的方式。如果 pod 中的容器未 exit 0，则表示成功。

示例测试

下面是一个示例 WordPress chart 中 helm 测试 pod 定义的示例。这个测试验证了 mariadb 的连接和登录：

  1. wordpress/
  2.   Chart.yaml
  3.   README.md
  4.   values.yaml
  5.   charts/
  6.   templates/
  7.   templates/tests/test-mariadb-connection.yaml

在 wordpress/templates/tests/test-mariadb-connection.yaml 中：

  1. apiVersion: v1
  2. kind: Pod
  3. metadata:
  4.   name: "{{.Release.Name}}-credentials-test"
  5.   annotations:
  6.     "helm.sh/hook": test-success
  7. spec:
  8.   containers:
  9.   - name: {{.Release.Name}}-credentials-test
  10.     image: {{.Values.image}}
  11.     env:
  12.       - name: MARIADB_HOST
  13.         value: {{template "mariadb.fullname" .}}
  14.       - name: MARIADB_PORT
  15.         value: "3306"
  16.       - name: WORDPRESS_DATABASE_NAME
  17.         value: {{default "" .Values.mariadb.mariadbDatabase | quote}}
  18.       - name: WORDPRESS_DATABASE_USER
  19.         value: {{default "" .Values.mariadb.mariadbUser | quote}}
  20.       - name: WORDPRESS_DATABASE_PASSWORD
  21.         valueFrom:
  22.           secretKeyRef:
  23.             name: {{template "mariadb.fullname" .}}
  24.             key: mariadb-password
  25.     command: ["sh", "-c", "mysql --host=$MARIADB_HOST --port=$MARIADB_PORT --user=$WORDPRESS_DATABASE_USER --password=$WORDPRESS_DATABASE_PASSWORD"]
  26.   restartPolicy: Never

在 release 上运行测试套件的步骤

  1. $ helm install stable\wordpress

    1. NAME:   quirky-walrus
    2. LAST DEPLOYED: Mon Feb 13 13:50:43 2017
    3. NAMESPACE: default
    4. STATUS: DEPLOYED

  2. $ helm test quirky-walrus

    1. RUNNING: quirky-walrus-credentials-test
    2. SUCCESS: quirky-walrus-credentials-test

注意

  • 可以在单个 yaml 文件中定义尽可能多的测试，也可以在 templates / 目录中的多个 yaml 文件中进行分布测试
  • 提倡将测试套件嵌入到一个tests/目录下，比如<chart-name>/templates/tests/以便实现更多隔离