Acionar teste por commit do Git

Você pode acionar automaticamente testes automatizados do Apidog por meio de eventos de commit do Git (como push, pull request) sem nenhuma intervenção manual. Este recurso funciona em qualquer plataforma de CI/CD, incluindo GitHub Actions, Jenkins, GitLab CI e outras.

Princípio central: acionamento por evento + execução de comando da CLI

Acionar automaticamente testes do Apidog após um commit do Git se baseia em um princípio universal:

Seja por meio de um Webhook ou do listener de eventos integrado fornecido pela plataforma de CI/CD (por exemplo, on: push no GitHub Actions), a essência é a mesma:
monitorar eventos de commit do Git e executar o comando de teste do Apidog.

Desde que seu ambiente de CI/CD possa responder a commits do Git e executar um script de linha de comando, você pode integrar testes automatizados do Apidog.

Em geral, há dois mecanismos de acionamento:

1. Mecanismos de eventos integrados (por exemplo, GitHub Actions, GitLab CI)

O GitHub Actions, por exemplo, fornece uma configuração de evento como:

Este método não exige configuração de Webhook. A plataforma monitora eventos internamente e é uma abordagem leve.

2. Webhooks externos (por exemplo, Jenkins, serviços auto-hospedados)

Ao usar o Jenkins ou configurações entre plataformas, normalmente você precisa configurar Webhooks manualmente.

Exemplos comuns de integração com CI/CD

Acionamento de testes automatizados por meio de mecanismos de eventos integrados:

Integrar com o GitHub Actions

Integrar com o GitLab

Exemplo de integração entre plataformas: GitHub Actions + Jenkins

Cenário

O repositório de código está hospedado no GitHub

O ambiente de execução do pipeline é o Jenkins

Use GitHub Webhook para acionar o pipeline do Jenkins

Execute apidog run no Jenkins para executar testes automatizados do Apidog

Etapa 1: Configurar o projeto do Jenkins

Consulte Integrar com o Jenkins para criar um projeto e configurá-lo com sucesso.

Interface de configuração do projeto Jenkins

Etapa 2: Obter a URL do Webhook

A URL do Webhook é o ponto de entrada que o Jenkins usa para receber requisições externas e acionar pipelines. Você pode obter essa URL de várias maneiras, como usando o plugin Generic Webhook Trigger.

No Jenkins Plugin Manager, pesquise e instale o plugin "Generic Webhook Trigger". Reinicie o Jenkins após a instalação.

Gerenciador de plugins do Jenkins mostrando o plugin Generic Webhook Trigger

No Jenkins Dashboard, selecione seu projeto e acesse Configure. Habilite Generic Webhook Trigger.
A URL do Webhook é: http://<your Jenkins host>/generic-webhook-trigger/invoke