Kubernetes සමග GitLab CI හි JUnit

ඔබේ මෘදුකාංගය පරීක්ෂා කිරීම වැදගත් සහ අවශ්‍ය බව සෑම දෙනාම හොඳින් දන්නා අතර, බොහෝ දෙනෙක් එය දිගු කලක් ස්වයංක්‍රීයව කරමින් සිටියද, Habr හි විශාලත්වය තුළ එවැනි ජනප්‍රිය නිෂ්පාදනවල එකතුවක් සැකසීම සඳහා එක වට්ටෝරුවක්වත් නොතිබුණි. මෙම නිකේතනය (අපගේ ප්රියතම) GitLab සහ JUnit . අපි මේ අඩුව පුරවමු!

Kubernetes සමග GitLab CI හි JUnit

හඳුන්වාදීමේ

පළමුව, මට යම් සන්දර්භයක් ලබා දෙන්න:

  • අපගේ සියලුම යෙදුම් Kubernetes මත ක්‍රියාත්මක වන බැවින්, සුදුසු යටිතල පහසුකම් පිළිබඳ පරීක්ෂණ ධාවනය කිරීම අපි සලකා බලමු.
  • එකලස් කිරීම සහ යෙදවීම සඳහා අපි භාවිතා කරමු werf (යටිතල පහසුකම් සංරචක අනුව, මෙය ස්වයංක්‍රීයව අදහස් වන්නේ හෙල්ම් සම්බන්ධ බවයි).
  • මම පරීක්ෂණවල සත්‍ය නිර්මාණය පිළිබඳ විස්තර වෙත නොයමි: අපගේ නඩුවේදී, සේවාදායකයා විසින්ම පරීක්ෂණ ලියන අතර, අපි ඒවා දියත් කිරීම පමණක් සහතික කරමු (සහ ඒකාබද්ධ කිරීමේ ඉල්ලීමේ අනුරූප වාර්තාවක් තිබීම).


සාමාන්‍ය ක්‍රියා අනුපිළිවෙල කෙබඳු වනු ඇත්ද?

  1. යෙදුම ගොඩනැගීම - අපි මෙම අදියරේ විස්තරය ඉවත් කරමු.
  2. යෙදුම Kubernetes පොකුරේ වෙනම නාම අවකාශයකට යොදවා පරීක්ෂා කිරීම ආරම්භ කරන්න.
  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

කුබර්නෙට්ස්

දැන් නාමාවලියෙහි .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}) සහ එය පෙරළන්න:

  1. ConfigMap පරීක්ෂණ පිටපත සමඟ;
  2. රැකියා පොඩ් විස්තරය සහ නිශ්චිත නියෝගය සමඟ command, හුදෙක් පරීක්ෂණ ධාවනය කරන;
  3. PV සහ PVC, පරීක්ෂණ දත්ත ගබඩා කිරීමට ඔබට ඉඩ සලසයි.

සමඟ හඳුන්වාදීමේ තත්ත්වය කෙරෙහි අවධානය යොමු කරන්න if මැනිෆෙස්ටයේ ආරම්භයේදී - ඒ අනුව, යෙදුම සමඟ හෙල්ම් ප්‍රස්ථාරයේ අනෙකුත් 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 බෙදාගැනීමක් සාදා, පසුව එය කරල්වල සවි කිරීම කිසිවෙකු තහනම් නොකරයි.

අදහස් දැක්වීම්

ඔබට කෙලින්ම shell runner මත පරීක්ෂණ සහිත ස්ක්‍රිප්ට් එකක් ධාවනය කළ හැකි නම් රැකියාවක් නිර්මාණය කිරීමෙන් සියල්ල සංකීර්ණ කරන්නේ මන්දැයි ඔබ අසනවා විය හැක. උත්තරේ හරිම තුච්ඡයි...

සමහර පරීක්ෂණ සඳහා යටිතල පහසුකම් (MongoDB, RabbitMQ, PostgreSQL, ආදිය) ඒවා නිවැරදිව ක්‍රියා කරන බව තහවුරු කිරීමට ප්‍රවේශය අවශ්‍ය වේ. අපි පරීක්ෂණ ඒකාබද්ධ කරන්නෙමු - මෙම ප්‍රවේශය සමඟ, එවැනි අතිරේක ආයතන ඇතුළත් කිරීම පහසු වේ. මීට අමතරව, අපට ලැබේ සම්මත යෙදවීමේ ප්‍රවේශය (NFS භාවිතා කළත්, නාමාවලි අතිරේක සවිකිරීම).

ප්රතිඵලය

අපි සකස් කළ වින්‍යාසය යොදන විට අපට පෙනෙන්නේ කුමක්ද?

ඒකාබද්ධ කිරීමේ ඉල්ලීම එහි නවතම නල මාර්ගයේ ධාවනය වන පරීක්ෂණ සඳහා සාරාංශ සංඛ්‍යාලේඛන පෙන්වනු ඇත:

Kubernetes සමග GitLab CI හි JUnit

සෑම දෝෂයක්ම විස්තර සඳහා මෙහි ක්ලික් කළ හැක:

Kubernetes සමග GitLab CI හි JUnit

NB: අපි NodeJS යෙදුමක් පරීක්ෂා කරන බව අවධානයෙන් සිටින පාඨකයාට පෙනෙනු ඇත, සහ තිරපිටපත්වල - .NET... පුදුම නොවන්න: ලිපිය සකස් කිරීමේ කොටසක් ලෙස, පළමු යෙදුම පරීක්ෂා කිරීමේදී කිසිදු දෝෂයක් හමු නොවීය, නමුත් ඒවා තවත් එකකින් හමු විය.

නිගමනය

ඔබට පෙනෙන පරිදි, කිසිවක් සංකීර්ණ නොවේ!

ප්‍රතිපත්තිමය වශයෙන්, ඔබට දැනටමත් කවච එකතු කරන්නෙකු තිබේ නම් සහ එය ක්‍රියාත්මක වේ නම්, නමුත් ඔබට කුබර්නෙට්ස් අවශ්‍ය නොවේ නම්, එයට පරීක්ෂණ ඇමිණීම මෙහි විස්තර කර ඇති ප්‍රමාණයට වඩා සරල කාර්යයක් වනු ඇත. සහ තුළ GitLab CI ලියකියවිලි ඔබට Ruby, Go, Gradle, Maven සහ තවත් සමහරක් සඳහා උදාහරණ සොයාගත හැකිය.

ප්රාදේශීය සභා

අපගේ බ්ලොග් අඩවියේ ද කියවන්න:

මූලාශ්රය: www.habr.com

අදහස් එක් කරන්න