Điều kiện tiên quyết#
Jenkins đã được cài đặt và đang chạy (khuyến nghị v2.0 trở lên)
Node.js v16 trở lên đã được cài đặt trên máy chủ Jenkins
Tài khoản Apidog đã tạo các kịch bản kiểm thử
Quyền truy cập để tạo token truy cập Apidog
Cài đặt Jenkins#
Jenkins là một công cụ build tự động giúp nhà phát triển tự động hóa quy trình build, kiểm thử và triển khai ứng dụng trong quá trình phát triển phần mềm. Sau đây là cách cài đặt Jenkins trên hệ thống Linux:1.
Thêm khóa công khai GPG của Jenkins:
2.
Thêm nguồn Jenkins vào danh sách nguồn phần mềm APT:
3.
Cập nhật danh sách gói APT:
5.
Khởi động dịch vụ Jenkins:
http://localhost:8080 hoặc http://{your_public_IP}:8080 để truy cập bảng điều khiển Jenkins. Console cung cấp một web API để bạn quản lý và cấu hình các dịch vụ Jenkins.Cấu hình môi trường Node.js cho Jenkins#
Trước khi chạy Apidog CLI, bạn cần đảm bảo số phiên bản Node.js là v16 trở lên, vì vậy trước tiên bạn cần cấu hình các phụ thuộc NodeJS trong môi trường Jenkins.
1.
Mở phần quản lý plugin của Jenkins, tìm plugin NodeJS, cài đặt plugin và khởi động lại.
2.
Tạo một NodeJS mới trong cấu hình công cụ toàn cục, cấu hình số phiên bản (yêu cầu v16 trở lên) và tên gói apidog-cli.
1.
Thêm cấu hình trong pipeline trực quan (Freestyle Project)
2.
Tích hợp mã nhúng vào pipeline (Pipeline)
Chạy lệnh CLI#
Cấu hình pipeline bằng giao diện trực quan#
Mở Apidog và lấy lệnh CLI từ trang chi tiết Tích hợp liên tục. Nếu môi trường Jenkins của bạn có quyền truy cập internet, bạn có thể chọn sử dụng lệnh "Run online data in real time". Nếu không có quyền truy cập internet, trước tiên bạn cần xuất tệp dữ liệu CLI JSON vào môi trường, sau đó thực thi tệp đó thông qua CLI.Trong trang cấu hình dự án, tìm phần Build Environment, chọn tùy chọn "Provide Node & npm bin/ folder to PATH", và chọn phiên bản NodeJS (ví dụ: nodejs18) mà bạn đã cấu hình trong phần Global Tool Configuration (Tools).Sau khi thiết lập môi trường build, chuyển đến phần Build Steps, nhấp vào Add build step, và chọn Execute Shell (chọn Execute Windows Batch Command nếu bạn đang sử dụng hệ thống Windows).Dán lệnh Apidog CLI vào ô nhập Command và lưu cấu hình.Nhấp vào Build Now trong dự án để bắt đầu thực thi.Bạn có thể kiểm tra tiến trình và kết quả build trong "Build History".Tích hợp mã nhúng vào pipeline#
Chuyển đến tab CI/CD và sao chép đoạn mã nhúng, sau đó dán đoạn mã đó vào tệp cấu hình Jenkins của bạn.Chỉ cần dán mã trực tiếp vào cấu hình pipeline Jenkins để nhúng mã vào quy trình CI/CD hiện có của bạn.nodejs18 được đề cập ở đây là bí danh NodeJS đã được thiết lập trước đó — vui lòng thay thế bằng bí danh thực tế của bạn. Ngoài ra, hãy đảm bảo thay thế biến $APIDOG_ACCESS_TOKEN trong mã bằng Access Token thực tế của bạn. Ngoài ra, bạn có thể thêm một biến môi trường có tên APIDOG_ACCESS_TOKEN trong Jenkins tại Dashboard → Manage Jenkins → System, và đặt giá trị của biến này thành Access Token của bạn. Điều này cho phép pipeline đọc Access Token của bạn trong quá trình thực thi.Bạn có thể đơn giản hóa mã ở trên bằng cách xóa script cài đặt Apidog CLI. Bằng cách này, không cần cài đặt lại apidog-cli mỗi khi một build được thực thi, giúp giảm cả thời gian build và mức tiêu thụ tài nguyên. Điều này khả thi vì NodeJS và các gói npm toàn cục (tức là apidog-cli) đã được cấu hình trước trong Global Tool Configuration (Tools), đảm bảo các công cụ cần thiết luôn sẵn sàng trong quá trình build.Nhấp vào Build Now trong dự án để bắt đầu thực thi.Xuất bản báo cáo với Jenkins#
Chỉ định tên báo cáo được tạo ${JOB_NAME}_${BUILD_NUMBER} (biến tích hợp sẵn của Jenkins) trong lệnh. Sử dụng plugin HTML Publisher để xem báo cáo.