ProHoster > Blog > İdarə > GitLab Shell Runner. Docker Compose ilə rəqabətli şəkildə sınaqdan keçirilə bilən xidmətləri işə salın
GitLab Shell Runner. Docker Compose ilə rəqabətli şəkildə sınaqdan keçirilə bilən xidmətləri işə salın
Bu məqalə həm test edənlər, həm də tərtibatçılar üçün maraqlı olacaq, lakin infrastruktur resurslarının qeyri-kafi olması və/və ya konteyner orkestrinin olmaması şəraitində inteqrasiya testi üçün GitLab CI / CD qurmaq problemi ilə üzləşən avtomatçılar üçün nəzərdə tutulub. platforma. Mən sizə bir GitLab shell runner-də docker compose istifadə edərək test mühitlərinin yerləşdirilməsini necə konfiqurasiya edəcəyinizi söyləyəcəyəm və bir neçə mühiti yerləşdirərkən işə salınan xidmətlər bir-birinə mane olmasın.
Mənim təcrübəmdə tez-tez layihələrdə inteqrasiya testini “müalicə etmək” baş verirdi. Və tez-tez ilk və ən əhəmiyyətli problem inteqrasiya testinin aparıldığı CI boru kəməridir inkişaf etmişdir xidmət(lər) inkişaf/mərhələ mühitində yerləşdirilir. Bu, bir sıra problemlərə səbəb oldu:
İnteqrasiya testi zamanı bu və ya digər xidmətdə olan qüsurlara görə, test sxemi pozulmuş məlumatlarla pozula bilər. Qırılan JSON formatı ilə sorğunun göndərilməsi xidməti dayandırdıqda, stendi tamamilə fəaliyyətsiz hala gətirən hallar oldu.
Test məlumatlarının artması ilə sınaq dövrəsinin yavaşlaması. Hesab edirəm ki, verilənlər bazasını təmizləmək / geri qaytarmaq ilə bir nümunə təsvir etmək mənasızdır. Təcrübəmdə bu prosedurun rahat keçəcəyi bir layihəyə rast gəlməmişəm.
Ümumi sistem parametrlərini sınaqdan keçirərkən sınaq dövrəsinin işini pozma riski. Məsələn, istifadəçi/qrup/parol/tətbiq siyasəti.
Avtotestlərdən əldə edilən test məlumatları əl ilə test edənlərin həyatını çətinləşdirir.
Kimsə deyəcək ki, yaxşı avtotestlər məlumatları özündən sonra təmizləməlidir. Qarşı arqumentlərim var:
Dinamik stendlərdən istifadə etmək çox rahatdır.
API vasitəsilə hər bir obyekt sistemdən silinə bilməz. Məsələn, obyektin silinməsinə çağırış iş məntiqinə zidd olduğu üçün həyata keçirilmir.
API vasitəsilə obyekt yaratarkən, aradan qaldırılması problemli olan böyük miqdarda metadata yaradıla bilər.
Testlər bir-birindən asılıdırsa, testlər aparıldıqdan sonra məlumatların təmizlənməsi prosesi baş ağrısına çevrilir.
API-yə əlavə (və mənim fikrimcə, əsaslandırılmamış) zənglər.
Və əsas arqument: test məlumatları birbaşa verilənlər bazasından təmizlənməyə başlayanda. Bu əsl PK/FK sirkinə çevrilir! Tərtibatçılardan eşidirik: "Mən indicə işarəni əlavə etdim/çıxardım/adını dəyişdim, niyə 100500 inteqrasiya testi keçdi?"
Məncə, ən optimal həll dinamik mühitdir.
Bir çox insanlar test mühitini idarə etmək üçün docker-compose-dan istifadə edir, lakin CI/CD-də inteqrasiya testi apararkən az adam docker-compose-dan istifadə edir. Və burada kubernetləri, sürü və digər konteyner orkestr platformalarını nəzərə almıram. Hər şirkətdə bunlar yoxdur. docker-compose.yml universal olsa yaxşı olardı.
Öz QA runnerimiz olsa belə, docker-compose vasitəsilə işə salınan xidmətlərin bir-birinə müdaxilə etmədiyinə necə əmin ola bilərik?
Test edilmiş xidmətlərin qeydlərini necə toplamaq olar?
Koşucunu necə təmizləmək olar?
Layihələrim üçün öz GitLab runnerim var və inkişaf etdirərkən bu problemlərlə qarşılaşdım Java müştəri uğrunda sınaq dəmir yolu. Daha dəqiq desək, inteqrasiya testlərini həyata keçirərkən. Burada biz bu layihədən nümunələrlə bu məsələləri həll etməyə davam edəcəyik.
Bir qaçışçı üçün 4 vCPU, 4 GB RAM, 50 GB HDD ilə Linux virtual maşını tövsiyə edirəm.
İnternetdə gitlab-runner qurmaq haqqında çoxlu məlumat var, qısacası:
SSH vasitəsilə maşına gedirik
Əgər 8 GB-dan az RAM varsa, o zaman məsləhət görürəm 10 GB dəyişdirinOOM qatili gəlib bizi RAM çatışmazlığı səbəbindən tapşırıqları öldürməsin. Bu, eyni vaxtda 5-dən çox tapşırıq yerinə yetirildikdə baş verə bilər. Tapşırıqlar daha yavaş, lakin sabit olacaq.
OOM killer ilə nümunə
Əgər tapşırıq qeydlərində görürsünüzsə bash: line 82: 26474 Killed, sonra yalnız qaçışçı üzərində icra edin 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
Şəkil bu kimi görünürsə, ya dəyişdirmə əlavə edin, ya da RAM-a atın.
Bu, eyni qaçışçıda paralel tapşırıqları yerinə yetirməyə imkan verəcəkdir. Daha çox oxu burada.
Daha güclü bir maşınınız varsa, məsələn, 8 vCPU, 16 GB RAM, onda bu rəqəmləri ən azı 2 dəfə böyütmək olar. Ancaq hər şey bu qaçışçıda nəyin və hansı miqdarda işə salınacağından asılıdır.
Əsas vəzifə, tərtibatçıların / testerlərin həm yerli, həm də CI boru kəmərində istifadə edə biləcəyi universal docker-compose.yml-dir.
İlk növbədə, biz CI üçün unikal xidmət adları edirik. GitLab CI-də unikal dəyişənlərdən biri dəyişəndir CI_JOB_ID. Müəyyən etsəniz container_name mənası ilə "service-${CI_JOB_ID:-local}", sonra halda:
əgər CI_JOB_ID mühit dəyişənlərində müəyyən edilməmiş,
sonra xidmət adı olacaq service-local
əgər CI_JOB_ID mühit dəyişənlərində müəyyən edilmiş (məsələn, 123),
sonra xidmət adı olacaq service-123
İkincisi, biz xidmətlər üçün ümumi şəbəkə yaradırıq. Bu, birdən çox test mühiti işləyərkən bizə şəbəkə səviyyəsində izolyasiya verir.
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
Belə bir tapşırığın icrası nəticəsində artefaktlardakı jurnallar kataloqu xidmətlər və testlər qeydlərini ehtiva edəcəkdir. Hansı ki, səhvlər zamanı çox əlverişlidir. Paralel olaraq hər bir test öz jurnalını yazır, amma bu barədə ayrıca danışacağam.
$ 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
Bütün tapşırıqlar uğurla tamamlandı
Tapşırıq artefaktlarında xidmətlər və testlər qeydləri var
Hər şey gözəl görünür, amma bir nüans var. İnteqrasiya testləri işləyərkən boru kəməri məcburi ləğv edilə bilər, bu halda işləyən konteynerlər dayandırılmayacaq. Zaman zaman koşucuyu təmizləmək lazımdır. Təəssüf ki, GitLab CE-də təftiş tapşırığı hələ də statusundadır açıq
Lakin biz planlaşdırılmış tapşırığın işə salınmasını əlavə etdik və heç kim bizə onu əl ilə başlamağı qadağan etmir.
Layihəmizə gedin -> CI/CD -> Cədvəllər və tapşırığı yerinə yetirin Clean runner
Ümumi:
Bir mərmi qaçışçımız var.
Tapşırıqlar və ətraf mühit arasında heç bir ziddiyyət yoxdur.
İnteqrasiya testləri ilə paralel tapşırıqları işə salırıq.
Siz həm yerli, həm də konteynerdə inteqrasiya testlərini keçirə bilərsiniz.
Xidmət və sınaq jurnalları toplanır və boru kəməri tapşırığına əlavə olunur.
Koşucunu köhnə docker görüntülərindən təmizləmək mümkündür.
Quraşdırma müddəti ~ 2 saatdır.
Əslində, hamısı budur. Mən rəy bildirməkdən şad olaram.