🥇 कुबरनेटसह गिटलॅब सीआय मधील ज्युनिट

आपल्या सॉफ्टवेअरची चाचणी करणे महत्वाचे आणि आवश्यक आहे हे प्रत्येकाला चांगले ठाऊक असूनही आणि बरेच जण बर्‍याच काळापासून ते स्वयंचलितपणे करत आहेत, हब्रच्या विशालतेमध्ये अशा लोकप्रिय उत्पादनांचे संयोजन सेट करण्यासाठी एकही कृती नव्हती. हे कोनाडा (आमचे आवडते) GitLab आणि JUnit . चला ही पोकळी भरूया!

प्रास्ताविक

प्रथम, मी काही संदर्भ देतो:

आमची सर्व ऍप्लिकेशन्स कुबर्नेट्सवर चालत असल्याने, आम्ही योग्य पायाभूत सुविधांवर चाचण्या चालवण्याचा विचार करू.
असेंब्ली आणि डिप्लॉयमेंटसाठी आम्ही वापरतो werf (पायाभूत सुविधांच्या घटकांच्या बाबतीत, याचा अर्थ हेल्मचा समावेश आहे असा आपोआप होतो).
मी चाचण्यांच्या वास्तविक निर्मितीच्या तपशीलांमध्ये जाणार नाही: आमच्या बाबतीत, क्लायंट स्वतः चाचण्या लिहितो आणि आम्ही केवळ त्यांचे लॉन्च (आणि विलीनीकरण विनंतीमध्ये संबंधित अहवालाची उपस्थिती) सुनिश्चित करतो.

क्रियांचा सामान्य क्रम कसा दिसेल?

अनुप्रयोग तयार करणे - आम्ही या स्टेजचे वर्णन वगळू.
Kubernetes क्लस्टरच्या वेगळ्या नेमस्पेसवर अनुप्रयोग तैनात करा आणि चाचणी सुरू करा.
आर्टिफॅक्ट्स शोधत आहे आणि GitLab सह JUnit अहवाल पार्स करत आहे.
पूर्वी तयार केलेले नेमस्पेस हटवत आहे.

आता - अंमलबजावणीसाठी!

समायोजन

गिटलाब सीआय

चला एका तुकड्याने सुरुवात करूया .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

कुबेरनेट्स

आता निर्देशिकेत .helm/templates चला जॉबसह YAML तयार करू - tests-job.yaml — चाचण्या आणि कुबरनेट संसाधने चालवण्यासाठी. सूचीबद्ध केल्यानंतर स्पष्टीकरण पहा:

{{- 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, जे फक्त चाचण्या चालवते;
पीव्ही आणि पीव्हीसी, जे तुम्हाला चाचणी डेटा संचयित करण्याची परवानगी देते.

सह परिचयात्मक स्थितीकडे लक्ष द्या if मॅनिफेस्टच्या सुरुवातीला - त्यानुसार, हेल्म चार्टच्या इतर YAML फायली अनुप्रयोगासह गुंडाळल्या पाहिजेत उलट डिझाइन जेणेकरून ते चाचणी दरम्यान तैनात होणार नाहीत. ते आहे:

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

तथापि, जर चाचण्या काही पायाभूत सुविधा आवश्यक आहेत (उदाहरणार्थ, Redis, RabbitMQ, Mongo, PostgreSQL...) - त्यांचे YAML असू शकतात नाही बंद कर. त्यांना चाचणी वातावरणात देखील उपयोजित करा... अर्थातच तुम्हाला योग्य वाटेल तसे समायोजित करा.

अंतिम स्पर्श

कारण आत्तासाठी werf कार्ये वापरून असेंब्ली आणि उपयोजन फक्त बिल्ड सर्व्हरवर (गिटलॅब-रनरसह), आणि चाचण्यांसह पॉड मास्टरवर लॉन्च केला जातो, तुम्हाला एक निर्देशिका तयार करावी लागेल /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

गिटलॅब-रनरवर थेट NFS शेअर करण्यास आणि नंतर ते पॉड्समध्ये माउंट करण्यास कोणीही मनाई करत नाही.

शेरा

तुम्ही कदाचित विचारत असाल की जर तुम्ही थेट शेल रनरवर चाचण्यांसह स्क्रिप्ट चालवू शकत असाल तर जॉब तयार करून सर्वकाही गुंतागुंतीचे का करावे? उत्तर अगदी क्षुल्लक आहे...

काही चाचण्यांना पायाभूत सुविधांमध्ये प्रवेश आवश्यक आहे (MongoDB, RabbitMQ, PostgreSQL, इ.) ते योग्यरित्या कार्य करतात हे सत्यापित करण्यासाठी. आम्ही चाचणी एकत्रित करतो - या दृष्टिकोनासह, अशा अतिरिक्त घटकांचा समावेश करणे सोपे होते. या व्यतिरिक्त, आम्हाला मिळते मानक उपयोजन दृष्टीकोन (NFS वापरत असला तरीही, निर्देशिकांचे अतिरिक्त माउंटिंग).

परिणाम

जेव्हा आपण तयार केलेले कॉन्फिगरेशन लागू करतो तेव्हा आपण काय पाहू शकतो?

विलीनीकरण विनंती त्याच्या नवीनतम पाइपलाइनमध्ये चालवल्या जाणार्‍या चाचण्यांसाठी सारांश आकडेवारी दर्शवेल:

प्रत्येक त्रुटी तपशीलांसाठी येथे क्लिक केली जाऊ शकते:

NB: चौकस वाचकाच्या लक्षात येईल की आम्ही NodeJS ऍप्लिकेशनची चाचणी करत आहोत, आणि स्क्रीनशॉट्समध्ये - .NET... आश्चर्यचकित होऊ नका: लेख तयार करताना, पहिल्या ऍप्लिकेशनची चाचणी करताना कोणत्याही त्रुटी आढळल्या नाहीत, परंतु ते दुसर्‍यामध्ये सापडले.

निष्कर्ष

जसे आपण पाहू शकता, काहीही क्लिष्ट नाही!

तत्वतः, जर तुमच्याकडे आधीपासून शेल कलेक्टर असेल आणि ते कार्य करते, परंतु तुम्हाला कुबर्नेट्सची आवश्यकता नसेल, तर त्यास चाचणी संलग्न करणे येथे वर्णन करण्यापेक्षा सोपे काम असेल. आणि मध्ये GitLab CI दस्तऐवजीकरण तुम्हाला Ruby, Go, Gradle, Maven आणि इतर काही उदाहरणे सापडतील.

PS

आमच्या ब्लॉगवर देखील वाचा:

स्त्रोत: www.habr.com

GitLab CI मधील JUnit कुबर्नेट्ससह