Модульное тестирование приложения на Python, использующего библиотеку запросов

Question

Я пишу приложение, которое выполняет операции REST, используя библиотеку запросов Кеннета Рейтца , и я изо всех сил пытаюсь найти хороший способ для модульного тестирования этих приложений, потому что запросы предоставляют свои методы с помощью методов уровня модуля.

Что я хочу, так это умение синтезировать разговор между двумя сторонами; предоставить серию утверждений и ответов на запросы.

Answer 1

Если вы используете специальные запросы, попробуйте httmock . Это удивительно просто и элегантно:

from httmock import urlmatch, HTTMock
import requests

# define matcher:
@urlmatch(netloc=r'(.*\.)?google\.com$')
def google_mock(url, request):
    return 'Feeling lucky, punk?'

# open context to patch
with HTTMock(google_mock):
    # call requests
    r = requests.get('http://google.com/')
print r.content  # 'Feeling lucky, punk?'

Если вы хотите что-то более общее (например, чтобы издеваться над любой библиотекой, выполняющей вызовы http), выберите httpretty .

Почти так же элегантно:

import requests
import httpretty

@httpretty.activate
def test_one():
    # define your patch:
    httpretty.register_uri(httpretty.GET, "http://yipit.com/",
                        body="Find the best daily deals")
    # use!
    response = requests.get('http://yipit.com')
    assert response.text == "Find the best daily deals"

HTTPretty гораздо более многофункциональный - он также предлагает имитирующий код состояния, потоковые ответы, чередующиеся ответы, динамические ответы (с обратным вызовом).

Answer 2

На самом деле немного странно, что в библиотеке есть пустая страница о модульном тестировании конечного пользователя, ориентированная на удобство использования и простоту использования. Однако Dropbox предлагает простую в использовании библиотеку, что неудивительно называется responses. Вот его вступительное сообщение . В нем говорится, что они не смогли использовать httpretty, не указав причину ошибки, и написали библиотеку с похожим API.

import unittest

import requests
import responses


class TestCase(unittest.TestCase):

  @responses.activate  
  def testExample(self):
    responses.add(**{
      'method'         : responses.GET,
      'url'            : 'http://example.com/api/123',
      'body'           : '{"error": "reason"}',
      'status'         : 404,
      'content_type'   : 'application/json',
      'adding_headers' : {'X-Foo': 'Bar'}
    })

    response = requests.get('http://example.com/api/123')

    self.assertEqual({'error': 'reason'}, response.json())
    self.assertEqual(404, response.status_code)

Answer 3

Вы можете использовать ложную библиотеку, такую ​​как Mocker , чтобы перехватывать вызовы библиотеки запросов и возвращать указанные результаты.

В качестве очень простого примера рассмотрим этот класс, который использует запросыбиблиотека:

class MyReq(object):
    def doSomething(self):
        r = requests.get('https://api.github.com', auth=('user', 'pass'))
        return r.headers['content-type']

Вот модульный тест, который перехватывает вызов на requests.get и возвращает указанный результат для тестирования:

import unittest
import requests
import myreq

from mocker import Mocker, MockerTestCase

class MyReqTests(MockerTestCase):
    def testSomething(self):
        # Create a mock result for the requests.get call
        result = self.mocker.mock()
        result.headers
        self.mocker.result({'content-type': 'mytest/pass'})

        # Use mocker to intercept the call to requests.get
        myget = self.mocker.replace("requests.get")
        myget('https://api.github.com', auth=('user', 'pass'))
        self.mocker.result(result)

        self.mocker.replay()

        # Now execute my code
        r = myreq.MyReq()
        v = r.doSomething()

        # and verify the results
        self.assertEqual(v, 'mytest/pass')
        self.mocker.verify()

if __name__ == '__main__':
    unittest.main()

Когда я запускаю этот модульный тест, я получаю следующеерезультат:

.
----------------------------------------------------------------------
Ran 1 test in 0.004s

OK

Answer 4

с использованием mocker, как в ответе srgerg:

def replacer(method, endpoint, json_string):
    from mocker import Mocker, ANY, CONTAINS
    mocker = Mocker()
    result = mocker.mock()
    result.json()
    mocker.count(1, None)
    mocker.result(json_string)
    replacement = mocker.replace("requests." + method)
    replacement(CONTAINS(endpoint), params=ANY)
    self.mocker.result(result)
    self.mocker.replay()

Для библиотеки запросов это будет перехватывать запрос по методу и конечной точке, к которой вы обращаетесь, и заменять .json () в ответе на json_stringпрошло.

Answer 5

В этих ответах отсутствует запросов-макет .

С их страницы:

>>> import requests
>>> import requests_mock

Как менеджер контекста:

>>> with requests_mock.mock() as m:

...     m.get('http://test.com', text='data')
...     requests.get('http://test.com').text
...
'data'

Или как декоратор:

>>> @requests_mock.mock()
... def test_func(m):
...     m.get('http://test.com', text='data')
...     return requests.get('http://test.com').text
...
>>> test_func()
'data'