प्रोहोस्टर > ब्लॉग > प्रशासन > गिटलैब शैल रनर। डॉकर कंपोज़ का उपयोग करके परीक्षण की गई सेवाओं का प्रतिस्पर्धी लॉन्च
गिटलैब शैल रनर। डॉकर कंपोज़ का उपयोग करके परीक्षण की गई सेवाओं का प्रतिस्पर्धी लॉन्च
यह लेख परीक्षकों और डेवलपर्स दोनों के लिए रुचिकर होगा, लेकिन मुख्य रूप से स्वचालन विशेषज्ञों के लिए है, जो अपर्याप्त बुनियादी ढांचे संसाधनों और/या कंटेनर की अनुपस्थिति की स्थिति में एकीकरण परीक्षण के लिए GitLab CI/CD स्थापित करने की समस्या का सामना कर रहे हैं। आर्केस्ट्रा मंच. मैं आपको बताऊंगा कि एक एकल GitLab शेल रनर पर डॉकर कंपोज़ का उपयोग करके परीक्षण वातावरण की तैनाती कैसे सेट की जाए और ताकि कई वातावरणों को तैनात करते समय, लॉन्च की गई सेवाएं एक-दूसरे के साथ हस्तक्षेप न करें।
मेरे व्यवहार में, अक्सर ऐसा होता था कि परियोजनाओं पर एकीकरण परीक्षण का "उपचार" किया जाता था। और अक्सर पहली और सबसे महत्वपूर्ण समस्या सीआई पाइपलाइन होती है, जिसमें एकीकरण परीक्षण होता है विकसित किया जा रहा सेवाएँ एक विकास/मंच वातावरण में की जाती हैं। इससे काफी समस्याएँ उत्पन्न हुईं:
एकीकरण परीक्षण के दौरान किसी विशेष सेवा में दोष के कारण, टूटे हुए डेटा से परीक्षण सर्किट क्षतिग्रस्त हो सकता है। ऐसे मामले थे जब टूटे हुए JSON प्रारूप के साथ अनुरोध भेजने से सेवा क्रैश हो गई, जिससे स्टैंड पूरी तरह से निष्क्रिय हो गया।
परीक्षण डेटा बढ़ने पर परीक्षण सर्किट धीमा हो जाता है। मुझे लगता है कि डेटाबेस को साफ करने/वापस लाने के उदाहरण का वर्णन करने का कोई मतलब नहीं है। अपने अभ्यास में, मुझे ऐसा कोई प्रोजेक्ट नहीं मिला जहां यह प्रक्रिया सुचारू रूप से चली हो।
सामान्य सिस्टम सेटिंग्स का परीक्षण करते समय परीक्षण सर्किट की कार्यक्षमता बाधित होने का जोखिम होता है। उदाहरण के लिए, उपयोगकर्ता/समूह/पासवर्ड/एप्लिकेशन नीति।
स्वचालित परीक्षणों से प्राप्त परीक्षण डेटा मैन्युअल परीक्षकों के लिए जीवन कठिन बना देता है।
कुछ लोग कहेंगे कि अच्छे ऑटोटेस्ट को डेटा को स्वयं साफ़ करना चाहिए। मेरे पास इसके विरुद्ध तर्क हैं:
डायनामिक स्टैंड का उपयोग करना बहुत सुविधाजनक है।
प्रत्येक ऑब्जेक्ट को एपीआई के माध्यम से सिस्टम से नहीं हटाया जा सकता है। उदाहरण के लिए, किसी ऑब्जेक्ट को हटाने का कॉल लागू नहीं किया गया क्योंकि यह व्यावसायिक तर्क के विपरीत है।
एपीआई के माध्यम से ऑब्जेक्ट बनाते समय, बड़ी मात्रा में मेटाडेटा बनाया जा सकता है, जिसे हटाना समस्याग्रस्त है।
यदि परीक्षणों में आपस में निर्भरताएँ हैं, तो परीक्षण चलाने के बाद डेटा साफ़ करने की प्रक्रिया सिरदर्द बन जाती है।
एपीआई पर अतिरिक्त (और, मेरी राय में, उचित नहीं) कॉल।
और मुख्य तर्क: जब परीक्षण डेटा सीधे डेटाबेस से साफ़ होना शुरू हो जाता है। यह एक वास्तविक पीके/एफके सर्कस में बदल रहा है! हम डेवलपर्स से सुनते हैं: "मैंने अभी एक चिह्न जोड़ा/हटाया/नाम बदला है, 100500 एकीकरण परीक्षण क्यों पकड़े गए?"
मेरी राय में, सबसे इष्टतम समाधान एक गतिशील वातावरण है।
कई लोग परीक्षण वातावरण चलाने के लिए डॉकर-कंपोज़ का उपयोग करते हैं, लेकिन सीआई/सीडी में एकीकरण परीक्षण करते समय कुछ लोग डॉकर-कंपोज़ का उपयोग करते हैं। और यहां मैं कुबेरनेट्स, झुंड और अन्य कंटेनर ऑर्केस्ट्रेशन प्लेटफार्मों को ध्यान में नहीं रख रहा हूं। हर कंपनी के पास ये नहीं हैं. यह अच्छा होता यदि docker-compose.yml सार्वभौमिक होता।
भले ही हमारे पास अपना स्वयं का QA रनर हो, हम यह कैसे सुनिश्चित कर सकते हैं कि docker-compose के माध्यम से लॉन्च की गई सेवाएँ एक-दूसरे के साथ हस्तक्षेप न करें?
परीक्षण की गई सेवाओं के लॉग कैसे एकत्रित करें?
धावक को कैसे साफ़ करें?
मेरे पास अपनी परियोजनाओं के लिए अपना खुद का GitLab रनर है और विकास के दौरान मुझे इन सवालों का सामना करना पड़ा जावा क्लाइंट के लिए टेस्ट रेल. अधिक सटीक रूप से, एकीकरण परीक्षण चलाते समय। नीचे हम इस परियोजना के उदाहरणों का उपयोग करके इन मुद्दों को हल करेंगे।
एक धावक के लिए, मैं 4 वीसीपीयू, 4 जीबी रैम, 50 जीबी एचडीडी के साथ एक लिनक्स वर्चुअल मशीन की सिफारिश करता हूं।
इंटरनेट पर गिटलैब-रनर स्थापित करने के बारे में बहुत सारी जानकारी है, इसलिए संक्षेप में:
SSH के माध्यम से मशीन में लॉगिन करें
यदि आपके पास 8 जीबी से कम रैम है, तो मैं अनुशंसा करता हूं 10 जीबी स्वैप करेंताकि OOM किलर आकर RAM की कमी के कारण हमारे कार्यों को ख़त्म न कर दे। ऐसा तब हो सकता है जब 5 से अधिक कार्य एक साथ लॉन्च किए जाएं। कार्य धीरे-धीरे, लेकिन तेजी से आगे बढ़ेंगे।
OOM किलर के साथ उदाहरण
यदि आप कार्य लॉग में देखते हैं bash: line 82: 26474 Killed, तो बस धावक पर अमल करें sudo dmesg | grep 26474
[26474] 1002 26474 1061935 123806 339 0 0 java
Out of memory: Kill process 26474 (java) score 127 or sacrifice child
Killed process 26474 (java) total-vm:4247740kB, anon-rss:495224kB, file-rss:0kB, shmem-rss:0kB
और अगर चित्र कुछ इस तरह दिखता है, तो या तो स्वैप जोड़ें या रैम जोड़ें।
यह आपको एक धावक पर समानांतर कार्य चलाने की अनुमति देगा। और पढ़ें यहां.
यदि आपके पास अधिक शक्तिशाली मशीन है, उदाहरण के लिए 8 वीसीपीयू, 16 जीबी रैम, तो इन संख्याओं को कम से कम 2 गुना बड़ा किया जा सकता है। लेकिन यह सब इस बात पर निर्भर करता है कि वास्तव में इस धावक पर क्या लॉन्च किया जाएगा और कितनी मात्रा में।
मुख्य कार्य एक सार्वभौमिक docker-compose.yml है, जिसे डेवलपर्स/परीक्षक स्थानीय और सीआई पाइपलाइन दोनों में उपयोग कर सकते हैं।
सबसे पहले, हम सीआई के लिए अद्वितीय सेवा नाम बनाते हैं। GitLab CI में अद्वितीय वेरिएबल्स में से एक वेरिएबल है CI_JOB_ID. यदि आप निर्दिष्ट करते हैं container_name अर्थ सहित "service-${CI_JOB_ID:-local}", तो मामले में:
अगर CI_JOB_ID पर्यावरण चर में परिभाषित नहीं,
तो सेवा का नाम होगा service-local
अगर CI_JOB_ID पर्यावरण चर में परिभाषित (उदाहरण के लिए 123),
तो सेवा का नाम होगा service-123
दूसरे, हम लॉन्च की गई सेवाओं के लिए एक सामान्य नेटवर्क बनाते हैं। एकाधिक परीक्षण वातावरण चलाते समय यह हमें नेटवर्क-स्तरीय अलगाव देता है।
टिप्पणियों के साथ मेरे docker-compose.yml का उदाहरण
version: "3"
# Для корректной работы web (php) и fmt нужно,
# чтобы контейнеры имели общий исполняемый контент.
# В нашем случае, это директория /var/www/testrail
volumes:
static-content:
# Изолируем окружение на сетевом уровне
networks:
default:
external:
name: testrail-network-${CI_JOB_ID:-local}
services:
db:
image: mysql:5.7.22
# Каждый container_name содержит ${CI_JOB_ID:-local}
container_name: "testrail-mysql-${CI_JOB_ID:-local}"
environment:
MYSQL_HOST: db
MYSQL_DATABASE: mydb
MYSQL_ROOT_PASSWORD: 1234
SKIP_GRANT_TABLES: 1
SKIP_NETWORKING: 1
SERVICE_TAGS: dev
SERVICE_NAME: mysql
networks:
- default
migration:
image: registry.gitlab.com/touchbit/image/testrail/migration:latest
container_name: "testrail-migration-${CI_JOB_ID:-local}"
links:
- db
depends_on:
- db
networks:
- default
fpm:
image: registry.gitlab.com/touchbit/image/testrail/fpm:latest
container_name: "testrail-fpm-${CI_JOB_ID:-local}"
volumes:
- static-content:/var/www/testrail
links:
- db
networks:
- default
web:
image: registry.gitlab.com/touchbit/image/testrail/web:latest
container_name: "testrail-web-${CI_JOB_ID:-local}"
# Если переменные TR_HTTP_PORT или TR_HTTPS_PORTS не определены,
# то сервис поднимается на 80 и 443 порту соответственно.
ports:
- ${TR_HTTP_PORT:-80}:80
- ${TR_HTTPS_PORT:-443}:443
volumes:
- static-content:/var/www/testrail
links:
- db
- fpm
networks:
- default
Integration:
stage: test
tags:
- my-shell-runner
before_script:
# Аутентифицируемся в registry
- docker login -u gitlab-ci-token -p ${CI_JOB_TOKEN} ${CI_REGISTRY}
# Генерируем псевдоуникальные TR_HTTP_PORT и TR_HTTPS_PORT
- export TR_HTTP_PORT=$(shuf -i10000-60000 -n1)
- export TR_HTTPS_PORT=$(shuf -i10000-60000 -n1)
# создаем директорию с идентификатором задачи
- mkdir ${CI_JOB_ID}
# копируем в созданную директорию наш docker-compose.yml
# чтобы контекст был разный для каждой задачи
- cp .indirect/docker-compose.yml ${CI_JOB_ID}/docker-compose.yml
script:
# поднимаем наше окружение
- make docker-up
# запускаем тесты исполняемым jar (у меня так)
- java -jar itest.jar --http-port ${TR_HTTP_PORT} --https-port ${TR_HTTPS_PORT}
# или в контейнере
- docker run --network=testrail-network-${CI_JOB_ID:-local} --rm itest
after_script:
# собираем логи
- make docker-logs
# останавливаем окружение
- make docker-kill
artifacts:
# сохраняем логи
when: always
paths:
- logs
expire_in: 30 days
ऐसे कार्य को चलाने के परिणामस्वरूप, कलाकृतियों में लॉग निर्देशिका में सेवा और परीक्षण लॉग होंगे। जो त्रुटियों की स्थिति में बहुत सुविधाजनक है। प्रत्येक परीक्षण समानांतर में अपना स्वयं का लॉग लिखता है, लेकिन मैं इस बारे में अलग से बात करूंगा।
$ docker login -u gitlab-ci-token -p ${CI_JOB_TOKEN} ${CI_REGISTRY}
WARNING! Using --password via the CLI is insecure. Use --password-stdin.
WARNING! Your password will be stored unencrypted in /home/gitlab-runner/.docker/config.json.
Configure a credential helper to remove this warning. See
https://docs.docker.com/engine/reference/commandline/login/#credentials-store
Login Succeeded
$ export TR_HTTP_PORT=$(shuf -i10000-60000 -n1)
$ export TR_HTTPS_PORT=$(shuf -i10000-60000 -n1)
$ mkdir ${CI_JOB_ID}
$ cp .indirect/docker-compose.yml ${CI_JOB_ID}/docker-compose.yml
$ make docker-up
docker-compose -f ${CI_JOB_ID:-.indirect}/docker-compose.yml kill
docker network rm testrail-network-${CI_JOB_ID:-local} || true
Error: No such network: testrail-network-204645172
docker network create testrail-network-${CI_JOB_ID:-local}
0a59552b4464b8ab484de6ae5054f3d5752902910bacb0a7b5eca698766d0331
docker-compose -f ${CI_JOB_ID:-.indirect}/docker-compose.yml pull
Pulling web ... done
Pulling fpm ... done
Pulling migration ... done
Pulling db ... done
docker-compose -f ${CI_JOB_ID:-.indirect}/docker-compose.yml up --force-recreate --renew-anon-volumes -d
Creating volume "204645172_static-content" with default driver
Creating testrail-mysql-204645172 ...
Creating testrail-mysql-204645172 ... done
Creating testrail-migration-204645172 ... done
Creating testrail-fpm-204645172 ... done
Creating testrail-web-204645172 ... done
docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
c6b76f9135ed registry.gitlab.com/touchbit/image/testrail/web:latest "nginx -g 'daemon of…" 13 seconds ago Up 1 second 0.0.0.0:51148->80/tcp, 0.0.0.0:25426->443/tcp testrail-web-204645172
01d303262d8e registry.gitlab.com/touchbit/image/testrail/fpm:latest "docker-php-entrypoi…" 16 seconds ago Up 13 seconds 9000/tcp testrail-fpm-204645172
2cdab1edbf6a registry.gitlab.com/touchbit/image/testrail/migration:latest "docker-entrypoint.s…" 16 seconds ago Up 13 seconds 3306/tcp, 33060/tcp testrail-migration-204645172
826aaf7c0a29 mysql:5.7.22 "docker-entrypoint.s…" 18 seconds ago Up 16 seconds 3306/tcp testrail-mysql-204645172
6dbb3fae0322 registry.gitlab.com/touchbit/image/testrail/web:latest "nginx -g 'daemon of…" 36 seconds ago Up 22 seconds 0.0.0.0:44202->80/tcp, 0.0.0.0:20151->443/tcp testrail-web-204645084
3540f8d448ce registry.gitlab.com/touchbit/image/testrail/fpm:latest "docker-php-entrypoi…" 38 seconds ago Up 35 seconds 9000/tcp testrail-fpm-204645084
70fea72aa10d mysql:5.7.22 "docker-entrypoint.s…" 40 seconds ago Up 37 seconds 3306/tcp testrail-mysql-204645084
d8aa24b2892d registry.gitlab.com/touchbit/image/testrail/web:latest "nginx -g 'daemon of…" About a minute ago Up 53 seconds 0.0.0.0:31103->80/tcp, 0.0.0.0:43872->443/tcp testrail-web-204644881
6d4ccd910fad registry.gitlab.com/touchbit/image/testrail/fpm:latest "docker-php-entrypoi…" About a minute ago Up About a minute 9000/tcp testrail-fpm-204644881
685d8023a3ec mysql:5.7.22 "docker-entrypoint.s…" About a minute ago Up About a minute 3306/tcp testrail-mysql-204644881
1cdfc692003a registry.gitlab.com/touchbit/image/testrail/web:latest "nginx -g 'daemon of…" About a minute ago Up About a minute 0.0.0.0:44752->80/tcp, 0.0.0.0:23540->443/tcp testrail-web-204644793
6f26dfb2683e registry.gitlab.com/touchbit/image/testrail/fpm:latest "docker-php-entrypoi…" About a minute ago Up About a minute 9000/tcp testrail-fpm-204644793
029e16b26201 mysql:5.7.22 "docker-entrypoint.s…" About a minute ago Up About a minute 3306/tcp testrail-mysql-204644793
c10443222ac6 registry.gitlab.com/touchbit/image/testrail/web:latest "nginx -g 'daemon of…" 5 hours ago Up 5 hours 0.0.0.0:57123->80/tcp, 0.0.0.0:31657->443/tcp testrail-web-204567103
04339229397e registry.gitlab.com/touchbit/image/testrail/fpm:latest "docker-php-entrypoi…" 5 hours ago Up 5 hours 9000/tcp testrail-fpm-204567103
6ae0accab28d mysql:5.7.22 "docker-entrypoint.s…" 5 hours ago Up 5 hours 3306/tcp testrail-mysql-204567103
b66b60d79e43 registry.gitlab.com/touchbit/image/testrail/web:latest "nginx -g 'daemon of…" 5 hours ago Up 5 hours 0.0.0.0:56321->80/tcp, 0.0.0.0:58749->443/tcp testrail-web-204553690
033b1f46afa9 registry.gitlab.com/touchbit/image/testrail/fpm:latest "docker-php-entrypoi…" 5 hours ago Up 5 hours 9000/tcp testrail-fpm-204553690
a8879c5ef941 mysql:5.7.22 "docker-entrypoint.s…" 5 hours ago Up 5 hours 3306/tcp testrail-mysql-204553690
069954ba6010 registry.gitlab.com/touchbit/image/testrail/web:latest "nginx -g 'daemon of…" 5 hours ago Up 5 hours 0.0.0.0:32869->80/tcp, 0.0.0.0:16066->443/tcp testrail-web-204553539
ed6b17d911a5 registry.gitlab.com/touchbit/image/testrail/fpm:latest "docker-php-entrypoi…" 5 hours ago Up 5 hours 9000/tcp testrail-fpm-204553539
1a1eed057ea0 mysql:5.7.22 "docker-entrypoint.s…" 5 hours ago Up 5 hours 3306/tcp testrail-mysql-204553539
सभी कार्य सफलतापूर्वक पूर्ण हुए
कार्य कलाकृतियों में सेवा और परीक्षण लॉग होते हैं
सब कुछ सुंदर लगता है, लेकिन एक बारीकियां है। एकीकरण परीक्षण चलने के दौरान पाइपलाइन को बलपूर्वक रद्द किया जा सकता है, ऐसी स्थिति में चल रहे कंटेनरों को रोका नहीं जाएगा। समय-समय पर आपको रनर को साफ करने की जरूरत होती है। दुर्भाग्य से, GitLab CE में सुधार का कार्य अभी भी स्थिति में है प्रारंभिक
लेकिन हमने एक कार्य के लॉन्च को एक शेड्यूल के अनुसार जोड़ा है, और कोई भी हमें इसे मैन्युअल रूप से चलाने से मना नहीं करता है।
हमारे प्रोजेक्ट -> सीआई/सीडी -> शेड्यूल पर जाएं और कार्य चलाएं Clean runner
कुल:
हमारे पास एक शेल रनर है।
कार्यों और पर्यावरण के बीच कोई टकराव नहीं है।
हम समानांतर में एकीकरण परीक्षणों के साथ कार्य चलाते हैं।
आप एकीकरण परीक्षण स्थानीय स्तर पर या किसी कंटेनर में चला सकते हैं।
सेवा और परीक्षण लॉग एकत्र किए जाते हैं और पाइपलाइन कार्य से जुड़े होते हैं।
पुरानी डॉकर छवियों से रनर को साफ़ करना संभव है।
सेटअप समय ~2 घंटे है.
वास्तव में बस इतना ही। मुझे प्रतिक्रिया पाकर ख़ुशी होगी.