Tích hợp kiểm thử API tự động với DeerFlow và Postman

Trong kiến trúc microservice, các dịch vụ thường tương tác với nhau thông qua các giao diện lập trình ứng dụng (API). Việc kiểm thử thủ công các API này không chỉ tốn nhiều thời gian và công sức mà còn dễ phát sinh sai sót. Khi hệ thống ngày càng mở rộng với số lượng API tăng lên, công tác kiểm thử trở nên phức tạp hơn.

DeerFlow, một khuôn khổ nghiên cứu đa tác tử, cung cấp một loạt các API phong phú cho phép gọi từ bên ngoài. Tính ổn định và độ tin cậy của các API này ảnh hưởng trực tiếp đến khả năng sẵn sàng của toàn bộ hệ thống. Thông qua việc sử dụng Postman để tự động hóa kiểm thử, chúng ta có thể đảm bảo rằng mỗi API hoạt động đúng như mong đợi, kịp thời phát hiện và khắc phục các sự cố.

Chuẩn bị môi trường và cấu hình công cụ

Cài đặt phần mềm cần thiết

Trước tiên, hãy đảm bảo bạn đã cài đặt các công cụ sau:

# Cài đặt Node.js (dùng để chạy script kiểm thử)
brew install node

# Cài đặt Newman (trình chạy dòng lệnh cho Postman)
npm install -g newman

# Cài đặt newman-reporter-html (để tạo báo cáo dạng HTML)
npm install -g newman-reporter-html

Cấu hình môi trường Postman

  1. Tải xuống và cài đặt phiên bản Postman dành cho máy tính.
  2. Tạo một không gian làm việc mới, đặt tên là "DeerFlow-API-Testing".
  3. Nhập tài liệu API của DeerFlow (nếu có tệp định dạng OpenAPI/Swagger).

Tạo bộ sưu tập kiểm thử Postman

Thiết lập yêu cầu cơ bản

Bắt đầu bằng việc thiết lập các biến môi trường để lưu trữ cấu hình thường dùng:

// Thiết lập biến môi trường trong tab Tests của Postman
pm.environment.set("base_url", "http://localhost:8000");
pm.environment.set("api_version", "v1");

Viết các trường hợp kiểm thử

Tạo các trường hợp kiểm thử cho các API cốt lõi của DeerFlow:

// Ví dụ kiểm thử API TTS
const ttsTest = {
    "name": "Kiểm thử API TTS",
    "request": {
        "method": "POST",
        "header": [
            {
                "key": "Content-Type",
                "value": "application/json"
            }
        ],
        "body": {
            "mode": "raw",
            "raw": JSON.stringify({
                "text": "Kiểm tra chức năng chuyển văn bản thành giọng nói",
                "speed_ratio": 1.0,
                "volume_ratio": 1.0,
                "pitch_ratio": 1.0
            })
        },
        "url": {
            "raw": "{{base_url}}/api/tts",
            "host": ["{{base_url}}"],
            "path": ["api", "tts"]
        }
    },
    "response": []
};

Viết script kiểm thử tự động

Xác minh kiểm thử cơ bản

Thêm các khẳng định kiểm thử cho mỗi yêu cầu API:

// Kiểm tra mã trạng thái là 200
pm.test("Mã trạng thái là 200", function () {
    pm.response.to.have.status(200);
});

// Kiểm tra thời gian phản hồi nằm trong giới hạn hợp lý
pm.test("Thời gian phản hồi dưới 2 giây", function () {
    pm.expect(pm.response.responseTime).to.be.below(2000);
});

// Kiểm tra phản hồi chứa các trường cần thiết
pm.test("Phản hồi chứa dữ liệu hợp lệ", function () {
    const response = pm.response.json();
    pm.expect(response).to.have.property('success', true);
    pm.expect(response).to.have.property('data');
});

Các kịch bản kiểm thử nâng cao

Xử lý các kịch bản kiểm thử phức tạp hơn, ví dụ như các phụ thuộc và kiểm thử quy trình:

// Kiểm thử API quy trình nghiên cứu
pm.test("Kiểm thử quy trình nghiên cứu hoàn chỉnh", function () {
    const response = pm.response.json();
    
    // Xác minh ID nghiên cứu tồn tại
    pm.expect(response).to.have.property('research_id');
    
    // Lưu research_id làm biến môi trường cho các yêu cầu tiếp theo
    pm.environment.set("research_id", response.research_id);
    
    // Xác minh trạng thái là 'accepted'
    pm.expect(response).to.have.property('status', 'accepted');
});

// Yêu cầu tiếp theo sử dụng ID nghiên cứu đã lưu
const researchStatusRequest = {
    "method": "GET",
    "url": "{{base_url}}/api/research/{{research_id}}/status"
};

Tích hợp vào quy trình làm việc của DeerFlow

Tạo quy trình kiểm thử

Tích hợp kiểm thử API vào quy trình CI/CD:

# .github/workflows/api-tests.yml
name: Kiểm thử API

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  test:
    runs-on: ubuntu-latest
    
    steps:
    - uses: actions/checkout@v3
    
    - name: Thiết lập Node.js
      uses: actions/setup-node@v3
      with:
        node-version: '18'
    
    - name: Cài đặt Newman
      run: npm install -g newman newman-reporter-html
    
    - name: Chạy Kiểm thử API
      run: |
        newman run deerflow-api-tests.postman_collection.json \
          -e deerflow-env.postman_environment.json \
          -r html,cli \
          --reporter-html-export test-results.html
    
    - name: Tải lên Kết quả Kiểm thử
      uses: actions/upload-artifact@v3
      with:
        name: kết quả-kiểm-thử-api
        path: test-results.html

