如何在 Django 中测试从外部端点请求数据的函数

Question

我正在尝试在我的 django api 上测试我的函数，这些函数对外部 api 执行外部请求。 我如何测试以下场景：成功、失败和超时等异常

下面是一个简化的功能

def get_quote(*args):
    # log request
    try:
      response = requests.post(url, json=data)
      # parse this response
    except:
      # log file :)
    finally:
      # log_response(...)
  return parsed_response or None

无：响应可以是成功，失败，可以是超时。 我想测试那些场景

Answer 1

您可以模拟调用外部 API 的结果并在测试函数中设置一个预期的返回值：

from unittest.mock import patch
from django.test import TestCase

class ExternalAPITests(TestCase):

    @patch("requests.post")
    def test_get_quote(self, mock):
         mock.return_value = "predetermined external result"
         self.assertEquals("expected return value", get_quote())

Answer 2

您可以使用响应包 - https://pypi.org/project/responses/

import unittest
import responses
from your_package import get_quote


class TestPackage(unittest.TestCase):

    @responses.activate
    def test_get_quote(self):
        url = "http://some_fake_url.com"
        responses.add(responses.POST, url, json={"test": "ok"}, status=200)
        self.assertDictEqual({"test": "ok"}, get_quote(url))

    @responses.activate
    def test_get_quote_with_exception(self):
        url = "http://some_fake_url.com"
        responses.add(responses.POST, url, body=Exception('...'))
        with self.assertRaises(Exception):
            get_quote(url)