ప్రోహోస్టర్ > బ్లాగ్ > పరిపాలన > కుబెర్నెట్స్‌తో GitLab CIలో JUnit

కుబెర్నెట్స్‌తో GitLab CIలో JUnit

మీ సాఫ్ట్‌వేర్‌ను పరీక్షించడం చాలా ముఖ్యం మరియు అవసరమని అందరికీ బాగా తెలిసినప్పటికీ, చాలా మంది చాలా కాలంగా స్వయంచాలకంగా దీన్ని చేస్తున్నారు, హబ్ర్ యొక్క విస్తారతలో అటువంటి ప్రసిద్ధ ఉత్పత్తుల కలయికను ఏర్పాటు చేయడానికి ఒక్క రెసిపీ కూడా లేదు. ఈ సముచితం (మాకు ఇష్టమైనది) GitLab మరియు JUnit . ఈ ఖాళీని పూరించుకుందాం!

కుబెర్నెట్స్‌తో GitLab CIలో JUnit

పరిచయ

మొదట, నేను కొంత సందర్భాన్ని ఇస్తాను:

  • మా అప్లికేషన్‌లన్నీ కుబెర్నెట్స్‌లో రన్ అవుతున్నందున, తగిన మౌలిక సదుపాయాలపై పరీక్షలను అమలు చేయడాన్ని మేము పరిశీలిస్తాము.
  • అసెంబ్లీ మరియు విస్తరణ కోసం మేము ఉపయోగిస్తాము వర్ఫ్ (అవస్థాపన భాగాల పరంగా, ఇది స్వయంచాలకంగా హెల్మ్ ప్రమేయం ఉందని కూడా అర్థం).
  • నేను పరీక్షల యొక్క వాస్తవ సృష్టి యొక్క వివరాలలోకి వెళ్లను: మా విషయంలో, క్లయింట్ స్వయంగా పరీక్షలను వ్రాస్తాడు మరియు మేము వారి ప్రారంభాన్ని మాత్రమే నిర్ధారిస్తాము (మరియు విలీన అభ్యర్థనలో సంబంధిత నివేదిక ఉనికి).


సాధారణ చర్యల క్రమం ఎలా ఉంటుంది?

  1. అప్లికేషన్‌ను రూపొందించడం - మేము ఈ దశ యొక్క వివరణను వదిలివేస్తాము.
  2. అప్లికేషన్‌ను కుబెర్నెటెస్ క్లస్టర్ యొక్క ప్రత్యేక నేమ్‌స్పేస్‌లో అమర్చండి మరియు పరీక్షను ప్రారంభించండి.
  3. GitLabతో కళాఖండాల కోసం శోధించడం మరియు JUnit నివేదికలను అన్వయించడం.
  4. గతంలో సృష్టించిన నేమ్‌స్పేస్‌ను తొలగిస్తోంది.

ఇప్పుడు - అమలుకు!

సర్దుబాటు

గిట్‌ల్యాబ్ సిఐ

ఒక భాగంతో ప్రారంభిద్దాం .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}) మరియు దాన్ని బయటకు తీయండి:

  1. ConfigMap పరీక్ష స్క్రిప్ట్‌తో;
  2. Job పాడ్ యొక్క వివరణ మరియు పేర్కొన్న నిర్దేశకంతో command, ఇది కేవలం పరీక్షలను నిర్వహిస్తుంది;
  3. 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

గిట్‌లాబ్-రన్నర్‌లో నేరుగా NFS షేర్ చేయడం, ఆపై పాడ్‌లలో మౌంట్ చేయడాన్ని ఎవరూ నిషేధించరు.

వ్యాఖ్య

మీరు షెల్ రన్నర్‌పై నేరుగా పరీక్షలతో స్క్రిప్ట్‌ను అమలు చేయగలిగితే, ఉద్యోగాన్ని సృష్టించడం ద్వారా ప్రతిదాన్ని ఎందుకు క్లిష్టతరం చేయాలి అని మీరు అడగవచ్చు? సమాధానం చాలా చిన్నది...

కొన్ని పరీక్షలకు అవి సరిగ్గా పని చేస్తున్నాయని ధృవీకరించడానికి అవస్థాపన (MongoDB, RabbitMQ, PostgreSQL, మొదలైనవి) యాక్సెస్ అవసరం. మేము పరీక్షను ఏకీకృతం చేస్తాము - ఈ విధానంతో, అటువంటి అదనపు ఎంటిటీలను చేర్చడం సులభం అవుతుంది. దీనికి అదనంగా, మేము పొందుతాము ప్రామాణిక విస్తరణ విధానం (NFSని ఉపయోగిస్తున్నప్పటికీ, డైరెక్టరీల అదనపు మౌంటు).

ఫలితంగా

మేము సిద్ధం చేసిన కాన్ఫిగరేషన్‌ను వర్తింపజేసినప్పుడు మనం ఏమి చూస్తాము?

విలీనం అభ్యర్థన దాని తాజా పైప్‌లైన్‌లో అమలు చేయబడిన పరీక్షల సారాంశ గణాంకాలను చూపుతుంది:

కుబెర్నెట్స్‌తో GitLab CIలో JUnit

ప్రతి లోపం వివరాల కోసం ఇక్కడ క్లిక్ చేయవచ్చు:

కుబెర్నెట్స్‌తో GitLab CIలో JUnit

NB: శ్రద్ధగల రీడర్ మేము NodeJS అప్లికేషన్‌ని పరీక్షిస్తున్నామని మరియు స్క్రీన్‌షాట్‌లలో - .NET... ఆశ్చర్యపోకండి: కథనం యొక్క తయారీలో భాగంగా, మొదటి అప్లికేషన్‌ను పరీక్షించడంలో ఎటువంటి లోపాలు కనుగొనబడలేదు, కానీ అవి మరొకదానిలో కనుగొనబడ్డాయి.

తీర్మానం

మీరు గమనిస్తే, సంక్లిష్టంగా ఏమీ లేదు!

సూత్రప్రాయంగా, మీకు ఇప్పటికే షెల్ కలెక్టర్ ఉంటే మరియు అది పని చేస్తుంది, కానీ మీకు కుబెర్నెట్స్ అవసరం లేదు, దానికి పరీక్షను జోడించడం ఇక్కడ వివరించిన దానికంటే చాలా సులభమైన పని. మరియు లోపల GitLab CI డాక్యుమెంటేషన్ మీరు రూబీ, గో, గ్రాడిల్, మావెన్ మరియు మరికొన్నింటికి ఉదాహరణలను కనుగొంటారు.

PS

మా బ్లాగులో కూడా చదవండి:

మూలం: www.habr.com

ఒక వ్యాఖ్యను జోడించండి