🥇GitLab CI 中的 JUnit 与 Kubernetes

尽管每个人都清楚地知道测试软件是重要且必要的，并且许多人长期以来一直自动进行测试，但在浩瀚的 Habr 中，没有一个单一的方法可以在其中设置此类流行产品的组合。这个利基市场是（我们最喜欢的）GitLab 和 JUnit。让我们来填补这个空白吧！

介绍性

首先，让我提供一些背景信息：

由于我们所有的应用程序都在 Kubernetes 上运行，因此我们将考虑在适当的基础设施上运行测试。
对于组装和部署，我们使用韦尔夫（就基础设施组件而言，这也自动意味着 Helm 的参与）。
我不会详细讨论实际创建测试的细节：在我们的例子中，客户自己编写测试，我们只确保它们的启动（以及合并请求中存在相应的报告）。

一般的行动顺序会是什么样子？

构建应用程序 - 我们将省略此阶段的描述。
将应用程序部署到 Kubernetes 集群的单独命名空间并开始测试。
使用 GitLab 搜索工件并解析 JUnit 报告。
删除以前创建的命名空间。

现在——实施！

调整

亚搏体育app CI

让我们从一个片段开始 .gitlab-ci.yaml，它描述了部署应用程序和运行测试。列表内容相当庞大，因此补充了完整的评论：

variables:
# объявляем версию werf, которую собираемся использовать
  WERF_VERSION: "1.0 beta"

.base_deploy: &base_deploy
  script:
# создаем namespace в K8s, если его нет
    - kubectl --context="${WERF_KUBE_CONTEXT}" get ns ${CI_ENVIRONMENT_SLUG} || kubectl create ns ${CI_ENVIRONMENT_SLUG}
# загружаем werf и деплоим — подробнее об этом см. в документации
# (https://werf.io/how_to/gitlab_ci_cd_integration.html#deploy-stage)
    - type multiwerf && source <(multiwerf use ${WERF_VERSION})
    - werf version
    - type werf && source <(werf ci-env gitlab --tagging-strategy tag-or-branch --verbose)
    - werf deploy --stages-storage :local
      --namespace ${CI_ENVIRONMENT_SLUG}
      --set "global.commit_ref_slug=${CI_COMMIT_REF_SLUG:-''}"
# передаем переменную `run_tests`
# она будет использоваться в рендере Helm-релиза
      --set "global.run_tests=${RUN_TESTS:-no}"
      --set "global.env=${CI_ENVIRONMENT_SLUG}"
# изменяем timeout (бывают долгие тесты) и передаем его в релиз
      --set "global.ci_timeout=${CI_TIMEOUT:-900}"
     --timeout ${CI_TIMEOUT:-900}
  dependencies:
    - Build

.test-base: &test-base
  extends: .base_deploy
  before_script:
# создаем директорию для будущего отчета, исходя из $CI_COMMIT_REF_SLUG
    - mkdir /mnt/tests/${CI_COMMIT_REF_SLUG} || true
# вынужденный костыль, т.к. GitLab хочет получить артефакты в своем build-dir’е
    - mkdir ./tests || true
    - ln -s /mnt/tests/${CI_COMMIT_REF_SLUG} ./tests/${CI_COMMIT_REF_SLUG}
  after_script:
# после окончания тестов удаляем релиз вместе с Job’ом
# (и, возможно, его инфраструктурой)
    - type multiwerf && source <(multiwerf use ${WERF_VERSION})
    - werf version
    - type werf && source <(werf ci-env gitlab --tagging-strategy tag-or-branch --verbose)
    - werf dismiss --namespace ${CI_ENVIRONMENT_SLUG} --with-namespace
# мы разрешаем падения, но вы можете сделать иначе
  allow_failure: true
  variables:
    RUN_TESTS: 'yes'
