Phương thức Mock Requests trong Python

Khi bạn làm việc với các API, việc kiểm thử trở nên phức tạp hơn do phụ thuộc vào các yếu tố bên ngoài như kết nối mạng hay trạng thái của máy chủ. Để giải quyết vấn đề này, bạn có thể sử dụng kỹ thuật mô phỏng (mocking) các yêu cầu HTTP. Trong bài viết này, bạn sẽ học cách mô phỏng mô-đun requests trong Python để kiểm thử một API bằng cách sử dụng mô-đun unittest. Phương pháp này sẽ giúp bạn kiểm soát và giả lập các phản hồi của API, từ đó kiểm thử mã nguồn một cách độc lập và hiệu quả hơn.

Giới thiệu về mô phỏng requests trong Python

Mô-đun requests là một thư viện HTTP cho phép bạn gửi các yêu cầu HTTP một cách dễ dàng. Thông thường, bạn sử dụng mô-đun requests để gọi một API từ một máy chủ từ xa.

Trong ví dụ này, mình sẽ sử dụng một API công khai được cung cấp bởi jsonplaceholder.typicode.com:

https://jsonplaceholder.typicode.com/

Để thực hiện một cuộc gọi API, bạn sẽ sử dụng phương thức requests.get() để gửi một yêu cầu HTTP GET đến điểm cuối sau:

https://jsonplaceholder.typicode.com/albums/1

Nó sẽ trả về dữ liệu JSON theo định dạng sau:

Bài viết này được đăng tại [free tuts .net]

{
  "userId": 1,
  "id": 1,
  "title": "quidem molestiae enim"
}

Vì mô-đun requests không phải là một mô-đun tích hợp sẵn trong Python, bạn cần cài đặt nó bằng cách chạy lệnh pip sau:

pip install requests

Thực hiện cuộc gọi API sử dụng mô-đun requests trong Python

Sau đây là một mô-đun mới có tên là album.py với một hàm find_album_by_id() trả về một album theo ID:

import requests

def find_album_by_id(id):
    url = f'https://jsonplaceholder.typicode.com/albums/{id}'
    response = requests.get(url)
    if response.status_code == 200:
        return response.json()['title']
    else:
        return None

Cách hoạt động:

Đầu tiên, định dạng điểm cuối API bao gồm tham số id:

url = f'https://jsonplaceholder.typicode.com/albums/{id}'

Thứ hai, gọi hàm get() của mô-đun requests để lấy một đối tượng Response:

response = requests.get(url)

Thứ ba, gọi phương thức json() của đối tượng response nếu cuộc gọi API thành công:

if response.status_code == 200:
   return response.json()['title']
else:
   return None

Phương thức response.json() trả về một dictionary đại diện cho dữ liệu JSON.

Tạo một mô-đun kiểm thử trong Python

Chúng ta sẽ tạo một mô-đun kiểm thử có tên test_album.py để kiểm thử các hàm trong mô-đun album.py:

import unittest
from album import find_album_by_id

class TestAlbum(unittest.TestCase):
   pass

Mô phỏng mô-đun requests trong Python

Hàm find_album_by_id() có hai phụ thuộc:

• Phương thức get() của mô-đun requests
• Đối tượng Response trả về từ hàm get()

Để kiểm thử hàm find_album_by_id(), bạn cần:

• Mô phỏng mô-đun requests và gọi hàm get() (mock_requests)
• Mô phỏng đối tượng response trả về

Nói cách khác, mock_requests.get() trả về một đối tượng response giả.

Để mô phỏng mô-đun requests, bạn có thể sử dụng hàm patch(). Giả sử rằng mock_requests là một giả lập của mô-đun requests.

Hàm mock_requests.get() nên trả về một giả lập cho response. Để mô phỏng response, bạn có thể sử dụng lớp MagicMock của mô-đun unittest.mock.

Dưới đây là cách kiểm thử hàm find_album_by_id() bằng cách sử dụng phương thức kiểm thử test_find_album_by_id_success():

import unittest
from unittest.mock import MagicMock, patch
from album import find_album_by_id

