Denne artikkelen vil være av interesse for både testere og utviklere, men er hovedsakelig ment for automatiseringsspesialister som står overfor problemet med å sette opp GitLab CI/CD for integrasjonstesting under forholdene med utilstrekkelige infrastrukturressurser og/eller fravær av en beholder orkestreringsplattform. Jeg vil fortelle deg hvordan du setter opp distribusjonen av testmiljøer ved å bruke docker compose på én enkelt GitLab shell runner, og slik at når du distribuerer flere miljøer, vil ikke de lanserte tjenestene forstyrre hverandre.
Innhold
Предпосылки
-
I min praksis hendte det ofte at integrasjonstesting ble «behandlet» på prosjekter. Og ofte er det første og mest betydelige problemet CI-rørledningen, der integrasjonstesting blir utviklet tjeneste(r) utføres i et dev/stage-miljø. Dette førte til en del problemer:
- På grunn av feil i en bestemt tjeneste under integrasjonstesting, kan testkretsen bli skadet av ødelagte data. Det var tilfeller da sending av en forespørsel med et ødelagt JSON-format krasjet tjenesten, noe som gjorde stativet helt ubrukelig.
- Nedbremsing av testkretsen når testdataene øker. Jeg tror det ikke gir noen mening å beskrive et eksempel med å rense/rulle tilbake databasen. I min praksis har jeg ikke vært borti et prosjekt hvor denne prosedyren gikk knirkefritt.
- Risiko for å forstyrre funksjonaliteten til testkretsen ved testing av generelle systeminnstillinger. For eksempel bruker/gruppe/passord/applikasjonspolicy.
- Testdata fra automatiserte tester gjør livet vanskelig for manuelle testere.
Noen vil si at gode autotester bør rydde opp i dataene etter seg. Jeg har argumenter mot:
- Dynamiske stativer er veldig praktiske å bruke.
- Ikke alle objekter kan fjernes fra systemet via API. Et kall for å slette et objekt ble for eksempel ikke implementert fordi det motsier forretningslogikken.
- Når du oppretter et objekt via API, kan det lages en enorm mengde metadata, noe som er problematisk å slette.
- Hvis tester har avhengigheter seg imellom, blir prosessen med å rense data etter å ha kjørt tester til en hodepine.
- Ytterligere (og, etter min mening, ikke berettigede) kall til API.
- Og hovedargumentet: når testdata begynner å bli slettet direkte fra databasen. Dette er i ferd med å bli et skikkelig PK/FK-sirkus! Vi hører fra utviklere: "Jeg har nettopp lagt til/fjernet/omdøpt et skilt, hvorfor ble 100500 XNUMX integrasjonstester fanget?"
Etter min mening er den mest optimale løsningen et dynamisk miljø.
- Mange bruker docker-compose for å kjøre et testmiljø, men få bruker docker-compose når de utfører integrasjonstesting i CI/CD. Og her tar jeg ikke hensyn til kubernetes, sverm og andre containerorkestreringsplattformer. Ikke alle selskaper har dem. Det ville vært fint om docker-compose.yml var universell.
- Selv om vi har vår egen QA-løper, hvordan kan vi sørge for at tjenester lansert via docker-compose ikke forstyrrer hverandre?
- Hvordan samler jeg inn logger over testede tjenester?
- Hvordan rengjøre løperen?
Jeg har min egen GitLab-løper for prosjektene mine, og jeg møtte disse spørsmålene under utviklingen for . Mer presist, når du kjører integrasjonstester. Nedenfor vil vi løse disse problemene ved å bruke eksempler fra dette prosjektet.
GitLab Shell Runner
For en løper anbefaler jeg en virtuell Linux-maskin med 4 vCPU, 4 GB RAM, 50 GB HDD.
Det er mye informasjon om å sette opp gitlab-runner på Internett, så kort:
- Logg inn på maskinen via SSH
-
Hvis du har mindre enn 8 GB RAM, så anbefaler jeg slik at OOM-morderen ikke kommer og dreper oppgavene våre på grunn av mangel på RAM. Dette kan skje når mer enn 5 oppgaver startes samtidig. Oppgavene vil utvikle seg saktere, men jevnt.
Eksempel med OOM killer
Hvis du ser i oppgaveloggene
bash: line 82: 26474 Killed, så er det bare å utføre på løperensudo 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 bildet ser omtrent slik ut, legg enten til swap eller legg til RAM.
- Satt , , , gjøre.
- Legger til en bruker
gitlab-runnertil gruppendockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab-runner.
-
Åpne for redigering
/etc/gitlab-runner/config.tomlog legg tilconcurrent=20 [[runners]] request_concurrency = 10Dette vil tillate deg å kjøre parallelle oppgaver på én løper. Les mer .
Hvis du har en kraftigere maskin, for eksempel 8 vCPU, 16 GB RAM, kan disse tallene gjøres minst 2 ganger større. Men alt avhenger av nøyaktig hva som skal lanseres på denne løperen og i hvilken mengde.
Det er nok.
Forbereder docker-compose.yml
Hovedoppgaven er en universell docker-compose.yml, som utviklere/testere kan bruke både lokalt og i CI-pipeline.
Først av alt lager vi unike tjenestenavn for CI. En av de unike variablene i GitLab CI er variabelen CI_JOB_ID. Hvis du spesifiserer container_name med mening "service-${CI_JOB_ID:-local}", så i tilfellet:
- hvis
CI_JOB_IDikke definert i miljøvariabler,
da vil tjenestenavnet væreservice-local - hvis
CI_JOB_IDdefinert i miljøvariabler (for eksempel 123),
da vil tjenestenavnet væreservice-123
For det andre skaper vi et felles nettverk for lanserte tjenester. Dette gir oss isolasjon på nettverksnivå når vi kjører flere testmiljøer.
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}Faktisk er dette det første steget til suksess =)
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øp
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 lansering i CI.
Forbereder Makefilen
Jeg bruker Makefile fordi det er veldig praktisk både for lokalmiljøstyring og i CI. Flere kommentarer på nett
# У меня в проектах все вспомогательные вещи лежат в директории `.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
Sjekker
gjøre docker-up
$ 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
lage docker-logger
$ 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
Kjører integrasjonstester
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 av å kjøre en slik oppgave, vil loggkatalogen i artefaktene inneholde tjeneste- og testlogger. Noe som er veldig praktisk ved feil. Hver test parallelt skriver sin egen logg, men jeg skal snakke om dette separat.
Rengjøring av løperen
Oppgaven vil kun bli lansert i henhold til en tidsplan.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanGå deretter til GitLab-prosjektet vårt -> CI/CD -> Tidsplaner -> Ny tidsplan og legg til en ny tidsplan
Resultat
Lansering av 4 oppgaver i GitLab CI
I loggene til den siste oppgaven med integrasjonstester ser vi containere fra forskjellige oppgaver
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-204553539Mer detaljert logg
$ 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 oppgaver fullført
Oppgaveartefakter inneholder service- og testlogger
Alt ser ut til å være vakkert, men det er en nyanse. Pipeline kan tvangskanselleres mens integrasjonstester kjører, i så fall vil ikke kjørende containere bli stoppet. Fra tid til annen må du rengjøre løperen. Dessverre er oppgaven for forbedring i GitLab CE fortsatt i status
Men vi har lagt til lansering av en oppgave i henhold til en tidsplan, og ingen forbyr oss å kjøre den manuelt.
Gå til vårt prosjekt -> CI/CD -> Tidsplaner og kjør oppgaven Clean runner
totalt:
- Vi har en skallløper.
- Det er ingen konflikter mellom oppgaver og miljø.
- Vi kjører oppgaver med integrasjonstester parallelt.
- Du kan kjøre integrasjonstester enten lokalt eller i en beholder.
- Service- og testlogger samles inn og festes til rørledningsoppgaven.
- Det er mulig å rense løperen fra gamle Docker-bilder.
Oppsetttiden er ~2 timer.
Det er alt, faktisk. Jeg vil gjerne motta tilbakemeldinger.
Kilde: www.habr.com