Оваа статија ќе биде од интерес и за тестерите и за програмерите, но е наменета главно за специјалисти за автоматизација кои се соочуваат со проблемот на поставување на GitLab CI/CD за тестирање на интеграција во услови на недоволни инфраструктурни ресурси и/или отсуство на контејнер платформа за оркестрација. Ќе ви кажам како да го поставите распоредувањето на околините за тестирање со користење на докер компонирање на еден единечен GitLab школка и така што при распоредување на неколку околини, стартуваните услуги не се мешаат едни со други.
содржина
Позадина
-
Во мојата пракса, често се случуваше тестирањето за интеграција да се „третира“ на проекти. И често првиот и најзначаен проблем е CI гасоводот, во кој се тестира интеграцијата се развива услуга(и) се врши во средина на dev/stage. Ова предизвика доста проблеми:
- Поради дефекти во одредена услуга за време на интеграциското тестирање, колото за тестирање може да се оштети од скршени податоци. Имаше случаи кога испраќањето барање со скршен JSON формат ја урна услугата, што го направи штандот целосно нефункционален.
- Забавување на тест колото како што се зголемуваат податоците од тестот. Мислам дека нема смисла да се опишува пример со чистење/враќање на базата на податоци. Во мојата пракса не сум сретнал проект каде што оваа процедура се одвивала без проблеми.
- Ризик од нарушување на функционалноста на тест колото при тестирање на општите системски поставки. На пример, политика на корисник/група/лозинка/апликација.
- Податоците од тестовите од автоматизираните тестови го отежнуваат животот на рачните тестери.
Некои ќе речат дека добрите автотестови треба да ги исчистат податоците по себе. Имам аргументи против:
- Динамичните држачи се многу погодни за употреба.
- Не може секој објект да се отстрани од системот преку API. На пример, повикот за бришење објект не беше имплементиран бидејќи е во спротивност со деловната логика.
- Кога креирате објект преку API, може да се создаде огромна количина на метаподатоци, што е проблематично да се избрише.
- Ако тестовите имаат зависност меѓу себе, тогаш процесот на чистење на податоците по извршувањето на тестовите се претвора во главоболка.
- Дополнителни (и, според мое мислење, неоправдани) повици до API.
- И главниот аргумент: кога податоците од тестот ќе почнат да се бришат директно од базата на податоци. Ова се претвора во вистински ПК/ФК циркус! Слушаме од програмерите: „Само што додадов/отстранав/преименував знак, зошто беа фатени 100500 тестови за интеграција?“
Според мене, најоптимално решение е динамичното опкружување.
- Многу луѓе користат docker-compose за извршување на средина за тестирање, но малку луѓе користат docker-compose кога спроведуваат тестирање за интеграција во CI/CD. И тука не ги земам предвид кубернетите, ројот и другите платформи за оркестрација на контејнери. Не секоја компанија ги има. Би било убаво 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 и да ги убие нашите задачи поради недостаток на RAM меморија. Ова може да се случи кога повеќе од 5 задачи се активираат истовремено. Задачите ќе напредуваат побавно, но стабилно.
Пример со OOM убиец
Ако видите во дневниците за задачи
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-тркач.
-
Отвори за уредување
/etc/gitlab-runner/config.tomlи додадетеconcurrent=20 [[runners]] request_concurrency = 10Ова ќе ви овозможи да извршувате паралелни задачи на еден тркач. Прочитај повеќе .
Ако имате помоќна машина, на пример 8 vCPU, 16 GB RAM, тогаш овие бројки може да се направат најмалку 2 пати поголеми. Но, се зависи од тоа што точно ќе биде лансиран на овој тркач и во која количина.
Тоа е доволно.
Подготовка docker-compose.yml
Главната задача е универзален docker-compose.yml, кој програмерите/тестерите можат да го користат и локално и во CI гасоводот.
Прво, правиме уникатни имиња на услуги за 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 бидејќи е многу погодно и за управување со локалното опкружување и за 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
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
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Како резултат на извршување на таква задача, директориумот за дневници во артефактите ќе содржи дневници за услуги и тестови. Што е многу погодно во случај на грешки. Секој тест паралелно пишува свој дневник, но јас ќе зборувам за ова посебно.
Чистење на тркачот
Задачата ќе биде лансирана само според распоред.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanСледно, одете на нашиот проект GitLab -> CI/CD -> Распореди -> Нов распоред и додајте нов распоред
Резултира
Стартување на 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Сите задачи се успешно завршени
Артефактите на задачите содржат дневници за услуги и тестови
Се чини дека се е убаво, но има една нијанса. Цевководот може да биде принудно откажан додека се извршуваат тестовите за интеграција, во тој случај контејнерите што работат нема да бидат запрени. Од време на време треба да го исчистите тркачот. За жал, задачата за подобрување во GitLab CE сè уште е во статус
Но, додадовме стартување на задача според распоред и никој не ни забранува да ја извршуваме рачно.
Одете во нашиот проект -> CI/CD -> Распореди и извршете ја задачата Clean runner
Вкупно:
- Имаме еден тркач на школка.
- Нема конфликти помеѓу задачите и околината.
- Паралелно извршуваме задачи со тестови за интеграција.
- Можете да извршите тестови за интеграција или локално или во контејнер.
- Дневниците за сервисирање и тестирање се собираат и се прикачуваат на задачата за гасоводот.
- Можно е да се исчисти тркачот од старите слики на Docker.
Времето на поставување е ~ 2 часа.
Тоа е се, всушност. Ќе ми биде драго да добијам повратни информации.
Извор: www.habr.com