Apidog CLI 설치 및 실행

Apidog CLI는 명령줄에서 Apidog 테스트 시나리오를 실행하도록 설계되었습니다. Apidog CLI를 사용하려면 먼저 Node.js를 설치한 다음 Apidog CLI를 설치하십시오. 그런 다음 테스트 시나리오를 실행하실 수 있습니다.

필수 조건

시스템에 Node.js v16 이상이 설치되어 있어야 합니다.

npm(Node Package Manager)이 설치되어 있어야 합니다.

테스트 시나리오가 생성된 Apidog 계정이 있어야 합니다.

Apidog CLI 설치

Apidog CLI는 Node.js 기반으로 구축되었습니다. Apidog CLI를 실행하려면 사용하기 전에 Node.js를 설치해 주십시오.

Apidog CLI는 Node.js 버전 v16 이상에 의존합니다.

시스템에 npm을 통해 Apidog CLI를 전역으로 설치하면 어디서든 실행할 수 있습니다.

다음은 Apidog CLI가 성공적으로 설치되었는지 확인하는 몇 가지 명령어입니다.

성공적으로 설치된 경우, 위 명령어를 실행하면 버전 번호와 설치 경로가 바로 출력됩니다.

버전 번호와 경로가 포함된 성공적인 Apidog CLI 설치를 보여 주는 터미널 출력

Apidog CLI 업데이트

아래 명령어를 사용하여 Apidog CLI를 업그레이드하십시오.

Apidog CLI 실행

Apidog CLI를 사용하여 테스트 시나리오를 실행하려면 먼저 테스트 시나리오를 생성하고 구성해야 합니다. 그런 다음 시각적 인터페이스에서 실행하는 것과 마찬가지로 Apidog CLI를 사용하여 명령줄에서 테스트 시나리오를 실행하고 테스트 보고서를 받을 수 있습니다.

Apidog CLI는 두 가지 실행 방식을 지원합니다.

온라인 데이터로 실행: 라이브 시나리오에 적합합니다.

내보낸 테스트 시나리오로 실행: 오프라인 시나리오에 적합합니다.

온라인 데이터를 실시간으로 실행

테스트 시나리오에서 CI/CD 탭으로 전환하십시오.

환경, 테스트 데이터, 반복 횟수, 지연 등을 구성하십시오.

CI/CD 제공자 섹션에서 "Command line"을 선택하십시오.

"Add access token" 버튼을 클릭한 다음 "Generate token"을 클릭하십시오.

access token에 대해 자세히 알아보십시오.

명령어를 클릭하여 복사하십시오.

명령줄에 명령어를 붙여넣고 실행하십시오. 그러면 명령줄에서 테스트 보고서를 받을 수 있습니다.

2단계에서 설정한 구성은 CLI에서 사용되는 옵션과 값을 자동으로 결정합니다.

환경: -e <environmentId>에 매핑됩니다.

테스트 데이터: -d <testDataId>에 매핑됩니다.

반복 횟수: -n <n>에 매핑됩니다.

지연: --delay-request <n>에 매핑됩니다.

환경/전역 변수: Export current value and use it을 선택하면, 프로젝트의 환경/전역 변수 현재 값을 파일로 내보내기 위한 내보내기 옵션을 아래에서 확인할 수 있습니다. 이는 --variables <path>에 영향을 줍니다. CLI를 실행하는 머신으로 이 파일을 가져온 다음 --variables <path>를 통해 해당 경로를 지정해야 합니다. "Use initial value"와 "Export current value and use it"의 차이점에 대해 여기에서 자세히 알아보십시오.

테스트 시나리오가 로컬에 저장된 데이터베이스 연결 구성도 사용하는 경우, 제품 인터페이스에서 이러한 구성을 로컬 파일로 내보내도록 안내하며, 이는 --database-connection <path>에 영향을 줍니다. 그런 다음 내보낸 이 파일을 CLI를 실행하는 머신으로 가져오고 --database-connection <path>에 해당 경로를 지정해야 합니다.

내보낸 데이터 실행

이 옵션을 사용하면 내보낸 파일을 사용하여 로컬에서 오프라인 테스트를 실행할 수 있습니다.

테스트 시나리오에서 CI/CD 탭으로 전환하십시오.

환경, 테스트 데이터, 반복 횟수, 지연 등을 구성하십시오.

CI/CD 제공자에서 "Command line"을 선택한 다음 "Run exported data"로 전환하십시오.

테스트 시나리오를 JSON 파일로 내보내십시오.

아래에 표시된 명령어를 복사하십시오.

명령줄에 명령어를 붙여넣고 실행하십시오. 명령줄 테스트 보고서를 받게 됩니다.

2단계의 설정("Run Online Data" 등)은 아래 CLI에서 사용되는 옵션과 값에 자동으로 영향을 줍니다. 이 방식으로 실행할 때 환경/전역 변수는 테스트 시나리오와 함께 내보낸 파일의 값을 사용한다는 점에 유의하십시오. 여기에서 자세히 알아보십시오.

CLI 테스트 보고서

CLI를 실행한 후에는 테스트 시나리오의 실행 통계와 실패한 요청에 대한 검증 및 어서션이 포함된 명령줄 테스트 보고서를 받게 됩니다.

CLI를 실행한 폴더에서 /apidog-reports/ 디렉터리도 찾을 수 있습니다. 이 디렉터리에는 HTML 형식의 CLI 테스트 보고서가 포함되어 있습니다.

옵션

Apidog CLI는 컬렉션 실행을 사용자 지정할 수 있는 다양한 옵션을 제공합니다. Apidog CLI Options에서 자세히 알아보십시오.

CI/CD와 함께 Apidog CLI 사용

Apidog CLI는 Jenkins, GitLab, GitHub Actions 등 다양한 파이프라인 도구와의 통합을 지원합니다. CI/CD 통합에 대해 자세히 알아보십시오.

Apidog CLI 설치 및 실행

필수 조건#

Apidog CLI 설치#

Apidog CLI 업데이트#

Apidog CLI 실행#

온라인 데이터를 실시간으로 실행#

내보낸 데이터 실행#

CLI 테스트 보고서#

옵션#

CI/CD와 함께 Apidog CLI 사용#

필수 조건

Apidog CLI 설치

Apidog CLI 업데이트

Apidog CLI 실행

온라인 데이터를 실시간으로 실행

내보낸 데이터 실행

CLI 테스트 보고서

옵션

CI/CD와 함께 Apidog CLI 사용