Manfaat Menggunakan Konfigurasi Koneksi Basis Data Cloud
Sebelum diperkenalkannya fungsionalitas konfigurasi koneksi basis data cloud, menjalankan skenario pengujian dengan operasi basis data melalui CLI memerlukan penyelesaian beberapa langkah yang merepotkan:
- Proses Ekspor Manual: Temukan entri ekspor konfigurasi koneksi basis data di antarmuka produk dan ekspor sebagai file
- Manajemen File: Transfer file konfigurasi koneksi basis data yang diekspor ke mesin eksekusi CLI
- Konfigurasi Jalur: Salin jalur file di mesin
- Modifikasi Perintah: Perbarui opsi baris perintah dengan nilai jalur sebenarnya, contohnya:
apidog run --access-token $APIDOG_ACCESS_TOKEN -t 123456 -e 123456 -n 1 -r html,cli --database-connection /Users/xxx/yyy/database-connections.json
Proses ini melibatkan banyak tugas persiapan, dan setiap perubahan pada konfigurasi koneksi basis data memerlukan pengulangan semua langkah ini. Pengalaman pengguna secara keseluruhan tidak efisien dan membosankan.
Dengan konfigurasi koneksi basis data cloud, Anda dapat sepenuhnya menghilangkan kebutuhan untuk mengekspor file konfigurasi, mentransfernya ke mesin eksekusi CLI, dan secara manual menentukan nilai opsi dalam baris perintah. Cukup atur nilai aktual untuk variabel dalam konfigurasi koneksi basis data cloud agar berjalan dengan sukses, secara signifikan meningkatkan pengalaman pengguna.
Metode 1: Menggunakan Nilai Lokal + Konfigurasi Koneksi Basis Data Cloud
Ketika semua koneksi basis data dalam skenario pengujian Anda menggunakan konfigurasi yang disimpan di cloud, opsi ekspor konfigurasi koneksi basis data tidak akan muncul (karena tidak lagi diperlukan). Selama eksekusi CLI, sistem dapat langsung mengambil variabel yang diperlukan dari konfigurasi koneksi basis data cloud dan menemukan nilai variabel aktual sesuai dengan aturan penggantian variabel untuk membangun koneksi.
Implementasi Langkah demi Langkah:
Konfigurasi Variabel Lingkungan: Dalam manajemen lingkungan, atur nilai koneksi basis data aktual dalam nilai lokal variabel yang sesuai untuk setiap lingkungan yang perlu Anda gunakan.
Pastikan Konfigurasi Berbasis Variabel: Pastikan konfigurasi koneksi basis data Anda menggunakan variabel sepenuhnya (kecuali untuk port), memastikan bahwa itu disimpan sebagai koneksi basis data cloud.
Verifikasi Konfigurasi Skenario Pengujian: Konfirmasikan bahwa semua skenario pengujian yang ingin Anda jalankan melalui CLI menggunakan "konfigurasi koneksi basis data cloud" (yaitu, konfigurasi yang disimpan dengan variabel).
Ekspor Nilai Lokal: Navigasikan ke halaman CI/CD, pilih "Ekspor nilai lokal untuk digunakan" di bawah Variabel Lingkungan/Global, lalu klik tombol ekspor.
Tinjau dan Modifikasi File Ekspor: Dalam file yang diekspor, Anda akan melihat nilai variabel lingkungan yang digunakan oleh konfigurasi koneksi basis data. Anda dapat secara manual memodifikasi nilai-nilai ini dalam file jika diperlukan. Tempatkan file di mesin CLI dan salin jalur file.
Konfigurasi Perintah CI/CD: Di halaman CI/CD, masukkan Token Akses Anda, salin perintah, dan tempelkan jalur aktual file variabel ke dalam nilai opsi:
apidog run --access-token $APIDOG_ACCESS_TOKEN -t 123456 -e 123456 -n 1 -r html,cli --variables /Users/xxx/yyy/pptest_variables.json
Jalankan dan Verifikasi: Jalankan perintah CLI di atas. Koneksi basis data seharusnya berfungsi dengan benar dan berhasil dieksekusi.
Tinjau Hasil: Jika pencetakan hasil dikonfigurasi, Anda dapat melihat detail eksekusi koneksi basis data di detail laporan yang diunggah.
Pertimbangan Penting:
⚠️ Catatan Keamanan: Nilai lokal masih menggunakan penyimpanan file lokal untuk konfigurasi koneksi basis data aktual guna memastikan keamanan data. Jika Anda perlu mengubah konfigurasi koneksi, modifikasi secara manual nilai variabel yang sesuai dalam file ini.
⚠️ Peringatan Nilai Jarak Jauh: Meskipun menggunakan nilai jarak jauh untuk variabel konfigurasi koneksi basis data dapat menghindari operasi ekstra mengekspor file nilai lokal dan menambahkan opsi baris perintah tambahan (dan memungkinkan modifikasi langsung nilai jarak jauh di klien Apidog), pendekatan ini menimbulkan risiko keamanan data dan ❌ tidak direkomendasikan.
⚠️ Penggunaan Teks Biasa: Jika Anda menggunakan teks biasa sepenuhnya atau sebagian (kecuali untuk bidang port) dalam konfigurasi koneksi Anda, Anda masih perlu mengekspor file konfigurasi dan menggunakannya melalui --database-connection dalam perintah. Pola penggunaan ini ❌ tidak direkomendasikan.
Metode 2: Menggunakan Variabel Vault + Konfigurasi Koneksi Basis Data Cloud
Jika Anda menggunakan nilai jarak jauh variabel lingkungan + variabel Vault untuk mempertahankan koneksi basis data cloud, dan ingin menggunakan koneksi yang disimpan di cloud ini di CLI, ikuti langkah-langkah ini:
Implementasi Langkah demi Langkah:
Konfigurasi Variabel Vault: Dalam manajemen lingkungan, atur variabel Vault koneksi basis data dalam nilai jarak jauh variabel yang sesuai, menjaga nilai lokal mengikuti nilai jarak jauh. Konfigurasi ini untuk setiap lingkungan yang perlu Anda gunakan.
Pastikan Konfigurasi Berbasis Variabel: Pastikan konfigurasi koneksi basis data Anda menggunakan variabel sepenuhnya (kecuali untuk port), memastikan bahwa itu disimpan sebagai koneksi basis data cloud.
Verifikasi Konfigurasi Skenario Pengujian: Konfirmasikan bahwa semua skenario pengujian yang ingin Anda jalankan melalui CLI menggunakan "konfigurasi koneksi basis data cloud" (yaitu, konfigurasi yang disimpan dengan variabel).
Konfigurasi Pengaturan CI/CD: Navigasikan ke halaman CI/CD, pilih "Gunakan nilai jarak jauh" di bawah Variabel Lingkungan/Global, konfigurasikan sesuai dengan situasi aktual Anda, lalu salin perintah CLI.
Atur Variabel Vault: Di mesin tempat Anda perlu menjalankan CLI, dalam pipeline atau terminal Anda, pertama-tama masukkan export APIDOG_VAULT_KEY=VALUE untuk benar-benar menggunakan variabel Vault. Pisahkan beberapa variabel Vault dengan spasi.
Sintaks Spesifik Sistem Operasi:
| Linux & MacOS | Windows |
|---|---|
Atur Variabel: Gunakan export, pisahkan variabel dengan spasiexport APIDOG_VAULT_KEY1=VALUE1 APIDOG_VAULT_KEY2=VALUE2 APIDOG_VAULT_KEY3=VALUE3 |
Atur Variabel: Gunakan set, pisahkan variabel dengan &set APIDOG_VAULT_KEY1=VALUE1&APIDOG_VAULT_KEY2=VALUE2&APIDOG_VAULT_KEY3=VALUE3 |
Kueri Variabel: Gunakan echo $VARIABLE_NAMEecho $APIDOG_VAULT_KEY1 |
Kueri Variabel: Gunakan echo %VARIABLE_NAME%echo %APIDOG_VAULT_KEY1% |
Jalankan Perintah CLI: Jalankan perintah CLI Anda untuk memulai eksekusi.
Verifikasi Hasil: Setelah selesai, Anda dapat melihat hasil koneksi basis data dalam laporan, mengonfirmasi koneksi basis data dan eksekusi operasi yang berhasil.
Tinjau Detail Eksekusi: Jika pencetakan hasil dikonfigurasi, Anda dapat melihat detail eksekusi koneksi basis data di detail laporan yang diunggah.
Pengingat Penting:
⚠️ Persyaratan Pra-eksekusi: Sebelum menjalankan perintah CLI yang berisi variabel Vault untuk koneksi basis data, selalu gunakan export/set untuk memasukkan nilai variabel Vault yang sebenarnya. Jika tidak, koneksi basis data akan gagal karena ketidakmampuan untuk mengambil konfigurasi yang sebenarnya.
⚠️ Cakupan Variabel Sementara: Nilai aktual variabel Vault yang dimasukkan melalui export/set hanya berlaku untuk eksekusi saat ini, berfungsi seperti variabel sementara. Anda perlu memasukkannya kembali menggunakan metode ini untuk eksekusi selanjutnya.
Kesimpulan
Konfigurasi koneksi basis data cloud secara signifikan menyederhanakan alur kerja pengujian CLI dengan menghilangkan manajemen file manual dan mengurangi kompleksitas konfigurasi. Baik menggunakan nilai lokal maupun variabel Vault, pendekatan ini menyediakan solusi yang lebih aman, efisien, dan mudah dipelihara untuk menjalankan skenario pengujian yang terhubung ke basis data di lingkungan CI/CD.
Pilih metode yang paling sesuai dengan persyaratan keamanan dan preferensi operasional Anda:
- Nilai Lokal: Lebih baik untuk skenario yang memerlukan keamanan data maksimum dengan kontrol file lokal
- Variabel Vault: Ideal untuk pipeline CI/CD otomatis dengan manajemen rahasia terpusat
Kedua pendekatan ini memastikan koneksi basis data Anda tetap aman sambil memberikan fleksibilitas dan efisiensi yang dibutuhkan untuk alur kerja pengujian modern.