🥇कुबेरनेट्स के साथ GitLab CI में JUnit

इस तथ्य के बावजूद कि हर कोई अच्छी तरह से जानता है कि आपके सॉफ़्टवेयर का परीक्षण करना महत्वपूर्ण और आवश्यक है, और कई लोग इसे लंबे समय से स्वचालित रूप से कर रहे हैं, हैबर की विशालता में ऐसे लोकप्रिय उत्पादों के संयोजन को स्थापित करने के लिए एक भी नुस्खा नहीं था। यह स्थान (हमारे पसंदीदा) GitLab और JUnit के रूप में है। आइये इस कमी को पूरा करें!

परिचयात्मक

सबसे पहले, मैं कुछ संदर्भ देता हूँ:

चूँकि हमारे सभी एप्लिकेशन कुबेरनेट्स पर चलते हैं, हम उपयुक्त बुनियादी ढांचे पर परीक्षण चलाने पर विचार करेंगे।
असेंबली और परिनियोजन के लिए हम उपयोग करते हैं Werf (बुनियादी ढांचे के घटकों के संदर्भ में, इसका स्वचालित रूप से यह भी मतलब है कि हेल्म शामिल है)।
मैं परीक्षणों के वास्तविक निर्माण के विवरण में नहीं जाऊंगा: हमारे मामले में, ग्राहक स्वयं परीक्षण लिखता है, और हम केवल उनका लॉन्च (और मर्ज अनुरोध में संबंधित रिपोर्ट की उपस्थिति) सुनिश्चित करते हैं।

क्रियाओं का सामान्य क्रम कैसा दिखेगा?

एप्लिकेशन का निर्माण - हम इस चरण का विवरण छोड़ देंगे।
एप्लिकेशन को कुबेरनेट्स क्लस्टर के एक अलग नेमस्पेस पर तैनात करें और परीक्षण शुरू करें।
कलाकृतियों की खोज करना और 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

Kubernetes

अब निर्देशिका में .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 हो सकते हैं नहीं बंद करें। उन्हें परीक्षण परिवेश में भी तैनात करें... बेशक, जैसा आप उचित समझें, उन्हें समायोजित करें।

अंतिम परिष्करण

क्योंकि वेयरफ़ का उपयोग करके असेंबली और परिनियोजन अभी काम करता है केवल बिल्ड सर्वर पर (gitlab-runner के साथ), और परीक्षणों के साथ पॉड मास्टर पर लॉन्च किया गया है, आपको एक निर्देशिका बनाने की आवश्यकता होगी /mnt/tests गुरु पर और इसे धावक को दे दो, उदाहरण के लिए, एनएफएस के माध्यम से. स्पष्टीकरण के साथ एक विस्तृत उदाहरण यहां पाया जा सकता है 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

कोई भी एनएफएस शेयर को सीधे गिटलैब-रनर पर बनाने और फिर उसे पॉड्स में माउंट करने से मना नहीं करता है।

नोट

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

कुछ परीक्षणों को यह सत्यापित करने के लिए बुनियादी ढांचे (MongoDB, RabbitMQ, PostgreSQL, आदि) तक पहुंच की आवश्यकता होती है कि वे सही ढंग से काम करते हैं। हम परीक्षण को एकीकृत बनाते हैं - इस दृष्टिकोण से, ऐसी अतिरिक्त संस्थाओं को शामिल करना आसान हो जाता है। इसके अतिरिक्त हमें मिलता है मानक परिनियोजन दृष्टिकोण (भले ही एनएफएस का उपयोग कर रहे हों, निर्देशिकाओं की अतिरिक्त माउंटिंग)।

परिणाम

जब हम तैयार कॉन्फ़िगरेशन लागू करेंगे तो हम क्या देखेंगे?

मर्ज अनुरोध इसकी नवीनतम पाइपलाइन में चलाए गए परीक्षणों के सारांश आंकड़े दिखाएगा:

प्रत्येक त्रुटि के विवरण के लिए यहां क्लिक किया जा सकता है:

NB: चौकस पाठक देखेंगे कि हम एक NodeJS एप्लिकेशन का परीक्षण कर रहे हैं, और स्क्रीनशॉट में - .NET... आश्चर्यचकित न हों: यह सिर्फ इतना है कि लेख तैयार करते समय, पहले एप्लिकेशन के परीक्षण में कोई त्रुटि नहीं पाई गई, लेकिन वे दूसरे में पाए गए.

निष्कर्ष

जैसा कि आप देख सकते हैं, कुछ भी जटिल नहीं है!

सिद्धांत रूप में, यदि आपके पास पहले से ही एक शेल कलेक्टर है और यह काम करता है, लेकिन आपको कुबेरनेट्स की आवश्यकता नहीं है, तो इसमें परीक्षण संलग्न करना यहां वर्णित की तुलना में और भी सरल कार्य होगा। और में GitLab सीआई दस्तावेज़ीकरण आपको रूबी, गो, ग्रैडल, मावेन और कुछ अन्य के उदाहरण मिलेंगे।

पुनश्च

हमारे ब्लॉग पर भी पढ़ें:

स्रोत: www.habr.com

Kubernetes के साथ GitLab CI में JUnit