명령줄 인터페이스(CLI) 인증

Autify CLI(명령줄 인터페이스)는 텍스트 기반 명령줄을 통해 Autify 서비스와 통신하는 데 사용되는 소프트웨어 애플리케이션입니다. 브라우저를 열지 않고도 Autify와 상호 작용할 수 있으므로 Autify CLI를 사용하여 CI/CD 통합과 같은 자동화된 통합을 쉽게 수행할 수 있습니다.

이 문서에서는 기본 사항부터 포괄적인 명령어 목록까지 Autify CLI에 대해 설명합니다.

시작하기

요약

Autify CLI는 브라우저 UI 대신 Autify 시스템과 인터페이스할 수 있는 또 다른 방법을 제공합니다. 텍스트 기반 명령줄 인터페이스를 통해 Autify와의 통합을 쉽게 자동화할 수 있습니다.

Autify CLI를 사용하려면 먼저 플랫폼에 Autify CLI를 설치해야 합니다. 그런 다음 Autify용 개인 액세스 토큰을 사용하여 CLI에 로그인하고 "테스트 시나리오를 실행하고 완료될 때까지 기다립니다."와 같이 Autify CLI에서 제공하는 고급 명령을 실행할 수 있습니다. 다음 몇 섹션에서 이 과정을 살펴보겠습니다.

설치

홈브루(Linux/macOS), 셸 인스톨러(Linux/macOS) 또는 기본 인스톨러(macOS/Windows)를 통해 Autify CLI를 설치할 수 있습니다. 타르볼에서 직접 설치할 수도 있습니다.

홈브루

Linux 및 macOS 플랫폼의 경우, 홈브루를 사용하여 탭을 사용하여 autify-cli를 설치할 수 있습니다:

brew install autifyhq/tap/autify-cli

또는

brew tap autifyhq/tap
brew install autify-cli

출력 예제입니다:

$ brew install autifyhq/tap/autify-cli
==> Tapping autifyhq/tap
Cloning into '/usr/local/Homebrew/Library/Taps/autifyhq/homebrew-tap'...
remote: Enumerating objects: 19, done.
remote: Counting objects: 100% (19/19), done.
remote: Compressing objects: 100% (15/15), done.
remote: Total 19 (delta 1), reused 19 (delta 1), pack-reused 0
Receiving objects: 100% (19/19), done.
Resolving deltas: 100% (1/1), done.
Tapped 1 formula (16 files, 12.9KB).
==> Cloning https://github.com/autifyhq/autify-cli
Cloning into '/Users/runner/Library/Caches/Homebrew/autify-cli--git'...
==> Checking out revision b03bec6
HEAD is now at b03bec6 Release 0.2.0
==> Installing autify-cli from autifyhq/tap
==> curl https://autify-cli-assets.s3.amazonaws.com/autify-cli/versions/0.2.0/b03bec6/autify-v0.2.0-b03bec6-darwin-arm64.tar.gz | tar xz
🍺  /usr/local/Cellar/autify-cli/0.2.0: 10,082 files, 98.7MB, built in 29 seconds

셸 인스톨러

Linux 및 macOS 플랫폼의 경우 아래 명령어를 통해 셸 인스톨러를 사용할 수 있습니다:

curl https://autify-cli-assets.s3.amazonaws.com/autify-cli/channels/stable/install-standalone.sh | sh

출력 예시입니다:

$ curl https://autify-cli-assets.s3.amazonaws.com/autify-cli/channels/stable/install-standalone.sh | sh
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  2049  100  2049    0     0  10784      0 --:--:-- --:--:-- --:--:-- 10784
This script requires superuser access.
You will be prompted for your password by sudo.
Installing CLI from https://autify-cli-assets.s3.amazonaws.com/autify-cli/channels/stable/autify-linux-x64.tar.xz
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 21.9M  100 21.9M    0     0  2157k      0  0:00:10  0:00:10 --:--:-- 2588k
v16.15.0
autify installed to /usr/local/bin/autify
autify-cli/0.1.0 linux-x64 node-v16.15.0

기본 인스톨러

macOS와 Windows의 경우 기본 인스톨러를 제공합니다.

참고: 아직 제대로 서명되지 않았습니다. 따라서 설치 시 몇 가지 경고가 표시됩니다. 조만간 제대로 서명할 예정입니다.

Tarball

아래 타르볼을 제공합니다:

다음은 Linux(Intel 64비트)용 tar.gz 파일을 다운로드하고 압축을 푸는 예제 명령어입니다:

$ curl -O https://autify-cli-assets.s3.us-west-2.amazonaws.com/autify-cli/channels/stable/autify-linux-x64.tar.gz

$ tar -xzf ./autify-linux-x64.tar.gz

$ ./autify/bin/autify --version
autify-cli/0.1.0 linux-x64 node-v16.15.0

