Denne artikel vil være af interesse for både testere og udviklere, men er mere tiltænkt automatister, der står over for problemet med at opsætte GitLab CI/CD til integrationstest i lyset af utilstrækkelige infrastrukturressourcer og/eller fraværet af en containerorkestrering platform. Jeg vil fortælle dig, hvordan du konfigurerer udrulningen af testmiljøer ved hjælp af docker compose på en enkelt GitLab shell runner, og så når du installerer flere miljøer, forstyrrer de lancerede tjenester ikke hinanden.
Indhold
Предпосылки
-
I min praksis skete det ofte at "behandle" integrationstest på projekter. Og ofte er det første og mest væsentlige problem CI-pipeline, hvori integrationstest udviklede sig tjenesten/tjenesterne hostes i dev/stage-miljøet. Dette gav en del problemer:
- På grund af fejl i en eller anden tjeneste under integrationstestning kan testkredsløbet blive beskadiget af ødelagte data. Der var tilfælde, hvor man sendte en anmodning med et ødelagt JSON-format, og tjenesten blev hængt op, hvilket bragte standen fuldstændig ude af drift.
- Afmatningen af testkredsløbet med væksten af testdata. Jeg synes, det giver ingen mening at beskrive et eksempel med at rense/rulle databasen tilbage. I min praksis har jeg ikke mødt et projekt, hvor denne procedure ville forløbe glat.
- Risikoen for at forstyrre testkredsløbets ydeevne ved test af generelle systemindstillinger. For eksempel bruger/gruppe/adgangskode/applikationspolitik.
- Testdata fra autotest gør livet svært for manuelle testere.
Nogen vil sige, at gode autotest bør rydde op i dataene efter sig. Jeg har argumenter imod:
- Dynamiske stativer er meget praktiske at bruge.
- Ikke alle objekter kan fjernes fra systemet via API'et. For eksempel implementeres et opkald om at slette et objekt ikke, da det modsiger forretningslogikken.
- Når du opretter et objekt gennem API'et, kan der skabes en enorm mængde metadata, som er problematisk at fjerne.
- Hvis testene er afhængige af hinanden, bliver processen med at rydde op i data, efter testene er blevet udført, til en hovedpine.
- Yderligere (og efter min mening ikke berettigede) kald til API'en.
- Og hovedargumentet: når testdataene begynder at blive renset direkte fra databasen. Dette er ved at blive til et rigtigt PK/FK-cirkus! Vi hører fra udviklerne: "Jeg har lige tilføjet/slettet/omdøbt skiltet, hvorfor faldt 100500 integrationstests igennem?"
Efter min mening er den mest optimale løsning et dynamisk miljø.
- Mange bruger docker-compose til at køre et testmiljø, men de færreste bruger docker-compose, når de laver integrationstest i CI/CD. Og her tager jeg ikke højde for kubernetes, sværm og andre containerorkestreringsplatforme. Ikke alle virksomheder har dem. Det ville være rart, hvis docker-compose.yml var universel.
- Selv hvis vi har vores egen QA-løber, hvordan kan vi så sikre os, at tjenester lanceret via docker-compose ikke forstyrrer hinanden?
- Hvordan indsamler man logs over testede tjenester?
- Hvordan rengøres løberen?
Jeg har min egen GitLab-løber til mine projekter, og jeg løb ind i disse problemer, mens jeg udviklede mig for . Mere specifikt, når du kører integrationstest. Her vil vi fortsætte med at løse disse problemstillinger med eksempler fra dette projekt.
GitLab Shell Runner
For en løber anbefaler jeg en virtuel Linux-maskine med 4 vCPU, 4 GB RAM, 50 GB HDD.
Der er meget information om opsætning af gitlab-runner på internettet, så kort sagt:
- Vi går til maskinen via SSH
-
Hvis du har mindre end 8 GB RAM, så anbefaler jeg så OOM-morderen ikke kommer og dræber os opgaver på grund af manglende RAM. Dette kan ske, når mere end 5 opgaver kører på samme tid. Opgaverne vil være langsommere, men stabile.
Eksempel med OOM killer
Hvis du ser i opgaveloggene
bash: line 82: 26474 Killed, så skal du bare udføre på løberensudo 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:0kBOg hvis billedet ser sådan ud, så tilføj enten swap eller smid RAM ind.
- Indstil , , , lav.
- Tilføjelse af en bruger
gitlab-runnertil gruppendockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab-runner.
-
Åben for redigering
/etc/gitlab-runner/config.tomlog tilføjeconcurrent=20 [[runners]] request_concurrency = 10Dette giver dig mulighed for at køre parallelle opgaver på den samme løber. Læs mere .
Hvis du har en mere kraftfuld maskine, for eksempel 8 vCPU, 16 GB RAM, så kan disse tal gøres mindst 2 gange større. Men det hele afhænger af, hvad der præcist vil blive lanceret på denne løber og i hvilken mængde.
Det er nok.
Forbereder docker-compose.yml
Hovedopgaven er en universel docker-compose.yml, som udviklere/testere kan bruge både lokalt og i CI-pipelinen.
Først og fremmest laver vi unikke servicenavne til CI. En af de unikke variabler i GitLab CI er variablen CI_JOB_ID. Hvis du angiver container_name med betydningen "service-${CI_JOB_ID:-local}", så i tilfældet:
- hvis
CI_JOB_IDikke defineret i miljøvariabler,
så bliver tjenestenavnetservice-local - hvis
CI_JOB_IDdefineret i miljøvariabler (f.eks. 123),
så bliver tjenestenavnetservice-123
For det andet laver vi et fælles netværk til drift af tjenester. Dette giver os netværksniveauisolation, når vi kører flere testmiljøer.
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}Faktisk er dette det første skridt til succes =)
Et eksempel på min docker-compose.yml med kommentarer
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:
- defaultEksempel på lokalt løb
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 ... doneMen ikke alt er så enkelt med lancering i CI.
Forberedelse af Makefilen
Jeg bruger Makefilen, da den er ret praktisk til både lokal miljøstyring og CI. Flere online kommentarer
# У меня в проектах все вспомогательные вещи лежат в директории `.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
Kontrol
gøre havnearbejder
$ 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
lave docker-logs
$ 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
Forbereder .gitlab-ci.yml
Kørsel af integrationstests
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 daysSom et resultat af at køre en sådan opgave, vil logbiblioteket i artefakter indeholde logfiler over tjenester og test. Hvilket er meget praktisk i tilfælde af fejl. Hver test skriver parallelt sin egen log, men jeg vil tale om dette separat.
Rengøring af løberen
Opgaven kører kun i henhold til tidsplanen.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanGå derefter til vores GitLab-projekt -> CI/CD -> Skemaer -> Nyt skema og tilføj en ny tidsplan
Outcome
Kør 4 opgaver i GitLab CI
I loggene på den sidste opgave med integrationstest ser vi containere fra forskellige opgaver
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-204553539Mere detaljeret log
$ 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-204553539Alle opgaver udført med succes
Opgaveartefakter indeholder logfiler over tjenester og tests
Alt ser ud til at være smukt, men der er en nuance. En pipeline kan tvangsannulleres, mens integrationstest kører, i hvilket tilfælde kørende containere ikke stoppes. Fra tid til anden skal du rengøre løberen. Desværre er opgaven til revision i GitLab CE stadig i status
Men vi har tilføjet en planlagt opgavestart, og ingen forbyder os at starte den manuelt.
Gå til vores projekt -> CI/CD -> Tidsplaner og kør opgaven Clean runner
Totalt:
- Vi har en shell runner.
- Der er ingen konflikter mellem opgaver og miljø.
- Vi har en sideløbende lancering af opgaver med integrationstest.
- Du kan køre integrationstest både lokalt og i en container.
- Service- og testlogs indsamles og vedhæftes pipeline-opgaven.
- Det er muligt at rense løberen fra gamle docker-billeder.
Opsætningstiden er ~2 timer.
Det er faktisk alt. Jeg vil være glad for feedback.
Kilde: www.habr.com