ProHoster > Blog > Administratioun > GitLab Shell Runner. Kompetitiv Start vun geteste Servicer mat Docker Compose
GitLab Shell Runner. Kompetitiv Start vun geteste Servicer mat Docker Compose
Dësen Artikel ass interessant fir Tester an Entwéckler, awer ass haaptsächlech fir Automatiséierungsspezialisten geduecht, déi mam Problem konfrontéiert sinn GitLab CI / CD opzestellen fir Integratiounstestung an de Bedéngungen vun net genuch Infrastrukturressourcen an / oder d'Feele vun engem Container Orchestratioun Plattform. Ech wäert Iech soen wéi Dir d'Deployment vun Testëmfeld mat Docker compose op engem eenzegen GitLab Shell Runner opstellt a sou datt wann Dir e puer Ëmfeld ofsetzt, déi lancéiert Servicer net matenee stéieren.
A menger Praxis ass et dacks geschitt datt d'Integratiounstester op Projeten "behandelt" gouf. An dacks ass den éischten a bedeitendste Problem d'CI Pipeline, an där Integratiounstest entwéckelt ginn Service (en) gëtt an engem Dev / Bühn Ëmfeld duerchgefouert. Dëst huet e puer Probleemer verursaacht:
Wéinst Mängel an engem bestëmmte Service während Integratioun Testen, kann den Test Circuit duerch futtis Daten beschiedegt ginn. Et waren Fäll, wann eng Ufro mat engem gebrachene JSON-Format geschéckt huet, de Service ofgebrach huet, wat de Stand komplett inoperabel gemaach huet.
Verlängerung vum Testkrees wéi d'Testdaten eropgeet. Ech mengen et mécht kee Sënn e Beispill ze beschreiwen mat Botzen / Rolling zréck der Datebank. A menger Praxis hunn ech kee Projet begéint, wou dës Prozedur glat gaang ass.
Risiko fir d'Funktionalitéit vum Testkrees ze stéieren wann Dir allgemeng Systemastellungen testen. Zum Beispill, Benotzer / Grupp / Passwuert / Applikatioun Politik.
Testdaten aus automatiséierten Tester maachen d'Liewe schwéier fir manuell Tester.
E puer wäerte soen datt gutt Autotester d'Donnéeën no sech selwer solle botzen. Ech hunn Argumenter géint:
Dynamesch Stänn si ganz bequem ze benotzen.
Net all Objet kann aus dem System iwwer d'API geläscht ginn. Zum Beispill, en Uruff fir en Objet ze läschen gouf net ëmgesat well et d'Geschäftslogik widdersprécht.
Wann Dir en Objet iwwer d'API erstellt, kann eng enorm Quantitéit u Metadaten erstallt ginn, wat problematesch ass ze läschen.
Wann Tester Ofhängegkeeten ënnereneen hunn, da verwandelt de Prozess vun der Botzen vun Donnéeën no Lafen Tester zu engem Kappwéi.
Zousätzlech (an menger Meenung no, net gerechtfäerdegt) Appellen un d'API.
An den Haaptargument: wann Testdaten ufänken direkt aus der Datebank geläscht ze ginn. Dëst gëtt an e richtege PK/FK Zirkus! Mir héieren vun Entwéckler: "Ech hunn just e Schëld bäigefüügt / ewechgeholl / ëmbenannt, firwat sinn 100500 Integratiounstester gefaange ginn?"
Menger Meenung no ass déi optimalst Léisung en dynamescht Ëmfeld.
Vill Leit benotzen docker-compose fir en Testëmfeld ze lafen, awer wéineg Leit benotzen docker-compose wann se Integratiounstestung an CI / CD maachen. An hei huelen ech net Rechnung kubernetes, Schwarm an aner Container Orchestratioun Plattformen. Net all Firma huet se. Et wier flott wann docker-compose.yml universal wier.
Och wa mir eisen eegene QA Runner hunn, wéi kënne mir sécher sinn datt Servicer, déi iwwer Docker-compose lancéiert ginn, net matenee stéieren?
Wéi sammelen ech Logbicher vun getestene Servicer?
Wéi de Leefer ze botzen?
Ech hunn mäin eegene GitLab Leefer fir meng Projeten an ech hunn dës Froen während der Entwécklung begéint Java Client fir TestRail. Méi präzis, wann Dir Integratiounstester leeft. Drënner wäerte mir dës Problemer mat Beispiller aus dësem Projet léisen.
Fir e Leefer, Ech recommandéieren eng Linux virtuell Maschinn mat 4 vCPU, 4 GB RAM, 50 GB HDD.
Et gëtt vill Informatioun iwwer Gitlab-Runner um Internet opzestellen, also kuerz:
Login op d'Maschinn via SSH
Wann Dir manner wéi 8 GB RAM hutt, da recommandéieren ech maachen Swap 10 GBsou datt den OOM Killer net kënnt an eis Aufgaben ëmbréngen wéinst Mangel u RAM. Dëst ka geschéien wann méi wéi 5 Aufgaben gläichzäiteg lancéiert ginn. D'Aufgabe wäerte méi lues, awer stänneg virukommen.
Beispill mat OOM Killer
Wann Dir an den Task Logbicher gesitt bash: line 82: 26474 Killed, da just op de Leefer ausféieren 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
A wann d'Bild esou eppes ausgesäit, da füügt entweder Swap oder RAM derbäi.
Dëst erlaabt Iech parallel Aufgaben op engem Leefer ze lafen. Liest méi hei.
Wann Dir eng méi mächteg Maschinn hutt, zum Beispill 8 vCPU, 16 GB RAM, da kënnen dës Zuelen op d'mannst 2 Mol méi grouss ginn. Mee et hänkt alles dovun of, wat genee op dësem Leefer lancéiert gëtt an a wéi enger Quantitéit.
D'Haaptaufgab ass eng universell docker-compose.yml, déi Entwéckler / Tester souwuel lokal wéi an der CI Pipeline benotze kënnen.
Éischt vun all, mir maachen eenzegaarteg Service Nimm fir CI. Eng vun den eenzegaartegen Variablen am GitLab CI ass d'Variabel CI_JOB_ID. Wann Dir uginn container_name mat Bedeitung "service-${CI_JOB_ID:-local}", dann am Fall:
wann CI_JOB_ID net an Ëmweltvariablen definéiert,
da gëtt de Service Numm service-local
wann CI_JOB_ID definéiert an Ëmfeldvariablen (zum Beispill 123),
da gëtt de Service Numm service-123
Zweetens kreéiere mir e gemeinsamt Netzwierk fir lancéiert Servicer. Dëst gëtt eis Netzniveau Isolatioun wann Dir verschidde Testëmfeld leeft.
Eigentlech ass dëst den éischte Schrëtt zum Erfolleg =)
Beispill vu mengem docker-compose.yml mat Kommentaren
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
Als Resultat vun der Ausféierung vun esou enger Aufgab wäert de Logbicherverzeechnes an den Artefakte Service- an Testprotokoller enthalen. Wat ganz bequem ass am Fall vu Feeler. All Test parallel schreift säin eegene Logbuch, awer ech wäert iwwer dëst separat schwätzen.
$ 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
All Aufgaben erfollegräich ofgeschloss
Aufgab Artefakte enthalen Service- an Testprotokoller
Alles schéngt schéin ze sinn, awer et gëtt eng Nuance. Pipeline kann Kraaft annuléiert ginn wärend Integratiounstester lafen, an deem Fall lafen Container net gestoppt ginn. Vun Zäit zu Zäit musst Dir de Leefer botzen. Leider ass d'Aufgab fir d'Verbesserung am GitLab CE nach ëmmer am Status Open
Awer mir hunn de Start vun enger Aufgab no engem Zäitplang bäigefüügt, a kee verbitt eis et manuell ze lafen.
Gitt op eise Projet -> CI/CD -> Zäitplang a lafen d'Aufgab Clean runner
Total:
Mir hunn eng Schuel Leefer.
Et gi keng Konflikter tëscht Aufgaben an der Ëmwelt.
Mir lafen Aufgaben mat Integratiounstester parallel.
Dir kënnt Integratiounstester entweder lokal oder an engem Container ausféieren.
Service- an Testprotokoller ginn gesammelt an un d'Pipelinetask befestegt.
Et ass méiglech de Leefer aus alen Docker Biller ze botzen.
Setup Zäit ass ~ 2 Stonnen.
Dat ass alles, eigentlech. Ech wäert frou Feedback ze kréien.