Ovaj članak će biti od interesa i za testere i za programere, ali je više namijenjen automatatorima koji se suočavaju s problemom postavljanja GitLab CI/CD-a za testiranje integracije s obzirom na nedovoljne infrastrukturne resurse i/ili odsustvo orkestracije kontejnera. platforma. Reći ću vam kako da konfigurišete implementaciju testnih okruženja koristeći docker compose na jednom GitLab shell runneru i tako da prilikom postavljanja nekoliko okruženja pokrenute usluge ne ometaju jedna drugu.
Sadržaj
Preduslovi
-
U mojoj praksi se često dešavalo da „tretim“ integracijsko testiranje na projektima. I često je prvi i najznačajniji problem CI pipeline, u kojem se vrši testiranje integracije razvijen usluga(e) se hostuje u dev/stage okruženju. To je izazvalo dosta problema:
- Zbog kvarova u jednoj ili drugoj usluzi tokom integracijskog testiranja, testno kolo može biti oštećeno neispravnim podacima. Bilo je slučajeva kada je slanje zahtjeva sa pokvarenim JSON formatom prekinuo servis, zbog čega je štand potpuno nefunkcionalan.
- Usporavanje testnog kola sa porastom testnih podataka. Mislim da nema smisla opisivati primjer sa čišćenjem / vraćanjem baze podataka. U svojoj praksi nisam sreo projekat u kojem bi ova procedura prošla glatko.
- Rizik od narušavanja performansi testnog kola prilikom testiranja opštih postavki sistema. Na primjer, politika korisnika/grupe/lozinke/aplikacije.
- Testni podaci iz autotestova otežavaju život ručnim testerima.
Neko će reći da bi dobri autotestovi trebali očistiti podatke za sobom. Imam argumente protiv:
- Dinamički stalci su vrlo praktični za korištenje.
- Ne može se svaki objekat ukloniti iz sistema preko API-ja. Na primjer, poziv za brisanje objekta nije implementiran, jer je u suprotnosti s poslovnom logikom.
- Prilikom kreiranja objekta putem API-ja može se stvoriti ogromna količina metapodataka koje je problematično ukloniti.
- Ako su testovi zavisni jedan od drugog, onda se proces čišćenja podataka nakon izvršenja testova pretvara u glavobolju.
- Dodatni (i, po mom mišljenju, neopravdani) pozivi API-ju.
- I glavni argument: kada testni podaci počnu da se čiste direktno iz baze podataka. Ovo se pretvara u pravi PK/FK cirkus! Od programera čujemo: „Upravo sam dodao/izbrisao/imenovao znak, zašto je palo 100500 integracijskih testova?”
Po mom mišljenju, najoptimalnije rješenje je dinamično okruženje.
- Mnogi ljudi koriste docker-compose za pokretanje testnog okruženja, ali malo ljudi koristi docker-compose kada radi testiranje integracije u CI/CD. I ovdje ne uzimam u obzir kubernetes, swarm i druge platforme za orkestraciju kontejnera. Nema ih svaka kompanija. Bilo bi lijepo kada bi docker-compose.yml bio univerzalan.
- Čak i ako imamo vlastiti QA runner, kako možemo osigurati da usluge pokrenute putem docker-compose ne ometaju jedna drugu?
- Kako prikupiti dnevnike testiranih usluga?
- Kako očistiti trkač?
Imam svoj GitLab pokretač za svoje projekte i naišao sam na ove probleme dok sam razvijao do . Konkretnije, kada se izvode integracijski testovi. Ovdje ćemo nastaviti rješavati ova pitanja na primjerima iz ovog projekta.
GitLab Shell Runner
Za trkače, preporučujem Linux virtuelnu mašinu sa 4 vCPU, 4 GB RAM-a, 50 GB HDD.
Postoji mnogo informacija o postavljanju gitlab-runner-a na internetu, pa ukratko:
- Idemo do mašine preko SSH-a
-
Ako imate manje od 8 GB RAM-a, preporučujem tako da OOM killer ne dođe i ubije nam zadatke zbog nedostatka RAM-a. Ovo se može dogoditi kada se istovremeno izvršava više od 5 zadataka. Zadaci će biti sporiji, ali stabilni.
Primjer sa OOM killerom
Ako u evidenciji zadataka vidite
bash: line 82: 26474 Killed, a zatim samo izvršite na trkačusudo 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:0kBA ako slika izgleda otprilike ovako, onda ili dodajte swap, ili ubacite RAM.
- Instalirajte , , , napraviti.
- Dodavanje korisnika
gitlab-runnergrupidockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab-runner.
-
Otvoreno za uređivanje
/etc/gitlab-runner/config.tomli dodaticoncurrent=20 [[runners]] request_concurrency = 10Ovo će vam omogućiti da izvodite paralelne zadatke na istom trkaču. Čitaj više .
Ako imate moćniju mašinu, na primjer, 8 vCPU, 16 GB RAM-a, onda se ovi brojevi mogu povećati barem 2 puta. Ali sve ovisi o tome što će se točno lansirati na ovom trkaču i u kojoj količini.
Dosta je.
Priprema docker-compose.yml
Glavni zadatak je univerzalni docker-compose.yml koji programeri/testeri mogu koristiti i lokalno i u CI pipelineu.
Prije svega, pravimo jedinstvena imena usluga za CI. Jedna od jedinstvenih varijabli u GitLab CI je varijabla CI_JOB_ID. Ako navedete container_name sa značenjem "service-${CI_JOB_ID:-local}", zatim u slučaju:
- ako
CI_JOB_IDnije definisano u varijablama okruženja,
tada će biti naziv uslugeservice-local - ako
CI_JOB_IDdefinisano u varijablama okruženja (npr. 123),
tada će biti naziv uslugeservice-123
Drugo, pravimo zajedničku mrežu za pokretanje servisa. Ovo nam daje izolaciju na nivou mreže kada pokrećemo više testnih okruženja.
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}Zapravo, ovo je prvi korak do uspjeha =)
Primjer mog docker-compose.yml s komentarima
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:
- defaultPrimjer lokalnog pokretanja
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 ... doneAli nije sve tako jednostavno s pokretanjem u CI.
Priprema Makefile-a
Koristim Makefile jer je prilično zgodan i za lokalno upravljanje okruženjem i za CI. Više online komentara
# У меня в проектах все вспомогательные вещи лежат в директории `.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
Proverite
napraviti 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
napraviti docker-logove
$ 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
Priprema .gitlab-ci.yml
Pokretanje integracijskih testova
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 daysKao rezultat pokretanja takvog zadatka, direktorij dnevnika u artefaktima će sadržavati dnevnike usluga i testova. Što je vrlo zgodno u slučaju grešaka. Svaki test paralelno piše svoj dnevnik, ali o tome ću govoriti posebno.
Čišćenje trkača
Zadatak će se izvoditi samo prema rasporedu.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanZatim idite na naš GitLab projekat -> CI/CD -> Rasporedi -> Novi raspored i dodajte novi raspored
rezultat
Pokrenite 4 zadatka u GitLab CI
U zapisnicima posljednjeg zadatka sa integracijskim testovima vidimo kontejnere iz različitih zadataka
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-204553539Detaljniji dnevnik
$ 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-204553539Svi zadaci uspješno obavljeni
Artefakti zadataka sadrže dnevnike usluga i testova
Čini se da je sve lijepo, ali postoji nijansa. Cjevovod se može prisilno otkazati dok se izvode integracijski testovi, u kom slučaju radni kontejneri neće biti zaustavljeni. S vremena na vrijeme trebate očistiti trkač. Nažalost, zadatak za reviziju u GitLab CE je još uvijek u statusu
Ali dodali smo planirano pokretanje zadatka i niko nam ne brani da ga pokrenemo ručno.
Idite na naš projekt -> CI/CD -> Rasporedi i pokrenite zadatak Clean runner
Ukupno:
- Imamo jednu školjku.
- Nema sukoba između zadataka i okoline.
- Imamo paralelno pokretanje zadataka sa integracijskim testovima.
- Možete pokrenuti integracijske testove i lokalno i u kontejneru.
- Dnevnici servisa i testiranja se prikupljaju i prilažu zadatku cjevovoda.
- Moguće je očistiti runner od starih docker slika.
Vrijeme postavljanja je ~2 sata.
To je, u stvari, sve. Bit će mi drago da dobijem povratnu informaciju.
izvor: www.habr.com