Xử lý ngoại lệ kiểm thử

Thêm cơ chế xử lý ngoại lệ để đảm bảo tính ổn định của kiểm thử:

// Cơ chế thử lại
const maxRetries = 3;
const retryDelay = 1000; // 1 giây

const runTestWithRetry = async (request, retries = maxRetries) => {
    try {
        const response = await pm.sendRequest(request);
        return response;
    } catch (error) {
        if (retries > 0) {
            console.log(`Số lần thử lại còn lại: ${retries}`);
            await new Promise(resolve => setTimeout(resolve, retryDelay));
            return runTestWithRetry(request, retries - 1);
        }
        throw error;
    }
};

// Thực hiện kiểm thử bằng cơ chế thử lại
runTestWithRetry(ttsTest)
    .then(response => {
        // Xử lý phản hồi thành công
        pm.test("Kiểm thử API TTS thành công", function () {
            pm.expect(response.code).to.equal(200);
        });
    })
    .catch(error => {
        // Xử lý lỗi cuối cùng
        console.error("Kiểm thử thất bại:", error);
    });

Báo cáo kiểm thử và giám sát

Tạo báo cáo kiểm thử chi tiết

Cấu hình Newman để tạo báo cáo ở nhiều định dạng:

# Chạy kiểm thử và tạo báo cáo ở nhiều định dạng
newman run deerflow-api-tests.postman_collection.json \
  -e deerflow-env.postman_environment.json \
  -r html,json,junit \
  --reporter-html-export report.html \
  --reporter-json-export report.json \
  --reporter-junit-export report.xml

Thiết lập giám sát kiểm thử

Tạo bảng điều khiển giám sát để theo dõi tình trạng sức khỏe của API:

// Ví dụ script giám sát
const monitorAPIHealth = async () => {
    const endpoints = [
        { name: 'API TTS', url: '/api/tts', method: 'POST' },
        { name: 'API Trạng thái Nghiên cứu', url: '/api/research/status', method: 'GET' },
        { name: 'API Truy vấn Kiến thức', url: '/api/knowledge/query', method: 'POST' }
    ];
    
    const results = [];
    
    for (const endpoint of endpoints) {
        const startTime = Date.now();
        try {
            const response = await pm.sendRequest({
                url: `${pm.environment.get('base_url')}${endpoint.url}`,
                method: endpoint.method,
                timeout: 5000
            });
            
            const responseTime = Date.now() - startTime;
            results.push({
                name: endpoint.name,
                status: 'healthy',
                responseTime: responseTime,
                statusCode: response.code
            });
        } catch (error) {
            results.push({
                name: endpoint.name,
                status: 'unhealthy',
                error: error.message
            });
        }
    }
    
    return results;
};

Hiệu quả ứng dụng thực tế

Trong môi trường microservice thực tế, giải pháp kiểm thử này đã thể hiện giá trị rõ rệt. Thông qua kiểm thử tự động, chúng ta có thể:

  • Xác minh nhanh chóng tính đầy đủ chức năng của API sau mỗi lần commit mã nguồn.
  • Kịp thời phát hiện các vấn đề tương thích do thay đổi API.
  • Giám sát các chỉ số hiệu suất API, đảm bảo thời gian phản hồi nằm trong phạm vi chấp nhận được.
  • Giảm khối lượng công việc kiểm thử thủ công, nâng cao độ bao phủ của kiểm thử.

Đặc biệt trong các hệ thống đa tác tử như DeerFlow, nơi các thành phần phối hợp chặt chẽ với nhau thông qua API, kiểm thử tự động đảm bảo tính ổn định và độ tin cậy của toàn bộ hệ thống. Phạm vi kiểm thử bao gồm từ kiểm thử API đơn lẻ đơn giản đến kiểm thử quy trình nghiệp vụ đa bước phức tạp, cung cấp sự đảm bảo vững chắc cho chất lượng hệ thống.

Kết luận

Nhìn chung, giải pháp kiểm thử API tự động dựa trên Postman cho DeerFlow thực sự hữu ích. Quá trình triển khai và cấu hình tương đối đơn giản, việc viết các trường hợp kiểm thử cũng rất trực quan, có thể bắt đầu sử dụng mà không cần nền tảng kỹ thuật quá phức tạp. Về hiệu quả, nó bao phủ tốt các tình huống kiểm thử API chính và phát hiện kịp thời các vấn đề về API. Trong các dự án thực tế, nên bắt đầu với các API cốt lõi và dần dần mở rộng phạm vi kiểm thử. Khi gặp các tình huống phức tạp, có thể tận dụng chức năng scripting của Postman để thực hiện logic kiểm thử linh hoạt hơn. Về tích hợp liên tục, kết hợp với GitHub Actions hoặc các công cụ CI khác, có thể thực hiện quy trình kiểm thử tự động thực sự. Nếu bạn cũng đang xây dựng các hệ thống có mật độ API cao tương tự, hãy thử phương pháp này, nó sẽ giúp bạn tiết kiệm đáng kể thời gian kiểm thử và nâng cao độ tin cậy của hệ thống. Trong tương lai, có thể cân nhắc bổ sung kiểm thử hiệu năng và kiểm thử bảo mật để phạm vi kiểm thử toàn diện hơn.

Thẻ: API Testing postman Newman Automation Testing CI/CD

Đăng vào ngày 25 tháng 7 lúc 01:03

Thẻ Phổ Biến

©2026 Thành phố Cuồng loạn