class TestAlbum(unittest.TestCase):

    @patch('album.requests')
    def test_find_album_by_id_success(self, mock_requests):
        # Mô phỏng phản hồi
        mock_response = MagicMock()
        mock_response.status_code = 200
        mock_response.json.return_value = {
            'userId': 1,
            'id': 1,
            'title': 'hello',
        }

        # Chỉ định giá trị trả về của phương thức get()
        mock_requests.get.return_value = mock_response

        # Gọi hàm find_album_by_id và kiểm thử nếu tiêu đề là 'hello'
        self.assertEqual(find_album_by_id(1), 'hello')

Cách hoạt động:

Đầu tiên, mô phỏng mô-đun requests thành đối tượng mock_requests:

@patch('album.requests')
def test_find_album_by_id_success(self, mock_requests):
    # ...

Thứ hai, mô phỏng phản hồi của hàm get() bằng cách sử dụng lớp MagicMock. Trong phương thức kiểm thử này, mình chỉ định mã trạng thái 200 và giá trị trả về của hàm json() là một giá trị mã hóa cứng:

mock_response = MagicMock()
mock_response.status_code = 200
mock_response.json.return_value = {
   'userId': 1,
   'id': 1,
   'title': 'hello',
}

Thứ ba, sử dụng mock_response làm giá trị trả về của hàm get():

mock_requests.get.return_value = mock_response

Cuối cùng, kiểm thử nếu tiêu đề của album bằng với giá trị mà mình đã chỉ định trong mock_response:

self.assertEqual(find_album_by_id(1), 'hello')

Chạy kiểm thử:

python -m unittest -v

Kết quả:

test_find_album_by_id_success (test_album.TestAlbum) ... ok
----------------------------------------------------------------------
Ran 1 test in 0.001s

OK

Sử dụng cùng kỹ thuật này, bạn cũng có thể kiểm thử hàm find_album_by_id() trong trường hợp thất bại:

import unittest
from unittest.mock import MagicMock, patch
from album import find_album_by_id

class TestAlbum(unittest.TestCase):

    @patch('album.requests')
    def test_find_album_by_id_success(self, mock_requests):
        # Mô phỏng phản hồi
        mock_response = MagicMock()
        mock_response.status_code = 200
        mock_response.json.return_value = {
            'userId': 1,
            'id': 1,
            'title': 'hello',
        }

        # Chỉ định giá trị trả về của phương thức get()
        mock_requests.get.return_value = mock_response

        # Gọi hàm find_album_by_id và kiểm thử nếu tiêu đề là 'hello'
        self.assertEqual(find_album_by_id(1), 'hello')

    @patch('album.requests')
    def test_find_album_by_id_fail(self, mock_requests):
        mock_response = MagicMock()
        mock_response.status_code = 400

        mock_requests.get.return_value = mock_response
        self.assertIsNone(find_album_by_id(1))

Kết quả:

test_find_album_by_id_fail (test_album.TestAlbum) ... ok
test_find_album_by_id_success (test_album.TestAlbum) ... ok
----------------------------------------------------------------------
Ran 2 tests in 0.002s

OK

Kết bải

Trong bài viết này, mình đã tìm hiểu cách sử dụng patch() và MagicMock từ mô-đun unittest.mock để mô phỏng mô-đun requests trong Python. Điều này cho phép mình kiểm thử các hàm gọi API một cách độc lập và hiệu quả hơn, mà không cần phụ thuộc vào sự tồn tại thực tế của các kết nối mạng hay máy chủ.

Mình đã thấy cách giả lập hàm get() của requests để trả về các phản hồi giả lập, bao gồm cả các trường hợp thành công và thất bại của API. Việc này giúp đảm bảo rằng các hàm của mình hoạt động đúng như kỳ vọng trong các điều kiện kiểm thử khác nhau.

Ngoài ra, việc sử dụng patch() cũng cho phép mình làm sạch các giả lập sau mỗi phương thức kiểm thử, giúp bảo vệ sự cô lập và tính độc lập của từng bài kiểm tra.

Hy vọng hướng dẫn này đã hữu ích cho bạn trong việc hiểu và áp dụng các kỹ thuật kiểm thử trong Python. Chúc bạn thành công trong việc phát triển phần mềm!