この記事はテスターと開発者の両方にとって興味深いものですが、主にインフラストラクチャ リソースが不十分な状況やコンテナ オーケストレーションがない状況で統合テスト用に GitLab CI/CD をセットアップするという問題に直面している自動化スペシャリストを対象としています。プラットホーム。 単一の GitLab シェル ランナー上で docker compose を使用してテスト環境のデプロイメントをセットアップし、複数の環境をデプロイするときに起動されたサービスが互いに干渉しないようにする方法を説明します。
ページ内容
前提条件
-
私の実務では、プロジェクトで統合テストが「処理」されることがよくありました。 そして多くの場合、最初の最も重要な問題は CI パイプラインです。 開発中 サービスは開発/ステージング環境で実行されます。 これにより、かなり多くの問題が発生しました。
- 統合テスト中の特定のサービスの欠陥により、テスト回路が壊れたデータによって損傷を受ける可能性があります。 壊れた JSON 形式でリクエストを送信するとサービスがクラッシュし、スタンドが完全に動作不能になる場合がありました。
- テストデータが増加するにつれてテスト回路の速度が低下します。 データベースのクリーニング/ロールバックの例を説明するのは意味がないと思います。 私の実務では、この手順がスムーズに進んだプロジェクトに遭遇したことがありません。
- 一般的なシステム設定をテストするときに、テスト回路の機能が中断されるリスク。 たとえば、ユーザー/グループ/パスワード/アプリケーション ポリシーなどです。
- 自動テストからのテストデータは、手動テスターの作業を困難にします。
優れた自動テストでは、自動テスト自体の後にデータをクリーンアップする必要があると言う人もいます。 私には次のような反論があります。
- ダイナミックスタンドはとても使いやすいです。
- すべてのオブジェクトを API 経由でシステムから削除できるわけではありません。 たとえば、オブジェクトを削除する呼び出しは、ビジネス ロジックに矛盾するため実装されませんでした。
- API 経由でオブジェクトを作成すると、大量のメタデータが作成される可能性があるため、削除するのが困難になります。
- テスト間に依存関係がある場合、テストの実行後にデータをクリーンアップするプロセスが頭痛の種になります。
- API への追加の (そして、私の意見では正当化されていない) 呼び出し。
- そして主な議論は、テストデータがデータベースから直接消去され始める時期です。 これは本物の PK/FK サーカスと化しています! 開発者からは、「標識を追加/削除/名前変更したばかりなのに、なぜ 100500 個の統合テストが引っかかってしまったのでしょうか?」という声が聞かれます。
私の意見では、最も最適なソリューションは動的な環境です。
- テスト環境を実行するために docker-compose を使用する人は多くいますが、CI/CD で統合テストを実行するときに docker-compose を使用する人はほとんどいません。 ここでは、kubernetes、swarm、その他のコンテナ オーケストレーション プラットフォームは考慮していません。 すべての企業がそれらを持っているわけではありません。 docker-compose.yml がユニバーサルであれば良いのですが。
- 独自の QA ランナーがあるとしても、docker-compose 経由で起動されたサービスが相互に干渉しないようにするにはどうすればよいでしょうか?
- テストされたサービスのログを収集するにはどうすればよいですか?
- ランナーの掃除方法は？
私は自分のプロジェクト用に独自の GitLab ランナーを持っていますが、開発中に次のような質問に遭遇しました。 のために 。 より正確には、統合テストを実行するとき。 以下では、このプロジェクトの例を使用してこれらの問題を解決します。
GitLab シェルランナー
ランナーには、4 vCPU、4 GB RAM、50 GB HDD を搭載した Linux 仮想マシンをお勧めします。
gitlab-runner のセットアップに関する情報はインターネット上にたくさんありますので、簡単に説明します。
- SSH経由でマシンにログインします
-
RAM が 8 GB 未満の場合は、 RAM 不足のために OOM キラーが来てタスクを強制終了しないようにするためです。 これは、5 つを超えるタスクが同時に起動された場合に発生する可能性があります。 タスクはよりゆっくりと、しかし着実に進んでいきます。
OOMキラーを使用した例
タスクログに次のことが表示された場合
bash: line 82: 26474 Killed後はランナー上で実行するだけですsudo 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:0kB画像が次のようになった場合は、スワップを追加するか RAM を追加してください。
- セット , , 、作る。
- ユーザーの追加
gitlab-runnerグループにdockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab ランナー。
-
編集用に開く
/etc/gitlab-runner/config.tomlそして追加しますconcurrent=20 [[runners]] request_concurrency = 10これにより、XNUMX つのランナーで並列タスクを実行できるようになります。 続きを読む .
8 vCPU、16 GB RAM など、より強力なマシンを使用している場合は、これらの数値を少なくとも 2 倍大きくすることができます。 しかし、それはすべて、このランナーで正確に何が、そしてどのくらいの量で発射されるかによって異なります。
それは十分です。
docker-compose.ymlの準備
主なタスクはユニバーサル docker-compose.yml で、開発者/テスターはローカルと CI パイプラインの両方で使用できます。
まず、CI に独自のサービス名を付けます。 GitLab CI の一意な変数の XNUMX つは次の変数です。 CI_JOB_ID。 指定する場合 container_name 意味のある "service-${CI_JOB_ID:-local}"、その場合は次のようになります。
- 場合
CI_JOB_ID環境変数で定義されていない、
サービス名は次のようになりますservice-local - 場合
CI_JOB_ID環境変数で定義されているもの (例: 123)、
サービス名は次のようになりますservice-123
次に、立ち上げたサービスの共通ネットワークを構築します。 これにより、複数のテスト環境を実行するときにネットワーク レベルでの分離が実現します。
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}実際、これが成功への第一歩です =)
コメントを含む docker-compose.yml の例
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:
- defaultローカル実行の例
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 ... doneただし、CI での起動はすべてがそれほど単純であるわけではありません。
メイクファイルの準備
Makefile はローカル環境の管理にも CI にも非常に便利なので、私は Makefile を使用しています。 その他のオンラインコメント
# У меня в проектах все вспомогательные вещи лежат в директории `.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
チェック中
ドックアップを作る
$ 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
docker ログを作成する
$ 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 の準備
統合テストの実行
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 daysこのようなタスクを実行すると、アーティファクト内のログ ディレクトリにサービス ログとテスト ログが含まれます。 エラーが発生した場合に非常に便利です。 並行して各テストは独自のログを書き込みますが、これについては個別に説明します。
ランナーの掃除
タスクはスケジュールに従ってのみ起動されます。
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-clean次に、GitLab プロジェクト -> CI/CD -> スケジュール -> 新しいスケジュールに移動し、新しいスケジュールを追加します。
結果
GitLab CI で 4 つのタスクを起動する
統合テストを含む最後のタスクのログには、さまざまなタスクからのコンテナーが表示されます。
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-204553539より詳細なログ
$ 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-204553539すべてのタスクが正常に完了しました
タスク アーティファクトにはサービス ログとテスト ログが含まれます
すべてが美しいように見えますが、ニュアンスがあります。 統合テストの実行中にパイプラインを強制的にキャンセルできます。この場合、実行中のコンテナーは停止されません。 時々、ランナーを掃除する必要があります。 残念ながら、GitLab CE の改善課題はまだ残っています。
しかし、私たちはスケジュールに従ってタスクを起動する機能を追加しており、それを手動で実行することを誰も禁じていません。
プロジェクト -> CI/CD -> スケジュールに移動し、タスクを実行します Clean runner
合計：
- シェルランナーはXNUMXつあります。
- タスクと環境の間に競合はありません。
- 統合テストを伴うタスクを並行して実行します。
- 統合テストはローカルまたはコンテナーで実行できます。
- サービスおよびテストのログが収集され、パイプライン タスクに添付されます。
- 古い Docker イメージからランナーをクリーンアップすることができます。
セットアップ時間は約 2 時間です。
実はそれだけです。 フィードバックをいただければ幸いです。
出所： habr.com