單元測試使用圖書館

Question

我寫使用肯尼斯·賴茨的requests library，我努力尋找一個很好的方式，單元測試這些應用程序執行REST操作的應用程序的請求Python應用程序，因爲請求通過模塊 - 提供其方法級別的方法。

我想是合成雙方之間的對話的能力;提供一系列請求斷言和響應。

Answer 1

你可以用嘲弄的庫如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 2

使用模仿者就像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_string響應更換以.json（）

。

Answer 3

如果您使用的具體要求嘗試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 4

事實上，這是一個有些奇怪的是，圖書館擁有大約終端用戶單元測試一個空白頁，而針對用戶友好性和易用性。然而，Dropbox有一個易於使用的庫，不出意外地稱爲responses。這是它的intro post。它說他們沒有僱用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 5

這些答案的缺失是requests-mock。

從他們的網頁：

>>> 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'