Bu makale hem test uzmanlarının hem de geliştiricilerin ilgisini çekecektir ancak temel olarak, yetersiz altyapı kaynakları ve/veya konteyner yokluğu koşullarında entegrasyon testi için GitLab CI/CD'yi kurma sorunuyla karşı karşıya kalan otomasyon uzmanları için tasarlanmıştır. orkestrasyon platformu. Tek bir GitLab kabuk çalıştırıcısında docker compose kullanarak test ortamlarının dağıtımını nasıl ayarlayacağınızı ve böylece birden fazla ortamı dağıtırken başlatılan hizmetlerin birbirini etkilememesini anlatacağım.
Içerik
AMAÇ
-
Uygulamamda, entegrasyon testlerinin projelerde "işlemden geçirildiği" sıklıkla oluyordu. Ve çoğu zaman ilk ve en önemli sorun, entegrasyon testlerinin yapıldığı CI hattıdır. geliştirilmekte hizmet(ler) bir geliştirme/sahne ortamında gerçekleştirilir. Bu epeyce soruna neden oldu:
- Entegrasyon testi sırasında belirli bir hizmetteki kusurlar nedeniyle test devresi bozuk verilerden zarar görebilir. Bozuk bir JSON formatına sahip bir istek gönderildiğinde hizmetin çökmesine neden olan ve standı tamamen çalışmaz hale getiren durumlar vardı.
- Test verileri arttıkça test devresinin yavaşlaması. Veritabanını temizleme/geri alma ile ilgili bir örnek açıklamanın mantıklı olmadığını düşünüyorum. Uygulamamda bu sürecin sorunsuz gittiği bir projeye rastlamadım.
- Genel sistem ayarlarını test ederken test devresinin işlevselliğini bozma riski. Örneğin kullanıcı/grup/şifre/uygulama politikası.
- Otomatik testlerden elde edilen test verileri, manuel test yapanların hayatını zorlaştırır.
Bazıları, iyi otomatik testlerin verileri kendiliğinden temizlemesi gerektiğini söyleyecektir. Karşı argümanlarım var:
- Dinamik standların kullanımı oldukça uygundur.
- API aracılığıyla her nesne sistemden kaldırılamaz. Örneğin, bir nesneyi silme çağrısı, iş mantığıyla çeliştiği için uygulanmadı.
- API aracılığıyla bir nesne oluştururken, silinmesi sorunlu olan büyük miktarda meta veri oluşturulabilir.
- Testlerin kendi aralarında bağımlılıkları varsa testleri çalıştırdıktan sonra verileri temizleme işlemi baş ağrısına dönüşür.
- API'ye yapılan ek (ve bence haklı olmayan) çağrılar.
- Ve ana argüman: test verileri doğrudan veritabanından temizlenmeye başladığında. Bu gerçek bir PK/FK sirkine dönüşüyor! Geliştiricilerden şunu duyuyoruz: "Bir işareti ekledim/kaldırdım/yeniden adlandırdım, neden 100500 entegrasyon testi yakalandı?"
Bana göre en uygun çözüm dinamik bir ortamdır.
- Birçok kişi bir test ortamını çalıştırmak için docker-compose'u kullanır, ancak çok az kişi CI/CD'de entegrasyon testi gerçekleştirirken docker-compose'u kullanır. Ve burada kubernet'leri, sürüyü ve diğer konteyner düzenleme platformlarını hesaba katmıyorum. Her şirkette bunlara sahip değil. Docker-compose.yml'nin evrensel olması güzel olurdu.
- Kendi QA çalıştırıcımız olsa bile docker-compose aracılığıyla başlatılan hizmetlerin birbirini etkilemediğinden nasıl emin olabiliriz?
- Test edilen hizmetlerin günlükleri nasıl toplanır?
- Koşucu nasıl temizlenir?
Projelerim için kendi GitLab çalıştırıcım var ve geliştirme sırasında bu sorularla karşılaştım için . Daha doğrusu entegrasyon testlerini çalıştırırken. Aşağıda bu projedeki örnekleri kullanarak bu sorunları çözeceğiz.
GitLab Kabuk Çalıştırıcısı
Bir koşucu için 4 vCPU, 4 GB RAM, 50 GB HDD'ye sahip bir Linux sanal makinesi öneririm.
İnternette gitlab-runner kurulumuyla ilgili pek çok bilgi var, kısaca:
- Makineye SSH ile giriş yapın
-
8 GB'tan az RAM'iniz varsa, tavsiye ederim Böylece OOM katili gelip RAM yetersizliğinden dolayı görevlerimizi sonlandırmasın. Bu, aynı anda 5'ten fazla görev başlatıldığında meydana gelebilir. Görevler daha yavaş ama istikrarlı bir şekilde ilerleyecek.
OOM katili örneği
Görev günlüklerinde görüyorsanız
bash: line 82: 26474 Killed, ardından sadece koşucu üzerinde yürütünsudo 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:0kBResim buna benziyorsa, ya takas ekleyin ya da RAM ekleyin.
- Ayarlamak , , , Yapmak.
- Kullanıcı ekleme
gitlab-runnergrubadockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab koşucusu.
-
Düzenlemeye açık
/etc/gitlab-runner/config.tomlve Ekleconcurrent=20 [[runners]] request_concurrency = 10Bu, paralel görevleri tek bir koşucuda çalıştırmanıza olanak tanır. Devamını oku .
Daha güçlü bir makineniz varsa, örneğin 8 vCPU, 16 GB RAM, bu sayılar en az 2 kat daha büyük yapılabilir. Ancak her şey bu koşucuda tam olarak neyin ve hangi miktarda piyasaya sürüleceğine bağlı.
Bu yeterlidir.
Docker-compose.yml hazırlanıyor
Ana görev, geliştiricilerin/testçilerin hem yerel olarak hem de CI hattında kullanabileceği evrensel bir docker-compose.yml'dir.
Öncelikle CI'ya özel hizmet isimleri yapıyoruz. GitLab CI'daki benzersiz değişkenlerden biri değişkendir CI_JOB_ID. Eğer belirtirseniz container_name anlamı olan "service-${CI_JOB_ID:-local}", bu durumda:
- eğer
CI_JOB_IDortam değişkenlerinde tanımlanmamış,
o zaman hizmet adı şöyle olacaktırservice-local - eğer
CI_JOB_IDortam değişkenlerinde tanımlanmış (örneğin 123),
o zaman hizmet adı şöyle olacaktırservice-123
İkinci olarak başlatılan hizmetler için ortak bir ağ oluşturuyoruz. Bu, birden fazla test ortamını çalıştırırken bize ağ düzeyinde izolasyon sağlar.
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}Aslında bu başarının ilk adımı =)
Yorumlarla birlikte docker-compose.yml örneğim
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:
- defaultYerel çalıştırma örneği
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 ... doneAncak CI'da başlatmayla her şey o kadar basit değil.
Makefile'ın Hazırlanması
Makefile'ı hem yerel ortam yönetimi hem de CI'da çok uygun olduğu için kullanıyorum. Daha fazla çevrimiçi yorum
# У меня в проектах все вспомогательные вещи лежат в директории `.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
kontrol
liman işçisi oluştur
$ 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
liman işçisi günlükleri oluştur
$ 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
.gitlab-ci.yml hazırlanıyor
Entegrasyon testlerini çalıştırma
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 daysBöyle bir görevin çalıştırılması sonucunda yapıtlardaki loglar dizini servis ve test günlüklerini içerecektir. Hata durumunda çok kullanışlıdır. Her test paralel olarak kendi günlüğünü yazar ancak bunun hakkında ayrı ayrı konuşacağım.
Koşucunun temizlenmesi
Görev yalnızca bir zamanlamaya göre başlatılacaktır.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanArdından GitLab projemize gidin -> CI/CD -> Zamanlamalar -> Yeni Zamanlama ve yeni bir zamanlama ekleyin
sonuç
GitLab CI'da 4 görev başlatılıyor
Entegrasyon testleriyle birlikte son görevin günlüklerinde farklı görevlere ait kapsayıcılar görüyoruz
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-204553539Daha ayrıntılı günlük
$ 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-204553539Tüm görevler başarıyla tamamlandı
Görev yapıları servis ve test günlüklerini içerir
Her şey güzel gibi görünüyor ama bir nüans var. Entegrasyon testleri çalışırken işlem hattı zorla iptal edilebilir; bu durumda konteynerlerin çalıştırılması durdurulmaz. Zaman zaman koşucuyu temizlemeniz gerekir. Ne yazık ki GitLab CE'deki iyileştirme görevi hala devam ediyor
Ancak bir görevin başlatılmasını bir programa göre ekledik ve kimse onu manuel olarak çalıştırmamızı yasaklamıyor.
Projemize gidin -> CI/CD -> Zamanlamalar ve görevi çalıştırın Clean runner
Toplam:
- Bir mermi koşucumuz var.
- Görevler ve çevre arasında herhangi bir çatışma yoktur.
- Entegrasyon testleri ile görevleri paralel olarak yürütüyoruz.
- Entegrasyon testlerini yerel olarak veya bir kapsayıcıda çalıştırabilirsiniz.
- Servis ve test günlükleri toplanır ve işlem hattı görevine eklenir.
- Runner'ı eski Docker imajlarından temizlemek mümkündür.
Kurulum süresi ~2 saattir.
Aslında hepsi bu. Geri bildirim almaktan memnuniyet duyacağım.
Kaynak: habr.com