Šis raksts būs interesants gan testētājiem, gan izstrādātājiem, taču paredzēts galvenokārt automatizācijas speciālistiem, kuri saskaras ar GitLab CI/CD iestatīšanas problēmu integrācijas testēšanai nepietiekamu infrastruktūras resursu un/vai konteinera trūkuma apstākļos. orķestrēšanas platforma. Es jums pastāstīšu, kā iestatīt testa vidi izvietošanu, izmantojot docker compose vienā GitLab čaulas palaidējā un lai, izvietojot vairākas vides, palaistie pakalpojumi netraucētu viens otram.
saturs
Priekšnoteikumi
-
Manā praksē bieži gadījās, ka integrācijas testēšana tika “apstrādāta” projektiem. Un bieži vien pirmā un nozīmīgākā problēma ir CI cauruļvads, kurā tiek veikta integrācijas pārbaude tiek izstrādāts pakalpojums(-i) tiek nodrošināts(-i) izstrādātāja/posma vidē. Tas radīja vairākas problēmas:
- Konkrēta pakalpojuma defektu dēļ integrācijas testēšanas laikā testa ķēde var tikt bojāta bojātu datu dēļ. Bija gadījumi, kad, nosūtot pieprasījumu ar bojātu JSON formātu, serviss avarēja, kā rezultātā statīvs kļuva pilnībā nederīgs.
- Testa ķēdes palēnināšanās, palielinoties testa datiem. Es domāju, ka nav jēgas aprakstīt piemēru ar datu bāzes tīrīšanu/atgriešanu. Savā praksē neesmu saskāries ar projektu, kurā šī procedūra noritētu gludi.
- Pārbaudot vispārējos sistēmas iestatījumus, pastāv pārbaudes ķēdes darbības traucējumu risks. Piemēram, lietotāja/grupas/paroles/lietojumprogrammas politika.
- Testa dati no automatizētiem testiem apgrūtina manuālo testētāju dzīvi.
Daži teiks, ka labiem automātiskajiem testiem vajadzētu iztīrīt datus pēc sevis. Man ir argumenti pret:
- Dinamiskie statīvi ir ļoti ērti lietošanā.
- Ne katru objektu var noņemt no sistēmas, izmantojot API. Piemēram, aicinājums dzēst objektu netika īstenots, jo tas ir pretrunā ar biznesa loģiku.
- Veidojot objektu, izmantojot API, var izveidot milzīgu daudzumu metadatu, kuru dzēšana ir problemātiska.
- Ja testiem ir savstarpēja atkarība, tad datu tīrīšanas process pēc testu veikšanas pārvēršas par galvassāpēm.
- Papildu (un, manuprāt, nepamatoti) izsaukumi uz API.
- Un galvenais arguments: kad testa datus sāk dzēst tieši no datu bāzes. Šis pārvēršas par īstu PK/FK cirku! Mēs dzirdam no izstrādātājiem: “Es tikko pievienoju/noņēmu/pārdēvēju zīmi, kāpēc tika pieķerti 100500 XNUMX integrācijas testi?”
Manuprāt, optimālākais risinājums ir dinamiska vide.
- Daudzi cilvēki izmanto docker-compose, lai palaistu testa vidi, bet daži cilvēki izmanto docker-compose, veicot integrācijas testēšanu CI/CD. Un šeit es neņemu vērā kubernetes, spietu un citas konteineru orķestrēšanas platformas. Ne katram uzņēmumam tie ir. Būtu jauki, ja docker-compose.yml būtu universāls.
- Pat ja mums ir savs kvalitātes nodrošināšanas skrējējs, kā mēs varam nodrošināt, ka pakalpojumi, kas tiek palaisti, izmantojot docker-compose, netraucē viens otram?
- Kā apkopot pārbaudīto pakalpojumu žurnālus?
- Kā notīrīt skrējēju?
Man ir savs GitLab skrējējs saviem projektiem, un izstrādes laikā es saskāros ar šiem jautājumiem par . Precīzāk, veicot integrācijas testus. Tālāk mēs atrisināsim šīs problēmas, izmantojot šī projekta piemērus.
GitLab Shell Runner
Skrējējam iesaku Linux virtuālo mašīnu ar 4 vCPU, 4 GB RAM, 50 GB HDD.
Internetā ir daudz informācijas par gitlab-runner iestatīšanu, tāpēc īsumā:
- Piesakieties mašīnā, izmantojot SSH
-
Ja jums ir mazāk nekā 8 GB RAM, tad iesaku lai OOM slepkava nenāk un nenogalina mūsu uzdevumus RAM trūkuma dēļ. Tas var notikt, ja vienlaikus tiek palaisti vairāk nekā 5 uzdevumi. Uzdevumi virzīsies lēnāk, bet vienmērīgi.
Piemērs ar OOM killer
Ja uzdevumu žurnālos redzat
bash: line 82: 26474 Killed, tad vienkārši izpildiet skrējējusudo 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:0kBUn, ja attēls izskatās kaut kas līdzīgs šim, tad pievienojiet mijmaiņu vai pievienojiet RAM.
- Komplekts , , , veidot.
- Lietotāja pievienošana
gitlab-runneruz grupudockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab-runner.
-
Atvērts rediģēšanai
/etc/gitlab-runner/config.tomlun pievienotconcurrent=20 [[runners]] request_concurrency = 10Tas ļaus jums veikt paralēlus uzdevumus vienam skrējējam. Lasīt vairāk .
Ja jums ir jaudīgāka mašīna, piemēram, 8 vCPU, 16 GB RAM, tad šos skaitļus var palielināt vismaz 2 reizes. Bet viss ir atkarīgs no tā, kas tieši tiks palaists uz šī skrējēja un kādā daudzumā.
Tas ir pietiekami.
Notiek docker-compose.yml sagatavošana
Galvenais uzdevums ir universāls docker-compose.yml, kuru izstrādātāji/testētāji var izmantot gan lokāli, gan CI konveijerā.
Pirmkārt, mēs izveidojam unikālus pakalpojumu nosaukumus CI. Viens no unikālajiem GitLab CI mainīgajiem ir mainīgais CI_JOB_ID. Ja norādāt container_name ar nozīmi "service-${CI_JOB_ID:-local}", tad šādā gadījumā:
- ja
CI_JOB_IDnav definēts vides mainīgajos,
tad pakalpojuma nosaukums būsservice-local - ja
CI_JOB_IDdefinēti vides mainīgajos (piemēram, 123),
tad pakalpojuma nosaukums būsservice-123
Otrkārt, mēs izveidojam kopīgu tīklu uzsāktajiem pakalpojumiem. Tas nodrošina tīkla līmeņa izolāciju, palaižot vairākas testa vides.
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}Patiesībā šis ir pirmais solis uz panākumiem =)
Mana docker-compose.yml piemērs ar komentāriem
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:
- defaultVietējās palaišanas piemērs
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 ... doneBet ne viss ir tik vienkārši ar palaišanu CI.
Makefile sagatavošana
Es izmantoju Makefile, jo tas ir ļoti ērti gan lokālās vides pārvaldībai, gan CI. Vairāk tiešsaistes komentāru
# У меня в проектах все вспомогательные вещи лежат в директории `.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
Pārbaude
veikt doku-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
veikt docker-baļķus
$ 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
Notiek .gitlab-ci.yml sagatavošana
Integrācijas testu izpilde
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 daysŠāda uzdevuma izpildes rezultātā artefaktu žurnālu direktorijā būs pakalpojumu un pārbaudes žurnāli. Kas ir ļoti ērti kļūdu gadījumā. Katrs tests paralēli raksta savu žurnālu, bet par to es runāšu atsevišķi.
Skrējēja tīrīšana
Uzdevums tiks uzsākts tikai saskaņā ar grafiku.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanPēc tam dodieties uz mūsu GitLab projektu -> CI/CD -> Grafiki -> Jauns grafiks un pievienojiet jaunu grafiku
Piedzīvojiet efektīvu rezultātu spēku
4 uzdevumu palaišana GitLab CI
Pēdējā uzdevuma žurnālos ar integrācijas testiem mēs redzam konteinerus no dažādiem uzdevumiem
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-204553539Detalizētāks žurnāls
$ 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-204553539Visi uzdevumi veiksmīgi izpildīti
Uzdevumu artefakti satur pakalpojumu un pārbaudes žurnālus
Viss it kā ir skaisti, bet ir kāda nianse. Cauruļvadu var piespiedu kārtā atcelt, kamēr notiek integrācijas testi, un tādā gadījumā konteineru darbība netiks apturēta. Ik pa laikam vajag notīrīt skrējēju. Diemžēl GitLab CE uzlabošanas uzdevums joprojām ir statusā
Bet mēs esam pievienojuši uzdevuma palaišanu saskaņā ar grafiku, un neviens mums neaizliedz to palaist manuāli.
Dodieties uz mūsu projektu -> CI/CD -> Grafiki un palaidiet uzdevumu Clean runner
Kopā:
- Mums ir viens čaulas skrējējs.
- Nav konfliktu starp uzdevumiem un vidi.
- Paralēli veicam uzdevumus ar integrācijas testiem.
- Integrācijas testus var palaist lokāli vai konteinerā.
- Servisa un pārbaudes žurnāli tiek apkopoti un pievienoti cauruļvada uzdevumam.
- Ir iespējams attīrīt skrējēju no veciem Docker attēliem.
Uzstādīšanas laiks ir ~2 stundas.
Tas arī viss, patiesībā. Priecāšos saņemt atsauksmes.
Avots: www.habr.com