Tämä artikkeli kiinnostaa sekä testaajia että kehittäjiä, mutta se on tarkoitettu enemmän automatisoijille, joilla on ongelma GitLab CI:n / CD:n määrittämisessä integraatiotestausta varten riittämättömien infrastruktuuriresurssien ja/tai kontin orkestroinnin puuttuessa. alusta. Kerron, kuinka testiympäristöjen käyttöönotto docker composella konfiguroidaan yhdelle GitLab shell runnerille ja niin, että useita ympäristöjä otettaessa käyttöön käynnistetyt palvelut eivät häiritse toisiaan.
Pitoisuus
Предпосылки
-
Käytännössäni sattui usein "käsittelemään" integraatiotestausta projekteissa. Ja usein ensimmäinen ja merkittävin ongelma on CI-putki, jossa integraatiotestaus kehitetty palvelu(t) isännöidään dev/stage-ympäristössä. Tämä aiheutti useita ongelmia:
- Integraatiotestauksen aikana esiintyvien vikojen vuoksi testipiiri voi vioittua rikkinäisillä tiedoilla. Oli tapauksia, joissa rikkinäisen JSON-muodon pyynnön lähettäminen katkaisi palvelun, mikä teki telineen täysin toimintakyvyttömäksi.
- Testipiirin hidastuminen testitietojen kasvun myötä. Mielestäni ei ole järkevää kuvata esimerkkiä tietokannan puhdistamisesta / palauttamisesta. Käytännössäni en ole tavannut projektia, jossa tämä menettely sujuisi ongelmitta.
- Testipiirin toiminnan häiriintymisen riski testattaessa yleisiä järjestelmäasetuksia. Esimerkiksi käyttäjä/ryhmä/salasana/sovelluskäytäntö.
- Automaattitestien testitiedot vaikeuttavat manuaalisten testaajien elämää.
Joku sanoo, että hyvien automaattisten testien pitäisi puhdistaa tiedot itsensä jälkeen. Minulla on argumentteja vastaan:
- Dynaamiset jalustat ovat erittäin käteviä käyttää.
- Kaikkia esineitä ei voi poistaa järjestelmästä API:n kautta. Esimerkiksi kehotusta poistaa objekti ei ole toteutettu, koska se on ristiriidassa liiketoimintalogiikan kanssa.
- Kun objekti luodaan API:n kautta, voidaan luoda valtava määrä metadataa, jonka poistaminen on ongelmallista.
- Jos testit ovat riippuvaisia toisistaan, niin tietojen puhdistaminen testien suorittamisen jälkeen muuttuu päänsärkyksi.
- Lisäkutsuja (ja mielestäni perusteettomia) API:lle.
- Ja tärkein argumentti: kun testitietoja aletaan puhdistaa suoraan tietokannasta. Tästä on tulossa todellinen PK/FK-sirkus! Kuulemme kehittäjiltä: "Lisäsin / poistin / nimesin uudelleen merkin, miksi 100500 XNUMX integrointitestiä putosi?"
Minusta optimaalinen ratkaisu on dynaaminen ympäristö.
- Monet ihmiset käyttävät Docker-composea testiympäristön suorittamiseen, mutta harvat käyttävät docker-composea tehdessään integrointitestausta CI/CD:ssä. Ja tässä en ota huomioon kubernetteja, parvia ja muita konttien orkestrointialustoja. Kaikilla yrityksillä ei niitä ole. Olisi mukavaa, jos docker-compose.yml olisi universaali.
- Vaikka meillä olisi oma QA runner, miten voimme varmistaa, että docker-composen kautta käynnistetyt palvelut eivät häiritse toisiaan?
- Kuinka kerätä lokeja testatuista palveluista?
- Kuinka juoksija puhdistetaan?
Minulla on oma GitLab-runner projekteilleni ja törmäsin näihin ongelmiin kehittäessäni varten . Tarkemmin sanottuna integraatiotestejä suoritettaessa. Täällä jatkamme näiden ongelmien ratkaisemista tämän projektin esimerkkien avulla.
GitLab Shell Runner
Juoksijalle suosittelen Linux-virtuaalikonetta, jossa on 4 vCPU:ta, 4 Gt RAM-muistia, 50 Gt HDD.
Internetissä on paljon tietoa gitlab-runnerin asettamisesta, joten lyhyesti:
- Menemme koneelle SSH:n kautta
-
Jos sinulla on alle 8 Gt RAM-muistia, suosittelen jotta OOM-tappaja ei tule tappamaan meille tehtäviä RAM-muistin puutteen vuoksi. Tämä voi tapahtua, kun yli 5 tehtävää on käynnissä samanaikaisesti. Tehtävät ovat hitaampia, mutta vakaita.
Esimerkki OOM-killeristä
Jos näet tehtävälokeissa
bash: line 82: 26474 Killed, suorita sitten vain juoksijallasudo 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:0kBJa jos kuva näyttää tältä, lisää joko swap tai lisää RAM-muistia.
- Asettaa , , , tee.
- Käyttäjän lisääminen
gitlab-runnerryhmäändockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab-runner.
-
Avaa muokkausta varten
/etc/gitlab-runner/config.tomlja lisääconcurrent=20 [[runners]] request_concurrency = 10Näin voit suorittaa rinnakkaisia tehtäviä samalla juoksijalla. Lue lisää .
Jos sinulla on tehokkaampi kone, esimerkiksi 8 vCPU, 16 Gt RAM-muistia, nämä luvut voidaan tehdä vähintään 2 kertaa suuremmiksi. Mutta kaikki riippuu siitä, mitä tällä juoksijalla lanseerataan ja missä määrin.
Se riittää.
Valmistellaan docker-compose.yml
Päätehtävänä on yleinen docker-compose.yml, jota kehittäjät/testaajat voivat käyttää sekä paikallisesti että CI-liukuhihnassa.
Ensinnäkin teemme CI:lle ainutlaatuiset palvelunimet. Yksi GitLab CI:n ainutlaatuisista muuttujista on muuttuja CI_JOB_ID. Jos määrittelet container_name arvoilla "service-${CI_JOB_ID:-local}", sitten tapauksessa:
- jos
CI_JOB_IDei ole määritelty ympäristömuuttujissa,
sitten palvelun nimi onservice-local - jos
CI_JOB_IDmääritelty ympäristömuuttujissa (esim. 123),
sitten palvelun nimi onservice-123
Toiseksi teemme yhteisen verkon palveluiden pyörittämiseen. Tämä antaa meille verkkotason eristyksen, kun käytämme useita testiympäristöjä.
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}Itse asiassa tämä on ensimmäinen askel menestykseen =)
Esimerkki tiedostostani docker-compose.yml kommentteineen
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:
- defaultEsimerkki paikallisesta suorituksesta
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 ... doneMutta kaikki ei ole niin yksinkertaista CI:n käynnistämisessä.
Makefile-tiedoston valmistelu
Käytän Makefileä, koska se on varsin kätevä sekä paikallisessa ympäristönhallinnassa että CI:ssä. Lisää kommentteja netissä
# У меня в проектах все вспомогательные вещи лежат в директории `.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
tarkista
tehdä telakka-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
tehdä telakointilokkeja
$ 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
Valmistellaan tiedostoa .gitlab-ci.yml
Integraatiotestien suorittaminen
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 daysTällaisen tehtävän suorittamisen seurauksena artefaktien lokihakemisto sisältää palveluiden ja testien lokit. Mikä on erittäin kätevä virheiden sattuessa. Jokainen testi rinnakkain kirjoittaa oman lokinsa, mutta puhun tästä erikseen.
Juoksun puhdistaminen
Tehtävä suoritetaan vain aikataulun mukaan.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanSiirry seuraavaksi GitLab-projektiimme -> CI/CD -> Aikataulut -> Uusi aikataulu ja lisää uusi aikataulu
Tulos
Suorita 4 tehtävää GitLab CI:ssä
Viimeisen tehtävän lokeissa integrointitesteillä näemme eri tehtävien kontteja
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-204553539Tarkempi loki
$ 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-204553539Kaikki tehtävät suoritettu onnistuneesti
Tehtävien artefaktit sisältävät palvelu- ja testilokeja
Kaikki näyttää olevan kaunista, mutta siinä on vivahde. Liukulinja voidaan väkisin peruuttaa integrointitestien ollessa käynnissä, jolloin käynnissä olevia säiliöitä ei pysäytetä. Ajoittain sinun on puhdistettava juoksija. Valitettavasti GitLab CE:n versiotehtävä on edelleen tilassa
Mutta olemme lisänneet ajoitetun tehtäväkäynnistyksen, eikä kukaan kiellä meitä käynnistämästä sitä manuaalisesti.
Mene projektiimme -> CI/CD -> Aikataulut ja suorita tehtävä Clean runner
Yhteensä:
- Meillä on yksi shell runner.
- Työtehtävien ja ympäristön välillä ei ole ristiriitoja.
- Meillä on rinnakkain käynnistetty tehtäviä integraatiotesteillä.
- Voit suorittaa integrointitestejä sekä paikallisesti että säilössä.
- Palvelu- ja testilokit kerätään ja liitetään putkitehtävään.
- Runner on mahdollista puhdistaa vanhoista telakointikuvista.
Asennusaika on ~2 tuntia.
Siinä itse asiassa kaikki. Annan mielelläni palautetta.
Lähde: will.com