클라우드 데이터베이스 연결 구성 사용의 이점
클라우드 데이터베이스 연결 구성 기능이 도입되기 전에는 CLI를 통해 데이터베이스 작업을 포함하는 테스트 시나리오를 실행하려면 여러 번거로운 단계를 완료해야 했습니다.
- 수동 내보내기 프로세스: 제품 인터페이스에서 데이터베이스 연결 구성 내보내기 항목을 찾아 파일로 내보내기
- 파일 관리: 내보낸 데이터베이스 연결 구성 파일을 CLI 실행 머신으로 전송
- 경로 구성: 머신에서 파일 경로 복사
- 명령 수정: 실제 경로 값으로 명령줄 옵션 업데이트 (예시):
apidog run --access-token $APIDOG_ACCESS_TOKEN -t 123456 -e 123456 -n 1 -r html,cli --database-connection /Users/xxx/yyy/database-connections.json
이 프로세스는 수많은 준비 작업을 포함했으며, 데이터베이스 연결 구성에 변경 사항이 발생할 때마다 이 모든 단계를 반복해야 했습니다. 전반적인 사용자 경험은 비효율적이고 지루했습니다.
클라우드 데이터베이스 연결 구성을 사용하면 구성 파일을 내보내고, CLI 실행 머신으로 전송하고, 명령줄에서 옵션 값을 수동으로 지정할 필요가 완전히 사라집니다. 클라우드 데이터베이스 연결 구성에서 변수에 대한 실제 값만 설정하면 성공적으로 실행되어 사용자 경험이 크게 향상됩니다.
방법 1: 로컬 값 + 클라우드 데이터베이스 연결 구성 사용
테스트 시나리오의 모든 데이터베이스 연결이 클라우드에 저장된 구성을 사용하는 경우, 데이터베이스 연결 구성 내보내기 옵션은 나타나지 않습니다(더 이상 필요하지 않으므로). CLI 실행 중 시스템은 클라우드 데이터베이스 연결 구성에서 필요한 변수를 직접 검색하고 변수 대체 규칙에 따라 실제 변수 값을 찾아 연결을 설정할 수 있습니다.
단계별 구현:
환경 변수 구성: 환경 관리에서 사용해야 하는 각 환경에 대해 해당 변수의 로컬 값에 실제 데이터베이스 연결 값을 설정합니다.
변수 기반 구성 확인: 데이터베이스 연결 구성이 변수(포트 제외)를 완전히 사용하도록 하여 클라우드 데이터베이스 연결로 저장되었는지 확인합니다.
테스트 시나리오 구성 확인: CLI를 통해 실행하려는 모든 테스트 시나리오가 "클라우드 데이터베이스 연결 구성"(즉, 변수로 저장된 구성)을 사용하는지 확인합니다.
로컬 값 내보내기: CI/CD 페이지로 이동하여 환경/글로벌 변수 아래의 "사용할 로컬 값 내보내기"를 선택한 다음 내보내기 버튼을 클릭합니다.
내보내기 파일 검토 및 수정: 내보낸 파일에서 데이터베이스 연결 구성에 사용되는 환경 변수 값을 볼 수 있습니다. 필요한 경우 파일에서 이 값을 수동으로 수정할 수 있습니다. 파일을 CLI 머신에 배치하고 파일 경로를 복사합니다.
CI/CD 명령 구성: CI/CD 페이지에서 액세스 토큰을 삽입하고 명령을 복사한 다음 변수 파일의 실제 경로를 옵션 값에 붙여넣습니다.
apidog run --access-token $APIDOG_ACCESS_TOKEN -t 123456 -e 123456 -n 1 -r html,cli --variables /Users/xxx/yyy/pptest_variables.json
실행 및 확인: 위 CLI 명령을 실행합니다. 데이터베이스 연결이 올바르게 작동하고 성공적으로 실행되어야 합니다.
결과 검토: 결과 인쇄가 구성된 경우 업로드된 보고서 세부 정보에서 데이터베이스 연결 실행 세부 정보를 볼 수 있습니다.
중요 고려 사항:
⚠️ 보안 참고: 로컬 값은 데이터 보안을 보장하기 위해 실제 데이터베이스 연결 구성에 여전히 로컬 파일 스토리지를 사용합니다. 연결 구성을 변경해야 하는 경우 이 파일에서 해당 변수 값을 수동으로 수정하십시오.
⚠️ 원격 값 경고: 데이터베이스 연결 구성 변수에 원격 값을 사용하는 것은 로컬 값 파일을 내보내고 추가 명령줄 옵션을 추가하는 추가 작업을 피할 수 있지만(그리고 Apidog 클라이언트에서 원격 값을 직접 수정할 수 있지만), 이 접근 방식은 데이터 보안 위험을 초래하며 ❌ 권장되지 않습니다.
⚠️ 일반 텍스트 사용: 연결 구성에서 일반 텍스트를 완전히 또는 부분적으로(포트 필드 제외) 사용하는 경우, 여전히 구성 파일을 내보내고 명령에서 --database-connection을 통해 사용해야 합니다. 이 사용 패턴은 ❌ 권장되지 않습니다.
방법 2: Vault 변수 + 클라우드 데이터베이스 연결 구성 사용
환경 변수 원격 값 + Vault 변수를 사용하여 클라우드 데이터베이스 연결을 유지하고 CLI에서 이 클라우드 저장 연결을 사용하려면 다음 단계를 따르십시오.
단계별 구현:
Vault 변수 구성: 환경 관리에서 해당 변수의 원격 값에 데이터베이스 연결 Vault 변수를 설정하고, 로컬 값은 원격 값을 따르도록 합니다. 사용해야 하는 각 환경에 대해 이를 구성합니다.
변수 기반 구성 확인: 데이터베이스 연결 구성이 변수(포트 제외)를 완전히 사용하도록 하여 클라우드 데이터베이스 연결로 저장되었는지 확인합니다.
테스트 시나리오 구성 확인: CLI를 통해 실행하려는 모든 테스트 시나리오가 "클라우드 데이터베이스 연결 구성"(즉, 변수로 저장된 구성)을 사용하는지 확인합니다.
CI/CD 설정 구성: CI/CD 페이지로 이동하여 환경/글로벌 변수 아래의 "원격 값 사용"을 선택하고, 실제 상황에 따라 구성한 다음 CLI 명령을 복사합니다.
Vault 변수 설정: CLI를 실행해야 하는 머신에서 파이프라인 또는 터미널에 export APIDOG_VAULT_KEY=VALUE를 먼저 입력하여 Vault 변수를 실제로 사용합니다. 여러 Vault 변수는 공백으로 구분합니다.
운영 체제별 구문:
| Linux & MacOS | Windows |
|---|---|
변수 설정: export 사용, 변수는 공백으로 구분export APIDOG_VAULT_KEY1=VALUE1 APIDOG_VAULT_KEY2=VALUE2 APIDOG_VAULT_KEY3=VALUE3 |
변수 설정: set 사용, 변수는 &로 구분set APIDOG_VAULT_KEY1=VALUE1&APIDOG_VAULT_KEY2=VALUE2&APIDOG_VAULT_KEY3=VALUE3 |
변수 쿼리: echo $VARIABLE_NAME 사용echo $APIDOG_VAULT_KEY1 |
변수 쿼리: echo %VARIABLE_NAME% 사용echo %APIDOG_VAULT_KEY1% |
CLI 명령 실행: CLI 명령을 실행하여 실행을 시작합니다.
결과 확인: 완료 후 보고서에서 데이터베이스 연결 결과를 확인하여 데이터베이스 연결 및 작업 실행이 성공했음을 확인할 수 있습니다.
실행 세부 정보 검토: 결과 인쇄가 구성된 경우 업로드된 보고서 세부 정보에서 데이터베이스 연결 실행 세부 정보를 볼 수 있습니다.
중요 알림:
⚠️ 사전 실행 요구 사항: 데이터베이스 연결을 위한 Vault 변수를 포함하는 CLI 명령을 실행하기 전에 항상 export/set을 사용하여 실제 Vault 변수 값을 입력해야 합니다. 그렇지 않으면 실제 구성을 검색할 수 없어 데이터베이스 연결이 실패합니다.
⚠️ 임시 변수 범위: export/set을 통해 입력된 Vault 변수의 실제 값은 현재 실행에만 유효하며 임시 변수처럼 작동합니다. 다음 실행 시에는 이 방법을 사용하여 다시 입력해야 합니다.
결론
클라우드 데이터베이스 연결 구성은 수동 파일 관리를 없애고 구성 복잡성을 줄임으로써 CLI 테스트 워크플로우를 크게 간소화합니다. 로컬 값을 사용하든 Vault 변수를 사용하든 이 접근 방식은 CI/CD 환경에서 데이터베이스 연결 테스트 시나리오를 실행하기 위한 보다 안전하고 효율적이며 유지보수 가능한 솔루션을 제공합니다.
보안 요구 사항 및 운영 선호도에 가장 적합한 방법을 선택하십시오.
- 로컬 값: 로컬 파일 제어를 통해 최대 데이터 보안이 필요한 시나리오에 더 적합
- Vault 변수: 중앙 집중식 비밀 관리가 필요한 자동화된 CI/CD 파이프라인에 이상적
두 가지 접근 방식 모두 데이터베이스 연결의 보안을 유지하면서 최신 테스트 워크플로우에 필요한 유연성과 효율성을 제공합니다.