아래와 같이 /path/to/autify/bin/autify를 PATH 환경 변수 중 하나에 연결할 것을 권장합니다:

$ sudo ln -s /path/to/autify/bin/autify /usr/local/bin/autify

참고: /path/to/autify/bin에는 node 실행 파일이 포함됩니다. 따라서 PATH 환경 변수에 /path/to/autify/bin을 추가하면 기존 node 실행 파일보다 우선순위가 지정될 수 있습니다. 그렇기 때문에 /path/to/autify/bin/autify만 링크하는 것이 좋으며, 셸 설치 프로그램에서 바로 이 작업을 수행합니다.

사용법

먼저, {{변수.제품명 웹}} 및/또는 {{변수.제품명 모바일}}에서 개인 액세스 토큰을 생성해야 합니다.

그런 다음 Autify CLI에 로그인할 수 있습니다. 아래 명령을 실행하고 개인 액세스 토큰을 입력합니다:

## Autify NoCode Web
$ autify web auth login
? Enter Access Token **********

## Autify NoCode Mobile
$ autify mobile auth login
? Enter Access Token **********

{{변수.제품 이름 웹}}

이제 이미 만든 테스트 시나리오를 실행해 보겠습니다. 시작하려는 테스트 시나리오 또는 테스트 계획의 URL을 복사합니다(예: https://app.autify.com/projects/000/scenarios/00000). 그런 다음 아래 명령을 실행합니다:

autify web test run --wait <테스트 시나리오 URL>

예제 출력입니다:

$ autify web test run --wait https://app.autify.com/projects/000/scenarios/00000
✅ Successfully started: https://app.autify.com/projects/000/results/000000 (Capability is Linux Chrome 101.0)
🕐 Waiting for the test result: https://app.autify.com/projects/000/results/000000
  ✔ Waiting... (timeout: 300 s)
✅ Test passed!: https://app.autify.com/projects/000/results/000000

$ echo $?
0

이 명령은 기본 기능(Linux/Chrome)으로 테스트 시나리오를 실행하고 시간 초과(기본값 5분)까지 완료될 때까지 기다립니다. 테스트가 통과하면 종료 코드 0과 함께 명령이 종료되고, 그렇지 않으면 종료 코드가 0이 아닙니다. 결과는 위 $?의 출력으로 확인할 수 있습니다.

{{변수.제품명 모바일}}

변수.제품명 모바일}}을 사용하면 {{변수.제품명 웹}}과 거의 유사한 테스트 계획을 실행할 수 있습니다. 시작하려는 테스트 계획의 URL(예: https://mobile-app.autify.com/projects/AAA/test_plans/BBB)을 복사하고 애플리케이션 빌드 파일의 파일 경로(예: iOS의 경우 *.app 또는 Android의 경우 *.apk)도 복사합니다. 그런 다음 아래 명령을 실행합니다:

autify mobile test run --wait --build-path <빌드 경로> <테스트 시나리오 URL>

$ autify mobile test run --wait --build-path /path/to/android.apk https://mobile-app.autify.com/projects/AAA/test_plans/BBB
✅ Successfully uploaded android.apk (ID: CCC). See https://mobile-app.autify.com/projects/AAA/builds?os=android&selectedBuildId=CCC&page=1
✅ Successfully started: https://mobile-app.autify.com/projects/AAA/results/DDD
🕐 Waiting for the test result: https://mobile-app.autify.com/projects/AAA/results/DDD
  ✔ Waiting... (timeout: 300 s)
✅ Test passed!: https://mobile-app.autify.com/projects/AAA/results/DDD

$ echo $?
0

이 명령은 빌드 파일을 업로드하고 업로드된 빌드로 테스트 계획을 실행한 후 시간 초과(기본값 5분)까지 완료될 때까지 기다립니다. 테스트가 통과하면 종료 코드 0과 함께 명령이 종료되고, 그렇지 않으면 종료 코드가 0이 아닙니다. 결과는 위와 같이 $?의 출력으로 확인할 수 있습니다.

업데이트

Autify CLI는 매번 재설치하지 않기 위해 채널 릴리스를 업데이트에 사용합니다. 기본적으로 stable 채널이 사용되며, 실행하여 Autify CLI를 최신 stable 채널로 업데이트할 수 있습니다:

$ autify update
autify-cli: Updating CLI from 0.0.0-aaaaaa to 0.1.0-bbbbbb... done

참고: 홈브루 사용자는 이 명령을 사용하지 말고 대신 홈브루가 업데이트하도록 해야 합니다. 모든 안정 릴리스는 자동으로 탭으로 제공되므로 이 명령으로 최신 버전으로 업데이트할 수 있습니다:

$ brew upgrade autify-cli

참고: 사전 릴리스 버전을 미리 보기 위한 '베타' 채널과 릴리스 후보 채널이 있지만, 대부분의 경우 '안정' 채널로 충분합니다.

구성

설정 파일은 기본적으로 ~/.config/autify/config.env(macOS 또는 Linux) / %LOCALAPPDATA%\autify\config.env(Windows)에 저장됩니다. 환경 변수 XDG_CONFIG_HOME을 통해 구성 기본 디렉터리를 재정의할 수 있습니다.

모든 구성은 환경 변수로 구성되므로 AUTIFY_WEB_ACCESS_TOKEN=mytoken autify 웹 테스트 실행 ...과 같은 동일한 이름의 환경 변수를 제공하여 런타임에 언제든지 재정의할 수 있습니다.

4가지 구성을 사용할 수 있습니다:

autify_web_access_token

변수.제품 이름 웹}}으로 인증할 개인 액세스 토큰입니다.

