โปรโฮสต์ > บล็อก > การบริหาร > JUnit ใน GitLab CI กับ Kubernetes

JUnit ใน GitLab CI กับ Kubernetes

แม้ว่าทุกคนจะรู้ดีว่าการทดสอบซอฟต์แวร์ของคุณมีความสำคัญและจำเป็นและหลายคนทำโดยอัตโนมัติมาเป็นเวลานาน แต่ในความกว้างใหญ่ของ Habr ไม่มีสูตรสำเร็จเดียวในการตั้งค่าการผสมผสานผลิตภัณฑ์ยอดนิยมดังกล่าวใน ช่องนี้เป็น (รายการโปรดของเรา) GitLab และ JUnit มาเติมเต็มช่องว่างนี้กันเถอะ!

JUnit ใน GitLab CI กับ Kubernetes

เบื้องต้น

ก่อนอื่นให้ฉันให้บริบทบางอย่าง:

  • เนื่องจากแอปพลิเคชันทั้งหมดของเราทำงานบน Kubernetes เราจะพิจารณาดำเนินการทดสอบบนโครงสร้างพื้นฐานที่เหมาะสม
  • สำหรับการประกอบและการปรับใช้ที่เราใช้ เวร (ในแง่ของส่วนประกอบโครงสร้างพื้นฐาน นี่หมายความว่ามีส่วนเกี่ยวข้องกับ Helm โดยอัตโนมัติ)
  • ฉันจะไม่ลงรายละเอียดเกี่ยวกับการสร้างการทดสอบจริง: ในกรณีของเรา ลูกค้าเขียนการทดสอบเอง และเราเพียงแต่รับรองการเปิดตัวของพวกเขาเท่านั้น (และการมีอยู่ของรายงานที่เกี่ยวข้องในคำขอรวม)


ลำดับการกระทำโดยทั่วไปจะมีลักษณะอย่างไร?

  1. การสร้างแอปพลิเคชัน - เราจะละเว้นคำอธิบายของขั้นตอนนี้
  2. ทำให้แอปพลิเคชันใช้งานได้บนเนมสเปซแยกต่างหากของคลัสเตอร์ Kubernetes และเริ่มการทดสอบ
  3. ค้นหาสิ่งประดิษฐ์และแยกวิเคราะห์รายงาน JUnit ด้วย GitLab
  4. การลบเนมสเปซที่สร้างไว้ก่อนหน้านี้

ตอนนี้ - สู่การปฏิบัติ!

การตั้งค่า

GitLab CI

เริ่มจากชิ้นส่วนกันก่อน .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 ด้วย Job กันเถอะ - 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. พีวีและพีวีซีซึ่งช่วยให้คุณสามารถเก็บข้อมูลการทดสอบได้

ให้ความสนใจกับเงื่อนไขเบื้องต้นด้วย if ที่จุดเริ่มต้นของรายการ - ดังนั้นจึงต้องรวมไฟล์ YAML อื่น ๆ ของแผนภูมิ Helm พร้อมแอปพลิเคชันไว้ด้วย ย้อนกลับ ออกแบบเพื่อไม่ให้ถูกปรับใช้ระหว่างการทดสอบ นั่นคือ:

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

อย่างไรก็ตามหากการทดสอบ ต้องการโครงสร้างพื้นฐานบางอย่าง (เช่น Redis, RabbitMQ, Mongo, PostgreSQL...) - YAML ของพวกเขาสามารถ ไม่ ปิด. ปรับใช้ในสภาพแวดล้อมการทดสอบเช่นกัน... ปรับพวกมันตามที่เห็นสมควรแน่นอน

สัมผัสสุดท้าย

เพราะ การประกอบและการปรับใช้โดยใช้ wef ใช้งานได้ในตอนนี้ เท่านั้น บนบิลด์เซิร์ฟเวอร์ (ด้วย gitlab-runner) และพ็อดที่มีการทดสอบเปิดตัวบนต้นแบบ คุณจะต้องสร้างไดเร็กทอรี /mnt/tests บนนายแล้วมอบให้แก่นักวิ่ง เช่น ผ่าน NFS. สามารถดูตัวอย่างโดยละเอียดพร้อมคำอธิบายได้ใน เอกสาร K8.

ผลลัพธ์จะเป็น:

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 โดยตรงบน gitlab-runner แล้วติดตั้งในพ็อด

หมายเหตุ

คุณอาจถามว่าทำไมทุกอย่างถึงซับซ้อนด้วยการสร้างงาน หากคุณสามารถรันสคริปต์พร้อมการทดสอบบนเชลล์รันเนอร์ได้โดยตรง คำตอบค่อนข้างจะไร้สาระ...

การทดสอบบางอย่างจำเป็นต้องเข้าถึงโครงสร้างพื้นฐาน (MongoDB, RabbitMQ, PostgreSQL ฯลฯ) เพื่อตรวจสอบว่าทำงานได้อย่างถูกต้อง เราทำให้การทดสอบเป็นหนึ่งเดียว - ด้วยวิธีนี้ ทำให้ง่ายต่อการรวมเอนทิตีเพิ่มเติมดังกล่าว นอกจากนี้เรายังได้รับ มาตรฐาน วิธีการปรับใช้ (แม้ว่าจะใช้ NFS แต่การติดตั้งไดเร็กทอรีเพิ่มเติม)

ผล

เราจะเห็นอะไรเมื่อเราใช้การกำหนดค่าที่เตรียมไว้?

คำขอรวมจะแสดงสถิติสรุปสำหรับการทดสอบที่ดำเนินการในไปป์ไลน์ล่าสุด:

JUnit ใน GitLab CI กับ Kubernetes

ข้อผิดพลาดแต่ละข้อสามารถคลิกที่นี่เพื่อดูรายละเอียด:

JUnit ใน GitLab CI กับ Kubernetes

NB: ผู้อ่านที่สนใจจะสังเกตเห็นว่าเรากำลังทดสอบแอปพลิเคชัน NodeJS และในภาพหน้าจอ - .NET... อย่าแปลกใจ: ในขณะที่เตรียมบทความไม่พบข้อผิดพลาดในการทดสอบแอปพลิเคชันแรก แต่พวกเขา ถูกพบในอีกที่หนึ่ง

ข้อสรุป

อย่างที่คุณเห็นไม่มีอะไรซับซ้อน!

โดยหลักการแล้ว หากคุณมี Shell Collector อยู่แล้วและใช้งานได้ แต่คุณไม่จำเป็นต้องใช้ Kubernetes การแนบการทดสอบเข้ากับเชลล์จะเป็นงานที่ง่ายกว่าที่อธิบายไว้ที่นี่ และใน เอกสาร GitLab CI คุณจะพบตัวอย่างสำหรับ Ruby, Go, Gradle, Maven และอื่นๆ อีกมากมาย

PS

อ่านเพิ่มเติมในบล็อกของเรา:

ที่มา: will.com

เพิ่มความคิดเห็น