Tulisan ieu bakal dipikaresep ku panguji sareng pamekar, tapi khususna pikeun spesialis otomatis anu disanghareupan ku masalah nyetel GitLab CI/CD pikeun nguji integrasi dina kaayaan sumber daya infrastruktur anu teu cekap sareng / atanapi henteuna wadahna. platform orkestrasi. Kuring bakal nyarioskeun ka anjeun kumaha cara nyetél panyebaran lingkungan tés nganggo docker compose dina hiji pelari cangkang GitLab tunggal sareng ku kituna nalika nyebarkeun sababaraha lingkungan, jasa anu diluncurkeun henteu saling ngaganggu.
eusi
Suku Sunda
-
Dina prakna mah, mindeng kajadian nu nguji integrasi ieu "diperlakukeun" dina proyék. Sarta mindeng masalah kahiji jeung paling signifikan nyaéta pipa CI, nu nguji integrasi keur dimekarkeun jasa (s) dilaksanakeun dina lingkungan dev/tahap. Ieu nyababkeun sababaraha masalah:
- Kusabab cacad dina jasa khusus nalika uji integrasi, sirkuit tés tiasa ruksak ku data rusak. Aya kasus nalika ngirim pamenta kalayan format JSON anu rusak nabrak jasa éta, anu ngajantenkeun stan lengkep teu tiasa dianggo.
- Ngalambatkeun sirkuit tés nalika data tés ningkat. Jigana teu make akal pikiran pikeun ngajelaskeun conto kalayan beberesih / rolling deui database. Dina prakték kuring, kuring henteu acan mendakan proyék dimana prosedur ieu lancar.
- Résiko ngaganggu pungsionalitas sirkuit tés nalika nguji setélan sistem umum. Contona, pamaké / grup / sandi / kawijakan aplikasi.
- Data uji tina tés otomatis ngajadikeun hirup hésé pikeun panguji manual.
Sababaraha bakal nyebutkeun yén autotests alus kudu ngabersihan up data sanggeus sorangan. Kuring boga argumen ngalawan:
- nangtung dinamis pisan merenah ngagunakeun.
- Henteu unggal obyék tiasa dipiceun tina sistem liwat API. Contona, panggero pikeun mupus hiji obyék teu dilaksanakeun sabab contradicts logika bisnis.
- Nalika nyiptakeun obyék via API, sajumlah ageung metadata tiasa didamel, anu janten masalah pikeun ngahapus.
- Upami tés gaduh katergantungan diantara aranjeunna, maka prosés ngabersihkeun data saatos ngajalankeun tés janten nyeri sirah.
- Tambahan (jeung, dina pamanggih kuring, teu diyakinkeun) nelepon ka API.
- Jeung argumen utama: lamun data test mimiti diberesihan langsung tina database. Ieu robah jadi PK / FK sirkus nyata! Urang ngadangu ti pamekar: "Kuring nembé nambihan / dipiceun / namina nami tanda, naha 100500 tes integrasi katangkep?"
Dina pamanggih kuring, solusi anu paling optimal nyaéta lingkungan dinamis.
- Seueur jalma anu nganggo docker-compose pikeun ngajalankeun lingkungan tés, tapi sakedik jalma anu nganggo docker-compose nalika ngalaksanakeun tés integrasi dina CI / CD. Sareng di dieu kuring henteu nganggap kubernetes, ngagimbung sareng platform orkestrasi wadahna sanés. Henteu unggal perusahaan gaduh aranjeunna. Éta langkung saé upami docker-compose.yml universal.
- Sanaos urang gaduh QA runner sorangan, kumaha urang tiasa mastikeun yén jasa anu diluncurkeun via docker-compose henteu ngaganggu silih?
- Kumaha cara ngumpulkeun log jasa anu diuji?
- Kumaha ngabersihan runner?
Kuring gaduh runner GitLab kuring sorangan pikeun proyék-proyék kuring sareng kuring mendakan patarosan ieu nalika pangwangunan keur . Leuwih tepat, nalika ngajalankeun tés integrasi. Di handap ieu kami bakal ngajawab masalah ieu nganggo conto tina proyék ieu.
GitLab Shell Runner
Pikeun runner a, Kuring nyarankeun mesin virtual Linux Ubuntu jeung 4 vCPU, 4 GB RAM, 50 GB HDD.
Aya seueur inpormasi ngeunaan nyetél gitlab-runner dina Internét, janten sakedap:
- Asup ka mesin via SSH
-
Upami Anjeun gaduh kirang ti 8 GB RAM, lajeng Abdi nyarankeun supados pembunuh OOM henteu sumping sareng maéhan tugas urang kusabab kurangna RAM. Ieu tiasa lumangsung nalika langkung ti 5 tugas diluncurkeun sakaligus. Tugas bakal maju langkung laun, tapi ajeg.
Conto sareng pembunuh OOM
Upami anjeun ningali dina log tugas
bash: line 82: 26474 Killed, lajeng ngan ngaéksekusi on runnersudo 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:0kBSareng upami gambarna sapertos kieu, teras tambahkeun swap atanapi tambahkeun RAM.
- Masang , , , ngadamel.
- Nambahkeun pamaké
gitlab-runnerka grupdockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab-runner.
-
Dibuka pikeun ngédit
/etc/gitlab-runner/config.tomljeung nambahanconcurrent=20 [[runners]] request_concurrency = 10Ieu bakal ngidinan Anjeun pikeun ngajalankeun tugas paralel dina hiji runner. Maca deui .
Upami Anjeun gaduh mesin leuwih kuat, contona 8 vCPU, 16 GB RAM, lajeng angka ieu bisa dijieun sahenteuna 2 kali leuwih badag. Tapi éta sadayana gumantung kana naon anu bakal diluncurkeun dina runner ieu sareng dina jumlah naon.
Geus cukup.
Nyiapkeun docker-compose.yml
Tugas utama nyaéta docker-compose.yml universal, anu tiasa dianggo ku pamekar / panguji sacara lokal sareng dina pipa CI.
Anu mimiti, urang ngadamel nami jasa unik pikeun CI. Salah sahiji variabel unik dina GitLab CI nyaéta variabel CI_JOB_ID. Lamun nangtukeun container_name kalawan harti "service-${CI_JOB_ID:-local}", teras dina kasus:
- upami
CI_JOB_IDhenteu ditetepkeun dina variabel lingkungan,
lajeng nami jasa bakalservice-local - upami
CI_JOB_IDdidefinisikeun dina variabel lingkungan (contona 123),
lajeng nami jasa bakalservice-123
Bréh, urang nyieun jaringan umum pikeun layanan dibuka. Ieu masihan kami isolasi tingkat jaringan nalika ngajalankeun sababaraha lingkungan tés.
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}Sabenerna, ieu mangrupikeun léngkah munggaran pikeun suksés =)
Conto docker-compose.yml kuring sareng koméntar
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:
- defaultconto ngajalankeun lokal
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 ... doneTapi henteu sadayana saderhana pisan sareng peluncuran di CI.
Nyiapkeun Makefile
Kuring make Makefile sabab pohara merenah boh pikeun manajemén lingkungan lokal jeung di CI. Langkung komentar 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
Cék
nyieun 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
nyieun 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
Nyiapkeun .gitlab-ci.yml
Ngajalankeun tés integrasi
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 daysSalaku hasil tina ngajalankeun tugas sapertos kitu, diréktori log dina artefak bakal ngandung log jasa sareng uji. Nu pohara merenah bisi kasalahan. Unggal tés paralel nyerat log sorangan, tapi kuring bakal ngobrol ngeunaan ieu nyalira.
Beberesih lumpat
Tugas bakal diluncurkeun ngan dumasar kana jadwal.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanTeras, angkat ka proyék GitLab kami -> CI / CD -> Jadwal -> Jadwal Anyar sareng tambahkeun jadwal énggal
hasil
Ngaluncurkeun 4 tugas di GitLab CI
Dina log tina tugas panungtungan kalawan tés integrasi kami ningali wadah tina tugas béda
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-204553539log leuwih lengkep
$ 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-204553539Sadaya pancén parantos réngsé
Artefak tugas ngandung log jasa sareng uji
Sagalana sigana geulis, tapi aya nuansa. Pipeline tiasa dibolaykeun sacara paksa nalika tes integrasi dijalankeun, dina hal ieu wadah anu ngajalankeun moal dieureunkeun. Ti jaman ka jaman anjeun kudu ngabersihan runner. Hanjakal, tugas pikeun perbaikan di GitLab CE masih dina status
Tapi kami geus ditambahkeun peluncuran tugas nurutkeun jadwal a, sarta teu saurang ogé forbids urang ngajalankeun eta sacara manual.
Pindah ka proyék kami -> CI / CD -> Jadwal sareng jalankeun tugas Clean runner
total:
- Simkuring gaduh hiji cangkang runner.
- Henteu aya konflik antara tugas sareng lingkungan.
- Urang ngajalankeun tugas kalawan tés integrasi dina paralel.
- Anjeun tiasa ngajalankeun tés integrasi boh sacara lokal atanapi dina wadah.
- Service jeung test log dikumpulkeun sarta napel tugas pipa.
- Kasebut nyaéta dimungkinkeun pikeun ngabersihan runner tina gambar Docker heubeul.
Waktu setelan nyaéta ~ 2 jam.
Éta sadayana, sabenerna. Abdi bakal bungah nampi eupan balik.
sumber: www.habr.com