Šis straipsnis bus įdomus tiek testuotojams, tiek kūrėjams, tačiau daugiausia skirtas automatikos specialistams, kurie susiduria su GitLab CI/CD nustatymo problema, kad būtų galima atlikti integracijos testavimą, kai nepakanka infrastruktūros išteklių ir (arba) nėra konteinerio orkestravimo platforma. Papasakosiu, kaip nustatyti testavimo aplinkų diegimą naudojant docker compose viename GitLab apvalkalo paleidiklyje ir taip, kad diegiant kelias aplinkas paleistos paslaugos netrukdytų viena kitai.
Turinys
Būtinos sąlygos
-
Mano praktikoje dažnai atsitikdavo, kad integracijos testavimas buvo „gydomas“ projektuose. Ir dažnai pirmoji ir svarbiausia problema yra CI vamzdynas, kuriame atliekami integracijos bandymai kuriama paslauga (-os) atliekama kūrimo / etapo aplinkoje. Tai sukėlė nemažai problemų:
- Dėl tam tikros paslaugos defektų integravimo testavimo metu bandymo grandinė gali būti pažeista dėl sugadintų duomenų. Buvo atvejų, kai siunčiant užklausą sugedusiu JSON formatu, paslauga užgeso, dėl ko stovas buvo visiškai neveikiantis.
- Bandymo grandinės sulėtėjimas didėjant bandymo duomenims. Manau, kad nėra prasmės aprašinėti pavyzdį su duomenų bazės valymu/grąžinimu. Savo praktikoje nesu susidūręs su projektu, kuriame ši procedūra vyktų sklandžiai.
- Testuojant bendruosius sistemos nustatymus kyla bandymo grandinės veikimo sutrikimo rizika. Pavyzdžiui, vartotojo / grupės / slaptažodžio / programos politika.
- Automatinių testų bandymų duomenys apsunkina rankinių testuotojų gyvenimą.
Kai kurie sakys, kad geri automatiniai testai turėtų išvalyti duomenis po savęs. Turiu argumentų prieš:
- Dinaminius stovus labai patogu naudoti.
- Ne kiekvienas objektas gali būti pašalintas iš sistemos per API. Pavyzdžiui, raginimas ištrinti objektą nebuvo įgyvendintas, nes tai prieštarauja verslo logikai.
- Kuriant objektą per API, gali būti sukurtas didžiulis metaduomenų kiekis, kurį sunku ištrinti.
- Jei testai yra tarpusavyje susiję, tada duomenų valymo procesas po bandymų virsta galvos skausmu.
- Papildomi (ir, mano nuomone, nepateisinami) iškvietimai į API.
- Ir pagrindinis argumentas: kai bandymo duomenys pradedami valyti tiesiai iš duomenų bazės. Tai virsta tikru PK/FK cirku! Iš kūrėjų girdime: „Ką tik pridėjau / pašalinau / pervardijau ženklą, kodėl užkliuvo 100500 XNUMX integracijos testų?
Mano nuomone, optimaliausias sprendimas – dinamiška aplinka.
- Daugelis žmonių naudoja docker-compose, kad paleistų bandomąją aplinką, tačiau mažai žmonių naudoja docker-compose, kai atlieka integracijos testavimą CI / CD. Ir čia neatsižvelgiu į kubernetes, spiečius ir kitas konteinerių orkestravimo platformas. Ne kiekviena įmonė juos turi. Būtų gerai, jei docker-compose.yml būtų universalus.
- Net jei turime savo kokybės užtikrinimo programą, kaip galime užtikrinti, kad paslaugos, paleidžiamos naudojant docker-compose, netrukdytų viena kitai?
- Kaip rinkti patikrintų paslaugų žurnalus?
- Kaip išvalyti bėgiką?
Savo projektams turiu savo GitLab bėgiką ir su šiais klausimais susidūriau kurdamas už . Tiksliau, vykdant integracijos testus. Žemiau mes išspręsime šias problemas naudodami šio projekto pavyzdžius.
GitLab Shell Runner
Bėgikams rekomenduoju Linux virtualią mašiną su 4 vCPU, 4 GB RAM, 50 GB HDD.
Internete yra daug informacijos apie gitlab-runner nustatymą, todėl trumpai:
- Prisijunkite prie įrenginio per SSH
-
Jei turite mažiau nei 8 GB RAM, rekomenduoju kad OOM žudikas neateitų ir neužmuštų mūsų užduočių dėl RAM trūkumo. Taip gali nutikti, kai vienu metu paleidžiamos daugiau nei 5 užduotys. Užduotys vyks lėčiau, bet stabiliai.
Pavyzdys su OOM killer
Jei užduočių žurnaluose matote
bash: line 82: 26474 Killed, tada tiesiog paleiskite ant bėgikosudo 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:0kBIr jei paveikslėlis atrodo maždaug taip, tada pridėkite mainų arba pridėkite RAM.
- Nustatyti , , , padaryti.
- Pridedamas vartotojas
gitlab-runnerį grupędockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab bėgikas.
-
Atidaryti redaguoti
/etc/gitlab-runner/config.tomlir pridėkiteconcurrent=20 [[runners]] request_concurrency = 10Tai leis jums vykdyti lygiagrečias užduotis vienam bėgikui. Skaityti daugiau .
Jei turite galingesnį įrenginį, pavyzdžiui, 8 vCPU, 16 GB RAM, tada šiuos skaičius gali būti bent 2 kartus didesnis. Bet viskas priklauso nuo to, kas tiksliai bus paleista ant šio bėgiko ir kokiu kiekiu.
Tai pakankamai.
Ruošiamas docker-compose.yml
Pagrindinė užduotis yra universalus docker-compose.yml, kurį kūrėjai/bandytojai gali naudoti tiek lokaliai, tiek CI konvejeryje.
Visų pirma, CI sukuriame unikalius paslaugų pavadinimus. Vienas iš unikalių GitLab CI kintamųjų yra kintamasis CI_JOB_ID. Jei nurodysite container_name su prasme "service-${CI_JOB_ID:-local}", tada tokiu atveju:
- jei
CI_JOB_IDneapibrėžtas aplinkos kintamuosiuose,
tada paslaugos pavadinimas busservice-local - jei
CI_JOB_IDapibrėžti aplinkos kintamuosiuose (pavyzdžiui, 123),
tada paslaugos pavadinimas busservice-123
Antra, sukuriame bendrą pradėtų paslaugų tinklą. Tai suteikia mums tinklo lygio izoliaciją, kai vykdome kelias bandymo aplinkas.
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}Tiesą sakant, tai pirmas žingsnis į sėkmę =)
Mano docker-compose.yml pavyzdys su komentarais
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:
- defaultVietinio bėgimo pavyzdys
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 ... doneTačiau paleidus CI ne viskas taip paprasta.
Makefile paruošimas
Aš naudoju Makefile, nes tai labai patogu tiek vietiniam aplinkos valdymui, tiek CI. Daugiau komentarų internete
# У меня в проектах все вспомогательные вещи лежат в директории `.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
Patikrinkite
padaryti dokerį
$ 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
daryti dokų rąstus
$ 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
.gitlab-ci.yml paruošimas
Vykdomi integravimo testai
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 daysVykdant tokią užduotį, artefaktų žurnalų kataloge bus paslaugų ir bandymų žurnalai. Tai labai patogu klaidų atveju. Kiekvienas testas lygiagrečiai rašo savo žurnalą, bet apie tai kalbėsiu atskirai.
Bėgiklio valymas
Užduotis bus paleista tik pagal grafiką.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanTada eikite į mūsų GitLab projektą -> CI / CD -> Tvarkaraščiai -> Naujas tvarkaraštis ir pridėkite naują tvarkaraštį
Rezultatas
4 užduočių paleidimas „GitLab CI“.
Paskutinės užduoties su integravimo testais žurnaluose matome skirtingų užduočių konteinerius
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-204553539Išsamesnis žurnalas
$ 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-204553539Visos užduotys sėkmingai įvykdytos
Užduočių artefaktuose yra paslaugų ir bandymų žurnalai
Viskas lyg ir gražu, bet yra niuansas. Vamzdynas gali būti priverstinai atšauktas, kol vykdomi integravimo bandymai. Tokiu atveju veikiantys konteineriai nebus sustabdyti. Kartkartėmis reikia nuvalyti bėgiką. Deja, „GitLab CE“ tobulinimo užduotis vis dar vykdoma
Bet mes įtraukėme užduoties paleidimą pagal grafiką ir niekas nedraudžia mums jos vykdyti rankiniu būdu.
Eikite į mūsų projektą -> CI/CD -> Tvarkaraščiai ir paleiskite užduotį Clean runner
Iš viso:
- Mes turime vieną apvalkalo bėgiką.
- Nekyla konfliktų tarp užduočių ir aplinkos.
- Lygiagrečiai vykdome užduotis su integravimo testais.
- Integravimo testus galite vykdyti vietoje arba konteineryje.
- Surenkami aptarnavimo ir bandymų žurnalai ir pridedami prie dujotiekio užduoties.
- Galima išvalyti bėgiką nuo senų „Docker“ vaizdų.
Nustatymo laikas ~2 val.
Tai viskas, iš tikrųjų. Man bus malonu gauti atsiliepimų.
Šaltinis: www.habr.com