사전 요구 사항#
Jenkins가 설치되어 실행 중이어야 합니다(v2.0 이상 권장).
Jenkins 호스트에 Node.js v16 이상이 설치되어 있어야 합니다.
테스트 시나리오가 생성된 Apidog 계정이 있어야 합니다.
Apidog 액세스 토큰을 생성할 수 있는 권한이 있어야 합니다.
Jenkins 설치하기#
Jenkins는 소프트웨어 개발 과정에서 개발자가 애플리케이션의 빌드 프로세스, 테스트 및 배포를 자동화할 수 있도록 지원하는 자동화 빌드 도구입니다. Linux 시스템에 Jenkins를 설치하는 방법은 다음과 같습니다.2.
Jenkins 소스를 APT 소프트웨어 소스 목록에 추가합니다.
http://localhost:8080 또는 http://{your_public_IP}:8080을 입력하여 Jenkins 대시보드에 접근합니다. 콘솔은 Jenkins 서비스를 관리하고 구성할 수 있는 웹 API를 제공합니다.Jenkins용 Node.js 환경 구성하기#
Apidog CLI를 실행하기 전에 Node.js 버전 번호가 v16 이상인지 확인해야 하므 로, 먼저 Jenkins 환경에서 NodeJS 종속성을 구성해야 합니다.
1.
Jenkins 플러그인 관리를 열고 NodeJS 플러그인을 찾아 설치한 다음 다시 시작합니다.
2.
전역 도구 구성에서 새 NodeJS를 생성하고, 버전 번호(v16 이상 필요)와 패키지 이름 apidog-cli를 구성합니다.
1.
시각적 파이프라인(Freestyle Project)에 구성을 추가합니다.
2.
임베디드 코드를 파이프라인(Pipeline)에 통합합니다.
CLI 명령 실행하기#
파이프라인을 시각적으로 구성하기#
Apidog를 열고 지속적 통합 상세 페이지에서 CLI 명령을 가져옵니다. Jenkins 환경에서 인터넷에 접근할 수 있는 경우, "Run online data in real time" 명령을 사용하도록 선택할 수 있습니다. 인터넷 접근이 불가능한 경우, 먼저 CLI JSON 데이터 파일을 환경으로 내보낸 다음 CLI를 통해 실행해야 합니다.프로젝트 구성 페이지에서 Build Environment 섹션을 찾아 "Provide Node & npm bin/ folder to PATH" 옵션을 선택하고, Global Tool Configuration (Tools) 섹션에서 구성한 NodeJS 버전(예: nodejs18)을 선택합니다.빌드 환경 설정을 완료한 후 Build Steps 섹션으로 이동하여 Add build step을 클릭하고 Execute Shell을 선택합니다(Windows 시스템을 사용하는 경우 Execute Windows Batch Command를 선택하십시오).Apidog CLI 명령을 Command 입력 상자에 붙여넣고 구성을 저장합니다.프로젝트에서 Build Now를 클릭하여 실행을 시작합니다."Build History"에서 빌드 진행 상황과 결과를 확인할 수 있습니다.임베디드 코드를 파이프라인에 통합하기#
CI/CD 탭으로 이동하여 임베디드 코드 스니펫을 복사한 다음 Jenkins 구성 파일에 붙여넣습니다.코드를 Jenkins 파이프라인 구성에 직접 붙여넣기만 하면 기존 CI/CD 워크플로에 임베드할 수 있습니다.여기서 언급된 nodejs18은 이전에 설정한 NodeJS 별칭을 의미하므로 실제 별칭으로 바꾸십시오. 또한 코드의 변수 $APIDOG_ACCESS_TOKEN을 실제 Access Token으로 바꾸어야 합니다. 또는 Jenkins의 Dashboard → Manage Jenkins → System에서 APIDOG_ACCESS_TOKEN이라는 환경 변수를 추가하고, 해당 값을 Access Token으로 설정할 수 있습니다. 이렇게 하면 파이프라인이 실행 중에 Access Token을 읽을 수 있습니다.Apidog CLI 설치 스크립트를 제거하여 위 코드를 간소화할 수 있습니다. 이렇게 하면 빌드가 실행될 때마다 apidog-cli를 다시 설치할 필요가 없으므로 빌드 시간과 리소스 사용량을 모두 줄일 수 있습니다. 이는 NodeJS와 전역 npm 패키지(즉, apidog-cli)가 **Global Tool Configuration (Tools)**에서 사전에 이미 구성되어 있어, 빌드 프로세스 중 필요한 도구를 즉시 사용할 수 있기 때문에 가능합니다.프로젝트에서 Build Now를 클릭하여 실행을 시작합니다.Jenkins로 보고서 게시하기#
명령에서 생성된 보고서 이름 ${JOB_NAME}_${BUILD_NUMBER}(Jenkins 내장 변수)를 지정합니다. 보고서를 보려면 HTML Publisher 플러그인을 사용하십시오.