See artikkel pakub huvi nii testijatele kui ka arendajatele, kuid on mõeldud pigem automatiseerijatele, kes seisavad silmitsi GitLabi CI/CD seadistamise probleemiga integratsioonitestimiseks, pidades silmas ebapiisavat infrastruktuuriressurssi ja/või konteineri orkestratsiooni puudumist. platvorm. Ma räägin teile, kuidas konfigureerida testkeskkondade juurutamist docker compose abil ühel GitLabi shell runneril ja nii, et mitme keskkonna juurutamisel ei segaks käivitatud teenused üksteist.
Sisu
Предпосылки
-
Minu praktikas juhtus sageli projektide integratsioonitestimist "ravima". Ja sageli on esimene ja kõige olulisem probleem CI torujuhe, mille integratsiooni testimine arenenud teenus(t) on hostitud dev/stage keskkonnas. See põhjustas üsna palju probleeme:
- Ühe või teise teenuse defektide tõttu integratsioonitestimise ajal võivad testimisahelat rikkuda katkised andmed. Oli juhtumeid, kui katkise JSON-vorminguga päringu saatmine katkestas teenuse, mis muutis stendi täielikult töövõimetuks.
- Katseahela aeglustumine koos katseandmete kasvuga. Arvan, et andmebaasi puhastamise / tagasipööramise näidet pole mõtet kirjeldada. Oma praktikas pole ma kohanud projekti, kus see protseduur ladusalt sujuks.
- Süsteemi üldiste seadistuste testimisel on oht, et testahela jõudlus katkeb. Näiteks kasutaja/rühma/parooli/rakenduse poliitika.
- Autotestide testandmed muudavad käsitsi testijate elu keeruliseks.
Keegi ütleb, et head automaattestid peaksid andmed enda järelt puhastama. Mul on vastuargumendid:
- Dünaamilisi aluseid on väga mugav kasutada.
- Kõiki objekte ei saa API kaudu süsteemist eemaldada. Näiteks ei rakendata üleskutset objekti kustutada, kuna see läheb vastuollu äriloogikaga.
- API kaudu objekti loomisel võib tekkida tohutul hulgal metaandmeid, mille eemaldamine on problemaatiline.
- Kui testid on üksteisest sõltuvad, muutub andmete puhastamise protsess pärast testide sooritamist peavaluks.
- Täiendavad (ja minu arvates mitte õigustatud) kutsed API-le.
- Ja põhiargument: kui hakatakse testiandmeid otse andmebaasist puhastama. Sellest on saamas tõeline PK/FK tsirkus! Arendajatelt kuuleme: "Lisasin/kustutasin/nimetasin ümber märgi, miks 100500 integratsioonitesti läbi kukkus?"
Minu arvates on kõige optimaalsem lahendus dünaamiline keskkond.
- Paljud inimesed kasutavad testkeskkonna käitamiseks dockeri koostamist, kuid vähesed kasutavad CI/CD-s integratsioonitestide tegemisel dockeri koostamist. Ja siin ma ei võta arvesse kubernetes, sülemi ja muid konteinerite orkestreerimisplatvorme. Igal ettevõttel neid pole. Oleks tore, kui docker-compose.yml oleks universaalne.
- Isegi kui meil on oma kvaliteedikontrolli jooksja, kuidas saame tagada, et docker-compose kaudu käivitatud teenused üksteist ei segaks?
- Kuidas koguda testitud teenuste logisid?
- Kuidas jooksjat puhastada?
Mul on oma projektide jaoks oma GitLabi jooksja ja ma puutusin nende probleemidega kokku arendamise ajal eest . Täpsemalt integratsioonitestide käitamisel. Siin jätkame nende probleemide lahendamist selle projekti näidetega.
GitLabi Shell Runner
Jooksjale soovitan Linuxi virtuaalmasinat, millel on 4 vCPU, 4 GB RAM, 50 GB HDD.
Internetis on palju teavet gitlab-runneri seadistamise kohta, seega lühidalt:
- Me läheme masina juurde SSH kaudu
-
Kui teil on vähem kui 8 GB muutmälu, siis soovitan et OOM-i killer ei tuleks ja ei tapaks meile ülesandeid RAM-i puudumise tõttu. See võib juhtuda, kui korraga töötab rohkem kui 5 ülesannet. Ülesanded on aeglasemad, kuid stabiilsed.
Näide OOM killeriga
Kui ülesannete logides näete
bash: line 82: 26474 Killed, siis lihtsalt täitke jooksja pealsudo 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:0kBJa kui pilt näeb välja midagi sellist, siis kas lisage swap või visake RAM.
- Komplekt , , , tegema.
- Kasutaja lisamine
gitlab-runnerrühmaledockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab-jooksja.
-
Ava redigeerimiseks
/etc/gitlab-runner/config.tomlja lisageconcurrent=20 [[runners]] request_concurrency = 10See võimaldab teil samal jooksjal paralleelseid ülesandeid käivitada. Loe rohkem .
Kui sul on võimsam masin, näiteks 8 vCPU, 16 GB RAM, siis saab neid numbreid teha vähemalt 2 korda suuremaks. Kuid kõik sõltub sellest, mida sellel jooksjal täpselt käivitatakse ja millises koguses.
See on piisavalt.
Docker-compose.yml ettevalmistamine
Peamine ülesanne on universaalne docker-compose.yml, mida arendajad/testijad saavad kasutada nii kohapeal kui ka CI-konveieri kaudu.
Esiteks teeme CI jaoks ainulaadsed teenusenimed. Üks GitLab CI ainulaadsetest muutujatest on muutuja CI_JOB_ID. Kui täpsustate container_name tähendusega "service-${CI_JOB_ID:-local}", siis juhul:
- kui
CI_JOB_IDkeskkonnamuutujates määratlemata,
siis on teenuse nimiservice-local - kui
CI_JOB_IDmääratletud keskkonnamuutujates (nt 123),
siis on teenuse nimiservice-123
Teiseks teeme teenuste käitamiseks ühise võrgu. See annab meile võrgutaseme isolatsiooni mitme testkeskkonna käitamisel.
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}Tegelikult on see esimene samm edu poole =)
Minu docker-compose.yml näide koos kommentaaridega
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:
- defaultKohaliku käitamise näide
docker-compose -f docker-compose.yml up -d
Starting testrail-mysql-local ... done
Starting testrail-migration-local ... done
Starting testrail-fpm-local ... done
Recreating testrail-web-local ... doneKuid CI-s käivitamisel pole kõik nii lihtne.
Makefile'i ettevalmistamine
Ma kasutan Makefile'i, kuna see on üsna mugav nii kohaliku keskkonnahalduse kui ka CI jaoks. Rohkem online-kommentaare
# У меня в проектах все вспомогательные вещи лежат в директории `.indirect`,
# в том числе и `docker-compose.yml`
# Использовать bash с опцией pipefail
# pipefail - фейлит выполнение пайпа, если команда выполнилась с ошибкой
SHELL=/bin/bash -o pipefail
# Останавливаем контейнеры и удаляем сеть
docker-kill:
docker-compose -f $${CI_JOB_ID:-.indirect}/docker-compose.yml kill
docker network rm network-$${CI_JOB_ID:-testrail} || true
# Предварительно выполняем docker-kill
docker-up: docker-kill
# Создаем сеть для окружения
docker network create network-$${CI_JOB_ID:-testrail}
# Забираем последние образы из docker-registry
docker-compose -f $${CI_JOB_ID:-.indirect}/docker-compose.yml pull
# Запускаем окружение
# force-recreate - принудительное пересоздание контейнеров
# renew-anon-volumes - не использовать volumes предыдущих контейнеров
docker-compose -f $${CI_JOB_ID:-.indirect}/docker-compose.yml up --force-recreate --renew-anon-volumes -d
# Ну и, на всякий случай, вывести что там у нас в принципе запущено на машинке
docker ps
# Коллектим логи сервисов
docker-logs:
mkdir ./logs || true
docker logs testrail-web-$${CI_JOB_ID:-local} >& logs/testrail-web.log
docker logs testrail-fpm-$${CI_JOB_ID:-local} >& logs/testrail-fpm.log
docker logs testrail-migration-$${CI_JOB_ID:-local} >& logs/testrail-migration.log
docker logs testrail-mysql-$${CI_JOB_ID:-local} >& logs/testrail-mysql.log
# Очистка раннера
docker-clean:
@echo Останавливаем все testrail-контейнеры
docker kill $$(docker ps --filter=name=testrail -q) || true
@echo Очистка докер контейнеров
docker rm -f $$(docker ps -a -f --filter=name=testrail status=exited -q) || true
@echo Очистка dangling образов
docker rmi -f $$(docker images -f "dangling=true" -q) || true
@echo Очистка testrail образов
docker rmi -f $$(docker images --filter=reference='registry.gitlab.com/touchbit/image/testrail/*' -q) || true
@echo Очистка всех неиспользуемых volume
docker volume rm -f $$(docker volume ls -q) || true
@echo Очистка всех testrail сетей
docker network rm $(docker network ls --filter=name=testrail -q) || true
docker ps
Kontrollige
tee dokkija
$ make docker-up
docker-compose -f ${CI_JOB_ID:-.indirect}/docker-compose.yml kill
Killing testrail-web-local ... done
Killing testrail-fpm-local ... done
Killing testrail-mysql-local ... done
docker network rm network-${CI_JOB_ID:-testrail} || true
network-testrail
docker network create network-${CI_JOB_ID:-testrail}
d2ec063324081c8bbc1b08fd92242c2ea59d70cf4025fab8efcbc5c6360f083f
docker-compose -f ${CI_JOB_ID:-.indirect}/docker-compose.yml pull
Pulling db ... done
Pulling migration ... done
Pulling fpm ... done
Pulling web ... done
docker-compose -f ${CI_JOB_ID:-.indirect}/docker-compose.yml up --force-recreate --renew-anon-volumes -d
Recreating testrail-mysql-local ... done
Recreating testrail-fpm-local ... done
Recreating testrail-migration-local ... done
Recreating testrail-web-local ... done
docker ps
CONTAINER ID PORTS NAMES
a845d3cb0e5a 0.0.0.0:80->80/tcp, 0.0.0.0:443->443/tcp testrail-web-local
19d8ef001398 9000/tcp testrail-fpm-local
e28840a2369c 3306/tcp, 33060/tcp testrail-migration-local
0e7900c23f37 3306/tcp testrail-mysql-local
teha dokkimispalke
$ make docker-logs
mkdir ./logs || true
mkdir: cannot create directory ‘./logs’: File exists
docker logs testrail-web-${CI_JOB_ID:-local} >& logs/testrail-web.log
docker logs testrail-fpm-${CI_JOB_ID:-local} >& logs/testrail-fpm.log
docker logs testrail-migration-${CI_JOB_ID:-local} >& logs/testrail-migration.log
docker logs testrail-mysql-${CI_JOB_ID:-local} >& logs/testrail-mysql.log
Faili .gitlab-ci.yml ettevalmistamine
Integratsioonitestide käivitamine
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 daysSellise ülesande käitamise tulemusena sisaldab artefaktide logide kataloog teenuste ja testide logisid. Mis on vigade korral väga mugav. Iga paralleelne test kirjutab oma logi, kuid sellest räägin eraldi.
Jooksja puhastamine
Ülesanne toimub ainult ajakava järgi.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanJärgmisena avage meie GitLabi projekt -> CI/CD -> Ajakavad -> Uus ajakava ja lisage uus ajakava
Tulemus
Käivitage GitLab CI-s 4 ülesannet
Viimase ülesande logides koos integratsioonitestidega näeme konteinereid erinevatest ülesannetest
CONTAINER ID NAMES
c6b76f9135ed testrail-web-204645172
01d303262d8e testrail-fpm-204645172
2cdab1edbf6a testrail-migration-204645172
826aaf7c0a29 testrail-mysql-204645172
6dbb3fae0322 testrail-web-204645084
3540f8d448ce testrail-fpm-204645084
70fea72aa10d testrail-mysql-204645084
d8aa24b2892d testrail-web-204644881
6d4ccd910fad testrail-fpm-204644881
685d8023a3ec testrail-mysql-204644881
1cdfc692003a testrail-web-204644793
6f26dfb2683e testrail-fpm-204644793
029e16b26201 testrail-mysql-204644793
c10443222ac6 testrail-web-204567103
04339229397e testrail-fpm-204567103
6ae0accab28d testrail-mysql-204567103
b66b60d79e43 testrail-web-204553690
033b1f46afa9 testrail-fpm-204553690
a8879c5ef941 testrail-mysql-204553690
069954ba6010 testrail-web-204553539
ed6b17d911a5 testrail-fpm-204553539
1a1eed057ea0 testrail-mysql-204553539Täpsem logi
$ 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-204553539Kõik ülesanded edukalt täidetud
Ülesande artefaktid sisaldavad teenuste ja testide logisid
Kõik tundub olevat ilus, kuid on nüanss. Konveieri saab sunniviisiliselt katkestada integratsioonitestide käitamise ajal, sel juhul töötavaid konteinereid ei peatata. Aeg-ajalt tuleb jooksja puhastada. Kahjuks on GitLab CE-s läbivaatamise ülesanne endiselt olekus
Kuid oleme lisanud ajastatud ülesande käivitamise ja keegi ei keela meil seda käsitsi käivitada.
Avage meie projekt -> CI/CD -> Ajakavad ja käivitage ülesanne Clean runner
Kokku:
- Meil on üks shell runner.
- Ülesannete ja keskkonna vahel pole konflikte.
- Meil on paralleelselt käivitatud ülesanded koos integratsioonitestidega.
- Integratsiooniteste saate käitada nii kohapeal kui ka konteineris.
- Teenindus- ja katselogid kogutakse ja lisatakse torujuhtme ülesandele.
- Runneri on võimalik puhastada vanadest dockeri piltidest.
Seadistamise aeg on ~2 tundi.
See on tegelikult kõik. Annan hea meelega tagasisidet.
Allikas: www.habr.com