Este artigo será de interesse tanto para testadores quanto para desenvolvedores, mas é destinado principalmente a especialistas em automação que enfrentam o problema de configurar CI/CD GitLab para testes de integração em condições de recursos de infraestrutura insuficientes e/ou ausência de um contêiner plataforma de orquestração. Vou lhe dizer como configurar a implantação de ambientes de teste usando docker compose em um único executor de shell GitLab e para que, ao implantar vários ambientes, os serviços em execução não interfiram entre si.
Conteúdo
Pré-requisitos
-
Na minha prática, muitas vezes acontecia que os testes de integração eram “tratados” nos projetos. E muitas vezes o primeiro e mais significativo problema é o pipeline de CI, no qual os testes de integração sendo desenvolvido o(s) serviço(s) é(ão) realizado(s) em um ambiente de desenvolvimento/estágio. Isso causou alguns problemas:
- Devido a defeitos em um serviço específico durante o teste de integração, o circuito de teste pode ser danificado por dados quebrados. Houve casos em que o envio de uma solicitação com formato JSON quebrado travava o serviço, o que tornava o estande totalmente inoperante.
- Desaceleração do circuito de teste à medida que os dados de teste aumentam. Acho que não faz sentido descrever um exemplo de limpeza/reversão do banco de dados. Na minha prática, não encontrei um projeto em que esse procedimento ocorresse sem problemas.
- Risco de interromper a funcionalidade do circuito de teste ao testar as configurações gerais do sistema. Por exemplo, política de usuário/grupo/senha/aplicativo.
- Os dados de teste de testes automatizados dificultam a vida dos testadores manuais.
Alguns dirão que bons autotestes devem limpar os dados por si próprios. Tenho argumentos contra:
- Os suportes dinâmicos são muito convenientes de usar.
- Nem todos os objetos podem ser removidos do sistema por meio da API. Por exemplo, uma chamada para excluir um objeto não foi implementada porque contradiz a lógica de negócios.
- Ao criar um objeto por meio da API, uma grande quantidade de metadados pode ser criada, cuja exclusão é problemática.
- Se os testes tiverem dependências entre si, o processo de limpeza de dados após a execução dos testes se tornará uma dor de cabeça.
- Chamadas adicionais (e, na minha opinião, não justificadas) para a API.
- E o principal argumento: quando os dados de teste começam a ser apagados diretamente do banco de dados. Isso está se transformando em um verdadeiro circo PK/FK! Ouvimos dos desenvolvedores: “Acabei de adicionar/remover/renomear uma placa, por que 100500 testes de integração foram detectados?”
Na minha opinião, a solução ideal é um ambiente dinâmico.
- Muitas pessoas usam docker-compose para executar um ambiente de teste, mas poucas pessoas usam docker-compose ao realizar testes de integração em CI/CD. E aqui não estou levando em consideração kubernetes, swarm e outras plataformas de orquestração de contêineres. Nem toda empresa os possui. Seria bom se docker-compose.yml fosse universal.
- Mesmo que tenhamos nosso próprio executor de controle de qualidade, como podemos garantir que os serviços iniciados via docker-compose não interfiram uns com os outros?
- Como coletar logs de serviços testados?
- Como limpar o corredor?
Eu tenho meu próprio executor GitLab para meus projetos e encontrei essas questões durante o desenvolvimento para . Mais precisamente, ao executar testes de integração. A seguir resolveremos esses problemas usando exemplos deste projeto.
GitLab Shell Runner
Para um corredor, recomendo uma máquina virtual Linux com 4 vCPU, 4 GB de RAM e 50 GB de HDD.
Há muitas informações sobre como configurar o gitlab-runner na Internet, tão brevemente:
- Faça login na máquina via SSH
-
Se você tiver menos de 8 GB de RAM, recomendo para que o assassino OOM não venha e mate nossas tarefas por falta de RAM. Isto pode acontecer quando mais de 5 tarefas são iniciadas simultaneamente. As tarefas progredirão de forma mais lenta, mas constante.
Exemplo com assassino OOM
Se você vir nos logs de tarefas
bash: line 82: 26474 Killed, então basta executar no corredorsudo 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:0kBE se a imagem for parecida com esta, adicione swap ou adicione RAM.
- Conjunto , , , faço.
- Adicionando um usuário
gitlab-runnerpara o grupodockersudo groupadd docker sudo usermod -aG docker gitlab-runner - gitlab-runner.
-
Aberto para edição
/etc/gitlab-runner/config.tomle adicioneconcurrent=20 [[runners]] request_concurrency = 10Isso permitirá que você execute tarefas paralelas em um executor. Consulte Mais informação .
Se você tiver uma máquina mais potente, por exemplo 8 vCPU, 16 GB de RAM, então esses números podem ser pelo menos 2 vezes maiores. Mas tudo depende do que exatamente será lançado neste corredor e em que quantidade.
Isso é o suficiente.
Preparando docker-compose.yml
A tarefa principal é um docker-compose.yml universal, que os desenvolvedores/testadores podem usar localmente e no pipeline de CI.
Em primeiro lugar, criamos nomes de serviços exclusivos para CI. Uma das variáveis exclusivas no GitLab CI é a variável CI_JOB_ID. Se você especificar container_name com valor "service-${CI_JOB_ID:-local}", então no caso:
- se
CI_JOB_IDnão definido em variáveis de ambiente,
então o nome do serviço seráservice-local - se
CI_JOB_IDdefinido em variáveis de ambiente (por exemplo 123),
então o nome do serviço seráservice-123
Em segundo lugar, criamos uma rede comum para os serviços lançados. Isso nos proporciona isolamento no nível da rede ao executar vários ambientes de teste.
networks:
default:
external:
name: service-network-${CI_JOB_ID:-local}Na verdade, este é o primeiro passo para o sucesso =)
Exemplo do meu docker-compose.yml com comentários
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:
- defaultExemplo de execução local
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 ... doneMas nem tudo é tão simples com o lançamento em CI.
Preparando o Makefile
Eu uso o Makefile porque é muito conveniente tanto para gerenciamento de ambiente local quanto para CI. Mais comentários on-line
# У меня в проектах все вспомогательные вещи лежат в директории `.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
Verificar
fazer 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
fazer 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
Preparando .gitlab-ci.yml
Executando testes de integração
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 daysComo resultado da execução de tal tarefa, o diretório de logs nos artefatos conterá logs de serviço e de teste. O que é muito conveniente em caso de erros. Cada teste escreve seu próprio log em paralelo, mas falarei sobre isso separadamente.
Limpando o corredor
A tarefa será lançada apenas de acordo com um cronograma.
stages:
- clean
- build
- test
Clean runner:
stage: clean
only:
- schedules
tags:
- my-shell-runner
script:
- make docker-cleanEm seguida, vá para nosso projeto GitLab -> CI/CD -> Agendamentos -> Novo agendamento e adicione um novo agendamento
resultado
Lançando 4 tarefas no GitLab CI
Nos logs da última tarefa com testes de integração vemos containers de diferentes tarefas
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-204553539Registro mais detalhado
$ 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-204553539Todas as tarefas concluídas com sucesso
Os artefatos de tarefa contêm logs de serviço e de teste
Tudo parece lindo, mas há uma nuance. O pipeline pode ser cancelado à força enquanto os testes de integração estão em execução; nesse caso, a execução dos contêineres não será interrompida. De vez em quando você precisa limpar o corredor. Infelizmente, a tarefa de melhoria no GitLab CE ainda está em status
Mas adicionamos o lançamento de uma tarefa de acordo com um cronograma e ninguém nos proíbe de executá-la manualmente.
Vá para nosso projeto -> CI/CD -> Agendamentos e execute a tarefa Clean runner
Total:
- Temos um corredor de shell.
- Não há conflitos entre tarefas e o ambiente.
- Executamos tarefas com testes de integração em paralelo.
- Você pode executar testes de integração localmente ou em um contêiner.
- Os logs de serviço e teste são coletados e anexados à tarefa do pipeline.
- É possível limpar o executor de imagens antigas do Docker.
O tempo de configuração é de aproximadamente 2 horas.
Isso é tudo, na verdade. Ficarei feliz em receber feedback.
Fonte: habr.com