クラウドデータベース接続設定を使用する利点
クラウドデータベース接続設定機能が導入される前は、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パイプラインに最適です。
どちらのアプローチも、現代のテストワークフローに必要な柔軟性と効率性を提供しながら、データベース接続のセキュリティを確保します。