🥇 কুবারনেটেসের সাথে গিটল্যাব সিআই-তে জুনিট

যদিও সবাই ভালভাবে জানে যে আপনার সফ্টওয়্যার পরীক্ষা করা গুরুত্বপূর্ণ এবং প্রয়োজনীয়, এবং অনেকেই এটি স্বয়ংক্রিয়ভাবে দীর্ঘদিন ধরে করে আসছে, হাবরের বিশালতায় এই জাতীয় জনপ্রিয় পণ্যগুলির সংমিশ্রণ সেট আপ করার জন্য একটি রেসিপি ছিল না। (আমাদের প্রিয়) 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

Kubernetes

এখন ডিরেক্টরিতে .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, যা শুধু পরীক্ষা চালায়;
পিভি এবং পিভিসি, যা আপনাকে পরীক্ষার ডেটা সঞ্চয় করতে দেয়।

সঙ্গে পরিচায়ক অবস্থা মনোযোগ দিন 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... অবাক হবেন না: এটি ঠিক যে নিবন্ধটি প্রস্তুত করার সময়, প্রথম অ্যাপ্লিকেশনটি পরীক্ষা করার সময় কোনও ত্রুটি পাওয়া যায়নি, তবে তারা অন্যটিতে পাওয়া গেছে।

উপসংহার

আপনি দেখতে পারেন, কিছুই জটিল!

নীতিগতভাবে, আপনার যদি ইতিমধ্যে একটি শেল সংগ্রাহক থাকে এবং এটি কাজ করে তবে আপনার কুবারনেটসের প্রয়োজন নেই, এটির সাথে পরীক্ষা সংযুক্ত করা এখানে বর্ণিত হওয়ার চেয়ে আরও সহজ কাজ হবে। এবং ভিতরে গিটল্যাব সিআই ডকুমেন্টেশন আপনি রুবি, গো, গ্রেডল, ম্যাভেন এবং আরও কিছু উদাহরণ পাবেন।

দ্রষ্টব্য

আমাদের ব্লগেও পড়ুন:

উত্স: www.habr.com

কুবারনেটসের সাথে গিটল্যাব সিআই-এ JUnit