پرو ہوسٹر > بلاگ > انتظامیہ > گٹ لیب شیل رنر۔ ڈوکر کمپوز کا استعمال کرتے ہوئے آزمائشی خدمات کا مسابقتی آغاز
گٹ لیب شیل رنر۔ ڈوکر کمپوز کا استعمال کرتے ہوئے آزمائشی خدمات کا مسابقتی آغاز
یہ مضمون ٹیسٹرز اور ڈویلپرز دونوں کے لیے دلچسپی کا حامل ہو گا، لیکن اس کا مقصد بنیادی طور پر آٹومیشن ماہرین کے لیے ہے جنہیں ناکافی انفراسٹرکچر وسائل اور/یا کنٹینر کی عدم موجودگی میں انضمام کی جانچ کے لیے GitLab CI/CD ترتیب دینے کے مسئلے کا سامنا ہے۔ آرکیسٹریشن پلیٹ فارم. میں آپ کو بتاؤں گا کہ ایک واحد GitLab شیل رنر پر ڈوکر کمپوز کا استعمال کرتے ہوئے ٹیسٹ کے ماحول کی تعیناتی کو کیسے ترتیب دیا جائے اور تاکہ متعدد ماحول کو تعینات کرتے وقت، شروع کی گئی خدمات ایک دوسرے کے ساتھ مداخلت نہ کریں۔
میری پریکٹس میں، یہ اکثر ہوتا ہے کہ منصوبوں پر انضمام کی جانچ کا "علاج" کیا جاتا تھا۔ اور اکثر پہلا اور سب سے اہم مسئلہ CI پائپ لائن ہے، جس میں انضمام کی جانچ ہوتی ہے۔ تیار کیا جا رہا ہے خدمت (سروس) ایک dev/اسٹیج ماحول میں کی جاتی ہے۔ اس سے کچھ مسائل پیدا ہوئے:
انضمام کی جانچ کے دوران کسی خاص سروس میں نقائص کی وجہ سے، ٹوٹے ہوئے ڈیٹا سے ٹیسٹ سرکٹ کو نقصان پہنچ سکتا ہے۔ ایسے معاملات تھے جب ٹوٹے ہوئے JSON فارمیٹ کے ساتھ درخواست بھیجنے سے سروس کریش ہو گئی، جس نے اسٹینڈ کو مکمل طور پر ناکارہ بنا دیا۔
ٹیسٹ سرکٹ کی سست روی جیسے جیسے ٹیسٹ ڈیٹا بڑھتا ہے۔ میرے خیال میں ڈیٹا بیس کی صفائی/رولنگ بیک کے ساتھ مثال بیان کرنا کوئی معنی نہیں رکھتا۔ میری پریکٹس میں، میں نے کسی ایسے پروجیکٹ کا سامنا نہیں کیا جہاں یہ طریقہ کار آسانی سے چلا گیا ہو۔
عام نظام کی ترتیبات کی جانچ کرتے وقت ٹیسٹ سرکٹ کی فعالیت میں خلل ڈالنے کا خطرہ۔ مثال کے طور پر، صارف/گروپ/پاس ورڈ/درخواست کی پالیسی۔
خودکار ٹیسٹوں سے ٹیسٹ ڈیٹا دستی ٹیسٹرز کے لیے زندگی کو مشکل بنا دیتا ہے۔
کچھ لوگ کہیں گے کہ اچھے آٹو ٹیسٹس کو اپنے بعد ڈیٹا صاف کرنا چاہیے۔ میرے پاس اس کے خلاف دلائل ہیں:
متحرک اسٹینڈ استعمال کرنے میں بہت آسان ہیں۔
ہر چیز کو API کے ذریعے سسٹم سے نہیں ہٹایا جا سکتا۔ مثال کے طور پر، کسی چیز کو حذف کرنے کی کال کو لاگو نہیں کیا گیا کیونکہ یہ کاروباری منطق سے متصادم ہے۔
API کے ذریعے ایک آبجیکٹ بناتے وقت، میٹا ڈیٹا کی ایک بڑی مقدار بنائی جا سکتی ہے، جسے حذف کرنا مشکل ہے۔
اگر ٹیسٹوں کا آپس میں انحصار ہوتا ہے، تو ٹیسٹ چلانے کے بعد ڈیٹا صاف کرنے کا عمل سر درد میں بدل جاتا ہے۔
API کو اضافی (اور، میری رائے میں، جائز نہیں) کالز۔
اور اہم دلیل: جب ٹیسٹ ڈیٹا کو ڈیٹا بیس سے براہ راست صاف ہونا شروع ہوتا ہے۔ یہ ایک حقیقی PK/FK سرکس میں تبدیل ہو رہا ہے! ہم ڈویلپرز سے سنتے ہیں: "میں نے ابھی ایک نشان شامل کیا/ہٹا دیا/نام تبدیل کیا، 100500 انٹیگریشن ٹیسٹ کیوں پکڑے گئے؟"
میری رائے میں، سب سے زیادہ بہتر حل ایک متحرک ماحول ہے۔
بہت سے لوگ ٹیسٹ کے ماحول کو چلانے کے لیے docker-compose کا استعمال کرتے ہیں، لیکن CI/CD میں انٹیگریشن ٹیسٹنگ کرتے وقت کچھ لوگ docker-compose کا استعمال کرتے ہیں۔ اور یہاں میں kubernetes، swarm اور دیگر کنٹینر آرکیسٹریشن پلیٹ فارمز کو مدنظر نہیں رکھ رہا ہوں۔ ہر کمپنی ان کے پاس نہیں ہے۔ یہ اچھا ہو گا اگر docker-compose.yml عالمگیر ہو۔
یہاں تک کہ اگر ہمارا اپنا QA رنر ہے، تو ہم یہ کیسے یقینی بنا سکتے ہیں کہ docker-compose کے ذریعے شروع کی گئی خدمات ایک دوسرے کے ساتھ مداخلت نہیں کرتی ہیں؟
آزمائشی خدمات کے لاگز کو کیسے جمع کیا جائے؟
رنر کو کیسے صاف کریں؟
میرے پاس اپنے پروجیکٹس کے لیے اپنا GitLab رنر ہے اور مجھے ترقی کے دوران ان سوالات کا سامنا کرنا پڑا جاوا کلائنٹ لیے ٹیسٹ ریل. زیادہ واضح طور پر، انضمام ٹیسٹ چلاتے وقت۔ ذیل میں ہم اس پروجیکٹ کی مثالوں کا استعمال کرتے ہوئے ان مسائل کو حل کریں گے۔
رنر کے لیے، میں 4 وی سی پی یو، 4 جی بی ریم، 50 جی بی ایچ ڈی ڈی والی لینکس ورچوئل مشین تجویز کرتا ہوں۔
انٹرنیٹ پر gitlab-runner قائم کرنے کے بارے میں بہت ساری معلومات موجود ہیں، لہذا مختصر طور پر:
SSH کے ذریعے مشین میں لاگ ان کریں۔
اگر آپ کے پاس 8 جی بی سے کم ریم ہے تو میں تجویز کرتا ہوں۔ 10 جی بی کا تبادلہ کریں۔تاکہ OOM قاتل آکر ریم کی کمی کی وجہ سے ہمارے کاموں کو ختم نہ کردے۔ یہ اس وقت ہو سکتا ہے جب بیک وقت 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
اور اگر تصویر کچھ اس طرح نظر آتی ہے، تو یا تو swap شامل کریں یا RAM شامل کریں۔
یہ آپ کو ایک رنر پر متوازی کام چلانے کی اجازت دے گا۔ مزید پڑھ یہاں.
اگر آپ کے پاس زیادہ طاقتور مشین ہے، مثال کے طور پر 8 وی سی پی یو، 16 جی بی ریم، تو ان نمبروں کو کم از کم 2 گنا بڑا بنایا جا سکتا ہے۔ لیکن یہ سب اس پر منحصر ہے کہ اس رنر پر بالکل کیا لانچ کیا جائے گا اور کس مقدار میں۔
بنیادی کام یونیورسل docker-compose.yml ہے، جسے ڈویلپر/ٹیسٹر مقامی طور پر اور CI پائپ لائن دونوں میں استعمال کر سکتے ہیں۔
سب سے پہلے، ہم CI کے لیے منفرد سروس نام بناتے ہیں۔ GitLab CI میں منفرد متغیرات میں سے ایک متغیر ہے۔ CI_JOB_ID. اگر آپ وضاحت کریں۔ container_name معنی کے ساتھ "service-${CI_JOB_ID:-local}"، پھر کیس میں:
اگر CI_JOB_ID ماحولیاتی متغیرات میں بیان نہیں کیا گیا،
پھر خدمت کا نام ہوگا۔ service-local
اگر CI_JOB_ID ماحولیاتی متغیرات میں بیان کیا گیا ہے (مثال کے طور پر 123)،
پھر خدمت کا نام ہوگا۔ service-123
دوم، ہم شروع کی گئی خدمات کے لیے ایک مشترکہ نیٹ ورک بناتے ہیں۔ متعدد ٹیسٹ ماحول چلاتے وقت یہ ہمیں نیٹ ورک کی سطح کی تنہائی فراہم کرتا ہے۔
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
تمام کام کامیابی سے مکمل ہو گئے۔
ٹاسک نمونے سروس اور ٹیسٹ لاگز پر مشتمل ہیں۔
سب کچھ خوبصورت لگتا ہے، لیکن ایک nuance ہے. جب انضمام کے ٹیسٹ چل رہے ہوں تو پائپ لائن کو زبردستی منسوخ کیا جا سکتا ہے، ایسی صورت میں کنٹینرز کو چلانے کو نہیں روکا جائے گا۔ وقتا فوقتا آپ کو رنر کو صاف کرنے کی ضرورت ہے۔ بدقسمتی سے، GitLab CE میں بہتری کا کام اب بھی حالت میں ہے۔ اوپن
لیکن ہم نے ایک شیڈول کے مطابق ایک کام کا آغاز شامل کیا ہے، اور کوئی بھی ہمیں اسے دستی طور پر چلانے سے منع نہیں کرتا ہے۔
ہمارے پروجیکٹ پر جائیں -> CI/CD -> شیڈولز اور کام کو چلائیں۔ Clean runner
کل:
ہمارے پاس ایک شیل رنر ہے۔
کاموں اور ماحول کے درمیان کوئی تنازعات نہیں ہیں۔
ہم انضمام ٹیسٹ کے ساتھ کاموں کو متوازی طور پر چلاتے ہیں۔
آپ مقامی طور پر یا کنٹینر میں انضمام ٹیسٹ چلا سکتے ہیں۔
سروس اور ٹیسٹ لاگز جمع کیے جاتے ہیں اور پائپ لائن کے کام سے منسلک ہوتے ہیں۔
پرانی ڈوکر امیجز سے رنر کو صاف کرنا ممکن ہے۔
سیٹ اپ کا وقت ~2 گھنٹے ہے۔
یہ سب ہے، اصل میں. میں رائے حاصل کرنے کے لئے خوش ہو جائے گا.