Ця стаття буде цікава як тестувальникам, так і розробникам, але більшою мірою розрахована на автоматизаторів, які зіткнулися з проблемою налаштування GitLab CI/CD для проведення інтеграційного тестування в умовах недостатності інфраструктурних ресурсів та/або відсутності платформи оркестрації контейнерів. Я розповім, як налаштувати розгортання тестованих оточень за допомогою docker compose на одному єдиному GitLab shell раннері і так, щоб при розгортанні кількох оточень сервіси, що запускаються, один одному не заважали.
Зміст
передумови
-
У моїй практиці часто траплялося «лікувати» інтеграційне тестування на проектах. І найчастіше першою та найзначнішою проблемою є CI pipeline, у якому інтеграційне тестування розроблюваного сервіс(ів) проводиться в оточенні dev/stage. Це викликало чимало проблем:
- Через дефекти у тому чи іншому сервісі у процесі інтеграційного тестування тестовий контур може бути зіпсований битими даними. Траплялися випадки, коли відправка запиту з побитим JSON-форматом вішав сервіс, що приводило стенд повністю в неробочий стан.
- Уповільнення роботи тестового контуру зі зростанням тестових даних. Думаю, описувати приклад із очищенням/відкатом БД не має сенсу. У своїй практиці я не зустрічав проекту, де б ця процедура проходила гладко.
- Ризик порушити працездатність тестового контуру під час тестування загальних налаштувань системи. Наприклад, user/group/password/application policy.
- Тестові дані автотестів заважають жити ручним тестувальникам.
Хтось скаже, що хороші автотести мають чистити дані після себе. У мене є аргументи проти:
- Динамічні стенди дуже зручні у використанні.
- Не кожен об'єкт можна видалити із системи через API. Наприклад, виклик на видалення об'єкта не реалізований, оскільки суперечить бізнес логіці.
- При створенні об'єкта через API може створюватися безліч метаданих, які видалити проблематично.
- Якщо тести мають залежність між собою, процес очищення даних після виконання тестів перетворюється на головний біль.
- Додаткові (і, як на мене, не виправдані) виклики до API.
- І головний аргумент: коли тестові дані починають чистити прямо із БД. Це перетворюється на справжній PK/FK цирк! Від розробників чути: "Я тільки табличку додав/видалив/перейменував, чому 100500 інтеграційних тестів потрапляло?"
На мою думку, найоптимальніше рішення — динамічне оточення.
- Багато хто використовує docker-compose для запуску тестового оточення, але мало хто використовує docker-compose під час проведення інтеграційного тестування CI/CD. І тут я не беру до уваги kubernetes, swarm та інші платформи оркестрації контейнерів. Не у кожній компанії вони є. Добре було б, якби docker-compose.yml був універсальний.
- Якщо навіть у нас є свій QA раннер, як нам зробити так, щоб сервіси, що запускаються через docker-compose, не заважали один одному?
- Як збирати логи сервісів, що тестуються?
- Як чистити раннер?
У мене є власний раннер GitLab для своїх проектів і з цими питаннями я зіткнувся при розробці для . А точніше під час запуску інтеграційних тестів. Ось далі і вирішуватимемо ці питання з прикладами з цього проекту.
GitLab Shell Runner
Для раннера рекомендую лінуксову віртуалку із 4 vCPU, 4 GB RAM, 50 GB HDD.
На просторах інтернету дуже багато інформації з налаштування gitlab-runner, тому коротко:
- Заходимо на машинку по SSH
-
Якщо у вас менше 8 GB RAM, то рекомендую щоб не приходив OOM killer і не вбивав нам завдання через брак RAM. Таке може статися, коли одночасно запускається більше 5 завдань. Завдання проходитимуть повільніше, проте стабільно.
Приклад з OOM killer
Якщо у логах завдання ви побачите
bash: line 82: 26474 Killed, то просто виконайте на раннеріsudo 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:0kBІ якщо картина виглядає приблизно так, то або додавайте swap, або докидайте RAM.
- Встановлюємо , , , зробити.
- Додаємо користувача
gitlab-runnerв групуdockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab-runner.
-
Відкриваємо на редагування
/etc/gitlab-runner/config.tomlі додаємоconcurrent=20 [[runners]] request_concurrency = 10Це дозволить запускати паралельні завдання на одному раннері. Детальніше читати .
Якщо у вас машинка потужніша, наприклад 8 vCPU, 16 GB RAM, то ці цифри можна зробити як мінімум у 2 рази більше. Але все залежить від того, що конкретно запускатиметься на даному раннері і в якій кількості.
Цього достатньо.
Підготовка docker-compose.yml
Основне завдання – це універсальний docker-compose.yml, який розробники/тестувальники можуть використовувати як локально, так і в CI pipeline.
Насамперед ми робимо унікальні назви сервісів для CI. Однією з унікальних змінних у GitLab CI є змінна CI_JOB_ID. Якщо вказати container_name зі значенням "service-${CI_JOB_ID:-local}", то у випадку:
- якщо
CI_JOB_IDне визначено в змінних оточення,
то ім'я сервісу будеservice-local - якщо
CI_JOB_IDвизначена в змінних оточення (наприклад, 123),
то ім'я сервісу будеservice-123
У другу чергу ми робимо спільну мережу для сервісів, що запускаються. Це дає нам ізоляцію на рівні мережі під час запуску кількох тестових оточень.
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}Власне, це перший крок до успіху.
Приклад мого docker-compose.yml з коментарями
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:
- defaultПриклад локального запуску
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 ... doneАле не все так просто із запуском у CI.
Підготовка Makefile
Я використовую Makefile, тому що це дуже зручно як для локального управління оточенням, так і в CI. Далі коментарі інлайн
# У меня в проектах все вспомогательные вещи лежат в директории `.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
перевіряємо
make 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
make 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
Підготовка .gitlab-ci.yml
Запуск інтеграційних тестів
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В результаті запуску такого завдання в артефактах директорія logs міститиме логи сервісів та тестів. Що дуже зручно у разі виникнення помилок. У мене кожен тест у паралелі пише свій лог, але про це я розповім окремо.
Очищення раннера
Завдання запускатиметься лише за розкладом.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanДалі йдемо в наш GitLab проект -> CI/CD -> Schedules -> New Schedule та додаємо новий розклад
Результат
Запускаємо 4 завдання у GitLab CI
У логах останнього завдання з інтеграційними тестами бачимо контейнери від різних завдань
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-204553539Більш детальний лог
$ 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-204553539Усі завдання успішно завершено
Артефакти завдання містять логі сервісів та тестів
Начебто все за красою, але є нюанс. Pipeline може бути примусово скасовано під час виконання інтеграційних тестів, і в цьому випадку запущені контейнери не буде зупинено. Іноді потрібно чистити раннер. На жаль, завдання на доопрацювання у GitLab CE все ще у статусі
Але у нас додано запуск завдання за розкладом, і ніхто нам не забороняє його запустити вручну.
Переходимо в наш проект -> CI/CD -> Schedules та запускаємо завдання Clean runner
Разом:
- У нас є один shell runner.
- Конфліктів між завданнями та оточенням немає.
- Ми маємо паралельний запуск завдань з інтеграційними тестами.
- Можна запускати інтеграційні тести як локально, і у контейнері.
- Логи сервісів та тестів збираються та прикріплюються до pipeline-завдання.
- Є можливість очищення раннера від старих образів docker.
Час налаштування – ~2 години.
Ось, власне, і все. Радий фідбеку.
Джерело: habr.com