Questo articolo interesserà sia i tester che gli sviluppatori, ma è destinato principalmente agli specialisti di automazione che si trovano ad affrontare il problema della configurazione di GitLab CI/CD per i test di integrazione in condizioni di risorse infrastrutturali insufficienti e/o assenza di un container piattaforma di orchestrazione. Ti dirò come impostare la distribuzione di ambienti di test utilizzando docker compose su un unico shell runner GitLab e in modo che quando si distribuiscono più ambienti, i servizi lanciati non interferiscano tra loro.
contenuto
Предпосылки
-
Nella mia pratica, accadeva spesso che i test di integrazione venissero “trattati” sui progetti. E spesso il primo e più significativo problema è la pipeline CI, in cui vengono eseguiti i test di integrazione in fase di sviluppo i servizi vengono eseguiti in un ambiente di sviluppo/stage. Ciò ha causato non pochi problemi:
- A causa di difetti in un particolare servizio durante il processo di test di integrazione, il circuito di test potrebbe essere danneggiato da dati interrotti. Ci sono stati casi in cui l'invio di una richiesta con un formato JSON danneggiato ha bloccato il servizio, rendendo lo stand completamente inutilizzabile.
- Rallentamento del circuito di prova all'aumentare dei dati di prova. Penso che non abbia senso descrivere un esempio con la pulizia/il rollback del database. Nella mia pratica, non ho riscontrato un progetto in cui questa procedura si sia svolta senza intoppi.
- Rischio di interruzione della funzionalità del circuito di prova durante il test delle impostazioni generali del sistema. Ad esempio, criterio utente/gruppo/password/applicazione.
- I dati dei test automatizzati rendono la vita difficile ai tester manuali.
Alcuni diranno che i buoni autotest dovrebbero ripulire i dati da soli. Ho argomenti contro:
- I supporti dinamici sono molto comodi da usare.
- Non tutti gli oggetti possono essere rimossi dal sistema tramite l'API. Ad esempio, una chiamata per eliminare un oggetto non è stata implementata perché contraddice la logica aziendale.
- Quando si crea un oggetto tramite l'API, è possibile creare un'enorme quantità di metadati, la cui eliminazione è problematica.
- Se i test hanno dipendenze tra loro, il processo di pulizia dei dati dopo l'esecuzione dei test si trasforma in un mal di testa.
- Chiamate aggiuntive (e, a mio avviso, non giustificate) all'API.
- E l'argomento principale: quando i dati dei test iniziano a essere cancellati direttamente dal database. Questo si sta trasformando in un vero circo PK/FK! Sentiamo dagli sviluppatori: "Ho appena aggiunto/rimosso/rinominato un segno, perché sono stati rilevati 100500 test di integrazione?"
Secondo me, la soluzione ottimale è un ambiente dinamico.
- Molte persone utilizzano docker-compose per eseguire un ambiente di test, ma poche persone utilizzano docker-compose quando eseguono test di integrazione in CI/CD. E qui non sto prendendo in considerazione Kubernetes, Swarm e altre piattaforme di orchestrazione dei contenitori. Non tutte le aziende li hanno. Sarebbe bello se docker-compose.yml fosse universale.
- Anche se disponiamo di un nostro QA runner, come possiamo garantire che i servizi lanciati tramite docker-compose non interferiscano tra loro?
- Come raccogliere i log dei servizi testati?
- Come pulire il corridore?
Ho il mio runner GitLab per i miei progetti e ho riscontrato queste domande durante lo sviluppo per . Più precisamente, durante l'esecuzione dei test di integrazione. Di seguito risolveremo questi problemi utilizzando esempi di questo progetto.
GitLab Shell Runner
Per un runner consiglio una macchina virtuale Linux con 4 vCPU, 4 GB RAM, 50 GB HDD.
Ci sono molte informazioni sulla configurazione di gitlab-runner su Internet, quindi brevemente:
- Accedere alla macchina tramite SSH
-
Se hai meno di 8 GB di RAM, allora lo consiglio in modo che il killer OOM non arrivi e interrompa le nostre attività a causa della mancanza di RAM. Ciò può accadere quando vengono avviate più di 5 attività contemporaneamente. Le attività progrediranno più lentamente, ma costantemente.
Esempio con OOM killer
Se vedi nei registri delle attività
bash: line 82: 26474 Killed, quindi esegui semplicemente sul corridoresudo 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:0kBE se l'immagine assomiglia a questa, aggiungi swap o aggiungi RAM.
- Set , , , rendere.
- Aggiunta di un utente
gitlab-runneral gruppodockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab runner.
-
Aperto per la modifica
/etc/gitlab-runner/config.tomle aggiungiconcurrent=20 [[runners]] request_concurrency = 10Ciò ti consentirà di eseguire attività parallele su un corridore. Per saperne di più .
Se disponi di una macchina più potente, ad esempio 8 vCPU, 16 GB di RAM, questi numeri possono essere aumentati almeno 2 volte. Ma tutto dipende da cosa verrà lanciato esattamente su questo corridore e in quale quantità.
È abbastanza
Preparazione docker-compose.yml
L'attività principale è un docker-compose.yml universale, che gli sviluppatori/tester possono utilizzare sia localmente che nella pipeline CI.
Prima di tutto, creiamo nomi di servizio univoci per CI. Una delle variabili uniche in GitLab CI è la variabile CI_JOB_ID. Se specifichi container_name con significato "service-${CI_JOB_ID:-local}", allora nel caso:
- se
CI_JOB_IDnon definito nelle variabili di ambiente,
quindi il nome del servizio saràservice-local - se
CI_JOB_IDdefinito nelle variabili d'ambiente (ad esempio 123),
quindi il nome del servizio saràservice-123
In secondo luogo, creiamo una rete comune per i servizi lanciati. Questo ci fornisce l'isolamento a livello di rete quando si eseguono più ambienti di test.
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}In realtà, questo è il primo passo verso il successo =)
Esempio del mio docker-compose.yml con commenti
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:
- defaultEsempio di esecuzione locale
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 ... doneMa non tutto è così semplice con l'avvio in CI.
Preparazione del makefile
Utilizzo Makefile perché è molto comodo sia per la gestione dell'ambiente locale che in CI. Altri commenti online
# У меня в проектах все вспомогательные вещи лежат в директории `.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
controllare la
fare 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
creare log docker
$ 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
Preparazione di .gitlab-ci.yml
Esecuzione di test di integrazione
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 daysCome risultato dell'esecuzione di tale attività, la directory dei log negli artefatti conterrà i log di servizio e di test. Il che è molto comodo in caso di errori. Ogni test in parallelo scrive il proprio log, ma di questo ne parlerò separatamente.
Pulizia del corridore
L'attività verrà avviata solo in base a una pianificazione.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanSuccessivamente, vai al nostro progetto GitLab -> CI/CD -> Pianificazioni -> Nuova pianificazione e aggiungi una nuova pianificazione
risultato
Avvio di 4 attività in GitLab CI
Nei log dell'ultima attività con test di integrazione vediamo contenitori di attività diverse
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-204553539Registro più dettagliato
$ 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-204553539Tutte le attività sono state completate con successo
Gli artefatti dell'attività contengono log di servizi e test
Tutto sembra essere bello, ma c'è una sfumatura. La pipeline può essere annullata forzatamente mentre sono in esecuzione i test di integrazione, nel qual caso l'esecuzione dei contenitori non verrà interrotta. Di tanto in tanto è necessario pulire il corridore. Sfortunatamente, l'attività di miglioramento in GitLab CE è ancora in fase di elaborazione
Ma abbiamo aggiunto l'avvio di un'attività in base a una pianificazione e nessuno ci vieta di eseguirla manualmente.
Vai al nostro progetto -> CI/CD -> Pianificazioni ed esegui l'attività Clean runner
Totale:
- Abbiamo un corridore di conchiglie.
- Non ci sono conflitti tra compiti e ambiente.
- Eseguiamo attività con test di integrazione in parallelo.
- È possibile eseguire test di integrazione localmente o in un contenitore.
- I log di servizio e test vengono raccolti e allegati all'attività della pipeline.
- È possibile pulire il runner dalle vecchie immagini Docker.
Il tempo di installazione è di circa 2 ore.
Questo è tutto, in realtà. Sarò felice di ricevere feedback.
Fonte: habr.com