Prasyarat#
Jenkins telah terinstal dan berjalan (v2.0 atau yang lebih baru direkomendasikan)
Node.js v16 atau yang lebih baru terinstal pada host Jenkins
Akun Apidog dengan skenario pengujian yang telah dibuat
Akses untuk menghasilkan token akses Apidog
Menginstal Jenkins#
Jenkins adalah alat build otomatis yang membantu pengembang mengotomatiskan proses build, pengujian, dan deployment aplikasi selama proses pengembangan perangkat lunak. Berikut cara menginstalnya pada sistem Linux:1.
Tambahkan kunci publik GPG Jenkins:
2.
Tambahkan sumber Jenkins ke daftar sumber perangkat lunak APT:
3.
Perbarui daftar paket APT:
http://localhost:8080 atau http://{your_public_IP}:8080 untuk mengakses dasbor Jenkins. Konsol menyediakan API web bagi Anda untuk mengelola dan mengonfigurasi layanan Jenkins.Mengonfigurasi Lingkungan Node.js untuk Jenkins#
Sebelum menjalankan Apidog CLI, Anda perlu memastikan bahwa nomor versi Node.js adalah v16 atau yang lebih baru, sehingga Anda perlu mengonfigurasi dependensi NodeJS di lingkungan Jenkins terlebih dahulu.
1.
Buka pengelolaan plugin Jenkins dan temukan plugin NodeJS, instal plugin tersebut, lalu mulai ulang.
2.
Buat NodeJS baru dalam konfigurasi alat global, konfigurasikan nomor versi (memerlukan v16 atau yang lebih baru) dan nama paket apidog-cli.
1.
Tambahkan konfigurasi dalam pipeline visual (Freestyle Project)
2.
Integrasikan kode tertanam ke dalam pipeline (Pipeline)
Menjalankan Perintah CLI#
Mengonfigurasi Pipeline Secara Visual#
Buka Apidog dan ambil perintah CLI dari halaman detail Continuous Integration. Jika lingkungan Jenkins Anda memiliki akses internet, Anda dapat memilih untuk menggunakan perintah "Run online data in real time". Jika akses internet tidak tersedia, Anda perlu terlebih dahulu mengekspor file data JSON CLI ke dalam lingkungan, lalu mengeksekusinya melalui CLI.Pada halaman konfigurasi proyek, temukan bagian Build Environment, centang opsi "Provide Node & npm bin/ folder to PATH", dan pilih versi NodeJS (misalnya, nodejs18) yang telah Anda konfigurasikan di bagian Global Tool Configuration (Tools).Setelah menyiapkan lingkungan build, buka bagian Build Steps, klik Add build step, dan pilih Execute Shell (pilih Execute Windows Batch Command jika Anda menggunakan sistem Windows).Tempelkan perintah Apidog CLI ke dalam kotak input Command dan simpan konfigurasi.Klik Build Now dalam proyek untuk memulai eksekusi.Anda dapat memeriksa progres dan hasil build di "Build History."Mengintegrasikan Kode Tertanam ke dalam Pipeline#
Buka tab CI/CD dan salin cuplikan kode tertanam, lalu tempelkan ke file konfigurasi Jenkins Anda.Cukup tempelkan kode secara langsung ke konfigurasi pipeline Jenkins untuk menyematkannya ke dalam alur kerja CI/CD Anda yang sudah ada.nodejs18 yang disebutkan di sini merujuk pada alias NodeJS yang telah ditetapkan sebelumnya — silakan ganti dengan alias Anda yang sebenarnya. Selain itu, pastikan untuk mengganti variabel $APIDOG_ACCESS_TOKEN dalam kode dengan Access Token Anda yang sebenarnya. Sebagai alternatif, Anda dapat menambahkan variabel lingkungan bernama APIDOG_ACCESS_TOKEN di Jenkins melalui Dashboard → Manage Jenkins → System, dan menetapkan nilainya ke Access Token Anda. Ini memungkinkan pipeline membaca Access Token Anda selama eksekusi.Anda dapat menyederhanakan kode di atas dengan menghapus skrip untuk menginstal Apidog CLI. Dengan demikian, tidak perlu menginstal ulang apidog-cli setiap kali build dieksekusi, sehingga mengurangi waktu build dan konsumsi sumber daya. Hal ini dimungkinkan karena NodeJS dan paket npm global (yaitu, apidog-cli) telah dikonfigurasi sebelumnya di bagian Global Tool Configuration (Tools), sehingga alat yang diperlukan sudah tersedia selama proses build.Klik Build Now dalam proyek untuk memulai eksekusi.Menerbitkan Laporan dengan Jenkins#
Tentukan nama laporan yang dihasilkan ${JOB_NAME}_${BUILD_NUMBER} (variabel bawaan Jenkins) dalam perintah. Gunakan plugin HTML Publisher untuk melihat laporan.