Git 커밋으로 테스트 트리거하기

수동 개입 없이 Git 커밋 이벤트(예: push, pull request)를 통해 Apidog 자동화 테스트를 자동으로 트리거할 수 있습니다. 이 기능은 GitHub Actions, Jenkins, GitLab CI 등 모든 CI/CD 플랫폼에서 작동합니다.

핵심 원리: 이벤트 트리거 + CLI 명령 실행

Git 커밋 후 Apidog 테스트를 자동으로 트리거하는 것은 보편적인 원리를 기반으로 합니다.

Webhook을 통해서든, CI/CD 플랫폼에서 제공하는 기본 제공 이벤트 리스너를 통해서든 (예: GitHub Actions의 on: push), 핵심은 동일합니다.
Git 커밋 이벤트를 모니터링하고 Apidog의 테스트 명령을 실행하는 것입니다.

CI/CD 환경이 Git 커밋에 응답하고 명령줄 스크립트를 실행할 수 있기만 하면 Apidog 자동화 테스트를 통합할 수 있습니다.

일반적으로 두 가지 트리거 메커니즘이 있습니다.

1. 기본 제공 이벤트 메커니즘(예: GitHub Actions, GitLab CI)

예를 들어 GitHub Actions는 다음과 같은 이벤트 구성을 제공합니다.

이 방법은 Webhook 구성이 필요하지 않습니다. 플랫폼이 내부적으로 이벤트를 모니터링하며, 가벼운 접근 방식입니다.

2. 외부 Webhook(예: Jenkins, 자체 호스팅 서비스)

Jenkins 또는 크로스 플랫폼 설정을 사용하는 경우 일반적으로 Webhook을 수동으로 구성해야 합니다.

일반적인 CI/CD 통합 예시

기본 제공 이벤트 메커니즘을 통해 자동화 테스트 트리거하기:

Github Actions와 통합하기

Gitlab과 통합하기

크로스 플랫폼 통합 예시: GitHub Actions + Jenkins

시나리오

코드 저장소는 GitHub에 호스팅됩니다.

파이프라인 실행 환경은 Jenkins입니다.

GitHub Webhook을 사용하여 Jenkins 파이프라인을 트리거합니다.

Jenkins에서 apidog run을 실행하여 Apidog 자동화 테스트를 실행합니다.

1단계: Jenkins 프로젝트 구성

프로젝트를 생성하고 성공적으로 구성하려면 Jenkins와 통합하기를 참조하십시오.

2단계: Webhook URL 가져오기

Webhook URL은 Jenkins가 외부 요청을 수신하고 파이프라인을 트리거하는 데 사용하는 진입점입니다. Generic Webhook Trigger 플러그인을 사용하는 등 여러 방법으로 이 URL을 얻을 수 있습니다.

Jenkins Plugin Manager에서 "Generic Webhook Trigger" 플러그인을 검색하여 설치하십시오. 설치 후 Jenkins를 다시 시작하십시오.

Generic Webhook Trigger 플러그인을 표시하는 Jenkins 플러그인 관리자

Jenkins Dashboard에서 프로젝트를 선택하고 Configure로 이동하십시오. Generic Webhook Trigger를 활성화하십시오.
Webhook URL은 다음과 같습니다. http://<your Jenkins host>/generic-webhook-trigger/invoke

토큰을 정의할 수도 있습니다. Webhook URL은 다음과 같이 됩니다.
http://<your Jenkins host>/generic-webhook-trigger/invoke?token=<xxxxxx>

저장한 후 Webhook URL을 복사하십시오. 이 url은 Jenkins 테스트 실행을 트리거하는 데 사용됩니다.

3단계: GitHub Webhook 구성

"GitHub repository → Settings → Webhooks → Add webhook"으로 이동하십시오.

Payload URL: http://<your Jenkins host>/generic-webhook-trigger/invoke?token=<xxxxxx>

Content type: application/json

Secret: 선택 사항

Which events would you like to trigger this webhook? Just the push event 또는 다른 트리거 이벤트를 선택하십시오.

"Add webhook"을 클릭하십시오.

이제 코드가 push될 때마다 Jenkins가 자동으로 트리거되어 구성된 테스트 작업을 실행합니다.

결과 확인

GitHub 저장소에 코드를 push하십시오.

Jenkins가 즉시 빌드를 시작합니다.

Jenkins에서 콘솔 출력과 테스트 결과를 확인하십시오.

일반 플랫폼의 Webhook 문서

Git 커밋으로 테스트 트리거하기

핵심 원리: 이벤트 트리거 + CLI 명령 실행#

일반적인 CI/CD 통합 예시#

크로스 플랫폼 통합 예시: GitHub Actions + Jenkins#

시나리오#

1단계: Jenkins 프로젝트 구성#

2단계: Webhook URL 가져오기#

3단계: GitHub Webhook 구성#

결과 확인#

일반 플랫폼의 Webhook 문서#