Menginstal dan Menjalankan Apidog CLI

Apidog CLI dirancang untuk menjalankan skenario pengujian Apidog di baris perintah. Untuk mulai menggunakan Apidog CLI, instal Node.js, kemudian Apidog CLI. Setelah itu, Anda dapat menjalankan skenario pengujian Anda.

Prasyarat

Node.js v16 atau yang lebih baru terinstal pada sistem Anda

npm (Node Package Manager) terinstal

Akun Apidog dengan skenario pengujian yang telah dibuat

Menginstal Apidog CLI

Apidog CLI dibangun di atas Node.js. Untuk menjalankan Apidog CLI, silakan instal Node.js sebelum menggunakannya.

Apidog CLI bergantung pada Node.js versi v16 atau yang lebih baru.

Instal Apidog CLI dari npm secara global pada sistem Anda, sehingga Anda dapat menjalankannya dari mana saja:

Berikut adalah beberapa perintah untuk memverifikasi apakah Apidog CLI berhasil diinstal.

Jika berhasil diinstal, perintah di atas akan langsung mencetak nomor versi dan jalur instalasi setelah dijalankan.

Output terminal yang menunjukkan instalasi Apidog CLI berhasil dengan nomor versi dan jalur

Memperbarui Apidog CLI

Gunakan perintah di bawah ini untuk meningkatkan versi Apidog CLI.

Menjalankan Apidog CLI

Untuk menjalankan skenario pengujian menggunakan Apidog CLI, Anda terlebih dahulu perlu membuat dan mengorkestrasi skenario pengujian. Kemudian, Anda dapat menjalankan skenario pengujian dari baris perintah menggunakan Apidog CLI, seperti menjalankannya di antarmuka visual, dan mendapatkan laporan pengujian.

Apidog CLI mendukung dua cara menjalankan:

Menjalankan dengan data online: Ini sesuai untuk skenario langsung.

Menjalankan dengan skenario pengujian yang diekspor: Ini sesuai untuk skenario offline.

Menjalankan Data Online secara Real Time

Dalam skenario pengujian, beralihlah ke tab CI/CD.

Tab CI/CD di antarmuka skenario pengujian Apidog

Konfigurasikan lingkungan, data pengujian, iterasi, penundaan, dan sebagainya.

Di bagian penyedia CI/CD, pilih "Command line".

Klik tombol "Add access token" lalu "Generate token".

Pelajari selengkapnya tentang access token.

Klik perintah untuk menyalinnya.

Tempel dan jalankan perintah di baris perintah. Anda akan mendapatkan laporan pengujian di baris perintah.

Pada Langkah 2, konfigurasi yang Anda tetapkan akan secara otomatis menentukan opsi dan nilai yang digunakan di CLI:

Lingkungan: Dipetakan ke -e <environmentId>.

Data pengujian: Dipetakan ke -d <testDataId>.

Iterasi: Dipetakan ke -n <n>.

Penundaan: Dipetakan ke --delay-request <n>.

Variabel lingkungan/global: Jika memilihExport current value and use it, Anda dapat menemukan opsi ekspor di bawah untuk mengekspor nilai saat ini dari variabel lingkungan/global dari proyek Anda ke sebuah file. Ini memengaruhi--variables <path>. Anda perlu mengimpor file ini ke mesin yang menjalankan CLI dan menentukan jalurnya melalui--variables <path>. Pelajari selengkapnya tentang perbedaan antara "Use initial value" dan "Export current value and use it" di sini.

Jika skenario pengujian Anda juga menggunakan konfigurasi koneksi database yang disimpan secara lokal, antarmuka produk akan memandu Anda untuk mengekspor konfigurasi ini ke file lokal, yang memengaruhi --database-connection <path>. Anda kemudian perlu mengimpor file yang diekspor ini ke mesin yang menjalankan CLI dan menentukan jalurnya di--database-connection <path>.

Menjalankan Data yang Diekspor

Opsi ini memungkinkan Anda menjalankan pengujian offline secara lokal menggunakan file yang diekspor.

Dalam skenario pengujian, beralihlah ke tab CI/CD.

Konfigurasikan lingkungan, data pengujian, iterasi, penundaan, dan sebagainya.

Di penyedia CI/CD, pilih "Command line" lalu beralih ke "Run exported data".

Opsi Run exported data dalam konfigurasi CI/CD

Ekspor skenario pengujian sebagai file JSON.

Salin perintah yang ditampilkan di bawah.

Tempel dan jalankan perintah di baris perintah. Anda akan mendapatkan laporan pengujian baris perintah.

Pengaturan pada langkah 2 (seperti "Run Online Data") akan secara otomatis memengaruhi opsi dan nilai yang digunakan di CLI di bawah ini. Perhatikan bahwa saat menjalankan dengan cara ini, variabel lingkungan/global menggunakan nilai dari file yang diekspor bersama skenario pengujian. Pelajari selengkapnya di sini.

Laporan Pengujian CLI

Setelah menjalankan CLI, Anda akan menerima laporan pengujian baris perintah yang mencakup statistik eksekusi untuk skenario pengujian serta validasi dan aservi untuk permintaan yang gagal.

Anda juga dapat menemukan direktori /apidog-reports/ di folder tempat Anda menjalankan CLI. Direktori ini berisi laporan pengujian CLI dalam format HTML.

Opsi

Apidog CLI menyediakan serangkaian opsi yang lengkap untuk menyesuaikan eksekusi collection. Pelajari selengkapnya di Apidog CLI Options.

Menggunakan Apidog CLI dengan CI/CD

Apidog CLI mendukung integrasi dengan berbagai alat pipeline, seperti Jenkins, GitLab, GitHub Actions, dan lainnya. Pelajari selengkapnya tentang mengintegrasikan CI/CD.

Menginstal dan Menjalankan Apidog CLI

Prasyarat#

Menginstal Apidog CLI#

Memperbarui Apidog CLI#

Menjalankan Apidog CLI#

Menjalankan Data Online secara Real Time#

Menjalankan Data yang Diekspor#

Laporan Pengujian CLI#

Opsi#

Menggunakan Apidog CLI dengan CI/CD#

Prasyarat

Menginstal Apidog CLI

Memperbarui Apidog CLI

Menjalankan Apidog CLI

Menjalankan Data Online secara Real Time

Menjalankan Data yang Diekspor

Laporan Pengujian CLI

Opsi

Menggunakan Apidog CLI dengan CI/CD