# задаем контекст в werf
# (https://werf.io/how_to/gitlab_ci_cd_integration.html#infrastructure)
    WERF_KUBE_CONTEXT: 'admin@stage-cluster'
  tags:
# используем раннер с тегом `werf-runner`
    - werf-runner
  artifacts:
# требуется собрать артефакт для того, чтобы его можно было увидеть
# в пайплайне и скачать — например, для более вдумчивого изучения
    paths:
      - ./tests/${CI_COMMIT_REF_SLUG}/*
# артефакты старше недели будут удалены
    expire_in: 7 day
# важно: эти строки отвечают за парсинг отчета GitLab’ом
    reports:
      junit: ./tests/${CI_COMMIT_REF_SLUG}/report.xml

# для упрощения здесь показаны всего две стадии
# в реальности же у вас их будет больше — как минимум из-за деплоя
stages:
  - build
  - tests

build:
  stage: build
  script:
# сборка — снова по документации по werf
# (https://werf.io/how_to/gitlab_ci_cd_integration.html#build-stage)
    - type multiwerf && source <(multiwerf use ${WERF_VERSION})
    - werf version
    - type werf && source <(werf ci-env gitlab --tagging-strategy tag-or-branch --verbose)
    - werf build-and-publish --stages-storage :local
  tags:
    - werf-runner
  except:
    - schedules

run tests:
  <<: *test-base
  environment:
# "сама соль" именования namespace’а
# (https://docs.gitlab.com/ce/ci/variables/predefined_variables.html)
    name: tests-${CI_COMMIT_REF_SLUG}
  stage: tests
  except:
    - schedules

Kubernetes

现在在目录中 .helm/templates 让我们使用 Job 创建 YAML - tests-job.yaml — 运行测试及其所需的 Kubernetes 资源。参见列表后的说明：

{{- if eq .Values.global.run_tests "yes" }}
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: tests-script
data:
  tests.sh: |
    echo "======================"
    echo "${APP_NAME} TESTS"
    echo "======================"

    cd /app
    npm run test:ci
    cp report.xml /app/test_results/${CI_COMMIT_REF_SLUG}/

    echo ""
    echo ""
    echo ""

    chown -R 999:999 /app/test_results/${CI_COMMIT_REF_SLUG}
---
apiVersion: batch/v1
kind: Job
metadata:
  name: {{ .Chart.Name }}-test
  annotations:
    "helm.sh/hook": post-install,post-upgrade
    "helm.sh/hook-weight": "2"
    "werf/watch-logs": "true"
spec:
  activeDeadlineSeconds: {{ .Values.global.ci_timeout }}
  backoffLimit: 1
  template:
    metadata:
      name: {{ .Chart.Name }}-test
    spec:
      containers:
      - name: test
        command: ['bash', '-c', '/app/tests.sh']
{{ tuple "application" . | include "werf_container_image" | indent 8 }}
        env:
        - name: env
          value: {{ .Values.global.env }}
        - name: CI_COMMIT_REF_SLUG
          value: {{ .Values.global.commit_ref_slug }}
       - name: APP_NAME
          value: {{ .Chart.Name }}
{{ tuple "application" . | include "werf_container_env" | indent 8 }}
        volumeMounts:
        - mountPath: /app/test_results/
          name: data
        - mountPath: /app/tests.sh
          name: tests-script
          subPath: tests.sh
      tolerations:
      - key: dedicated
        operator: Exists
      - key: node-role.kubernetes.io/master
        operator: Exists
      restartPolicy: OnFailure
      volumes:
      - name: data
        persistentVolumeClaim:
          claimName: {{ .Chart.Name }}-pvc
      - name: tests-script
        configMap:
          name: tests-script
---
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: {{ .Chart.Name }}-pvc
spec:
  accessModes:
  - ReadWriteOnce
  resources:
    requests:
      storage: 10Mi
  storageClassName: {{ .Chart.Name }}-{{ .Values.global.commit_ref_slug }}
  volumeName: {{ .Values.global.commit_ref_slug }}

---
apiVersion: v1
kind: PersistentVolume
metadata:
  name: {{ .Values.global.commit_ref_slug }}
spec:
  accessModes:
  - ReadWriteOnce
  capacity:
    storage: 10Mi
  local:
    path: /mnt/tests/
  nodeAffinity:
   required:
     nodeSelectorTerms:
     - matchExpressions:
       - key: kubernetes.io/hostname
         operator: In
         values:
         - kube-master
  persistentVolumeReclaimPolicy: Delete
  storageClassName: {{ .Chart.Name }}-{{ .Values.global.commit_ref_slug }}
{{- end }}

什么样的资源 在此配置中描述？部署时，我们为项目创建一个唯一的命名空间（这在 .gitlab-ci.yaml - tests-${CI_COMMIT_REF_SLUG}）并推出：

配置映射 带有测试脚本；
工作包含 pod 的描述和指定的指令 command，它只运行测试；
光伏和聚氯乙烯，允许您存储测试数据。

注意介绍条件 if 在清单的开头 - 因此，带有应用程序的 Helm 图表的其他 YAML 文件必须包装在逆转设计时应确保它们在测试期间不会被部署。那是：

{{- if ne .Values.global.run_tests "yes" }}
---
я другой ямлик
{{- end }}

然而，如果测试 需要一些基础设施 （例如，Redis、RabbitMQ、Mongo、PostgreSQL...） - 它们的 YAML 可以是没有关。也将它们部署到测试环境中......当然，根据您的需要调整它们。

最后的触摸

因为目前可以使用 werf 进行组装和部署仅在构建服务器上（使用 gitlab-runner），并且带有测试的 pod 在 master 上启动，您将需要创建一个目录 /mnt/tests 放在主人身上并交给跑步者， 例如，通过 NFS。带有解释的详细示例可以在 K8s文档.

结果将是：

user@kube-master:~$ cat /etc/exports | grep tests
/mnt/tests    IP_gitlab-builder/32(rw,nohide,insecure,no_subtree_check,sync,all_squash,anonuid=999,anongid=998)

user@gitlab-runner:~$ cat /etc/fstab | grep tests
IP_kube-master:/mnt/tests    /mnt/tests   nfs4    _netdev,auto  0       0

没有人禁止直接在 gitlab-runner 上进行 NFS 共享，然后将其挂载到 pod 中。

注意

您可能会问，如果您可以直接在 shell 运行器上运行带有测试的脚本，为什么要通过创建作业来使一切变得复杂呢？答案很简单……

一些测试需要访问基础设施（MongoDB、RabbitMQ、PostgreSQL 等）以验证它们是否正常工作。我们使测试统一 - 通过这种方法，可以轻松包含此类附加实体。除此之外，我们还得到标准部署方式（即使使用NFS，额外挂载目录）。

导致

当我们应用准备好的配置时，我们会看到什么？

合并请求将显示在其最新管道中运行的测试的摘要统计信息：

每个错误可以点击此处查看详细信息：

NB：细心的读者会注意到我们正在测试一个 NodeJS 应用程序，并且在屏幕截图中 - .NET...不要感到惊讶：只是在准备文章时，在测试第一个应用程序时没有发现错误，但是它们是在另一个地方发现的。

结论

正如您所看到的，没什么复杂的！

原则上，如果您已经有一个 shell 收集器并且它可以工作，但您不需要 Kubernetes，那么对其进行测试将比此处描述的任务更简单。并且在亚搏体育appGitLab CI文档您会找到 Ruby、Go、Gradle、Maven 等示例。

PS

另请阅读我们的博客：

来源： habr.com

GitLab CI 中的 JUnit 与 Kubernetes

介绍性

调整

亚搏体育app CI

Kubernetes

最后的触摸

注意

导致

结论

PS

添加评论 取消回复

添加评论取消回复