Ta članek bo zanimiv tako za preizkuševalce kot za razvijalce, namenjen pa je predvsem strokovnjakom za avtomatizacijo, ki se soočajo s problemom nastavitve GitLab CI/CD za integracijsko testiranje v pogojih nezadostnih infrastrukturnih virov in/ali odsotnosti vsebnika. orkestracijsko platformo. Povedal vam bom, kako nastaviti uvajanje testnih okolij z uporabo docker compose na enem samem izvajalcu lupine GitLab in tako, da pri uvajanju več okolij zagnane storitve ne motijo druga druge.
Vsebina
Ozadje
-
V moji praksi se je pogosto dogajalo, da je bilo integracijsko testiranje »obdelano« na projektih. In pogosto je prva in najpomembnejša težava cevovod CI, v katerem poteka integracijsko testiranje se razvijajo storitev(-e) se izvaja(-jo) v okolju razvijalca/stopnje. To je povzročilo kar nekaj težav:
- Zaradi napak v določeni storitvi med testiranjem integracije se lahko testno vezje poškoduje zaradi pokvarjenih podatkov. Bilo je primerov, ko je pošiljanje zahteve s pokvarjenim formatom JSON povzročilo zrušitev storitve, zaradi česar je stojalo popolnoma neuporabno.
- Upočasnitev preskusnega vezja, ko se testni podatki povečajo. Mislim, da nima smisla opisovati primera s čiščenjem/vračanjem baze podatkov. V svoji praksi se še nisem srečal s projektom, kjer bi ta postopek potekal gladko.
- Nevarnost motenj v delovanju preskusnega vezja pri testiranju splošnih sistemskih nastavitev. Na primer pravilnik o uporabniku/skupini/geslu/aplikaciji.
- Testni podatki iz avtomatiziranih testov otežijo življenje ročnim preizkuševalcem.
Nekateri bodo rekli, da bi morali dobri samodejni testi počistiti podatke za seboj. Imam argumente proti:
- Dinamična stojala so zelo priročna za uporabo.
- Vsakega predmeta ni mogoče odstraniti iz sistema prek API-ja. Na primer, klic za brisanje predmeta ni bil implementiran, ker je v nasprotju s poslovno logiko.
- Pri ustvarjanju objekta preko API-ja lahko nastane ogromno metapodatkov, ki jih je problematično izbrisati.
- Če imajo testi medsebojne odvisnosti, se postopek čiščenja podatkov po izvajanju testov spremeni v glavobol.
- Dodatni (in po mojem mnenju neupravičeni) klici API-ju.
- In glavni argument: ko se testni podatki začnejo čistiti neposredno iz baze podatkov. To se spreminja v pravi PK/FK cirkus! Od razvijalcev slišimo: "Pravkar sem dodal/odstranil/preimenoval znak, zakaj je bilo ujetih 100500 integracijskih testov?"
Po mojem mnenju je najbolj optimalna rešitev dinamično okolje.
- Veliko ljudi uporablja docker-compose za zagon testnega okolja, vendar le malo ljudi uporablja docker-compose pri izvajanju testiranja integracije v CI/CD. In tukaj ne upoštevam kubernetes, swarm in druge platforme za orkestracijo vsebnikov. Nima jih vsako podjetje. Lepo bi bilo, če bi bil docker-compose.yml univerzalen.
- Kako lahko zagotovimo, da storitve, zagnane prek docker-compose, ne motijo druga druge, tudi če imamo lastnega tekača za zagotavljanje kakovosti?
- Kako zbrati dnevnike testiranih storitev?
- Kako očistiti tekač?
Za svoje projekte imam lastnega izvajalca GitLab in med razvojem sem naletel na ta vprašanja za . Natančneje, pri izvajanju integracijskih testov. Spodaj bomo te težave rešili s primeri iz tega projekta.
GitLab Shell Runner
Za tekače priporočam virtualni stroj Linux s 4 vCPU, 4 GB RAM-a, 50 GB HDD.
Na internetu je veliko informacij o nastavitvi gitlab-runnerja, zato na kratko:
- Prijavite se v stroj prek SSH
-
Če imate manj kot 8 GB RAM-a, priporočam tako da ubijalec OOM ne pride in uniči naših nalog zaradi pomanjkanja RAM-a. To se lahko zgodi, ko se hkrati zažene več kot 5 nalog. Naloge bodo napredovale počasneje, a vztrajno.
Primer z morilcem OOM
Če vidite v dnevnikih opravil
bash: line 82: 26474 Killed, nato samo izvedite na tekač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:0kBIn če slika izgleda nekako takole, potem ali dodajte swap ali dodajte RAM.
- Set , , , naredite.
- Dodajanje uporabnika
gitlab-runnerv skupinodockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab-runner.
-
Odprto za urejanje
/etc/gitlab-runner/config.tomlin dodajteconcurrent=20 [[runners]] request_concurrency = 10To vam bo omogočilo izvajanje vzporednih nalog na enem tekaču. Preberi več .
Če imate zmogljivejši stroj, na primer 8 vCPU, 16 GB RAM-a, potem lahko te številke povečate vsaj 2-krat. Vse pa je odvisno od tega, kaj točno bo lansirano na tem tekaču in v kakšni količini.
To je dovolj.
Priprava docker-compose.yml
Glavna naloga je univerzalni docker-compose.yml, ki ga lahko razvijalci/preizkuševalci uporabljajo tako lokalno kot v cevovodu CI.
Najprej naredimo edinstvena imena storitev za CI. Ena izmed edinstvenih spremenljivk v GitLab CI je spremenljivka CI_JOB_ID. Če navedete container_name s pomenom "service-${CI_JOB_ID:-local}", potem v primeru:
- če
CI_JOB_IDni definirano v spremenljivkah okolja,
potem bo ime storitveservice-local - če
CI_JOB_IDdefinirano v spremenljivkah okolja (na primer 123),
potem bo ime storitveservice-123
Drugič, ustvarimo skupno omrežje za lansirane storitve. To nam omogoča izolacijo na ravni omrežja pri izvajanju več testnih okolij.
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}Pravzaprav je to prvi korak do uspeha =)
Primer mojega docker-compose.yml s komentarji
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:
- defaultPrimer lokalnega teka
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 ... doneVendar z zagonom v CI ni vse tako preprosto.
Priprava datoteke Makefile
Uporabljam Makefile, ker je zelo priročen tako za upravljanje lokalnega okolja kot v CI. Več spletnih komentarjev
# У меня в проектах все вспомогательные вещи лежат в директории `.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
Preverite
narediti 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
naredite 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
Priprava .gitlab-ci.yml
Izvajanje integracijskih testov
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 daysKot rezultat izvajanja takšne naloge bo imenik dnevnikov v artefaktih vseboval servisne in testne dnevnike. Kar je zelo priročno v primeru napak. Vsak test vzporedno piše svoj dnevnik, a o tem bom govoril posebej.
Čiščenje tekača
Naloga bo zagnana le po urniku.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanNato pojdite na naš projekt GitLab -> CI/CD -> Urniki -> Nov razpored in dodajte nov razpored
Rezultat
Zagon 4 nalog v GitLab CI
V dnevnikih zadnje naloge z integracijskimi testi vidimo vsebnike iz različnih nalog
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-204553539Podrobnejši 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-204553539Vse naloge uspešno opravljene
Artefakti opravil vsebujejo dnevnike storitev in preskusov
Zdi se, da je vse lepo, vendar obstaja odtenek. Cevovod je mogoče na silo prekiniti, medtem ko se izvajajo integracijski testi, v tem primeru tekoči vsebniki ne bodo ustavljeni. Od časa do časa morate očistiti tekač. Na žalost je naloga za izboljšanje v GitLab CE še vedno v statusu
Dodali pa smo zagon opravila po urniku in nihče nam ne prepoveduje, da ga zaženemo ročno.
Pojdite na naš projekt -> CI/CD -> Urniki in zaženite opravilo Clean runner
Skupaj:
- Imamo enega tekača školjk.
- Ni konfliktov med nalogami in okoljem.
- Vzporedno izvajamo naloge z integracijskimi testi.
- Integracijske teste lahko izvajate lokalno ali v vsebniku.
- Servisni in preskusni dnevniki so zbrani in priloženi nalogi cevovoda.
- Tekač je mogoče očistiti iz starih slik Docker.
Čas nastavitve je ~2 uri.
To je pravzaprav vse. Vesel bom povratnih informacij.
Vir: www.habr.com