Hierdie artikel sal van belang wees vir beide toetsers en ontwikkelaars, maar is meer bedoel vir outomateerders wat gekonfronteer word met die probleem om GitLab CI / CD op te stel vir integrasietoetsing in die lig van onvoldoende infrastruktuurhulpbronne en / of die afwesigheid van 'n houerorkestrasie platform. Ek sal jou vertel hoe om die ontplooiing van toetsomgewings op te stel met behulp van docker compose op 'n enkele GitLab-doploper en sodat wanneer verskeie omgewings ontplooi word, die bekendgestelde dienste nie met mekaar inmeng nie.
inhoud
voorvereistes
-
In my praktyk het dit dikwels gebeur om integrasietoetsing op projekte te "behandel". En dikwels is die eerste en belangrikste probleem die CI-pyplyn, waarin integrasietoetsing ontwikkel die diens(s) word in die dev/stage-omgewing aangebied. Dit het heelwat probleme veroorsaak:
- As gevolg van defekte in een of ander diens tydens integrasietoetsing, kan die toetskring deur gebreekte data beskadig word. Daar was gevalle toe die stuur van 'n versoek met 'n gebroke JSON-formaat die diens opgehang het, wat die stand heeltemal onwerksaam gebring het.
- Die verlangsaming van die toetskring met die groei van toetsdata. Ek dink dit maak geen sin om 'n voorbeeld te beskryf met die skoonmaak / terugrol van die databasis nie. In my praktyk het ek nog nie 'n projek ontmoet waar hierdie prosedure glad sou verloop nie.
- Die risiko om die werkverrigting van die toetskring te ontwrig wanneer algemene stelselinstellings getoets word. Byvoorbeeld, gebruiker/groep/wagwoord/toepassingsbeleid.
- Toetsdata van outotoetse maak die lewe moeilik vir handtoetsers.
Iemand sal sê dat goeie outotoetse die data ná hulself moet skoonmaak. Ek het argumente teen:
- Dinamiese staanders is baie gerieflik om te gebruik.
- Nie elke voorwerp kan via die API van die stelsel verwyder word nie. Byvoorbeeld, 'n oproep om 'n voorwerp te skrap word nie geïmplementeer nie, aangesien dit die besigheidslogika weerspreek.
- Wanneer 'n voorwerp deur die API geskep word, kan 'n groot hoeveelheid metadata geskep word wat problematies is om te verwyder.
- As die toetse van mekaar afhanklik is, verander die proses om die data op te ruim nadat die toetse uitgevoer is, in 'n kopseer.
- Bykomende (en, na my mening, nie geregverdig nie) oproepe na die API.
- En die hoofargument: wanneer die toetsdata direk vanaf die databasis skoongemaak word. Dit is besig om in 'n regte PK/FK-sirkus te verander! Ons hoor van die ontwikkelaars: "Ek het sopas die teken bygevoeg/geskrap/hernoem, hoekom het 100500 integrasietoetse deurgeval?"
Na my mening is die mees optimale oplossing 'n dinamiese omgewing.
- Baie mense gebruik docker-compose om 'n toetsomgewing te bestuur, maar min mense gebruik docker-compose wanneer hulle integrasietoetse in CI/CD doen. En hier neem ek nie kubernetes, swerm en ander houer-orkestrasieplatforms in ag nie. Nie elke maatskappy het hulle nie. Dit sal lekker wees as docker-compose.yml universeel was.
- Selfs al het ons ons eie QA-hardloper, hoe kan ons seker maak dat dienste wat via docker-compose bekendgestel word nie met mekaar inmeng nie?
- Hoe om logs van getoetste dienste in te samel?
- Hoe om die hardloper skoon te maak?
Ek het my eie GitLab-hardloper vir my projekte en ek het hierdie probleme ondervind terwyl ek ontwikkel het vir . Meer spesifiek, wanneer integrasietoetse uitgevoer word. Hier sal ons voortgaan om hierdie probleme op te los met voorbeelde uit hierdie projek.
GitLab Shell Runner
Vir 'n hardloper beveel ek 'n Linux virtuele masjien aan met 4 vCPU, 4 GB RAM, 50 GB HDD.
Daar is baie inligting oor die opstel van gitlab-runner op die internet, so kortliks:
- Ons gaan na die masjien via SSH
-
As jy minder as 8 GB RAM het, beveel ek aan sodat die OOM-moordenaar nie ons take kom doodmaak weens 'n gebrek aan RAM nie. Dit kan gebeur wanneer meer as 5 take op dieselfde tyd loop. Take sal stadiger, maar stabiel wees.
Voorbeeld met OOM moordenaar
As jy in die taaklogboeke sien
bash: line 82: 26474 Killed, voer dan net op die hardloper uitsudo 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:0kBEn as die prentjie so iets lyk, voeg dan swap by, óf gooi RAM in.
- Stel , , , maak.
- Voeg 'n gebruiker by
gitlab-runneraan die groepdockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab-runner.
-
Oop vir redigering
/etc/gitlab-runner/config.tomlen voeg byconcurrent=20 [[runners]] request_concurrency = 10Dit sal jou toelaat om parallelle take op dieselfde hardloper uit te voer. Lees meer .
As jy 'n kragtiger masjien het, byvoorbeeld 8 vCPU, 16 GB RAM, kan hierdie getalle ten minste 2 keer groter gemaak word. Maar dit hang alles af van wat presies op hierdie hardloper bekendgestel sal word en in watter hoeveelheid.
Dit is genoeg.
Berei tans docker-compose.yml voor
Die hooftaak is 'n universele docker-compose.yml wat ontwikkelaars / toetsers beide plaaslik en in die CI-pyplyn kan gebruik.
Eerstens maak ons unieke diensname vir CI. Een van die unieke veranderlikes in GitLab CI is die veranderlike CI_JOB_ID. As jy spesifiseer container_name met betekenis "service-${CI_JOB_ID:-local}", dan in die geval:
- indien
CI_JOB_IDnie gedefinieer in omgewingsveranderlikes nie,
dan sal die diensnaam weesservice-local - indien
CI_JOB_IDgedefinieer in omgewingsveranderlikes (bv. 123),
dan sal die diensnaam weesservice-123
Tweedens maak ons 'n gemeenskaplike netwerk vir die bestuur van dienste. Dit gee ons netwerkvlak-isolasie wanneer ons verskeie toetsomgewings bestuur.
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}Eintlik is dit die eerste stap na sukses =)
'n Voorbeeld van my docker-compose.yml met kommentaar
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:
- defaultPlaaslike hardloop voorbeeld
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 ... doneMaar nie alles is so eenvoudig met die bekendstelling in CI nie.
Berei die Makefile voor
Ek gebruik die Makefile aangesien dit baie handig is vir beide plaaslike omgewingsbestuur en CI. Meer aanlyn kommentaar
# У меня в проектах все вспомогательные вещи лежат в директории `.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
Nagaan
dokwerker maak
$ 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
maak 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
Berei tans .gitlab-ci.yml voor
Voer integrasietoetse uit
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 daysAs gevolg van die uitvoering van so 'n taak, sal die logboekgids in artefakte logs van dienste en toetse bevat. Wat baie handig is in geval van foute. Elke toets in parallel skryf sy eie logboek, maar ek sal afsonderlik hieroor praat.
Maak die hardloper skoon
Die taak sal slegs volgens die skedule uitgevoer word.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanGaan dan na ons GitLab-projek -> CI/CD -> Skedules -> Nuwe skedule en voeg 'n nuwe skedule by
Gevolg
Voer 4 take in GitLab CI uit
In die logs van die laaste taak met integrasietoetse sien ons houers van verskillende take
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-204553539Meer gedetailleerde logboek
$ 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-204553539Alle take suksesvol voltooi
Taak artefakte bevat logs van dienste en toetse
Alles blyk pragtig te wees, maar daar is 'n nuanse. 'n Pyplyn kan met geweld gekanselleer word terwyl integrasietoetse loop, in welke geval lopende houers nie gestop sal word nie. Van tyd tot tyd moet jy die hardloper skoonmaak. Ongelukkig is die taak vir hersiening in GitLab CE steeds in die status
Maar ons het 'n geskeduleerde taakbekendstelling bygevoeg, en niemand verbied ons om dit met die hand te begin nie.
Gaan na ons projek -> CI/CD -> Skedules en voer die taak uit Clean runner
Totaal:
- Ons het een doploper.
- Daar is geen konflikte tussen take en die omgewing nie.
- Ons het 'n parallelle bekendstelling van take met integrasietoetse.
- U kan integrasietoetse beide plaaslik en in 'n houer uitvoer.
- Diens- en toetslogboeke word versamel en aan die pyplyntaak geheg.
- Dit is moontlik om die hardloper van ou docker-beelde skoon te maak.
Die opsteltyd is ~2 uur.
Dit is eintlik al. Ek sal met graagte terugvoer gee.
Bron: will.com