🥇JUnit GitLab CI मा Kubernetes सँग | प्रोहोस्टर

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

परिचयात्मक

पहिले, मलाई केहि सन्दर्भ दिनुहोस्:

हाम्रा सबै एप्लिकेसनहरू Kubernetes मा चल्ने भएकोले, हामी उपयुक्त पूर्वाधारमा परीक्षण चलाउने विचार गर्नेछौं।
विधानसभा र तैनाती को लागी हामी प्रयोग गर्छौं वाफ (पूर्वाधार घटकहरूको सन्दर्भमा, यसको स्वचालित अर्थ हो कि हेलम संलग्न छ)।
म परीक्षणहरूको वास्तविक सिर्जनाको विवरणहरूमा जानेछैन: हाम्रो मामलामा, ग्राहकले आफैंले परीक्षणहरू लेख्छ, र हामी केवल तिनीहरूको सुरुवात (र मर्ज अनुरोधमा सम्बन्धित रिपोर्टको उपस्थिति) सुनिश्चित गर्छौं।

कार्यहरूको सामान्य अनुक्रम कस्तो देखिन्छ?

अनुप्रयोग निर्माण गर्दै - हामी यस चरणको विवरण छोड्नेछौं।
अनुप्रयोगलाई Kubernetes क्लस्टरको छुट्टै नेमस्पेसमा डिप्लोय गर्नुहोस् र परीक्षण सुरु गर्नुहोस्।
कलाकृतिहरू खोज्दै र GitLab सँग JUnit रिपोर्टहरू पार्स गर्दै।
पहिले सिर्जना गरिएको नेमस्पेस मेटाउँदै।

अब - कार्यान्वयन गर्न!

समायोजन

GitLab सीआई

एक टुक्रा संग सुरु गरौं .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 - परीक्षणहरू चलाउन र यसलाई आवश्यक पर्ने 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 म्यानिफेस्टको सुरुमा - तदनुसार, एप्लिकेसनको साथ हेल्म चार्टका अन्य 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

Gitlab-runner मा सिधै NFS सेयर बनाउन, र त्यसपछि यसलाई पोडमा माउन्ट गर्न कसैले निषेध गर्दैन।

भन्नु

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

केही परीक्षणहरूलाई पूर्वाधारमा पहुँच चाहिन्छ (MongoDB, RabbitMQ, PostgreSQL, आदि) तिनीहरूले सही रूपमा काम गर्छन् भनेर प्रमाणित गर्न। हामी परीक्षणलाई एकीकृत बनाउँछौं - यस दृष्टिकोणबाट, त्यस्ता थप संस्थाहरू समावेश गर्न सजिलो हुन्छ। यसका अतिरिक्त, हामीले पाउँछौं मानक तैनाती दृष्टिकोण (NFS प्रयोग गर्दा पनि, डाइरेक्टरीहरूको अतिरिक्त माउन्टिङ)।

परिणाम

हामीले तयार कन्फिगरेसन लागू गर्दा हामी के देख्नेछौं?

मर्ज अनुरोधले यसको पछिल्लो पाइपलाइनमा चलाइएको परीक्षणहरूको लागि सारांश तथ्याङ्कहरू देखाउनेछ:

प्रत्येक त्रुटि विवरणहरूको लागि यहाँ क्लिक गर्न सकिन्छ:

NB: ध्यान दिएर पाठकले हामीले NodeJS एप्लिकेसनको परीक्षण गर्दैछौं, र स्क्रिनसटहरूमा - .NET... अचम्म नमान्नुहोस्: यो मात्र हो कि लेख तयार गर्दा, पहिलो अनुप्रयोग परीक्षण गर्दा कुनै त्रुटिहरू फेला परेनन्, तर तिनीहरू अर्कोमा भेटियो।

निष्कर्षमा

तपाईले देख्न सक्नुहुन्छ, केहि पनि जटिल छैन!

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

PS

हाम्रो ब्लगमा पनि पढ्नुहोस्:

स्रोत: www.habr.com

Kubernetes संग GitLab CI मा JUnit