Kubernetes を使用した GitLab CI の 🥇JUnit

ソフトウェアのテストが重要かつ必要であることは誰もがよく知っており、多くの人が長い間それを自動的に実行してきたにもかかわらず、広大なハブルでは、そのような人気のある製品を組み合わせてセットアップするための単一のレシピはありませんでした。このニッチは、（私たちのお気に入りの） GitLab や JUnit と同じです。このギャップを埋めていきましょう！

入門

まず、コンテキストを説明します。

すべてのアプリケーションは Kubernetes 上で実行されるため、適切なインフラストラクチャ上でテストを実行することを検討します。
アセンブリとデプロイメントに使用するのはワーフ (インフラストラクチャコンポーネントの観点から見ると、これは自動的に Helm が関与していることも意味します)。
実際のテスト作成の詳細については説明しません。この場合、クライアントは自分でテストを作成し、テストの起動 (およびマージリクエスト内の対応するレポートの存在) を確認するだけです。

アクションの一般的なシーケンスはどのようになりますか?

アプリケーションの構築 - この段階の説明は省略します。
アプリケーションを Kubernetes クラスターの別の名前空間にデプロイし、テストを開始します。
GitLab を使用したアーティファクトの検索と JUnit レポートの解析。
以前に作成した名前空間を削除します。

さあ、実装へ！

調整

GitLab 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}) をロールアウトします。

構成マップ テストスクリプト付き。
ジョブ ポッドの説明と指定されたディレクティブを含む command、テストを実行するだけです。
PVとPVC、テストデータを保存できます。

導入条件に注意してください if マニフェストの先頭 - したがって、アプリケーションを含む Helm チャートの他の YAML ファイルをラップする必要があります。逆行テスト中に展開されないように設計してください。あれは：

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

ただし、テストの場合、 何らかのインフラが必要 (例: Redis、RabbitMQ、Mongo、PostgreSQL...) - それらの YAML はノー消す。それらをテスト環境にも展開します...もちろん、必要に応じて調整します。

最後の仕上げ

なぜなら現時点では werf を使用したアセンブリとデプロイメントが機能しますのみビルドサーバー上 (gitlab-runner を使用) で、テストを含むポッドがマスター上で起動される場合は、ディレクトリを作成する必要があります。 /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 共有を作成し、それをポッドにマウントすることを禁じている人はいません。

注意

シェルランナー上でテストを含むスクリプトを直接実行できるのに、なぜジョブを作成してすべてを複雑にする必要があるのかと疑問に思われるかもしれません。答えは非常に些細なものです...

一部のテストでは、正しく動作することを確認するためにインフラストラクチャ (MongoDB、RabbitMQ、PostgreSQL など) にアクセスする必要があります。私たちはテストを統合します。このアプローチにより、そのような追加のエンティティを含めることが簡単になります。これに加えて、標準導入アプローチ (NFS を使用している場合でも、ディレクトリの追加マウント)。

結果

準備された構成を適用すると何が表示されるでしょうか?

マージリクエストには、最新のパイプラインで実行されたテストの概要統計が表示されます。

各エラーの詳細については、ここをクリックしてください。

NB: 注意深い読者は、スクリーンショットで NodeJS アプリケーションをテストしていることに気づくでしょう - .NET... 驚かないでください。記事の準備中に、最初のアプリケーションのテストでエラーが見つからなかっただけですが、別の場所で発見されました。

まとめ

ご覧のとおり、複雑なことは何もありません。

原則として、シェルコレクターがすでにあり、それが機能するが、Kubernetes が必要ない場合、それにテストをアタッチすることは、ここで説明するタスクよりもさらに簡単になります。そして、 GitLab CI ドキュメント Ruby、Go、Gradle、Maven などの例が見つかります。

PS

私たちのブログもお読みください:

出所： habr.com

Kubernetes を使用した GitLab CI の JUnit

入門

調整

GitLab CI

Kubernetes

最後の仕上げ

注意

結果

まとめ

PS

コメントを追加します返信をキャンセル

Kubernetes を使用した GitLab CI の JUnit

入門

調整

GitLab CI

Kubernetes

最後の仕上げ

注意

結果

まとめ

PS

コメントを追加します 返信をキャンセル

コメントを追加します返信をキャンセル