Dalam pengembangan perangkat lunak kolaboratif, menjalankan pengujian API secara manual setelah setiap commit kode dapat dengan cepat menjadi membosankan. Bukankah lebih baik jika pengujian ini dapat berjalan secara otomatis setiap kali kode baru didorong (push)?
Kabar baiknya adalah hal ini sepenuhnya mungkin. Sebagian besar tim sudah menggunakan platform CI/CD untuk menangani build dan deployment kode, dan platform ini dirancang untuk mendengarkan peristiwa commit Git. Saat Anda mendorong kode, mereka secara otomatis mengeksekusi tugas yang telah ditentukan seperti kompilasi, pengemasan, atau deployment.
Menjalankan pengujian API otomatis tidak berbeda. Apidog menyediakan alat CLI yang memungkinkan Anda memicu pengujian otomatis dengan satu perintah. Dengan menambahkan perintah ini ke alur CI/CD Anda, Anda dapat memastikan bahwa pengujian berjalan secara otomatis setelah setiap pengiriman kode.
Proses penyiapan sangat mudah. Hal utama yang perlu dipahami adalah bagaimana mekanisme pemicu bekerja, lalu memilih pendekatan integrasi yang tepat berdasarkan platform yang digunakan tim Anda.
Bagaimana Pemicu Pengujian Otomatis Bekerja? (Prinsip-prinsipnya)
Inti dari seluruh proses adalah "Mendengarkan Peristiwa + Eksekusi Perintah".
Saat Anda mendorong kode ke repositori Git, platform CI/CD mendengarkan peristiwa Git ini dan, sesuai dengan konfigurasi yang telah Anda atur (seperti skrip pipeline atau file konfigurasi), secara otomatis mengeksekusi perintah pengujian Apidog.
Prinsip ini dapat digambarkan sebagai berikut:
Ada dua cara utama bagi platform CI/CD untuk mendengarkan peristiwa Git:
Yang pertama adalah mekanisme peristiwa bawaan platform. Misalnya, GitHub Actions dapat langsung ditentukan dalam file konfigurasi: on: [push, pull_request]. Saat Anda mendorong kode atau membuat PR, platform secara otomatis mendengarkan peristiwa Git ini dan memulai pengujian.
Yang kedua adalah melalui Webhook, cocok untuk skenario seperti Jenkins di mana komunikasi lintas platform diperlukan. Anda harus mengonfigurasi URL pemicu secara manual.
Terlepas dari metodenya, langkah terakhir selalu sama: eksekusi perintah apidog run untuk memulai pengujian otomatis.
Solusi Integrasi untuk Platform Populer
Jika Anda menggunakan platform hosting kode seperti GitHub atau GitLab, memicu pengujian sangatlah mudah. Platform ini memiliki layanan CI/CD bawaan (seperti GitHub Actions, GitLab CI) yang dapat langsung mendengarkan peristiwa Git dan mengeksekusi tugas. Anda dapat merujuk ke dokumen-dokumen ini untuk memulai dengan cepat:
Namun, banyak tim memiliki penyiapan yang lebih kompleks. Misalnya, kode di-host di GitHub atau GitLab, tetapi alur CI/CD berjalan di Jenkins. Dalam kasus ini, GitHub/GitLab dan Jenkins adalah dua sistem independen — yang pertama tidak dapat langsung memicu yang kedua.
Untuk skenario lintas platform, Webhook adalah solusi yang sederhana dan efektif. Webhook bekerja seperti mekanisme panggilan balik — ketika peristiwa tertentu (seperti push Git) terjadi di GitHub, ia secara aktif mengirimkan permintaan ke URL Webhook yang telah ditentukan untuk memberi tahu sistem eksternal. Dengan menawarkan titik akhir Webhook, Jenkins dapat menerima notifikasi ini dan secara otomatis memicu tugas pengujian.
Mari kita lihat konfigurasi spesifik: kode di-host di GitHub, tetapi pipeline pengujian berjalan di Jenkins.
Integrasi GitHub + Jenkins untuk Menjalankan Pengujian Otomatis Apidog
Jika tim Anda menyimpan kode di GitHub tetapi menggunakan Jenkins untuk menjalankan tugas build, berikut cara Anda dapat mengaturnya:
Langkah 1: Konfigurasi Jenkins dan Dapatkan URL Webhook
Pertama, siapkan tugas pengujian di Jenkins. Ikuti dokumentasi Integrasi dengan Jenkins untuk membuat proyek, mengonfigurasi perintah build, dan memastikan perintah CLI dapat berjalan dengan benar.
Selanjutnya, dapatkan URL Webhook dari Jenkins. URL ini berfungsi sebagai titik masuk bagi sistem eksternal untuk memanggil Jenkins, dan GitHub akan menggunakannya untuk memicu tugas pengujian.
Cara termudah adalah dengan menginstal plugin "Generic Webhook Trigger". Cari dan instal di halaman manajemen plugin Jenkins, lalu mulai ulang Jenkins.
Kemudian buka halaman konfigurasi proyek Anda dan aktifkan plugin ini. Alamat Webhook akan menjadi:
http://<alamat server Jenkins Anda>/generic-webhook-trigger/invoke`
Untuk keamanan, disarankan untuk mengatur Token kustom, sehingga alamatnya menjadi:
http://<alamat server Jenkins Anda>/generic-webhook-trigger/invoke?token=<xxxxxx>Setelah Anda memiliki URL ini, Anda dapat mengonfigurasi Webhook di GitHub.
Langkah 2: Konfigurasi Webhook GitHub
Buka "repositori GitHub Anda → Pengaturan → Webhooks", tambahkan Webhook baru, masukkan alamat dari langkah sebelumnya, atur Tipe Konten ke application/json, pilih push atau peristiwa lain yang ingin Anda picu pengujiannya, dan simpan konfigurasi.
Setelah konfigurasi, setiap push kode akan secara otomatis memicu Jenkins untuk mengeksekusi tugas pengujian. Anda dapat mendorong beberapa kode untuk mengujinya dan memeriksa log build Jenkins serta hasil pengujian.
Langkah 3: Verifikasi Seluruh Proses
Saat Anda mendorong kode ke GitHub, Webhook yang dikonfigurasi akan mengirimkan notifikasi ke Jenkins. Jenkins akan menerima permintaan dan memulai tugas build secara otomatis. Anda dapat melihat log eksekusi pengujian di "Konsol" proyek Jenkins dan melihat laporan pengujian akhir.
Konfigurasi Webhook untuk Platform Lain
Selain GitHub, platform hosting kode lain juga mendukung Webhook, seperti:
Metode konfigurasinya serupa. Kuncinya adalah memahami mekanisme pemicu: commit Git menghasilkan peristiwa, yang kemudian digunakan untuk memberi tahu platform CI/CD melalui pendengaran peristiwa atau Webhook, pada akhirnya memicu eksekusi otomatis perintah pengujian.
Untuk metode integrasi platform CI/CD lainnya, lihat bagian Integrasi CI/CD dari dokumentasi resmi Apidog.