autify_web_base_path

변수.제품 이름 웹}}과 통신할 API 기본 경로입니다. 기본값은 https://app.autify.com/api/v1입니다.

autify_mobile_access_token

변수.제품명 모바일}}로 인증할 개인 액세스 토큰입니다.

autify_mobile_base_path

변수.제품명 모바일}}과 통신할 API 기본 경로입니다. 기본값은 https://mobile-app.autify.com/api/v1입니다.

명령

다음은 명령어 목록입니다. 이 명령은 사용하기 쉽도록 설계되었기 때문에 API 사양에 대한 사전 지식이 없어도 사용할 수 있습니다. 대부분의 사용 사례를 다룰 수 있으며 더 많은 명령어/기능을 추가하여 계속 개선해 나갈 것입니다. 특정 사용 사례에 맞는 새로운 명령어를 요청하려면 GitHub 이슈에서 언제든지 요청해 주세요.

{{변수.제품명 웹}}

웹 인증 로그인 인증

이 명령은 대화형 또는 비대화형으로 {{변수.제품 이름 웹}}에 로그인할 수 있도록 합니다.

자세한 내용은 GitHub를 참조하세요.

웹 테스트 실행 인증

이 명령은 기능 또는 URL 교체와 같은 다양한 옵션을 사용하여 기존 테스트 시나리오 또는 테스트 계획을 실행합니다. 테스트가 완료될 때까지 기다리는 --wait 옵션도 지원합니다.

자세한 내용은 GitHub를 참조하세요.

웹 테스트 대기 인증

이 명령은 이미 요청된 테스트 시나리오 또는 테스트 계획이 완료될 때까지 기다립니다. 그러나 대부분의 경우 autify web test run --wait을 대신 사용합니다.

자세한 내용은 GitHub를 참조하세요.

{{변수.제품 이름 모바일}}

모바일 인증 로그인

이 명령은 대화형 또는 비대화형으로 {{변수.제품 이름 모바일}}에 로그인할 수 있도록 합니다.

자세한 내용은 GitHub를 참조하세요.

모바일 빌드 업로드 인증

이 명령은 새 빌드 파일을 {{변수.제품명 모바일}}에 업로드하고 빌드 ID를 반환합니다.

자세한 내용은 GitHub를 참조하세요.

모바일 테스트 실행 인증

이 명령은 새 빌드 파일 또는 이미 업로드된 빌드 ID를 사용하는 옵션과 함께 기존 테스트 계획을 실행합니다. 테스트가 완료될 때까지 기다리는 --wait 옵션도 지원합니다.

자세한 내용은 GitHub를 참조하세요.

모바일 테스트 대기 인증

이 명령은 이미 요청된 테스트 계획이 완료될 때까지 기다립니다. 그러나 대부분의 경우 autify mobile test run --wait을 대신 사용합니다.

자세한 내용은 GitHub를 참조하세요.

API 명령어

api 네임스페이스 아래의 명령(autify web api 및 autify mobile api)은 API 사양에서 자동 생성된 명령이므로 여기에 의도적으로 나열되지 않았습니다. 관심이 있으시다면 GitHub를 참조하세요. 여러 API를 api 명령어로 결합하는 훌륭한 사용 사례를 발견하면 누구나 동일한 로직을 쉽게 사용할 수 있도록 autify 웹 테스트 실행과 같은 사용 사례별 명령어로 구현해 드리겠습니다. 깃허브 이슈에서 아이디어를 공유해 주세요.

CI/CD 통합

Autify CLI로 구동되는 공식 CI/CD 통합에 대한 문서가 제공됩니다. CI/CD 통합이 무엇이며 현재 어떤 통합이 있는지 이해하려면 먼저 Autify를 사용한 CI/CD를 읽어보세요.

기여도

Autify CLI는 GitHub에서 호스팅되는 오픈 소스 소프트웨어입니다. 곧 코드 기여에 대한 지침을 제공할 예정입니다.