Newman có thể report kết quả test thành những file định dạng nào?

Danh mục:

Newman, công cụ dòng lệnh (command-line tool) do Postman phát triển, giúp tự động hóa việc chạy và test Collections Postman. Một tính năng hữu ích của Newman là khả năng tạo báo cáo chi tiết về kết quả test, giúp bạn dễ dàng theo dõi và phân tích hiệu suất của API. Newman hỗ trợ nhiều định dạng báo cáo khác nhau, đáp ứng nhu cầu đa dạng của người dùng.

1. Các định dạng báo cáo được hỗ trợ

Newman cung cấp 4 định dạng báo cáo chính:

HTML: Định dạng mặc định, tạo báo cáo web dễ đọc với thông tin chi tiết về mỗi request, response, assertion và kết quả test tổng thể.
JSON: Định dạng dữ liệu JSON, phù hợp cho việc xử lý tự động hoặc tích hợp với các công cụ khác.
Console: Hiển thị báo cáo text đơn giản trong terminal, hữu ích cho việc chạy nhanh và theo dõi kết quả test cơ bản.
JUnit XML: Định dạng XML tiêu chuẩn cho báo cáo JUnit, tương thích với các công cụ CI/CD và hệ thống quản lý test liên tục.

2. Chọn định dạng báo cáo

Để chọn định dạng báo cáo mong muốn, sử dụng tùy chọn --reporter khi chạy Newman. Ví dụ:
- HTML: newman run my-collection.json --reporter html
- JSON: newman run my-collection.json --reporter json
- Console: newman run my-collection.json --reporter console
- JUnit XML: newman run my-collection.json --reporter junit

3. Tùy chỉnh báo cáo

Ngoài việc chọn định dạng, bạn có thể tùy chỉnh thêm nội dung và bố cục báo cáo bằng cách sử dụng:
- Tập tin configuration: Tạo tập tin JSON newman-configuration.json để định nghĩa các tùy chỉnh báo cáo nâng cao.
- Handler báo cáo: Viết mã JavaScript để xử lý và tùy chỉnh báo cáo theo nhu cầu cụ thể.

4. Ví dụ

Tạo báo cáo HTML với tiêu đề tùy chỉnh:

{
  "reporter": "html",
  "reporterOptions": {
    "title": "My API Test Report"
  }
}

Tạo báo cáo JSON với các trường tùy chỉnh:

{
  "reporter": "json",
  "reporterOptions": {
    "fields": ["name", "method", "url", "status", "response_time"]
  }
}

5. Lựa chọn định dạng phù hợp

HTML: Phù hợp cho việc xem xét thủ công, dễ đọc và trực quan.
JSON: Phù hợp cho việc xử lý tự động, tích hợp với hệ thống khác hoặc lưu trữ dữ liệu.
Console: Phù hợp cho việc chạy nhanh, theo dõi kết quả cơ bản trong terminal.
JUnit XML: Phù hợp cho việc tích hợp với các công cụ CI/CD và hệ thống quản lý test liên tục.

6. Lưu ý

Newman hỗ trợ đa dạng định dạng báo cáo, giúp bạn linh hoạt theo dõi và phân tích kết quả test API. Lựa chọn định dạng phù hợp sẽ phụ thuộc vào nhu cầu và mục đích sử dụng của bạn.

Tham khảo thêm: