Cài đặt và chạy Apidog CLI

Apidog CLI được thiết kế để chạy các kịch bản kiểm thử Apidog trong dòng lệnh. Để bắt đầu sử dụng Apidog CLI, hãy cài đặt Node.js, sau đó cài đặt Apidog CLI. Sau đó, bạn có thể chạy các kịch bản kiểm thử của mình.

Điều kiện tiên quyết

Node.js v16 trở lên đã được cài đặt trên hệ thống của bạn

npm (Node Package Manager) đã được cài đặt

Tài khoản Apidog có các kịch bản kiểm thử đã được tạo

Cài đặt Apidog CLI

Apidog CLI được xây dựng trên Node.js. Để chạy Apidog CLI, vui lòng cài đặt Node.js trước khi sử dụng.

Apidog CLI phụ thuộc vào Node.js phiên bản v16 trở lên.

Cài đặt Apidog CLI từ npm dưới dạng toàn cục trên hệ thống của bạn, cho phép bạn chạy nó từ bất kỳ đâu:

Dưới đây là một số lệnh để xác minh Apidog CLI đã được cài đặt thành công hay chưa.

Nếu được cài đặt thành công, hệ thống sẽ trực tiếp in số phiên bản và đường dẫn cài đặt sau khi thực thi các lệnh ở trên.

Đầu ra Terminal hiển thị việc cài đặt Apidog CLI thành công với số phiên bản và đường dẫn

Cập nhật Apidog CLI

Sử dụng lệnh bên dưới để nâng cấp Apidog CLI.

Chạy Apidog CLI

Để chạy các kịch bản kiểm thử bằng Apidog CLI, trước tiên bạn cần tạo và điều phối một kịch bản kiểm thử. Sau đó, bạn có thể chạy kịch bản kiểm thử từ dòng lệnh bằng Apidog CLI, giống như khi chạy trong giao diện trực quan, và nhận báo cáo kiểm thử.

Apidog CLI hỗ trợ hai cách chạy:

Chạy với dữ liệu trực tuyến: Phù hợp với các kịch bản trực tiếp.

Chạy với các kịch bản kiểm thử đã xuất: Phù hợp với các kịch bản ngoại tuyến.

Chạy dữ liệu trực tuyến theo thời gian thực

Trong một kịch bản kiểm thử, chuyển sang tab CI/CD.

Tab CI/CD trong giao diện kịch bản kiểm thử Apidog

Cấu hình môi trường, dữ liệu kiểm thử, số lần lặp, độ trễ, v.v.

Trong phần nhà cung cấp CI/CD, chọn "Command line".

Nhấp vào nút "Add access token", sau đó nhấp "Generate token".

Tìm hiểu thêm về access token.

Nhấp vào lệnh để sao chép.

Dán và chạy lệnh trong dòng lệnh. Và bạn sẽ nhận được báo cáo kiểm thử trong dòng lệnh.

Ở Bước 2, các cấu hình bạn thiết lập sẽ tự động xác định các tùy chọn và giá trị được sử dụng trong CLI:

Môi trường: Ánh xạ tới -e <environmentId>.

Dữ liệu kiểm thử: Ánh xạ tới -d <testDataId>.

Số lần lặp: Ánh xạ tới -n <n>.

Độ trễ: Ánh xạ tới --delay-request <n>.

Biến môi trường/biến toàn cục: Nếu chọn Export current value and use it, bạn có thể tìm thấy một tùy chọn xuất bên dưới để xuất các giá trị hiện tại của biến môi trường/biến toàn cục từ dự án của bạn ra một tệp. Điều này ảnh hưởng đến --variables <path>. Bạn sẽ cần nhập tệp này vào máy chạy CLI và chỉ định đường dẫn của tệp thông qua --variables <path>. Tìm hiểu thêm về sự khác biệt giữa "Use initial value" và "Export current value and use it" tại đây.

Nếu kịch bản kiểm thử của bạn cũng sử dụng các cấu hình kết nối cơ sở dữ liệu được lưu trữ cục bộ, giao diện sản phẩm sẽ hướng dẫn bạn xuất các cấu hình này ra một tệp cục bộ, điều này ảnh hưởng đến --database-connection <path>. Sau đó, bạn sẽ cần nhập tệp đã xuất này vào máy chạy CLI và chỉ định đường dẫn của tệp trong --database-connection <path>.

Chạy dữ liệu đã xuất

Tùy chọn này cho phép bạn chạy các kiểm thử ngoại tuyến cục bộ bằng các tệp đã xuất.

Trong một kịch bản kiểm thử, chuyển sang tab CI/CD.

Cấu hình môi trường, dữ liệu kiểm thử, số lần lặp, độ trễ, v.v.

Trong nhà cung cấp CI/CD, chọn "Command line", sau đó chuyển sang "Run exported data".

Tùy chọn chạy dữ liệu đã xuất trong cấu hình CI/CD

Xuất kịch bản kiểm thử dưới dạng tệp JSON.

Sao chép lệnh được hiển thị bên dưới.

Dán và chạy lệnh trong dòng lệnh. Bạn sẽ nhận được báo cáo kiểm thử dòng lệnh.

Các thiết lập ở bước 2 (chẳng hạn như "Run Online Data") sẽ tự động ảnh hưởng đến các tùy chọn và giá trị được sử dụng trong CLI bên dưới. Lưu ý rằng khi chạy theo cách này, các biến môi trường/biến toàn cục sử dụng các giá trị từ tệp được xuất cùng với kịch bản kiểm thử. Tìm hiểu thêm tại đây.

Báo cáo kiểm thử CLI

Sau khi chạy CLI, bạn sẽ nhận được báo cáo kiểm thử trên dòng lệnh bao gồm thống kê thực thi cho các kịch bản kiểm thử cũng như xác thực và khẳng định cho các yêu cầu thất bại.

Bạn cũng có thể tìm thấy thư mục /apidog-reports/ trong thư mục nơi bạn đã chạy CLI. Thư mục này chứa báo cáo kiểm thử CLI ở định dạng HTML.

Tùy chọn

Apidog CLI cung cấp một tập hợp tùy chọn phong phú để tùy chỉnh một lần chạy collection. Tìm hiểu thêm tại Apidog CLI Options.

Sử dụng Apidog CLI với CI/CD

Apidog CLI hỗ trợ tích hợp với nhiều công cụ pipeline khác nhau, chẳng hạn như Jenkins, GitLab, GitHub Actions, v.v. Tìm hiểu thêm về tích hợp CI/CD.

Cài đặt và chạy Apidog CLI

Điều kiện tiên quyết#

Cài đặt Apidog CLI#

Cập nhật Apidog CLI#

Chạy Apidog CLI#

Chạy dữ liệu trực tuyến theo thời gian thực#

Chạy dữ liệu đã xuất#

Báo cáo kiểm thử CLI#

Tùy chọn#

Sử dụng Apidog CLI với CI/CD#

Điều kiện tiên quyết

Cài đặt Apidog CLI

Cập nhật Apidog CLI

Chạy Apidog CLI

Chạy dữ liệu trực tuyến theo thời gian thực

Chạy dữ liệu đã xuất

Báo cáo kiểm thử CLI

Tùy chọn

Sử dụng Apidog CLI với CI/CD