Овај чланак ће бити од интереса и за тестере и за програмере, али је углавном намењен стручњацима за аутоматизацију који се суочавају са проблемом подешавања ГитЛаб ЦИ/ЦД-а за тестирање интеграције у условима недовољних инфраструктурних ресурса и/или одсуства оркестрације контејнера. платформа. Рећи ћу вам како да подесите примену пробних окружења користећи доцкер цомпосе на једном ГитЛаб схелл руннер-у и тако да приликом постављања неколико окружења покренуте услуге не ометају једна другу.
Садржина
Предпосылки
-
У мојој пракси се често дешавало да се интеграционо тестирање „третира“ на пројектима. И често је први и најзначајнији проблем ЦИ цевовод, у којем се врши тестирање интеграције развија услуга(е) се изводе у дев/стаге окружењу. Ово је изазвало доста проблема:
- Због кварова у одређеној услузи током интеграционог тестирања, тестно коло може бити оштећено неисправним подацима. Било је случајева када је слање захтева са поквареним ЈСОН форматом срушило услугу, због чега је постоље постало потпуно нефункционално.
- Успоравање тестног кола како се подаци теста повећавају. Мислим да нема смисла описивати пример са чишћењем/повратком базе података. У својој пракси нисам се сусрео са пројектом где је овај поступак прошао глатко.
- Ризик од ометања функционалности тестног кола приликом тестирања општих поставки система. На пример, политика корисника/групе/лозинке/апликације.
- Подаци о тестовима из аутоматизованих тестова отежавају живот ручним тестерима.
Неки ће рећи да би добри аутотестови требали очистити податке за собом. Имам аргументе против:
- Динамичка постоља су веома згодна за употребу.
- Не може се сваки објекат уклонити из система преко АПИ-ја. На пример, позив за брисање објекта није имплементиран јер је у супротности са пословном логиком.
- Приликом креирања објекта преко АПИ-ја може се створити огромна количина метаподатака, које је проблематично избрисати.
- Ако тестови имају зависности међу собом, онда се процес чишћења података након покретања тестова претвара у главобољу.
- Додатни (и, по мом мишљењу, неоправдани) позиви АПИ-ју.
- И главни аргумент: када тестни подаци почну да се бришу директно из базе података. Ово се претвара у прави ПК/ФК циркус! Од програмера чујемо: „Управо сам додао/уклонио/преименовао знак, зашто је 100500 интеграцијских тестова ухваћено?”
По мом мишљењу, најоптималније решење је динамично окружење.
- Многи људи користе доцкер-цомпосе за покретање тестног окружења, али мало људи користи доцкер-цомпосе када спроводи тестирање интеграције у ЦИ/ЦД. И овде не узимам у обзир кубернете, рој и друге платформе за оркестрацију контејнера. Нема их свака компанија. Било би лепо када би доцкер-цомпосе.имл био универзалан.
- Чак и ако имамо сопствени КА руннер, како можемо да осигурамо да услуге покренуте преко доцкер-цомпосе не ометају једна другу?
- Како прикупити дневнике тестираних услуга?
- Како очистити тркач?
Имам свој ГитЛаб тркач за своје пројекте и наишао сам на ова питања током развоја за . Тачније, приликом покретања интеграцијских тестова. У наставку ћемо решити ова питања користећи примере из овог пројекта.
ГитЛаб Схелл Руннер
За тркаче, препоручујем Линук виртуелну машину са 4 вЦПУ, 4 ГБ РАМ-а, 50 ГБ ХДД.
Постоји много информација о постављању гитлаб-руннер-а на Интернету, па укратко:
- Пријавите се на машину преко ССХ
-
Ако имате мање од 8 ГБ РАМ-а, препоручујем тако да убица ООМ-а не дође и убије наше задатке због недостатка РАМ-а. Ово се може десити када се истовремено покрене више од 5 задатака. Задаци ће напредовати спорије, али стабилније.
Пример са ООМ убицом
Ако видите у евиденцији задатака
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А ако слика изгледа отприлике овако, онда или додајте свап или додајте РАМ.
- Сет , , , направити.
- Додавање корисника
gitlab-runnerгрупиdockersudo groupadd docker sudo usermod -aG docker gitlab-runner - гитлаб-руннер.
-
Отворите за уређивање
/etc/gitlab-runner/config.tomlи додатиconcurrent=20 [[runners]] request_concurrency = 10Ово ће вам омогућити да покренете паралелне задатке на једном тркачу. Опширније .
Ако имате моћнију машину, на пример 8 вЦПУ, 16 ГБ РАМ-а, онда се ови бројеви могу повећати најмање 2 пута. Али све зависи од тога шта ће тачно бити лансирано на овом тркачу и у којој количини.
То је довољно.
Припрема доцкер-цомпосе.имл
Главни задатак је универзални доцкер-цомпосе.имл, који програмери/тестери могу користити и локално и у ЦИ цевоводу.
Пре свега, правимо јединствена имена услуга за ЦИ. Једна од јединствених променљивих у ГитЛаб ЦИ је променљива 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}Заправо, ово је први корак ка успеху =)
Пример мог доцкер-цомпосе.имл са коментарима
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Али није све тако једноставно са покретањем у ЦИ.
Припрема Макефиле-а
Користим Макефиле јер је веома згодан и за локално управљање окружењем и за ЦИ. Више коментара на мрежи
# У меня в проектах все вспомогательные вещи лежат в директории `.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
Припрема .гитлаб-ци.имл
Покретање интеграцијских тестова
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Затим идите на наш ГитЛаб пројекат -> ЦИ/ЦД -> Распоред -> Нови распоред и додајте нови распоред
Резултат
Покретање 4 задатка у ГитЛаб ЦИ
У евиденцији последњег задатка са интеграцијским тестовима видимо контејнере из различитих задатака
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Сви задаци успешно завршени
Артефакти задатака садрже дневнике услуга и тестова
Чини се да је све лепо, али постоји нијанса. Цевовод се може принудно отказати док се изводе интеграциони тестови, у ком случају радни контејнери неће бити заустављени. С времена на време морате очистити тркач. Нажалост, задатак за побољшање ГитЛаб ЦЕ је још увек у статусу
Али ми смо додали покретање задатка по распореду и нико нам не забрањује да га покрећемо ручно.
Идите на наш пројекат -> ЦИ/ЦД -> Распореди и покрените задатак Clean runner
Укупно:
- Имамо једну шкољку.
- Не постоје сукоби између задатака и окружења.
- Паралелно покрећемо задатке са интеграцијским тестовима.
- Можете покренути интеграцијске тестове локално или у контејнеру.
- Дневници сервиса и тестирања се прикупљају и прилажу задатку цевовода.
- Могуће је очистити тркач од старих Доцкер слика.
Време подешавања је ~2 сата.
То је све, у ствари. Биће ми драго да добијем повратне информације.
Извор: ввв.хабр.цом