Ovaj će članak biti zanimljiv i testerima i programerima, ali je uglavnom namijenjen stručnjacima za automatizaciju koji se suočavaju s problemom postavljanja GitLab CI/CD za integracijsko testiranje u uvjetima nedovoljnih infrastrukturnih resursa i/ili nepostojanja spremnika. platforma za orkestraciju. Reći ću vam kako postaviti implementaciju testnih okruženja pomoću docker compose na jednom GitLab shell runneru tako da prilikom postavljanja nekoliko okruženja pokrenute usluge ne ometaju jedna drugu.
sadržaj
Предпосылки
-
U mojoj praksi često se događalo da se integracijsko testiranje “tretira” na projektima. A često je prvi i najznačajniji problem CI cjevovod, u kojem se vrši testiranje integracije razvija se usluga(e) provodi se u dev/stage okruženju. To je uzrokovalo dosta problema:
- Zbog kvarova u određenoj usluzi tijekom testiranja integracije, ispitni krug može biti oštećen neispravnim podacima. Bilo je slučajeva kada je slanje zahtjeva s pokvarenim JSON formatom srušilo uslugu, što je postolje učinilo potpuno neoperativnim.
- Usporavanje ispitnog kruga kako se ispitni podaci povećavaju. Mislim da nema smisla opisivati primjer s čišćenjem/vraćanjem baze podataka. U svojoj praksi nisam se susreo s projektom kod kojeg je ta procedura prošla glatko.
- Rizik od ometanja funkcionalnosti ispitnog kruga prilikom testiranja općih postavki sustava. Na primjer, pravila korisnika/grupe/lozinke/aplikacije.
- Testni podaci iz automatiziranih testova otežavaju život ručnim testerima.
Neki će reći da bi dobri autotestovi trebali počistiti podatke za sobom. Imam argumente protiv:
- Dinamički stalci vrlo su praktični za korištenje.
- Ne može se svaki objekt ukloniti iz sustava putem API-ja. Na primjer, poziv za brisanje objekta nije implementiran jer je u suprotnosti s poslovnom logikom.
- Prilikom izrade objekta putem API-ja može se stvoriti ogromna količina metapodataka koje je problematično izbrisati.
- Ako testovi imaju međusobne ovisnosti, tada se proces čišćenja podataka nakon izvođenja testova pretvara u glavobolju.
- Dodatni (i, po mom mišljenju, neopravdani) pozivi API-ju.
- I glavni argument: kada se testni podaci počnu brisati izravno iz baze podataka. Ovo se pretvara u pravi PK/FK cirkus! Čujemo od programera: "Upravo sam dodao/uklonio/preimenovao znak, zašto je 100500 integracijskih testova uhvaćeno?"
Po meni je najoptimalnije rješenje dinamično okruženje.
- Mnogi ljudi koriste docker-compose za pokretanje testnog okruženja, ali malo ljudi koristi docker-compose kada provode testiranje integracije u CI/CD-u. I ovdje ne uzimam u obzir kubernetes, swarm i druge platforme za orkestraciju kontejnera. Nema ih svaka tvrtka. Bilo bi lijepo da je docker-compose.yml univerzalan.
- Čak i ako imamo vlastitog QA runnera, kako možemo osigurati da servisi pokrenuti putem docker-compose ne ometaju jedni druge?
- Kako prikupiti dnevnike testiranih usluga?
- Kako očistiti trkač?
Imam vlastiti GitLab pokretač za svoje projekte i naišao sam na ta pitanja tijekom razvoja za . Točnije, prilikom izvođenja integracijskih testova. U nastavku ćemo riješiti ove probleme koristeći primjere iz ovog projekta.
GitLab Shell Runner
Za trkača, preporučujem Linux virtualni stroj s 4 vCPU-a, 4 GB RAM-a, 50 GB HDD.
Na internetu ima mnogo informacija o postavljanju gitlab-runnera, pa ukratko:
- Prijavite se na stroj putem SSH
-
Ako imate manje od 8 GB RAM-a, preporučujem tako da OOM killer ne dođe i ubije naše zadatke zbog nedostatka RAM-a. To se može dogoditi kada se više od 5 zadataka pokrene istovremeno. Zadaci će napredovati sporije, ali postojano.
Primjer s OOM ubojicom
Ako vidite u zapisnicima zadataka
bash: line 82: 26474 Killed, 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 dodajte RAM.
- Postaviti , , , napraviti.
- Dodavanje korisnika
gitlab-runnergrupidockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab-trkač.
-
Otvoreno za uređivanje
/etc/gitlab-runner/config.tomli dodajteconcurrent=20 [[runners]] request_concurrency = 10To će vam omogućiti pokretanje paralelnih zadataka na jednom trkaču. Čitaj više .
Ako imate snažniji stroj, na primjer 8 vCPU-a, 16 GB RAM-a, tada se ove brojke mogu povećati barem 2 puta. Ali sve ovisi o tome što će se točno lansirati na ovom trkaču iu kojoj količini.
To je dovoljno.
Priprema docker-compose.yml
Glavni zadatak je univerzalni docker-compose.yml, koji programeri/testeri mogu koristiti i lokalno i u CI cjevovodu.
Prije svega, izrađujemo jedinstvena imena usluga za CI. Jedna od jedinstvenih varijabli u GitLab CI je varijabla CI_JOB_ID. Ako navedete container_name s vrijednošću "service-${CI_JOB_ID:-local}", tada u slučaju:
- ako
CI_JOB_IDnije definirano u varijablama okruženja,
tada će naziv usluge bitiservice-local - ako
CI_JOB_IDdefinirano u varijablama okoline (na primjer 123),
tada će naziv usluge bitiservice-123
Drugo, stvaramo zajedničku mrežu za pokrenute usluge. To nam daje izolaciju na mrežnoj razini kada izvodimo 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
Koristim Makefile jer je vrlo zgodan i za upravljanje lokalnim 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
Provjeravanje
izraditi 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
Izvođenje 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 zapisa u artefaktima sadržavat će servisne i testne zapisnike. Što je vrlo zgodno u slučaju pogrešaka. Svaki test paralelno piše svoj dnevnik, ali o tome ću posebno.
Čišćenje trkača
Zadatak će se pokrenuti 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 projekt -> CI/CD -> Rasporedi -> Novi raspored i dodajte novi raspored
Rezultirati
Pokretanje 4 zadatka u GitLab CI
U zapisnicima posljednjeg zadatka s integracijskim testovima vidimo spremnike 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 zadatka sadrže servisne i testne zapisnike
Čini se da je sve lijepo, ali postoji nijansa. Cjevovod se može prisilno otkazati dok se izvode integracijski testovi, u kojem slučaju spremnici koji rade neće biti zaustavljeni. S vremena na vrijeme morate očistiti trkač. Nažalost, zadatak za poboljšanje u GitLab CE još uvijek je u statusu
Ali dodali smo pokretanje zadatka prema rasporedu i nitko nam ne brani da ga pokrenemo ručno.
Idite na naš projekt -> CI/CD -> Rasporedi i pokrenite zadatak Clean runner
Ukupno:
- Imamo jednog trkača školjke.
- Nema sukoba između zadataka i okoline.
- Paralelno izvodimo zadatke s integracijskim testovima.
- Integracijske testove možete izvoditi lokalno ili u spremniku.
- Servisni i testni dnevnici prikupljaju se i prilažu zadatku cjevovoda.
- Moguće je očistiti runner od starih Docker slika.
Vrijeme postavljanja je ~2 sata.
To je zapravo sve. Bit će mi drago dobiti povratne informacije.
Izvor: www.habr.com