કુબરનેટ્સ સાથે GitLab CI માં JUnit

એ હકીકત હોવા છતાં કે દરેક વ્યક્તિ સારી રીતે જાણે છે કે તમારા સૉફ્ટવેરનું પરીક્ષણ કરવું મહત્વપૂર્ણ અને આવશ્યક છે, અને ઘણા લાંબા સમયથી તે આપમેળે કરી રહ્યા છે, હેબરની વિશાળતામાં આવા લોકપ્રિય ઉત્પાદનોના સંયોજનને સેટ કરવા માટે એક પણ રેસીપી નહોતી. (અમારા મનપસંદ) GitLab અને 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

ક્યુબર્નેટિસ

હવે ડિરેક્ટરીમાં .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. જોબ પોડના વર્ણન અને ઉલ્લેખિત નિર્દેશ સાથે command, જે ફક્ત પરીક્ષણો ચલાવે છે;
3. પીવી અને પીવીસી, જે તમને ટેસ્ટ ડેટા સ્ટોર કરવાની મંજૂરી આપે છે.

સાથે પ્રારંભિક સ્થિતિ પર ધ્યાન આપો if મેનિફેસ્ટની શરૂઆતમાં - તદનુસાર, એપ્લિકેશન સાથે હેલ્મ ચાર્ટની અન્ય YAML ફાઇલો આવરિત હોવી આવશ્યક છે વિપરીત ડિઝાઇન જેથી તેઓ પરીક્ષણ દરમિયાન તૈનાત ન થાય. તે જ:

{{- if ne .Values.global.run_tests "yes" }}
---
я другой ямлик
{{- end }}

જો કે, જો પરીક્ષણો અમુક ઇન્ફ્રાસ્ટ્રક્ચરની જરૂર છે (ઉદાહરણ તરીકે, Redis, RabbitMQ, Mongo, PostgreSQL...) - તેમના YAML હોઈ શકે છે નથી બંધ કરો તેમને પરીક્ષણ વાતાવરણમાં પણ ગોઠવો... અલબત્ત, તમને યોગ્ય લાગે તેમ તેમને સમાયોજિત કરો.

અંતિમ સ્પર્શ

કારણ કે એસેમ્બલી અને જમાવટ હમણાં માટે વર્ફ વર્ક્સનો ઉપયોગ કરીને માત્ર બિલ્ડ સર્વર પર (ગીટલેબ-રનર સાથે), અને પરીક્ષણો સાથેનો પોડ માસ્ટર પર લોંચ કરવામાં આવે છે, તમારે ડિરેક્ટરી બનાવવાની જરૂર પડશે /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: સચેત વાચક જોશે કે અમે નોડજેએસ એપ્લિકેશનનું પરીક્ષણ કરી રહ્યા છીએ, અને સ્ક્રીનશોટમાં - .NET... આશ્ચર્ય પામશો નહીં: લેખની તૈયારીના ભાગરૂપે, પ્રથમ એપ્લિકેશનના પરીક્ષણમાં કોઈ ભૂલો મળી નથી, પરંતુ તેઓ બીજામાં મળી આવ્યા હતા.

નિષ્કર્ષ

જેમ તમે જોઈ શકો છો, કંઈ જટિલ નથી!

સૈદ્ધાંતિક રીતે, જો તમારી પાસે પહેલેથી જ શેલ કલેક્ટર છે અને તે કામ કરે છે, પરંતુ તમારે કુબરનેટ્સની જરૂર નથી, તો તેની સાથે પરીક્ષણ જોડવું એ અહીં વર્ણવેલ કરતાં વધુ સરળ કાર્ય હશે. અને માં GitLab CI દસ્તાવેજીકરણ તમને રૂબી, ગો, ગ્રેડલ, માવેન અને અન્ય કેટલાક ઉદાહરણો મળશે.

PS

અમારા બ્લોગ પર પણ વાંચો:

• «કુબરનેટ્સ અને ગિટલેબ સાથે શ્રેષ્ઠ CI/CD પ્રેક્ટિસ (સમીક્ષા અને વિડિયો રિપોર્ટ)»;
• «GitLab CI માં કસ્ટમ વર્કફ્લો બનાવવા માટેની ટિપ્સ»;
• «ઉત્પાદનમાં સતત એકીકરણ અને ડિલિવરી માટે GitLab CI».

સોર્સ: www.habr.com