Artikel ini akan menarik bagi penguji dan pengembang, tetapi ditujukan terutama untuk spesialis otomasi yang menghadapi masalah dalam menyiapkan GitLab CI/CD untuk pengujian integrasi dalam kondisi sumber daya infrastruktur yang tidak mencukupi dan/atau tidak adanya wadah platform orkestrasi. Saya akan memberi tahu Anda cara mengatur penerapan lingkungan pengujian menggunakan docker composer pada satu shell runner GitLab dan agar saat menerapkan beberapa lingkungan, layanan yang diluncurkan tidak saling mengganggu.
kadar
Предпосылки
-
Dalam praktik saya, sering kali pengujian integrasi “ditangani” pada proyek. Dan seringkali masalah pertama dan paling signifikan adalah pipeline CI, tempat pengujian integrasi sedang dikembangkan layanan dilakukan di lingkungan pengembang/panggung. Hal ini menyebabkan beberapa masalah:
- Karena cacat pada layanan tertentu selama pengujian integrasi, rangkaian pengujian mungkin rusak karena data yang rusak. Ada kalanya pengiriman permintaan dengan format JSON yang rusak menyebabkan layanan crash, sehingga stand tidak dapat dioperasikan sepenuhnya.
- Perlambatan rangkaian pengujian seiring dengan bertambahnya data pengujian. Saya pikir tidak masuk akal untuk menjelaskan contoh pembersihan/pengembalian database. Dalam praktik saya, saya belum pernah menemukan proyek yang prosedurnya berjalan lancar.
- Risiko mengganggu fungsi sirkuit pengujian saat menguji pengaturan sistem secara umum. Misalnya, kebijakan pengguna/grup/kata sandi/aplikasi.
- Data pengujian dari pengujian otomatis mempersulit penguji manual.
Beberapa orang akan mengatakan bahwa tes otomatis yang baik harus membersihkan datanya sendiri. Saya mempunyai argumen yang menentang:
- Stand dinamis sangat nyaman digunakan.
- Tidak semua objek dapat dihapus dari sistem melalui API. Misalnya, panggilan untuk menghapus suatu objek tidak dilaksanakan karena bertentangan dengan logika bisnis.
- Saat membuat objek melalui API, sejumlah besar metadata dapat dibuat, sehingga sulit untuk dihapus.
- Jika pengujian memiliki ketergantungan satu sama lain, maka proses pembersihan data setelah menjalankan pengujian menjadi memusingkan.
- Panggilan tambahan (dan, menurut saya, tidak dibenarkan) ke API.
- Dan argumen utamanya: ketika data pengujian mulai dihapus langsung dari database. Ini berubah menjadi sirkus PK/FK sungguhan! Kami mendengar dari pengembang: “Saya baru saja menambahkan/menghapus/mengganti nama sebuah tanda, mengapa 100500 pengujian integrasi tertangkap?”
Menurut saya, solusi paling optimal adalah lingkungan yang dinamis.
- Banyak orang menggunakan docker-compose untuk menjalankan lingkungan pengujian, namun hanya sedikit orang yang menggunakan docker-compose saat melakukan pengujian integrasi di CI/CD. Dan di sini saya tidak memperhitungkan kubernet, gerombolan, dan platform orkestrasi kontainer lainnya. Tidak semua perusahaan memilikinya. Alangkah baiknya jika docker-compose.yml bersifat universal.
- Meskipun kita memiliki QA runner sendiri, bagaimana kita dapat memastikan bahwa layanan yang diluncurkan melalui docker-compose tidak saling mengganggu?
- Bagaimana cara mengumpulkan log layanan yang diuji?
- Bagaimana cara membersihkan pelari?
Saya memiliki pelari GitLab sendiri untuk proyek saya dan saya menemui pertanyaan-pertanyaan ini selama pengembangan untuk . Lebih tepatnya, saat menjalankan pengujian integrasi. Di bawah ini kami akan menyelesaikan masalah ini menggunakan contoh dari proyek ini.
Pelari GitLab Shell
Bagi seorang pelari, saya merekomendasikan mesin virtual Linux dengan 4 vCPU, RAM 4 GB, HDD 50 GB.
Ada banyak informasi tentang pengaturan gitlab-runner di Internet, secara singkat:
- Masuk ke mesin melalui SSH
-
Jika Anda memiliki RAM kurang dari 8 GB, saya sarankan agar OOM killer tidak datang dan mematikan tugas kita karena kekurangan RAM. Hal ini dapat terjadi ketika lebih dari 5 tugas diluncurkan secara bersamaan. Tugas akan berjalan lebih lambat, namun pasti.
Contoh dengan OOM killer
Jika Anda melihatnya di log tugas
bash: line 82: 26474 Killed, lalu jalankan saja pada 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:0kBDan jika gambarnya terlihat seperti ini, tambahkan swap atau tambahkan RAM.
- Mengatur , , , buat.
- Menambahkan pengguna
gitlab-runnerke grupdockersudo groupadd docker sudo usermod -aG docker gitlab-runner - pelari gitlab.
-
Terbuka untuk diedit
/etc/gitlab-runner/config.tomldan tambahkanconcurrent=20 [[runners]] request_concurrency = 10Ini akan memungkinkan Anda menjalankan tugas paralel pada satu pelari. Baca selengkapnya .
Jika Anda memiliki mesin yang lebih bertenaga, misalnya 8 vCPU, RAM 16 GB, maka angka ini bisa dibuat minimal 2 kali lebih besar. Tapi itu semua tergantung apa sebenarnya yang akan diluncurkan pada runner ini dan dalam jumlah berapa.
Itu sudah cukup.
Mempersiapkan buruh pelabuhan-compose.yml
Tugas utamanya adalah docker-compose.yml universal, yang dapat digunakan oleh pengembang/penguji baik secara lokal maupun di pipeline CI.
Pertama-tama, kami membuat nama layanan unik untuk CI. Salah satu variabel unik di GitLab CI adalah variabel CI_JOB_ID. Jika Anda menentukan container_name dengan makna "service-${CI_JOB_ID:-local}", maka dalam kasus ini:
- jika
CI_JOB_IDtidak didefinisikan dalam variabel lingkungan,
maka nama layanannya adalahservice-local - jika
CI_JOB_IDdidefinisikan dalam variabel lingkungan (misalnya 123),
maka nama layanannya adalahservice-123
Kedua, kami membuat jaringan umum untuk layanan yang diluncurkan. Ini memberi kita isolasi tingkat jaringan saat menjalankan beberapa lingkungan pengujian.
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}Sebenarnya ini adalah langkah awal menuju sukses =)
Contoh docker-compose.yml saya dengan komentar
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:
- defaultContoh yang dijalankan secara 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 ... doneNamun tidak semuanya sesederhana itu dengan peluncuran di CI.
Mempersiapkan Makefile
Saya menggunakan Makefile karena sangat nyaman untuk manajemen lingkungan lokal dan CI. Lebih banyak 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
Memeriksa
membuat buruh pelabuhan
$ 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
membuat log buruh pelabuhan
$ 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
Mempersiapkan .gitlab-ci.yml
Menjalankan tes 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 daysSebagai hasil dari menjalankan tugas seperti itu, direktori log di artefak akan berisi log layanan dan pengujian. Yang sangat berguna jika terjadi kesalahan. Setiap tes secara paralel menulis lognya sendiri, tetapi saya akan membicarakannya secara terpisah.
Membersihkan pelari
Tugas akan diluncurkan hanya sesuai jadwal.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanSelanjutnya, buka proyek GitLab kami -> CI/CD -> Jadwal -> Jadwal Baru dan tambahkan jadwal baru
Hasil
Meluncurkan 4 tugas di GitLab CI
Dalam log tugas terakhir dengan pengujian integrasi, kami melihat kontainer dari berbagai tugas
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-204553539Catatan lebih detail
$ 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-204553539Semua tugas berhasil diselesaikan
Artefak tugas berisi log layanan dan pengujian
Segalanya tampak indah, tetapi ada nuansanya. Pipeline dapat dibatalkan secara paksa saat pengujian integrasi sedang berjalan, sehingga container yang sedang berjalan tidak akan dihentikan. Dari waktu ke waktu Anda perlu membersihkan pelari. Sayangnya, tugas perbaikan di GitLab CE masih berstatus
Namun kami telah menambahkan peluncuran tugas sesuai jadwal, dan tidak ada yang melarang kami menjalankannya secara manual.
Buka proyek kami -> CI/CD -> Jadwal dan jalankan tugas Clean runner
Total:
- Kami memiliki satu pelari shell.
- Tidak ada konflik antara tugas dan lingkungan.
- Kami menjalankan tugas dengan pengujian integrasi secara paralel.
- Anda dapat menjalankan pengujian integrasi baik secara lokal atau dalam container.
- Log layanan dan pengujian dikumpulkan dan dilampirkan ke tugas alur.
- Dimungkinkan untuk membersihkan runner dari image Docker lama.
Waktu pengaturan adalah ~2 jam.
Sebenarnya itu saja. Saya akan dengan senang hati menerima masukan.
Sumber: www.habr.com