Artykuł ten zainteresuje zarówno testerów, jak i programistów, jednak przeznaczony jest głównie dla specjalistów od automatyzacji, którzy stoją przed problemem skonfigurowania GitLab CI/CD do testów integracyjnych w warunkach niewystarczających zasobów infrastruktury i/lub braku kontenera platforma orkiestracyjna. Opowiem Ci jak skonfigurować wdrożenie środowisk testowych za pomocą docker compose na jednym pojedynczym launcherze powłoki GitLab, tak aby przy wdrażaniu kilku środowisk uruchamiane usługi nie kolidowały ze sobą.
Zawartość
Wymagania wstępne
-
W mojej praktyce często zdarzało się, że na projektach „traktowano” testy integracyjne. Często pierwszym i najbardziej znaczącym problemem jest rurociąg CI, w którym przeprowadzane są testy integracyjne w trakcie opracowywania usługi są realizowane w środowisku deweloperskim/etapowym. Powodowało to sporo problemów:
- Z powodu defektów konkretnej usługi podczas testów integracyjnych, obwód testowy może zostać uszkodzony w wyniku uszkodzonych danych. Zdarzały się przypadki, gdy wysłanie żądania z uszkodzonym formatem JSON powodowało awarię usługi, przez co stanowisko całkowicie przestało działać.
- Spowolnienie obwodu testowego wraz ze wzrostem danych testowych. Myślę, że nie ma sensu opisywać przykładu czyszczenia/przywracania bazy danych. W swojej praktyce nie spotkałem się z projektem, w którym ta procedura przebiegłaby bezproblemowo.
- Ryzyko zakłócenia funkcjonalności obwodu testowego podczas testowania ogólnych ustawień systemu. Na przykład zasady dotyczące użytkownika/grupy/hasła/aplikacji.
- Dane testowe z testów automatycznych utrudniają życie testerom manualnym.
Niektórzy powiedzą, że dobre autotesty powinny oczyścić dane po sobie. Mam argumenty przeciw:
- Stojaki dynamiczne są bardzo wygodne w użyciu.
- Nie każdy obiekt da się usunąć z systemu poprzez API. Na przykład nie zaimplementowano wywołania usunięcia obiektu, ponieważ jest to sprzeczne z logiką biznesową.
- Tworząc obiekt poprzez API, można utworzyć ogromną ilość metadanych, których usunięcie jest problematyczne.
- Jeśli testy mają między sobą zależności, to proces czyszczenia danych po uruchomieniu testów przyprawia o ból głowy.
- Dodatkowe (i moim zdaniem nieuzasadnione) wywołania API.
- I główny argument: kiedy dane testowe zaczynają być usuwane bezpośrednio z bazy danych. To się zmienia w prawdziwy cyrk PK/FK! Od programistów słyszymy: „Właśnie dodałem/usunąłem/zmieniłem nazwę znaku, dlaczego wyłapano 100500 XNUMX testów integracyjnych?”
Moim zdaniem najbardziej optymalnym rozwiązaniem jest środowisko dynamiczne.
- Wiele osób korzysta z funkcji docker compose do uruchamiania środowiska testowego, ale niewiele osób korzysta z funkcji docker compose podczas przeprowadzania testów integracyjnych w CI/CD. I tutaj nie biorę pod uwagę kubernetesa, roju i innych platform do orkiestracji kontenerów. Nie każda firma je posiada. Byłoby miło, gdyby plik docker-compose.yml był uniwersalny.
- Nawet jeśli mamy własnego modułu kontroli jakości, w jaki sposób możemy się upewnić, że usługi uruchamiane za pomocą narzędzia docker-compose nie kolidują ze sobą?
- Jak zbierać logi testowanych usług?
- Jak wyczyścić prowadnicę?
Mam własnego modułu uruchamiającego GitLab dla moich projektów i podczas programowania napotkałem te pytania dla . Dokładniej, podczas uruchamiania testów integracyjnych. Poniżej rozwiążemy te problemy na przykładach z tego projektu.
Uruchomienie powłoki GitLab
Dla biegacza polecam maszynę wirtualną Linux z 4 vCPU, 4 GB RAM, 50 GB HDD.
W Internecie jest mnóstwo informacji na temat konfigurowania gitlab-runnera, więc krótko:
- Zaloguj się do urządzenia poprzez SSH
-
Jeśli masz mniej niż 8 GB RAM to polecam aby zabójca OOM nie przyszedł i nie zabił naszych zadań z powodu braku pamięci RAM. Może się to zdarzyć, gdy jednocześnie uruchomionych zostanie więcej niż 5 zadań. Zadania będą postępowały wolniej, ale równomiernie.
Przykład z zabójcą OOM
Jeśli widzisz w dziennikach zadań
bash: line 82: 26474 Killed, a następnie po prostu wykonaj na biegaczusudo 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:0kBA jeśli obraz wygląda mniej więcej tak, dodaj wymianę lub dodaj pamięć RAM.
- zainstalować , , , Marka.
- Dodawanie użytkownika
gitlab-runnerdo grupydockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab-runner.
-
Otwarte do edycji
/etc/gitlab-runner/config.tomli dodajconcurrent=20 [[runners]] request_concurrency = 10Umożliwi to uruchamianie równoległych zadań na jednym biegaczu. Czytaj więcej .
Jeśli masz mocniejszą maszynę, na przykład 8 vCPU, 16 GB RAM, liczby te można zwiększyć co najmniej 2 razy. Wszystko jednak zależy od tego, co dokładnie zostanie wystrzelone na tym biegaczu i w jakiej ilości.
To wystarczy.
Przygotowywanie pliku docker-compose.yml
Głównym zadaniem jest uniwersalny plik docker-compose.yml, z którego programiści/testerzy mogą korzystać zarówno lokalnie, jak i w potoku CI.
Przede wszystkim tworzymy unikalne nazwy usług dla CI. Jedną z unikalnych zmiennych w GitLab CI jest zmienna CI_JOB_ID. Jeśli określisz container_name ze znaczeniem "service-${CI_JOB_ID:-local}", to w przypadku:
- jeśli
CI_JOB_IDniezdefiniowane w zmiennych środowiskowych,
wtedy będzie nazwa usługiservice-local - jeśli
CI_JOB_IDzdefiniowane w zmiennych środowiskowych (na przykład 123),
wtedy będzie nazwa usługiservice-123
Po drugie, tworzymy wspólną sieć dla uruchamianych usług. Zapewnia to izolację na poziomie sieci podczas uruchamiania wielu środowisk testowych.
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}Właściwie to pierwszy krok do sukcesu =)
Przykład mojego pliku docker-compose.yml z komentarzami
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:
- defaultPrzykład uruchomienia lokalnego
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 ... doneAle nie wszystko jest takie proste przy uruchamianiu w CI.
Przygotowanie pliku Makefile
Używam Makefile, ponieważ jest bardzo wygodny zarówno do zarządzania środowiskiem lokalnym, jak i w CI. Więcej komentarzy w internecie
# У меня в проектах все вспомогательные вещи лежат в директории `.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
Kontrola
zrobić dokowanie
$ 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
utwórz dzienniki dokerów
$ 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
Przygotowywanie .gitlab-ci.yml
Uruchamianie testów integracyjnych
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 daysW wyniku uruchomienia takiego zadania katalog logs w artefaktach będzie zawierał logi serwisowe i testowe. Co jest bardzo wygodne w przypadku błędów. Każdy test równolegle zapisuje swój własny dziennik, ale o tym opowiem osobno.
Czyszczenie prowadnicy
Zadanie zostanie uruchomione wyłącznie zgodnie z harmonogramem.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanNastępnie przejdź do naszego projektu GitLab -> CI/CD -> Harmonogramy -> Nowy harmonogram i dodaj nowy harmonogram
Doświadcz mocnych i skutecznych rezultatów
Uruchomienie 4 zadań w GitLab CI
W logach ostatniego zadania z testami integracyjnymi widzimy kontenery z różnych zadań
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-204553539Bardziej szczegółowy dziennik
$ 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-204553539Wszystkie zadania zostały zakończone pomyślnie
Artefakty zadań zawierają dzienniki usług i testów
Wszystko wydaje się piękne, ale jest pewien niuans. Potok może zostać wymuszony anulowany podczas działania testów integracyjnych, w takim przypadku działające kontenery nie zostaną zatrzymane. Od czasu do czasu trzeba wyczyścić prowadnicę. Niestety zadanie ulepszenia w GitLab CE jest nadal aktualne
Ale dodaliśmy uruchamianie zadania zgodnie z harmonogramem i nikt nie zabrania nam uruchamiania go ręcznie.
Przejdź do naszego projektu -> CI/CD -> Harmonogramy i uruchom zadanie Clean runner
Razem:
- Mamy jednego biegacza skorupowego.
- Nie ma konfliktów pomiędzy zadaniami a otoczeniem.
- Równolegle realizujemy zadania z testami integracyjnymi.
- Testy integracyjne można uruchamiać lokalnie lub w kontenerze.
- Dzienniki usług i testów są gromadzone i dołączane do zadania potoku.
- Możliwe jest oczyszczenie modułu runner ze starych obrazów Dockera.
Czas konfiguracji wynosi ~2 godziny.
Właściwie to wszystko. Będzie mi miło otrzymać informację zwrotną.
Źródło: www.habr.com