So, these days I was working in a project that uses requests to make some http\/https calls:<\/p>\n
\nimport requests\n\n\nURL = 'https:\/\/us.api.battle.net\/wow\/auction\/data\/{}?locale=en_US'\nAPI = 'myapikey'\n\ndef request_with_api(url):\n apikey = {'apikey': API}\n return requests.get(url, params=apikey)\n\n\ndef get_auctions_url(realm):\n url = URL.format(realm)\n r = request_with_api(url)\n if r.status_code == 200:\n data = r.json()\n data_url = data['files'][0]['url']\n return data_url\n return None\n\n\ndef get_auctions(realm):\n url = get_auctions_url(realm)\n if url:\n r = request_with_api(url)\n if r.status_code == 200:\n return r.json()\n else:\n raise Exception('Error in return code: %s' % r.status_code)\n else:\n raise Exception('Auction data not found')\n\n\nif __name__ == '__main__':\n auctions = get_auctions('medivh')\n print auctions\n\n<\/pre>\nAnd as usual, I wanted to have my unit tests, and requests is very tricky, because, you don’t want to keep making requests to the real server, every time you run your unit tests, and here is a couple of reasons:<\/p>\n
\n- I’ll depend of internet to access the server all the time<\/li>\n
- The server has a limit of requests that I don’t want to waste testing<\/li>\n
- Some servers may block your account if you do too many requests in a small amount of time.<\/li>\n<\/ol>\n
Mocking<\/h2>\n
So, the easiest way to test would be using mock<\/a>, and then do something like this:<\/p>\n\nimport unittest\nimport mock\n\nimport wow\n\nfrom wow import request_with_api\n\nclass TestWow(unittest.TestCase):\n\n @mock.patch('wow.request_with_api')\n def test_get_auctions_url(self, wow_patch):\n wow_patch.return_value.status_code = 200\n wow_patch.return_value.json.return_value = {'files': [\n {'url': ('http:\/\/auction-api-us.worldofwarcraft.com\/'\n 'auction-data')}\n ]}\n data = wow.get_auctions_url('medivh')\n wow_patch.assert_called_once()\n self.assertEquals(data,\n 'http:\/\/auction-api-us.worldofwarcraft.com\/auction-data')\n\n wow_patch.reset_mock()\n wow_patch.return_value.status_code = 403\n data = wow.get_auctions_url('medivh')\n wow_patch.assert_called_once()\n self.assertIsNone(data)\n\n\nif __name__ == '__main__':\n unittest.main()\n\n<\/pre>\nThis looks good, all I have to do is set the mock return values, reset the mock, set the values of the status_code, the return of the r.json() value, and all of this inside our tests. Of course, I could create the setUp method, and configure the values there:<\/p>\n
\nimport unittest\nimport mock\n\nimport wow\n\nfrom wow import request_with_api\n\nclass TestWow(unittest.TestCase):\n def setUp(self):\n self.ok_return = ('http:\/\/auction-api-us.worldofwarcraft.com\/'\n 'auction-data')\n self.json_ok_return = {\n 'files': [\n {\n 'url': self.ok_return\n }\n ]\n }\n\n @mock.patch('wow.request_with_api')\n def test_get_auctions_url(self, wow_patch):\n wow_patch.return_value.status_code = 200\n wow_patch.return_value.json.return_value = self.json_ok_return\n data = wow.get_auctions_url('medivh')\n wow_patch.assert_called_once()\n self.assertEquals(data, self.ok_return)\n\n wow_patch.reset_mock()\n\n wow_patch.return_value.status_code = 403\n data = wow.get_auctions_url('medivh')\n wow_patch.assert_called_once()\n self.assertIsNone(data)\n\n\nif __name__ == '__main__':\n unittest.main()\n\n<\/pre>\nNow, so far, we are only testing the get_auctions_url method, let’s add the test to get_auctions method, who calls the get_auctions_url method as well:<\/p>\n
\nimport unittest\nimport mock\n\nimport wow\n\n\nclass TestWow(unittest.TestCase):\n def setUp(self):\n self.ok_return = ('http:\/\/auction-api-us.worldofwarcraft.com\/'\n 'auction-data')\n self.json_ok_return = {\n 'files': [\n {\n 'url': self.ok_return\n }\n ]\n }\n\n self.json_auction_data = {\n 'content': {\n "realms": [\n {"name": "Medivh", "slug": "medivh"},\n {"name": "Exodar", "slug": "exodar"}\n ],\n "auctions": [\n {\n "auc": 1283349179, "item": 129158,\n "owner": "Toiletcow",\n "ownerRealm": "Medivh", "bid": 8360, "buyout": 8800,\n "quantity": 1, "timeLeft": "LONG", "rand": 0,\n "seed": 0, "context": 0\n }\n ]\n }\n }\n\n @mock.patch('wow.request_with_api')\n def test_get_auctions_url(self, wow_patch):\n wow_patch.return_value.status_code = 200\n wow_patch.return_value.json.return_value = self.json_ok_return\n data = wow.get_auctions_url('medivh')\n wow_patch.assert_called_once()\n self.assertEquals(data, self.ok_return)\n\n wow_patch.reset_mock()\n\n wow_patch.return_value.status_code = 403\n data = wow.get_auctions_url('medivh')\n wow_patch.assert_called_once()\n self.assertIsNone(data)\n\n @mock.patch('wow.get_auctions_url')\n @mock.patch('wow.request_with_api')\n def test_get_auctions(self, request_with_api_mock,\n get_auctions_url_mock):\n get_auctions_url_mock.return_value = None\n self.assertRaises(Exception, wow.get_auctions, 'medivh')\n get_auctions_url_mock.assert_called_once()\n\n get_auctions_url_mock.reset_mock()\n\n request_with_api_mock.return_value.status_code = 200\n request_with_api_mock.return_value.json.return_value = (\n self.json_auction_data)\n get_auctions_url_mock.return_value = self.ok_return\n get_auctions_url_mock.json.return_value = self.json_auction_data\n data = wow.get_auctions('medivh')\n self.assertDictEqual(data, self.json_auction_data)\n\n\nif __name__ == '__main__':\n unittest.main()\n\n<\/pre>\nSo, now things are starting to get a little bit messy, here we need to mock both wow.get_auctions_url, and wow.request_with_api, and reset the mocks and assert that the mock is being called once. It works, but still, it’as a mess for the next guy who will check this code.<\/p>\n
HTTMock<\/h2>\n