ProHoster > وبلاگ > اداره > GitLab Shell Runner. با Docker Compose خدمات قابل آزمایش را بصورت رقابتی راه اندازی کنید
GitLab Shell Runner. با Docker Compose خدمات قابل آزمایش را بصورت رقابتی راه اندازی کنید
این مقاله هم برای آزمایشکنندگان و هم برای توسعهدهندگان جالب خواهد بود، اما بیشتر برای خودکارهایی در نظر گرفته شده است که با مشکل راهاندازی GitLab CI / CD برای آزمایش یکپارچهسازی در مواجهه با منابع زیرساخت ناکافی و/یا عدم وجود هماهنگی کانتینر مواجه هستند. سکو. من به شما خواهم گفت که چگونه استقرار محیط های آزمایشی را با استفاده از docker compose بر روی یک رانر پوسته GitLab پیکربندی کنید تا در هنگام استقرار چندین محیط، سرویس های راه اندازی شده با یکدیگر تداخل نداشته باشند.
در عمل من، اغلب برای "درمان" تست یکپارچه سازی در پروژه ها اتفاق می افتد. و اغلب اولین و مهم ترین مشکل خط لوله CI است که در آن تست یکپارچه سازی انجام می شود توسعه یافته سرویس(ها) در محیط dev/stage میزبانی می شود. این باعث ایجاد چند مشکل شد:
به دلیل نقص در یک یا سرویس دیگر در طول تست یکپارچه سازی، مدار تست می تواند توسط داده های خراب خراب شود. مواردی وجود داشت که ارسال یک درخواست با فرمت JSON شکسته سرویس را قطع کرد، که باعث شد استند کاملاً غیرفعال شود.
کند شدن مدار تست با رشد داده های تست. من فکر می کنم منطقی نیست که مثالی را با پاک کردن / برگرداندن پایگاه داده توضیح دهیم. در عمل من، پروژه ای را ندیده ام که این رویه به راحتی پیش برود.
خطر اختلال در عملکرد مدار تست هنگام تست تنظیمات عمومی سیستم. به عنوان مثال، سیاست کاربر/گروه/رمز عبور/برنامه.
داده های تست از تست های خودکار زندگی را برای آزمایش کنندگان دستی دشوار می کند.
کسی می گوید که تست های خودکار خوب باید داده ها را بعد از خود پاک کنند. من استدلال هایی علیه این دارم:
استفاده از پایه های دینامیک بسیار راحت است.
هر شیئی را نمی توان از طریق API از سیستم حذف کرد. به عنوان مثال، فراخوانی برای حذف یک شی اجرا نمی شود، زیرا با منطق تجاری در تضاد است.
هنگام ایجاد یک شی از طریق API، مقدار زیادی ابرداده می تواند ایجاد شود که حذف آن مشکل است.
اگر آزمایشها به یکدیگر وابسته باشند، پس از انجام آزمایشها، فرآیند پاکسازی دادهها به سردرد تبدیل میشود.
تماسهای اضافی (و به نظر من غیر قابل توجیه) به API.
و استدلال اصلی: زمانی که داده های آزمایشی شروع به پاکسازی مستقیم از پایگاه داده می کنند. این در حال تبدیل شدن به یک سیرک واقعی PK/FK است! ما از توسعه دهندگان می شنویم: "من به تازگی علامت را اضافه/حذف/تغییر نام دادم، چرا 100500 تست ادغام انجام شد؟"
به نظر من بهینه ترین راه حل یک محیط پویا است.
بسیاری از افراد از docker-compose برای اجرای یک محیط آزمایشی استفاده می کنند، اما افراد کمی از docker-compose هنگام انجام تست یکپارچه سازی در CI/CD استفاده می کنند. و در اینجا من کوبرنت ها، ازدحام و سایر پلت فرم های ارکستراسیون کانتینری را در نظر نمی گیرم. هر شرکتی آنها را ندارد. خیلی خوب بود که docker-compose.yml جهانی بود.
حتی اگر راهانداز QA خودمان را داشته باشیم، چگونه میتوانیم مطمئن شویم که سرویسهای راهاندازی شده از طریق docker-compose با یکدیگر تداخل ندارند؟
چگونه گزارش خدمات آزمایش شده را جمع آوری کنیم؟
چگونه رانر را تمیز کنیم؟
من رانر GitLab خودم را برای پروژه هایم دارم و در حین توسعه با این مسائل برخورد کردم کلاینت جاوا برای ریل آزمایشی. به طور خاص، هنگام اجرای تست های یکپارچه سازی. در اینجا به حل این مسائل با مثال هایی از این پروژه ادامه می دهیم.
برای یک رانر، یک ماشین مجازی لینوکس با 4 vCPU، 4 گیگابایت رم، 50 گیگابایت HDD را توصیه می کنم.
اطلاعات زیادی در مورد راه اندازی gitlab-runner در اینترنت وجود دارد، بنابراین به طور خلاصه:
ما از طریق SSH به دستگاه می رویم
اگر کمتر از 8 گیگابایت رم دارید، توصیه می کنم مبادله 10 گیگتا قاتل OOM نیاید و وظایف ما را به دلیل کمبود رم بکشد. این می تواند زمانی اتفاق بیفتد که بیش از 5 کار به طور همزمان در حال اجرا هستند. وظایف کندتر، اما پایدار خواهند بود.
مثال با قاتل OOM
اگر در لاگ های وظیفه می بینید bash: line 82: 26474 Killed، سپس فقط روی runner اجرا کنید 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 vCPU، 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
در نتیجه اجرای چنین کاری، دایرکتوری logs در مصنوعات حاوی گزارشهای خدمات و آزمایشها خواهد بود. که در صورت بروز خطا بسیار مفید است. هر تست به طور موازی گزارش خود را می نویسد، اما من در این مورد جداگانه صحبت خواهم کرد.
$ 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 هنوز در وضعیت است باز کن
اما ما یک راه اندازی کار برنامه ریزی شده اضافه کرده ایم و هیچکس ما را از شروع دستی آن منع نمی کند.
به پروژه ما -> CI/CD -> Schedules بروید و وظیفه را اجرا کنید Clean runner
مجموع:
ما یک پوسته دونده داریم.
هیچ تعارضی بین وظایف و محیط وجود ندارد.
ما راه اندازی موازی وظایف با تست های یکپارچه سازی داریم.
می توانید تست های ادغام را هم به صورت محلی و هم در یک ظرف اجرا کنید.
گزارش های سرویس و آزمایش جمع آوری شده و به وظیفه خط لوله متصل می شوند.
این امکان وجود دارد که رانر را از تصاویر قدیمی docker پاک کنید.
زمان راه اندازی ~ 2 ساعت است.
این در واقع همه چیز است. من خوشحال خواهم شد به بازخورد.